Best Practices

Overview

This document presents a comprehensive guide outlining the recommended best practices for the optimal utilization of the Test Assistant tool.

The configurations listed are not intended to be prescriptive but rather to serve as standard recommendations for clients with varying requirements and business cases.

Audience

These best practices are to be used by RIA Advisory employees when deploying and enhancing the Test Assistant tool in client environments.

This document is primarily an internal document, but the information is also relevant to clients managing their own Test Assistant configuration.

Test execution

• When a test execution is in progress, avoid opening a duplicate tab in the browser and clicking the back button to prevent system crashes.
• Before doing a batch execution, ensure that the following requests are tested in Postman to be working properly. See Verify JSON script in Postman.

Verify JSON script in Postman

POST method

The POST method is used to create resources. To verify a JSON script for POST method, follow these steps:

1. Search and open the Inbound Web Service for your JSON script.
2. Click View Specification to view the JSON script template.
3. Look for the POST method and click Try it out.
4. Copy the JSON script from the Request Body.
5. Navigate to Postman and add a new POST request.
6. Paste the copied JSON script in Step 4 to the Body. Replace values as needed.
7. Navigate back to the IWS page. You will see the Computed URL at the top of the API Specification page. Copy it and paste it into the URL of your request in Postman.
8. Save the request in Postman. Once the request is verified to be correct, click Send to generate the Response Body.

PUT method

The PUT method is used to update resources. To verify a JSON script for the PUT method, follow these steps:

1. Search and open the Inbound Web Service for your JSON script.
2. Click View Specification to view the JSON script template.
3. Look for the PUT method and click Try it out.
4. Copy the JSON script from the Request Body.
5. Navigate to Postman and add a new PUT request.
6. Paste the copied JSON script in Step 4 to the Body. Replace values as needed.
7. Navigate back to the IWS page. You will see the Computed URL at the top of the API Specification page. Copy it and paste it into the URL of your request in Postman.
   For the URL of the PUT method, append the URI component displayed in the Operations section on the IWS page.
8. Save the request in Postman. Once the request is verified to be correct, click Send to generate the Response Body.

GET method

The GET method is used to retrieve resources. To verify a JSON script for the GET method, follow these steps:

1. Search and open the Inbound Web Service for your JSON script.
2. Click View Specification to view the JSON script template.
3. Look for the GET method and click Try it out.
4. Enter the required string ID in the Parameters section.
5. Navigate to Postman and add a new GET request.
6. Add the string ID from Step 4 to the JSON script in the Request Body.
7. Navigate back to the IWS page. You will see the Computed URL at the top of the API Specification page. Copy it and paste it into the URL of your request in Postman.
   For the URL of the GET method, append the URI component displayed in the Operations section on the IWS page.
8. Save the request in Postman. Once the request is verified to be correct, click Send to generate the Response Body.

DELETE method

The DELETE method is used to delete resources. To verify a JSON script for the GET method, follow these steps:

1. Search and open the Inbound Web Service for your JSON script.
2. Click View Specification to view the JSON script template.
3. Look for the DELETE method and click Try it out.
4. Copy the JSON script from the Request Body.
5. Navigate to Postman and add a new DELETE request.
6. Paste the copied JSON script in Step 4 to the Body. Replace values as needed.
7. Navigate back to the IWS page. You will see the Computed URL at the top of the API Specification page. Copy it and paste it into the URL of your request in Postman.
   For the URL of the DELETE method, append the URI component displayed in the Operations section on the IWS page.
8. Save the request in Postman. Once the request is verified to be correct, click Send to generate the Response Body.

PATCH method

The PATCH method is used to apply partial changes to resources. To verify a JSON script for the PATCH method, follow these steps:

1. Search and open the Inbound Web Service for your JSON script.
2. Click View Specification to view the JSON script template.
3. Look for the PATCH method and click Try it out.
4. Copy the JSON script from the Request Body.
5. Navigate to Postman and add a new PATCH request.
6. Paste the copied JSON script in Step 4 to the Body. Replace values as needed.
7. Navigate back to the IWS page. You will see the Computed URL at the top of the API Specification page. Copy it and paste it into the URL of your request in Postman.
   For the URL of the PATCH method, append the following in order:
   • URI component displayed in the Operations section on the IWS page
   • action as displayed in the Internal Service in the Operations section on the IWS page
8. Save the request in Postman. Once the request is verified to be correct, click Send to generate the Response Body.

Data mining

• Ensure that the columns specified in the Velocity Script match the columns in the Output Columns list.

UI recording

• When recording the screen for your project, the screen should be in full-screen mode.
• Do not use shortcut keys, such as clicking the tab button when navigating to the next text box, as they will not be captured in the screen recording.
• Ensure that unused commands are removed to avoid any unwanted tabs from opening during the screen recording.
• Add a wait command in between commands configured to be executed in different paths.
• Add a wait command after a command that results in multiple popups.
• Ensure that unwanted commands that are automatically added during recording should be removed manually before uploading them to the Test Assistant tool.