## Configuration Guide

- VCollabWeb Configuration
- VCollabWeb Deployment

### VCollabWeb Configuration

VCollabWeb Viewer GUI can be customized by following methods

- Configuration file
- URL Querystring Parameter

Configuration file :

VCollabWeb Viewer GUI can be customized with the "config.json" file which is available at "[Extracted folder]/others/config.json" path.
This configuration feature is available from the version "VCollabWeb 2017 R1 Version 1.1.117.1207" onwards.

Sample config.json file and descriptions are shown below

        {
        "showUpdateMsgDays" : 0,
        "changeLogFile" : "others/changeLog.txt",
        "gui" : {
                "showGUI" : true,
                "showFileOpen" : true,
                "filterMenuIcons" : true,
                "menuIcons" :{
                                "viewpoints": true,
                                "caeanimation": true,
                                "displaymode": true,
                                "capture": true,
                                "fitview": true,
                                "resetviewpoint": true,
                                "legend": true,
                                "settings" : true,
                                "frameinfo": true,
                                "fullscreen": true
                            }
                }
        }

#### showUpdateMsgDays

Description | : | Use this option to define the days, update/change message Box should popup. It uses client machine date time to find the time difference.
Number | : | boolean
Values | : | any non negative number(0 - disable update/change popup message Box).
Default value | : | 0
Sample | : | showUpdateMsgDays: 7
See also | : | changeLogFile

#### changeLogFile

Description | : | URL path to the update/change log.
Number | : | String
Values | : | any URL path.
Default value | : | "others/changeLog.txt"
Sample | : | changeLogFile: "others/changeLog.txt "
See also | : | showUpdateMsgDays

#### showGUI

Description | : | Enable/Disable Viewer GUI.
Number | : | boolean
Values | : | true/false.
Default value | : | true
Sample | : | "gui" : { showGUI: false }
See also | : | GUI

#### showFileOpen

Description | : | Enable/Disable File Open bar.
Number | : | boolean
Values | : | true/false.
Default value | : | false
Sample | : | "gui" : { showFileOpen: true }
See also | : | -

#### filterMenuIcons

Description | : | Enable/Disable the filtering option for menu icons.
Number | : | boolean
Values | : | true/false.
Default value | : | false
Sample | : | "gui" : { filterMenuIcons: true }
See also | : | menuIcons

#### viewpoints

Description | : | Enable/Disable the viewpoint icon in the menu. "filterMenuIcons" should be true or else this option will be ignored.
Number | : | boolean
Values | : | true/false.
Default value | : | true
Sample | : | gui" : { "filterMenuIcons" : true, "menuIcons" :{ " viewpoints ": false } }
See also | : | filterMenuIcons

#### caeanimation

Description | : | Enable/Disable the CAE Animation icon in the menu. "filterMenuIcons" should be true or else this option will be ignored.
Number | : | boolean
Values | : | true/false.
Default value | : | true
Sample | : | gui" : { "filterMenuIcons" : true, "menuIcons" :{ " caeanimation ": false } }
See also | : | filterMenuIcons

#### displaymode

Description | : | Enable/Disable the display mode icon in the menu. "filterMenuIcons" should be true or else.
Number | : | boolean
Values | : | true/false.
Default value | : | true
Sample | : | gui" : { "filterMenuIcons" : true, "menuIcons" :{ " displaymode ": false } }
See also | : | filterMenuIcons

#### capture

Description | : | Enable/Disable the capture icon in the menu. "filterMenuIcons" should be true or else this option will be ignored.
Number | : | boolean
Values | : | true/false.
Default value | : | true
Sample | : | gui" : { "filterMenuIcons" : true, "menuIcons" :{ " capture ": false } }
See also | : | filterMenuIcons

#### fitview

Description | : | Enable/Disable the fitview icon in the menu. "filterMenuIcons" should be true or else this option will be ignored.
Number | : | boolean
Values | : | true/false.
Default value | : | true
Sample | : | gui" : { "filterMenuIcons" : true, "menuIcons" :{ " fitview ": false } }
See also | : | filterMenuIcons

#### resetviewpoint

Description | : | Enable/Disable the resetviewpoint icon in the menu. "filterMenuIcons" should be true or else this option will be ignored.
Number | : | boolean
Values | : | true/false.
Default value | : | true
Sample | : | gui" : { "filterMenuIcons" : true, "menuIcons" :{ " resetviewpoint ": false } }
See also | : | filterMenuIcons

#### legend

Description | : | Enable/Disable the legend icon in the menu. "filterMenuIcons" should be true or else this option will be ignored.
Number | : | boolean
Values | : | true/false.
Default value | : | true
Sample | : | gui" : { "filterMenuIcons" : true, "menuIcons" :{ " legend ": false } }
See also | : | filterMenuIcons

#### settings

Description | : | Enable/Disable the settings icon in the menu. "filterMenuIcons" should be true or else this option will be ignored.
Number | : | boolean
Values | : | true/false.
Default value | : | true
Sample | : | gui" : { "filterMenuIcons" : true, "menuIcons" :{ " settings ": false } }
See also | : | filterMenuIcons

#### frameinfo

Description | : | Enable/Disable the frameinfo icon in the menu. "filterMenuIcons" should be true or else this option will be ignored.
Number | : | boolean
Values | : | true/false.
Default value | : | true
Sample | : | gui" : { "filterMenuIcons" : true, "menuIcons" :{ " frameinfo ": false } }
See also | : | filterMenuIcons

