Web Server Configuration

Instructions to configure the Avo Assure Web Server

Prerequisites

1. Ensure Avo Assure Database is up and running.

2. Ensure Cache Database is up and running.

3. Ensure License Server is running and activated.

4. Ensure DAS Server is up and running.

5. Web Server should be present in the same machine where DAS is running.

6. The user should have the system IP of the machine and the port number where the Avo Assure Database is running.

7. The user should have the system IP of the machine and the port number where the Cache Database is running.

8. If the user wants to use the load balancing feature, they should have the certificate file and its corresponding key file of the system in which the webserver is to be deployed.

9. A shared location in the server where the screenshots can be stored should be available. It should be such that all the ICE clients can access this location.

   1. Share the folder over the network with server and client machines. That shared link should be used as a shared location.

   2. For windows, every backslash (\) should be replaced with double backslash (\\). Eg: \\server\images\screenshots\ will become \\\\server\\images\\screenshots\\

   3. The screenshots will be organized and saved based on the project, release, and cycle.

10. A shared location in the server where the dataset for object prediction can be stored should be available. It should be such that all the ICE clients have read/write permission to this location.

    1. Share the folder over the network with server and client machines. That shared link should be used as a shared location.

    2. For windows, every backslash (\) should be replaced with double backslash (\\). Eg: \\server\images\ObjectPrediction\ will become \\\\server\\images\\ObjectPrediction\\

    3. The dataset will be organized and saved based on the various object types.

Setting up

1. Extract the ‘AvoAssure_WebServer.zip’ or ‘AvoAssure_WebServer.7z’ file.

Target File

2. Navigate to the ‘webapp’ folder. 3. Open the ‘.env’ file.

Web Server env Configuration File Location

4. Do not add spaces before or after the equal sign. Update fields as follows:

1. ENV to be kept in PROD.

2. By default, Avo Assure Web Application listens on port 8443. But this can be changed to 443 or any other desired port. Remove ‘#’ added before SERVER_PORT. Then replace 8443 with the desired value. Eg: Server_Port=443

3. Replace 127.0.0.1 in CACHEDB_IP to the system IP of the machine where Cache Database is running.

4. Leave other configuration parameters unchanged.

5. Save and close the configuration file.

5. The CACHEDB_AUTH value should be saved, by executing the following command in the Webserver root folder, using a command prompt: “npm run storedbauth cachedb <CACHEDB_AUTH_value>”. Note: After passing the above command, a .token file will be created.

Web Server env configuration file

5. Navigate to the server and then the config folder. 6. Open the ‘config.json’ file.

Web Server Configuration File Location

7. Update fields as follows:

1. Every token issued should have an expiry date and time. If the user does not opt for any date and time then, by default 30 days is the expiry time. This can be changed by updating ‘defaultTokenExpiry’ to the desired value.

2. To enable/disable the terms and conditions (EULA – End User’s License Agreement) pop-up, the following change should be made in the webserver’s config file:

   1. "showEULA": true – to Enable the terms and conditions pop-up.

   2. "showEULA": false – to Disable the terms and conditions pop-up.

3. In Avo Assure, after the ICE – webserver connection is established, the webserver checks the status of ICE after every interval defined in ‘pingTimer'. ICE emits status to the webserver, in half the interval defined in ‘pingTimer’. The value defined in pingTimer is in milliseconds.

4. In Avo Assure, Test Artifacts are managed by assigning them as Tasks. There are a set of well-defined rules that apply to tasks. Like, unless a task is reviewed and approved, it cannot be executed. The same can be enforced by changing ‘strictTaskWorkflow’ to true. The default value is false.

5. The date configuration is provided to support different date formats as mentioned below:

   1. DD-MM-YYYY

   2. MM-DD-YYYY

   3. YYYY-MM-DD Note:

      1. Apart from hyphen (-), no other symbol must be used to specify the Date Format.

      2. By default, the dateFormat value will be “MM-DD-YYYY”.

      3. Server will not start if an incorrect date format is given.

