Setup-Avo Assure Client
Last updated
Avo Assure - User Guide v23.1
Last updated
Navigate to the Avo Assure Client folder.
Open the Command prompt from the folder.
Run console.bat with the given arguments.
console.bat --register --host ip:port --token tokentext
console.bat --register --token tokentext --Host: Optional argument. If it’s not given, its value is read from config.json
4. On successful registration, the following message is displayed: “‘Avo Assure Client “name” is registered successfully with Avo Assure”.
5. Avo Assure Client can be connected to the server with two modes.
Connect mode: Avo Assure Client connection followed by the registration process. CMD: console.bat --connect
Guest connect mode: Avo Assure Client Connection without the registration process. But the token is mandatory for authentication. CMD: console.bat --connect --host ip:port --token tokentext console.bat --connect --token tokentext
6. On successful authentication, the connection is established with the Avo Assure Client server.
The Avo Assure Client UI has an option to enable and disable the DND mode.
2. On enabling DND mode, the Avo Assure Client will be disabled for other pool users temporarily.
3. This allows the owner of the Avo Assure Client to use the Avo Assure Client exclusively.
4. Execution triggered by the owner of the Avo Assure Client will be executed directly and will not be pushed to execution queues.
5. Avo Assure Client on DND mode can still be chosen by other users as it is still part of the pool but upon selection of such Avo Assure Client, executions will go to the execution queue and will not be executed until the DND mode is disabled.
6. If the user does not have access to the pool to which their Avo Assure Client is assigned, then the Avo Assure Client will not be accessible even after enabling DND mode.
Avo Assure Avo Assure Client can be configured by the user by clicking on Edit and then choosing the Configuration needed from the Avo Assure Client menu bar.
The system hostname of the Web Server machine will be set as the Server Address text field on registration. This value is the same as that of the AvoAssure product URL.
The server port hosting the AvoAssure Web Server will be set as the Server Port text field on registration. The user can find the port number in the AvoAssure URL. Use the default port number, 443, in case of using a patch updater.
3. The text field for Chrome Path specifies the path of the installation directory of the Chrome browser. It is applicable only for the Chrome browser, therefore web applications. The input value can either be the default or the path of the installation directory of the Chrome browser.
If the value is "default", then the Avo Assure Client automatically searches for the installation directory of Chrome in the system.
4. The text field for Chrome Profile specifies the path of the user profile if any from the Chrome browser data. It is applicable only for the Chrome browser, therefore web applications. The input value can either be the default or the path of the user's chrome profile created via Avo Assure Client.
If the value is "default", then the Avo Assure Client automatically searches for the chrome profile for the user in the system.
5. The text field for Extension Path specifies the path of the folder that consists of extension files or the paths of the extension files. It is applicable only for Chrome and Chromium browsers, therefore web applications. The input value can either be default or the extensions file path/ path of the folder containing the extension files.
If the value is "default", then no extension paths are set.
6. The text field for Firefox Path specifies the path of the installation directory of the Firefox browser. It is applicable only for the Firefox browser, therefore web applications. The input value can either be the default or the path of the installation directory of the Firefox browser.
If the value is "default", then the Avo Assure Client automatically searches for the installation directory of Firefox in the system.
7. The Log File Path text field specifies the path of the log file.
Create a folder named "Logs" (preferably inside the extracted folder). Browse its location.
The system searches for a log file in the selected folder. If it does not exist, the system creates one and enters its path in the text field.
Its default value for Windows is "C:/TestautoV2.log".
Its default value for Mac is "/Users/username/Desktop/AvoAssure_Avo Assure Client/logs/TestautoV2.log".
8. The text field for Server Certificate specifies the absolute path to the AvoAssure Web server certificate (server.crt). Browse for the "CA_BUNDLE" folder (inside the AvoAssure folder). The system for the "server.crt" file inside the specified folder and enters its path in the text field.
The input value is "path/to/server/certificate/file.crt".
Its default value is "./Scripts/CA_BUNDLE/server.crt".
9. The text field for Query Timeout registers the time for which the tool needs to wait while connecting to the database. It is applicable for database keywords. It takes time (in seconds) as input with the default value of 3 seconds.
10. The text field for Time Out registers the time for which the tool needs to wait for an element to load on a web page. It is applicable for "waitForElementVisible" (web) and "waitForElementExist" (Android native) keywords. It takes time (in seconds) as input with the default value of 1 second.
11. The text field for Delay registers the time for which the tool needs to wait before it performs a "window switch" operation. It is applicable only to the Web. It takes time (in seconds) as input with the default value of 0.3 seconds.
12. The text field for Step Execution Wait registers the time for which the tool needs to wait before it proceeds with the debugging or execution of the next step. It takes time (in seconds) as input with the default value of 1 second.
13. The text field for Display Variable Timeout indicates the time for which the display variable value popup needs to be visible during debugging or execution. It is applicable for "displayVariableValue" keyword. It takes time (in seconds) as input with the default value of 3 seconds.
14. The text field for Connection Timeout registers timeout to disconnect ICE from the server. It takes time (in hours) as input with the default value of 0 hours.
15. The text field for Delay for String Input indicates the time between keystroke events when performing keystroke operations. It is applicable for the "sendFunctionKeys" keyword. It takes time (in seconds) as input with the default value of 3 seconds.
16. The text field for Global Wait Timeout registers the time for which the tool needs to wait for an element to load on the AUT. It takes time in seconds as its input. The default value of ‘Global Wait Time Out’ is 0. Note:
‘Global Wait Time Out’ will work only when the value of it in the ICE configuration is greater than 0.
It is available for all scraped objects across the app types – Web, Mobile App, and Mobile Web.
This property is applicable for each scraped object but not for each test step.
If the test case has the 'waitForElementVisible' keyword used on some scraped object and value for 'Global Wait TimeOut' is also mentioned in ICE configuration, then only the ‘Time Out’ of 'waitForElementVisible' will be considered for that object in that particular test step.
17. The text field for Max Retries for App Launch indicates the maximum number of retries to successfully launch the specified PDF Reader for “normalizePDF” keyword in any test step. The default value is 20.
18. The radio button for TLS Security Level gives the user an option to bypass hostname verification and/or certificate verification of secure websites in case of unavailability of a valid certificate.
High- Enforce TLS Certificate and Hostname verification. [default]
Med- Enforce TLS Certificate and Disable Hostname verification.
Low- Disable TLS Certificate and Hostname verification.
19. The radio button for Ignore AUT Certificate indicates if the errors of the AUT website's security certificates are to be ignored or not. It is applicable only for IE.
Yes- Ignore the errors of the AUT website's security certificates.
No- Do not ignore the errors of the AUT website's security certificates. [default]
20. The radio button for IE Architecture Type checks if the Client machine is a 64-bit machine or 32-bit. Depending on the selection, it selects the IE driver.
64-bit: Selects 64-bit IE driver to launch IE browser. [default]
32-bit: Selects 32-bit IE driver to launch IE browser.
21. The radio button for Exception Flag determines whether to terminate the scenario and continue execution from the next scenario in the Test Suite or to continue executing the next step in case of the error "Object is not found".
True- The error "Object is not found" while executing scripts leads to the termination of the scenario. The execution continues from the next scenario in the Test Suite.
False- The error "Object is not found" does not affect the execution, which continues from the next test step. [default]
22. The radio button for Ignore Visibility Check checks the visibility of the element during execution and is applicable only for Web Applications.
Yes- Ignore the element's visibility during execution.
No- Do not ignore the element's visibility during execution. [default]
23. The radio button for ScreenShot Flag facilitates capturing the screenshots of the test steps based on their value.
All- Capture screenshots for all the test steps. [default]
Fail- Capture screenshots for the failed test steps.
24. The radio button for HTTP Status Code Check determines whether to continue to debug/execute or stop in case of AUT website status code errors like 400, 401, 404, 500 et al. It is applicable only for Web Applications.
Yes- Terminate debugging/execution in case of any website error. [default]
No- Continue debugging/execution irrespective of any website error.
25. The radio button for Browser Check enables or disables Browser Compatibility check based on the selection.
Yes- Check if the current ICE patch is compatible with the browsers available in the system.
No- Disable Browser Compatibility check. [default]
26. The radio button for Enable Security Check provides an option for the IE browser to set all the security zones to the same level while executing the "openBrowser" keywords. It is applicable only when automating Web Applications in the IE browser.
Yes- Sets all security zones to the same level in IE browser while executing "openBrowser" keywords.
No- Doesn't check for the level of the security zones in the IE browser. [default]
27. When the user verifies the existence of an element using the "verifyExists" keyword, the radio button for Highlight Check highlights the element (or not) based on the selection. It is applicable only for the "verifyExists" keyword.
Yes- Highlight the element if it exists.
No- Do not highlight the element even if it exists. [default]
28. The radio button for Prediction for IRIS Objects enables or disables IRIS prediction based on its value.
Yes- Enable IRIS Prediction.
No- Disable IRIS Prediction. [default]
29. The radio button for Hide Soft. Keyboard indicates if the keypad, in Android devices, shows or not. It is applicable only for Android-based applications.
Yes- Hide the keypad.
No- Show the keypad. [default]
30. The radio button for Extension Enable indicates that during debugging if an object in the script is not found, then it allows the user to pause the debug process and meanwhile scrape the required object and continue executing the process.
Yes- Enable pause and scrape.
No- Disable pause and continue execution even if object not found. [default]
31. The radio button for Update Check indicates if the ICE should perform a check for the latest ICE packages on connection establishment between the ICE and server.
Yes- Check for updates on ‘Connect’.
No- Do not check for updates on ‘Connect’. [default]
32. The radio button for Headless Mode indicates whether to run the scripts with the UI or not. It is applicable only for web applications, supports Chrome and Firefox.
Yes- Perform execution in headless mode.
No- Perform execution in normal mode (with UI). [default]
33. The radio button for Clear Cache indicates whether to clear cache or retain the cache for the browser launched by ICE. It is applicable only for the Chrome browser.
Yes- Clear Cache for the browser.
No- Retain cache for the browser and enable text field Chrome Profile to provide the user’s chrome profile path. [default]
34. The radio button for Screen Recording indicates whether to record the screen during the execution or not.
Yes- Record execution.
No- Do not record execution. [default]
35. The radio button for Full Screenshot indicates whether to screenshot the entire page or the area of the page that is currently visible on the screen. This is applicable for Web application types only.
Yes – Take the screenshot of the entire page. [default]
No – Take the screenshot of only the area that is currently visible on the screen.
36. The radio button for Close Browser Popup indicates whether to close the popups generated by the browser (as and when generated) or keep them open. This is applicable for Web application types only.
Yes – whenever a popup is generated by the browser, close the popup. [default]
No – Do not close the popup generated by the browser.
37. The radio button for Use Custom Debug Port indicates whether to use a custom debug port (internally generated port) to launch the browser. This is applicable for Web application types only.
Yes – Uses a custom debug port to launch the browser.
No – Uses the system default port to launch the browser. [default]
Note: This is applicable for only Chrome browser and Chromium browser.
38. The radio button for Disable Screen Timeout disables/enables the Screen Timeout during executions.
Yes – Disables the Screen timeout.
No – The screen timeout of the system will not be changed. [default]
Note:
If Avo Assure Client is run as admin, then Disable Screen Timeout option will be enabled.
If Avo Assure Client is NOT run as admin, then Disable Screen Timeout option will be disabled.
Limitation: When Avo Assure Client crashes during execution, the screen timeout will not reset.
39. The radio button for Incognito/ Private Mode indicates whether to launch the browser in incognito/private mode or in normal mode. This is applicable for Web application types only.
Yes – Launches the browser in incognito/ private mode.
No – Launches the browser in normal mode. [default]
LIMITATION:
clearCache keyword when used in incognito/ private mode will close the browser.
Not applicable for IE browser.
40. The radio button for Kill Stale Process indicates whether to kill the stale processes launched via Avo Assure before every execution is triggered.
Yes – Kills stale processes before start of every execution. [default]
No – Retains processes started before every execution.
41. The radio button for Browser Screenshots indicates whether to capture generic screenshots or via browser driver. This is applicable for Web application types only.
Yes – Captures browser screenshots using driver instance. [default]
No – Captures generic screenshots.
Click on ‘Edit’ -> ‘Proxy Configuration’ in Avo Assure Client. The following pop-up will be displayed to the user.
Note: Environments with restricted access to specific URLs require a proxy server to be set up. Restricted URLs can be accessed only after performing a proxy configuration.
Avo Assure provides the user with the option of enabling/ disabling the proxy.
If the user enables proxy configuration, the following fields will be editable by the user:
Proxy URL: It is a means of entering the proxy server to read data or make changes to the settings.
Proxy Username: Required username to authenticate the user for the specified proxy URL.
Proxy Password: Required encrypted password (generated via AES method) to authenticate the user for the specified proxy URL.
To save the proxy configuration, click on the ‘Save’ button and confirm the proxy configuration changes.
To revert to the last saved proxy configuration, click on the ‘Close’ button.
An 'About' pop-up window appears when the user navigates to Help -> About. The about window displays relevant information about the current Avo Assure ICE in use.
‘Check for Updates’ popup appears when the user navigates to Help -> Check for Updates. Information regarding Avo Assure Client updates is displayed in this popup.
On clicking the Update button, a Progress Window popup is displayed, representing the progress of the update process.
Note: Avo Assure Client will be closed during the update process.
Once the update is completed, the progress window will be closed. On successful update, the following will be displayed. Click on the ‘OK’ button to launch the updated Avo Assure Client.
The Rollback Feature of Avo Assure Client provides the user the ability to use the previous version, which was used before the update.
To run this feature navigate to Help -> Rollback.
The Rollback popup window is displayed.
Clicking on Rollback will revert the current changes and replace them with the old package.
Note: This feature should be used if the user feels the need to go back to the previous version of Avo Assure Client.
4. During the rollback process, a progress window is displayed to reflect the rollback progress.
5. Once the rollback process is completed, an Information window is displayed prompting the user to click the Ok button to launch Avo Assure Client.
Avo Assure Client provides the ability to convert a JSON file (generated and placed in the Avo Assure Client folder) to PDF format. This ability can be used to provide one file at a time [Generate PDF Report] or a folder where all JSON files (generated by Avo Assure execution) are placed [Generate PDF Report (Batch)].
Click on ‘Generate PDF Report’. The user will be prompted to enter the ‘Source JSON file’, ‘Target PDF folder’, and ‘Target PDF filename’.
2. Once all valid details are entered, click on ‘Generate’ to generate the pdf file. The PDF file will be generated in the specified location.