#### fullscreen

Description | : | Enable/Disable the full screen icon in the menu. "filterMenuIcons" should be true or else this option will be ignored.
Number | : | boolean
Values | : | true/false.
Default value | : | true
Sample | : | gui" : { "filterMenuIcons" : true, "menuIcons" :{ " fullscreen ": false } }
See also | : | filterMenuIcons

URL Querystring Parameter:

VCollabWeb Viewer supports following Querystring options

- file
- GUI
- Crossorgin
- vpathindex / vpathname
- vpointindex / vpointname

#### file

Description | : | Used to specify the URL path of the WCAX file.
Data types | : | string
Values | : | any URL path to the WCAX File
Default value | : | ""
Sample | : | https://apps.vcollab.com/vcollabweb/viewer.html?file=samples/beam.wcax https://apps.vcollab.com/vcollabweb/viewer.html?file=https://apps.vcollab.com/vcollabweb/samples/beam.wcax
See also | : | -

#### GUI

Description | : | Enable/Disable Viewer GUI. If specified then it will override the "showGUI" value specified in config.json.
Data types | : | boolean
Values | : | true/false
Default value | : | true
Sample | : | https://apps.vcollab.com/vcollabweb/viewer.html?file=samples/beam.wcax&GUI=false
See also | : | showGUI

#### Crossorgin

Description | : | Enable/Disable 'withCredentials' option, while downloading the wcax file from different domain.
Data types | : | boolean
Values | : | true/false
Default value | : | false
Sample | : | https://apps.vcollab.com/vcollabweb/viewer.html?Crossorgin=true
See also | : | -

#### vpathindex / vpathname

Description | : | Used to specify the viewpath to be set after loading wcax file. Either vpathindex or vpathname can be given if both are given vpathname gets the priority. if this paramater is not given in the url then first view path will be set by default.
Data types | : | Number for vpathindex ,String from vpathname
Values | : | Vaild integer number for vpathindex, Vaild viewpath name for vpathname
Default value | : | 0 - first view path index
Sample | : | https://apps.vcollab.com/vcollabweb/viewer.html?vpathindex=0 https://apps.vcollab.com/vcollabweb/viewer.html?vpathname=Hot spot
See also | : | -

#### vpointindex / vpointname

Description | : | Used to specify the viewpoint to be set after loading wcax file. Either vpointindex or vpointname can be given if both are given vpointname gets the priority. if this paramater is not given in the url then first view point will be set by default.
Data types | : | Number for vpointindex ,String from vpointname
Values | : | Vaild integer number for vpointindex, Vaild viewpoint name for vpointname
Default value | : | 0 - first view point index
Sample | : | https://apps.vcollab.com/vcollabweb/viewer.html?vpointindex=0 https://apps.vcollab.com/vcollabweb/viewer.html?vpointname=Displacement
See also | : | -

### VCollabWeb Deployment

VCollabWeb comes as a zip file. User has to unzip it before using it.

- Extract the VCollabWeb.zip in any drive. For example, extract it in "d:\VCollabWeb"
- Configure the extracted folder "d:\VCollabWeb" in the web server.
- Configure the following mime type for json and wcax in the web server.

JSON | File name extension : .json MIME type : application/json
WCAX | File name extension : .wcax MIME type : application/octet-stream

Procedure to deploy VCollabWeb in different web servers is as follows:

Windows:

IIS Server

1. On the Start menu, click All Programs, click Accessories, and then click Run or press Windows Key+R.
2. In the Open box, type inetmgr and then click OK. IIS manager will open if it is properly installed.
3. In IIS Manager, expand the local computer and the Sites folder.
4. Right-click the site or folder where you want to create the virtual directory and then click Add Virtual Directory.
5. In the Add Virtual Directory dialog box, specify the following information:
   1. In Alias field, enter a name (VCollabWeb) for the virtual directory.
   2. In Physical Path field, enter or browse to the physical directory ("d:\VCollabWeb") that contains the VCollabWeb files.
6. Click OK.
7. Right-click the virtual directory that you created earlier and then click Convert to Application.
8. Right-click the Virtual Directory (VCollabWeb) in IIS manager, select Manage Application and Browse.

Apache Tomcat

Method 1:

1. Copy the extracted folder (d:\VCollabWeb ) and paste it inside "tomcat\webapps" folder
2. User can see the webpage using "http://[IPADDRESS or Host Name]/VCollabWeb"

Method 2:

1. Add the following line in the "server.xml" configuration file which is available in "tomcat\conf" folder.
   "<Context docBase="D:\VCollabWeb" path="/VCollabWeb" />"
   - The <Context> element should be added inside the <Host> element.
     Context has two attributes:
     docBase is the directory that contains VCollabWeb files.
     path refers to an URL from which VCollabWeb files will be served.
     Make sure that Tomcat has read access to the files in docBase.
   - Final server.xml file looks like below
   <Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="true">
   ...
   <Context docBase="D:/VCollabWeb" path="/VCollabWeb" />
   </Host>
2. After changing the server.xml file, restart the tomcat server
3. User can see the webpage using "http://[IPADDRESS or Host Name]:[Port]/VCollabWeb"

Linux:

Apache Tomcat

1. Extract the VCollabWeb.zip.
2. Move the VCollabWeb folder to "/tomcat/webapps" folder.
3. User can see the webpage using "http://[IPADDRESS or HostName]:[Port]/VCollabWeb"
   - E.g., http:// 192.168.1.10:8080/VCollabWeb.