6. Avo Assure Web Server runs on https. By default, Avo Assure is packaged with SLK’s domain certificates. These are not secure if the software is deployed outside of SLK premises. So, to use any other set of certificates, two files are required: CERT file (public key) and Key file (unencrypted private key). After acquiring those two, provide the details as follows:

   1. ‘cert’ in the certificate to the path of CERT file (.crt/.cer/.cert)

   2. 'key’ in the certificate to the path of KEY file (.key) Eg: If the server machine is in the example.com domain, then the certificate and key file will be required for the example.com domain.

7. Leave the socketio field unchanged.

8. To capture screenshots while execution, the shared directory path should be added where screenshots can be saved. This is the same as mentioned in the prerequisites. This section is optional, i.e., values can be left empty.

   1. Update ‘default’ in the screenShotPath section to the shared path which all ICE clients running in the windows-based machine can access.

   2. Update ‘mac’ in the screenShotPath section to the shared path which all ICE clients running in the macOS-based machine can access.

9. In the section of “objectPredictionPath”, specify the shared directory path where the dataset of scraped objects via IRIS will be stored for enhanced object prediction. This section is optional, i.e., values can be left empty.

   1. Update default in the objectPredictionPath section to the shared path which all ICE clients running in the windows-based machine can access.

   2. Update mac in the objectPredictionPath section to the shared path which all ICE clients running in the macOS-based machine can access.

Web Server Configuration File

8. Save and close the configuration file.

Starting the Server

1. Open an elevated command prompt in the ‘webapp’ folder.

2. Type ‘run.bat’ and hit enter. Alternatively, type ‘npm start’ and hit enter.

3. Upon successful start, you will receive the following message: ‘Avo Assure Server Ready…’

Starting Web Server

4. Avo Assure is available at ‘https://<hostname_of_system>:8443’ or ‘https://<hostname_of_system>:<port_configured>’. Open the URL in a browser (preferably Chrome) depending on the port they selected.

Avo Assure Web Application

Stopping the Server

1. Close the command prompt window in which the Web Server is running.

Installing the Server as a Windows Service

1. Open an elevated command prompt in the ‘webapp’ folder.

2. Type ‘install-service.bat’ and hit enter.

Installing Web Server Service

Starting the Windows Service

1. Open an elevated command prompt in the ‘webapp’ folder. Note: avoassurewebserver.exe service should already be installed.

2. Type ‘start-service.bat’ and hit enter.

Starting Web Server Service

Stopping the Windows Service

1. Open an elevated command prompt in the ‘webapp’ folder. Note: avoassurewebserver.exe service should be running.

2. Type ‘stop-service.bat’ and hit enter.

Stopping Web Server Service

Removing the Windows Service

1. Open an elevated command prompt in the ‘webapp’ folder. Note: avoassurewebserver.exe service should be in the stopped state.

2. Type ‘remove-service.bat’ and hit enter.

Removing Web Server Service

Restarting the Windows Service

1. Open an elevated command prompt in the ‘webapp’ folder.

2. Run the following commands in sequential order i.e., only after the previous command has been completed:

   1. Type ‘stop-service.bat’ and hit enter.

   2. Type ‘remove-service.bat’ and hit enter.

   3. Type ‘install-service.bat’ and hit enter.

   4. Type ‘start-service.bat’ and hit enter.

Troubleshooting

In case any of the above-mentioned steps fail, ensure the following points have been taken care of:

1. Commands are being run with an elevated command prompt (i.e., prompt has Administrator privileges)

2. Ensure port 8443 or 443 (or any custom selected port) is available and not used by any other program.

3. There are no spaces or special characters (such as ! @ # $ % ^ & ( ) + - = { } , . ; ' [ ] ~ `) in the folder name (and entire path) where the Web Server is being extracted. Example:

   1. Valid: D:\AvoAssure\Server\WebServer\

   2. Invalid: D:\AvoAssure install files\Server\WebServer\

   3. Invalid: D:\AvoAssure\Server@files\WebServer\

4. If all the above scenarios hold true and the server is still not running, please contact Avo Assure Support Team.