# Welcome to Avo Automation Docs!

Say hello to effortless, low-code test automation! Explore our guides to start building amazing, high-speed tests across your entire tech stack right now!

<h2 align="center">Welcome to Avo Assure Documentation</h2>

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><h3>Avo Assure</h3></td><td>Start Building, Managing, and Scaling Your Automation with Avo Assure.</td><td><a href="/spaces/k8QZzXZMIJSStKAzDSTu/pages/2Prs6YKNNddAj0eMNk2i">/spaces/k8QZzXZMIJSStKAzDSTu/pages/2Prs6YKNNddAj0eMNk2i</a></td><td><a href="/files/gSs55TcmY0GQTLiQreli">/files/gSs55TcmY0GQTLiQreli</a></td></tr><tr><td><h3> Release Center</h3></td><td>Explore the Latest Updates, Improvements, and Fixes Across Our Product Releases.</td><td><a href="/spaces/08bVaUUseV1isJdnkA7N/pages/fmYcWYEHdSgCMBU3kn4P">/spaces/08bVaUUseV1isJdnkA7N/pages/fmYcWYEHdSgCMBU3kn4P</a></td><td><a href="/files/3McUXHUedSAr7gATiXWu">/files/3McUXHUedSAr7gATiXWu</a></td></tr><tr><td><h3>Support Resources</h3></td><td>Access Helpful Guides, Tips, Best Practices, and FAQs to Effectively Use Avo Assure.</td><td><a href="/spaces/k8QZzXZMIJSStKAzDSTu/pages/ofpfHw7cwgH61W1EUaCW">/spaces/k8QZzXZMIJSStKAzDSTu/pages/ofpfHw7cwgH61W1EUaCW</a></td><td><a href="/files/j9fnsOs22S75mAn1sMSC">/files/j9fnsOs22S75mAn1sMSC</a></td></tr></tbody></table>

<h2 align="center">Knowledge Center</h2>

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><h3>Quick Video Guides</h3></td><td>Learn Faster with Short How-To Videos on Our YouTube Channel.</td><td><a href="https://www.youtube.com/@Avo_Academy" class="button primary" data-icon="youtube">Watch More Videos</a></td><td data-object-fit="contain"><a href="/files/KKzCHWUKg0jr9TrzBlwM">/files/KKzCHWUKg0jr9TrzBlwM</a></td></tr><tr><td><h3>Learnings &#x26; Certifications</h3></td><td>Explore Guided Learning Paths and Courses to Build Your Avo Expertise.</td><td><a href="/spaces/k8QZzXZMIJSStKAzDSTu/pages/mISuS1MDa2LMcsXwyvUQ" class="button primary" data-icon="play">View Our Courses</a></td><td data-object-fit="contain"><a href="/files/G3MEgve0FiVqV1RNtx4Y">/files/G3MEgve0FiVqV1RNtx4Y</a></td></tr></tbody></table>

<h2 align="center">Support &#x26; Community</h2>

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><h3>Avo Support Portal</h3></td><td>Self-Serve and Reach Out to Our Support Team.</td><td><a href="/spaces/k8QZzXZMIJSStKAzDSTu/pages/wLvDk4q6T4UjUAmD2LMf" class="button primary" data-icon="ellipsis">Know More</a></td><td data-object-fit="contain"><a href="/files/xAzy0ic5gy4tPqpNQjFS">/files/xAzy0ic5gy4tPqpNQjFS</a></td></tr><tr><td><h3>Avo Community</h3></td><td>Join the Avo Community to Connect and Collaborate.</td><td><a href="https://chat.whatsapp.com/LxTUhuemMs81KKFS0F9M26" class="button primary" data-icon="users">Join Our Community</a></td><td data-object-fit="contain"><a href="/files/QIypggUXl50yZColSdLN">/files/QIypggUXl50yZColSdLN</a></td></tr></tbody></table>

<h2 align="center">Reach Out to Us</h2>

### <i class="fa-envelope-open-text" style="color:$primary;">:envelope-open-text:</i> Email

Have a question or facing an issue?

Send us a message and we’ll be glad to help you resolve your query.

Feel free to email us at **<avodocs@avoautomation.com>**


# Getting Started with Avo Assure

Avo Assure is a platform open to all users, irrespective of their test automation knowledge and experience.

Learn about its features and functionalities in detail to help with end-to-end automation journey through Avo's comprehensive documentation, tutorials, learnings platform, and community forums.

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td>Know about the <strong>journey as a first-time user</strong> in Avo Assure.</td><td><a href="/pages/j801gJYgHCv6Q8n9yRNo">Learn more</a></td><td></td><td><a href="/files/uOGrJCpoP6EndD4BqTA9">/files/uOGrJCpoP6EndD4BqTA9</a></td></tr><tr><td>Follow the step-by-step guide to <strong>install</strong> Avo Assure on your system.</td><td><a href="/pages/jZwUSCRiFBvvfuvc1GSW">Learn more</a></td><td></td><td><a href="/files/BWoXGCUNcrEybUsaf4jM">/files/BWoXGCUNcrEybUsaf4jM</a></td></tr><tr><td>Know about roles and responsibilities of an <strong>Admin</strong> in Avo Assure.</td><td><a href="/pages/HxIcsyNvPbamcrwSP0s6">Learn more</a></td><td></td><td><a href="/files/VKy7m0gTEohzEpgORTcY">/files/VKy7m0gTEohzEpgORTcY</a></td></tr><tr><td>Know the <strong>End-User System Requirements</strong> for Avo Assure.</td><td><a href="/pages/ddaad31643a5eeb9647719dd98df1c22d77328e5">Learn more</a></td><td></td><td><a href="/files/mRzrEW7MIwIi4hodAp7t">/files/mRzrEW7MIwIi4hodAp7t</a></td></tr><tr><td>Know about the <strong>third-party integration</strong> tools in Avo Assure.</td><td><a href="/pages/QwJWQrdXtqofl1twVBM4">Learn more</a></td><td></td><td><a href="/files/KqX7ZTE3zEA7fMu0mj9D">/files/KqX7ZTE3zEA7fMu0mj9D</a></td></tr></tbody></table>


# Introduction to Avo Assure

Avo Assure is a no-code, AI-driven test automation platform that works with various software types and product implementation tools. It is used for innovative QA testing of business applications, covering a wide range of capabilities, from the visual layer to underlying services, and databases. It supports web, desktop, ERP, mainframes, mobile apps, and a lot more, making testing easier and efficient.

This comprehensive test automation solution is designed to help organizations of all sizes to effectively test their business applications. With its robust features, Avo Assure enables teams to create automated tests covering various aspects of their applications, ensuring higher quality and performance.

Whether the business operates in finance, healthcare, retail, or any other industry, Avo Assure provides the tools needed to streamline the testing process, reduce manual effort, and accelerate time to market.

Avo's platform vision is to revolutionize automation quality and functionality through thorough testing before any application hits the market. This direction of Avo Assure makes testing a positive and interactive experience rather than a challenge.


# Commence Avo Journey

This journey will guide you through the key sections of our Automation Testing Tool, helping you explore its functionalities in a logical sequence.

**1. Home Page**

Upon logging in for the first time, you'll be greeted by the [Home page](/avo-assure/introduction-to-avo-assure/exploring-home-page). Here, you’ll find an overview of your projects, quick links to essential features, and updates about new functionalities. This is your starting point for navigating the tool.

**2. Element Repository**

Next, head to the Element Repository. This section allows you to manage and organize UI elements for your tests. You can add, edit, or delete elements, making it easier to reference them in your test cases. Visit: [Element Repository](/avo-assure/create-and-execute-tests-with-design-studio/working-with-element-repository-section)

**3. Test Cases**

Once your elements are in place, navigate to the Test cases section. Here, you can create and manage your test cases, incorporating the elements you've defined. This is where you’ll spend a lot of time designing and refining your test cases. Visit: [Test cases](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section)

**4. Execution**

After setting up your test cases, proceed to the Execution section. This is where you can run your tests and monitor their progress. You'll see real-time feedback on test results, helping you identify any issues immediately. Visit: [Execution](/avo-assure/create-and-execute-tests-with-design-studio/working-with-execution-section)

**5. Reports**

Finally, review the Reports section. Here, you'll find detailed analytics and reports on your test executions, providing insights into the test cases. This section helps you make informed decisions for future testing. Visit: [Reports](/avo-assure/create-and-execute-tests-with-design-studio/working-with-reports-section)

**6. Dashboard**

The Avo Assure Dashboard provides a visual summary of your test executions with interactive graphs and metrics. Customize the dashboard to suit your needs and get detailed insights into your test results. [Dashboard](/avo-assure/introduction-to-avo-assure/exploring-home-page/managing-home-page/dashboard)


# Exploring Home Page

The Home page is the main place in Avo Assure where you can easily access and manage your automation work. It appears after you sign in and helps you manage projects, create test assets, configure integrations, and view project-related information from one place.

It helps you quickly navigate through different sections of the platform, manage testing activities, and track project progress easily. This article provides an overview of the Home page and describes the available sections, components, and their functionalities.

### Home Page Overview

The Home page divides into the following sections:

| Areas             | Descriptions                                                                                                                                                                                                                                                                                                                                                                 |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace Section | <p>Displays information related to the selected project, including <strong>Manage Users</strong>, <strong>Manage Integrations</strong>, <strong>Test Case</strong> creation, <strong>Element</strong></p><p><strong>Repository</strong> creation, <strong>Dashboard Information</strong>, <strong>Execution Profiles</strong>, and <strong>Execution Summaries</strong>.</p> |
| Left Section      | Displays **Project** information and provides access to **Home**, **Utility**, and **Admin** options.                                                                                                                                                                                                                                                                        |
| Top Section       | Displays **Profil**e icon along with **Notifications** icon for reviewed test artefacts.                                                                                                                                                                                                                                                                                     |

<figure><img src="/files/mBn7g57RMT12KeyScpZe" alt=""><figcaption></figcaption></figure>

### Home Page Components

The following table describes the components available on the Home page.

<table><thead><tr><th width="85">Sr.no</th><th width="161">Components</th><th>Descriptions</th></tr></thead><tbody><tr><td>1</td><td>New Test Case</td><td>Appears in the workspace section and provides the option to create new test cases using <strong>Design Studio</strong> or <strong>Avo Genius</strong>.<br><a href="/pages/HJFdg2YYWGmzXS0UMX4D">Learn more</a></td></tr><tr><td>2</td><td>New Element Repository</td><td>Appears in the workspace section and provides the option to create new element repositories for storing and capturing application elements using <strong>Design Studio</strong> or <strong>Avo Genius</strong>.<br><a href="/pages/at3jmGAsSlOqc5CBDdqj">Learn more</a></td></tr><tr><td>3</td><td>Dashboard Overview</td><td>Appears in the workspace section and displays project-related information for the selected project based on the applied dashboard filters. It helps you view insights related to <strong>Element Repositories</strong>, <strong>Test Cases</strong>, <strong>Execution Profiles</strong>, and <strong>Execution Summaries</strong> through different dashboard widgets. This section also includes options such as <strong>Filters</strong>, <strong>Refresh</strong>, <strong>Save View</strong>, <strong>Reset to Default</strong>, and <strong>Bitbucket Integration</strong> to customize and manage dashboard information.<br><a href="/pages/2ed7VbhGZJNMmetqhdwq">Learn more</a></td></tr><tr><td>4</td><td>Create Project</td><td>Appears in the left section and enables the creation of a new project. Newly created projects appear in the <strong>Project</strong> pane.<br><a href="/pages/MBm7gXhHGsQLlErVx77K">Learn more</a></td></tr><tr><td>5</td><td>Project Details</td><td>Appears in the left section and displays all assigned and created projects. Each project card displays the information such as the <strong>Project Name</strong>, <strong>User Role</strong>, and <strong>Last Edited</strong> details.</td></tr><tr><td>6</td><td>Search and Filter</td><td>Appears in the left section and helps locate projects by searching and filtering the project list based on the entered project name.</td></tr><tr><td>7</td><td>Manage Users</td><td>Appears in the workspace section and provides options to manage users associated with the selected project.<br><a href="/pages/mQRWReILyPXFOxDXMAU3">Learn more</a></td></tr><tr><td>8</td><td>Manage Integrations</td><td>Appears in the workspace section and provides options to manage test data and configure integrations associated with the selected project.<br><a href="/pages/QwJWQrdXtqofl1twVBM4">Learn more</a></td></tr><tr><td>9.</td><td>Design Studio</td><td>Appears in the workspace section and provides a unified workspace for managing elements, designing test cases, executing and debugging scenarios, and analyzing detailed reports throughout the automation lifecycle.<br><a href="/pages/Vyzx27EXi4BkBGrBt9X3">Learn more</a></td></tr><tr><td>10</td><td>Left Vertical</td><td><p>Appears in the left section and provides access to the modules available in Avo Assure.</p><ul><li><strong>Home</strong>: Provides navigation to the Home page from any left module within Avo Assure.</li><li><a href="/pages/03WEEm36dxNJNNcvRjdf"><strong>Utilities</strong></a>: Provides access to utility features such as <strong>Encryption</strong>, <strong>Authorization</strong>, and <strong>Migration to Avo</strong>.</li><li><a href="/pages/HxIcsyNvPbamcrwSP0s6"><strong>Admin</strong></a>: Provides centralized management for users, projects, features, execution settings, configurations, and licensing in Avo Assure.</li></ul></td></tr><tr><td>11</td><td>Profile</td><td>Appears in the top section and provides access to <strong>Account Settings</strong>, <strong>Client</strong> and <strong>Agent Downloads</strong>, <strong>Change Password</strong> and <strong>Token Management</strong> options.</td></tr><tr><td>12</td><td>Avo Logo</td><td>Appears in the top section and enables navigation to the <strong>Home</strong> page from any screen within <strong>Avo Assure</strong>.</td></tr></tbody></table>

<figure><img src="/files/DcjVBNrqlL49pR2kCOym" alt=""><figcaption></figcaption></figure>


# Managing Home Page

The Home page is the starting point for managing your work in Avo Assure. It provides quick access to your projects, account information, and dashboard features that help you navigate the application efficiently. This article explains how to perform common tasks from the Home page, including creating and searching for projects, filtering the project list, viewing your profile, accessing the dashboard, and understanding the information available on the dashboard.


# Creating Project

Project is the unique workspace created by the user on the Avo Assure Platform. It represents the first step in automation testing. Users create repositories, test cases, and execute processes within the unique projects they have created. Avo Assure landing page allows you to create new projects and sort existing projects by creation date, latest edited, and alphabetical order. This document covers how to create new projects and sort existing project in Avo assure.

{% hint style="info" %}
**Note:** On the landing page of Avo Assure, there is a sample ready on view mode, user can view the working of various features on this project and can use this knowledge while working on the live project. Save option is disabled for this sample.

<img src="/files/QbG6GajytCZbF7jZTZBs" alt="" data-size="original">
{% endhint %}

To add a new project to the Avo Assure, follow the steps below:

1. On **Home** page, select **Create Project** icon.
2. On **New Project** page, enter the **Project Name** and **Description** in their respective columns.

{% hint style="info" %}
By selecting the **Limit Bitbucket pushes to approved or user-assigned artifacts** checkbox, you can restrict Quality Engineers from pushing unassigned or not approved test artifacts.
{% endhint %}

3. Select the checkbox next to each user’s name in the **Select Users column** to add users to the project.

{% hint style="info" %}
You can search for a user by entering their name or email address in the search box.
{% endhint %}

4. Select **User Role** from dropdown.
5. Select **Create** button to create the project with the provided details in Avo Assure.


# Copying Project Link

The copy project link allows you to share direct links to the home page with the project details. Opening a project link automatically restores the selected project, even after a page refresh or when opened in a new browser tab. Access to the linked page is determined by your project assignment and permissions. This article explains how to copy and use project links for quick access and collaboration.

{% hint style="info" %}
**Note**:

* When you share a project link with a user, the user must be added to the project.
* You must log in to the Avo Assure instance to access a project's direct link.
  {% endhint %}

To copy project link, perform the following actions:

1. On the **Home** page, from **Projects** list, select required project.
2. On the browser address bar, select the project link.
3. Press **Ctrl + C** Key combination on the keyboard. The link gets copied.


# Sorting Projects

User can arrange the project according to **Date/Alphabet/Last Modified**

To sort projects in Avo Assure, follow the steps below.

1. Click the **Sort icon** in the landing page to rearrange the project sequence.
2. Filter the projects based on the date it is created, **Last Modified, Date Created** or **Alphabetical** order to bring up the projects as per the selection.

<img src="/files/FazCS3Xvh9mcyEoKMzbr" alt="" data-size="original">


# Changing Password in Avo Assure

The Change Password functionality allows you to update your existing password by replacing it with a new password. This helps maintain account security by enabling you to modify your credentials whenever required.

To change the Avo Assure password, perform the following actions:

1. On the **Home** page, select **Profile** icon.
2. Select **Change Password**.

![](/files/8fe7654e2fde86e8c1d0b69a1098a3cc4e8f062a)

3. On the **Change Password** dialog, in **Current Password** text box, enter current password.
4. Select **Continue**.

{% hint style="info" %}
**Note**: The **Cancel** button allows you to exit the change password process.
{% endhint %}

![](/files/0c2d3441cf6f4167b5b2670b54d0ebdbb08c3c22)

5. On the **Change Password** dialog, in **New password** text box, enter new password which matches all the criteria.
6. In **Confirm new password** text box, enter the same password which you have entered in **New password** textbox.
7. Select **I agree to the Terms of use and the Privacy policy** checkbox.
8. Select **Update Password**.

{% hint style="info" %}
**Note**:

* The **Cancel** button allows you to exit the change password process.
* If the previously used password is entered, the **Update password** button does not get enabled.
* If the new password does not meet all required criteria, the password does not update, and a warning message stating **Validation Failed** is displayed.
  {% endhint %}

![](/files/f46bb9e4f6c51b1dcd7df0f6bcb69bf5e46c01e6)


# Dashboard

The Dashboard serves as a central interface for accessing and interacting with automation data in Avo Assure. It provides access to key metrics, status indicators, trends, and summary data through a collection of interactive widgets and filters. This section provides an overview of how the Dashboard is organized and how users can interact with its components.

This document includes:

* [About the Dashboard](/avo-assure/introduction-to-avo-assure/exploring-home-page/managing-home-page/dashboard/about-the-dashboard)
* [Viewing the Dashboard](/avo-assure/introduction-to-avo-assure/exploring-home-page/managing-home-page/dashboard/viewing-the-dashboard)


# About the Dashboard

The Dashboard provides a centralized view of your automation activities. It allows you to monitor project activity, track execution results, analyse trends, and review status information from a single location. The dashboard also allows you to filter and view data based on different criteria, such as date range, project, creator, and assigned user.

The Dashboard displays information through multiple widgets. Each widget presents specific data to give insights into different aspects of testing and execution. This article walks you through the Dashboard in Avo Assure. It explains the key components of the Dashboard interface and describes the purpose of the available user interface (UI) controls, enabling users to interpret the displayed information effectively.

On the **Home** page (Dashboard), you can do the following:

1. **Filters**: Allows you to filter dashboard data based on the selected criteria.
2. **Date Range**: Allows you to filter dashboard data for a specific time period.
3. **Bitbucket Integration**: Allows you to filter data based on Bitbucket integration.
4. **Created By**: Allows you to view data created by a specific user.
5. **Assigned To**: Allows you to view data assigned to a specific user.
6. **Projects**: Allows you to select a project and view dashboard data associated with the selected project.
7. **Download**: Allows you to download the dashboard data.
8. **Refresh**: Allows you to refresh the dashboard and view the latest dashboard data. The **Last refreshed** timestamp displays the most recent dashboard refresh time in UTC.
9. **Save View**: Allows you to save the currently selected dashboard filters and preferences for future sessions. The saved view is automatically applied when you log in.
10. **Reset to Default**: Allows you to remove the saved dashboard filters and preferences and restore the default dashboard view.
11. **Element Repositories**: Allows you to view metrics and detailed insights related to element repositories.
12. **Edit Widgets**: Allows you to customize the widgets displayed in Element Repositories section. You can add or remove widgets based on your requirements.
13. **Total Repositories**: Allows you to view the total number of element repositories.
14. **Remove Widget**: Allows you to remove the Total repositories widget.
15. **App Type**: Allows you to select a specific application type and view the corresponding dashboard data.
16. **Open Repositories**: Allows you to navigate to the **Element Repository** page and view the available repositories.
17. **Resize Widgets**: Allows you to adjust the size of widgets to customize the dashboard layout. Drag the widget border or corner to resize the widget.
18. **Move widgets**: Allows you to move widgets and arrange them in the preferred order on the dashboard. Select and drag a widget to move it to the required location on the dashboard.
19. **Element Repository Status**: Allows you to view the [status](/avo-assure/create-and-execute-tests-with-design-studio/test-artifacts-in-avo-assure) of element repositories.
20. **Remove Widget**: Allows you to remove the Element repository status widget.
21. **Chart Type**: Allows you to view the element repository status data in Horizontal Bar, Pie, or Donut format.
22. **Filter Element Repository Status**: Allows you to filter the element repository status data based on the following criteria:
    * Date Range
    * Bitbucket Integration
    * Created by
    * Assigned to
23. **Element Repository Trends**: Allows you to view the element repository creation trend for the selected time period.
24. **Remove Widget**: Allows you to remove the Element repository trends widget.
25. **Chart Type**: Allows you to view the element repository trends data in Line, Bar, or Area format.
26. **Filter Element Repository Trends**: Allows you to filter the element repository creation trend data based on the following criteria:
    * Date Range
    * Bitbucket Integration
    * Created by
    * Assigned to
27. **Test Cases**: Allows you to view metrics and detailed insights related to test cases.
28. **Edit Widgets**: Allows you to customize the widgets displayed in Test Cases section. You can add or remove widgets based on your requirements.
29. **Total Test Cases**: Allows you to view the total number of test cases.
30. **Remove Widget**: Allows you to remove the Total test cases widget.
31. **Open Test Cases**: Allows you to navigate to the Test Case page and view the created test cases.
32. **Test Case Status**: Allows you to view the [status](/avo-assure/create-and-execute-tests-with-design-studio/test-artifacts-in-avo-assure) of test cases.
33. **Remove Widget**: Allows you to remove the Test case status widget.
34. **Chart Type**: Allows you to view the test case status data in Horizontal Bar, Pie, or Donut format.
35. **Filter Test Case Status**: Allows you to filter the test case status data based on the following criteria:
    * Date Range
    * Bitbucket Integration
    * Created by
    * Assigned to
36. **Test Case Trends**: Allows you to view the test case creation trend for the selected time period.
37. **Remove Widget**: Allows you to remove the Test case trends widget.
38. **Chart Type**: Allows you to view the test case trends data in Line, Bar, or Area format.
39. **Filter Test Case Trends**: Allows you to filter the test case creation trend data based on the following criteria:
    * Date Range
    * Bitbucket Integration
    * Created by
    * Assigned to
40. **Execution Profiles**: Allows you to view metrics and detailed insights related to execution lists.
41. **Edit Widgets**: Allows you to customize the widgets displayed in Execution Profiles section. You can add or remove widgets based on your requirements.
42. **Total Execution Lists**: Allows you to view the total number of execution lists.
43. **Remove Widget**: Allows you to remove the Total execution lists widget.
44. **Open Executions**: Allows you to navigate to the Execution page and view the available execution lists.
45. **Execution List Status**: Allows you to view the [status](/avo-assure/create-and-execute-tests-with-design-studio/test-artifacts-in-avo-assure) of execution lists.
46. **Remove Widget**: Allows you to remove the Execution list status widget.
47. **Chart Type**: Allows you to view the execution list status data in Horizontal Bar, Pie, or Donut format.
48. **Filter Execution List Status**: Allows you to filter the execution list status data based on the following criteria:
    * Date Range
    * Bitbucket Integration
    * Created by
    * Assigned to
49. **Execution List Trends**: Allows you to view the execution list creation trend for the selected time period.
50. **Remove Widget**: Allows you to remove the Execution list trends widget.
51. **Chart Type**: Allows you to view the execution list trends data in Line, Bar, or Area format.
52. **Filter Creation Trend**: Allows you to filter the execution list creation trend data based on the following criteria:
    * Date Range
    * Bitbucket Integration
    * Created by
    * Assigned to
53. **Execution Summaries**: Allows you to view metrics and detailed insights related to execution result summaries.
54. **Edit Widgets**: Allows you to customize the widgets displayed in Execution Summaries section. You can add or remove widgets based on your requirements.
55. **Total Execution Runs**: Allows you to view the total number of executions runs.
56. **Remove Widget**: Allows you to remove the Total execution runs widget.
57. **Open Runs**: Allows you to navigate to the Reports page and view the available execution summaries.
58. **Overall Pass Rates**: Allows you to view the overall execution pass rate for the selected execution runs.
59. **Remove Widget**: Allows you to remove the Overall pass rates widget.
60. **Filter Overall Pass Rates**: Allows you to filter the overall execution pass rate data based on the following criteria:
    * Date Range
    * Bitbucket Integration
    * Created by
    * Assigned to
61. **Execution Results**: Allows you to view the execution result summary.
62. **Remove Widget**: Allows you to remove the Execution results widget.
63. **Chart Type**: Allows you to view the execution result summary data in Horizontal Bar, Pie, or Donut format.
64. **Filter Execution Results**: Allows you to filter the execution results data based on the following criteria:
    * Date Range
    * Bitbucket Integration
    * Created by
    * Assigned to

<figure><img src="/files/TOLcHy2BYO3kYxVMYuJ4" alt=""><figcaption></figcaption></figure>


# Viewing the Dashboard

The Dashboard section allows you to filter and view data based on the selected criteria. This article explains how to access the Dashboard and view data using available dashboard sections, widgets, and filters, enabling users to analyze information and understand trends effectively.

## Viewing Dashboard Filters

The Dashboard filters allow you to refine and view dashboard data based on specific criteria, such as project, date range, creator, and assigned user.

To view and access the Dashboard filters, perform the following actions:

1. On the **Home** page, locate **Dashboard overview**.
2. In the **Dashboard overview** section, view the **Filters** dropdown section.
3. Select a date from the **Date Range** date picker to choose the required start date and end date for which you want to view dashboard data.
4. Select the **Bitbucket** integration toggle to view data based on Bitbucket integration status.
5. From the **Created by** multi-select dropdown, select the required user to filter and view data created by the specific user.

{% hint style="info" %}
**Note**: Use the **Select All** check box to select all available users.
{% endhint %}

6. From the **Assigned to** multi-select dropdown, select the required user to filter and view data assigned to the specific user.

{% hint style="info" %}
**Note**: Use the **Select All** check box to select all assigned users.
{% endhint %}

7. From the **Projects** multi-select dropdown, select the required project.

{% hint style="info" %}
**Note**:

* Use the **Select All** check box to select all available projects.
* By default, a project is automatically selected when you log in to the application.
  {% endhint %}

8. Select **Save filters** to save the selected filter criteria. A success message appears.
9. Select **Clear filters** to remove all the applied filters.

{% hint style="info" %}
**Note**:

* Select **Download** to download the dashboard data.
* Select **Refresh** to reload the dashboard data and display the latest updates.
* You can view the **Last refreshed** timestamp to verify the latest dashboard refresh time in UTC.
  {% endhint %}

After applying the required filters, the Dashboard displays data based on the selected filter criteria.

<img src="/files/x878hEjLuCKyqtpzksvY" alt="" height="178" width="602">

## Viewing Element Repositories Data

The Element Repositories section allows you to view element repository-related metrics, element repository status, and element repository creation trends.

To view and access the Element Repositories data, perform the following actions:

1. On the **Home** page, locate **Dashboard**.
2. In the **Dashboard** section, scroll to the **Element Repositories** dropdown section.
3. In the **Total repositories** widget, you can view the total number of element repositories based on the applied dashboard filters.
4. From the **App Type** multi-select dropdown, select the required application type for which you want to view repository data.
5. Select **Open repositories**. The **Element Repository** page opens, and you can view the available repositories.
6. In the **Element repository status** widget, you can view the element repository [status](/avo-assure/create-and-execute-tests-with-design-studio/test-artifacts-in-avo-assure) data.
7. Select the **Chart Type** icon and choose the required chart type to view the element repository status data in the selected chart format.
8. Select the **Element repository status** filter icon. The **Filter Element repository status** dialog opens. In the **Filter Element status** dialog, perform the following actions:

   1. Select a date from the **Date Range** date picker to choose the required start date and end date.
   2. Select the **Bitbucket integration** toggle to view data based on Bitbucket integration status.
   3. From the **Created by** multi-select dropdown, select the required user to filter and view data created by the specific user.

   **Note**: Use the **Select All** check box to select all available users.

   4. From the **Assigned to** multi-select dropdown, select the required user to filter and view data assigned to the specific user.

   **Note**: Use the **Select All** check box to select all assigned users.

   5. Select **Apply** to apply the selected filters.
   6. Select **Clear** to remove the applied filters.
9. In the **Element repository trends** widget, you can view the trend of element repositories created by each user over the selected time period.
10. Select the **Chart Type** icon and choose the required chart type to view the element repository trends data in the selected chart format.
11. Select the **Element repository trends** filter icon. The **Filter Element repository trends** dialog opens. In the **Filter Element repository trends** dialog, perform the following actions:

    1. Select a date from the **Date Range** date picker to choose the required start date and end date.
    2. Select the **Bitbucket integration** toggle to view data based on Bitbucket integration status.
    3. From the **Created by** multi-select dropdown, select the required user to filter and view data created by the specific user.

    **Note**: Use the **Select All** check box to select all available users.

    4. From the **Assigned to** multi-select dropdown, select the required user to filter and view data assigned to the specific user.

    **Note**: Use the **Select All** check box to select all assigned users.

    5. Select **Apply** to apply the selected filters.
    6. Select **Clear** to remove the applied filters.

After applying the required filters, the selected widgets display element repositories data based on the specified criteria.

<img src="/files/uOT0ky6iubittyv9U5AL" alt="" height="228" width="506">

## Viewing Test Cases Data

The Test Cases section allows you to view test case-related metrics, test case status, and test case creation trends.

To view and access the Test Cases data, perform the following actions:

1. On the **Home** page, locate Dashboard.
2. In the **Dashboard** section, scroll to the **Test Cases** dropdown section.
3. In the **Total test cases** widget, you can view the total number of test cases based on the applied dashboard filters.
4. Select **Open test cases**. The **Test Cases** page opens, and you can view the available test cases.
5. In the **Test case status** widget, you can view the test case [status ](/avo-assure/create-and-execute-tests-with-design-studio/test-artifacts-in-avo-assure)data.
6. Select the **Chart Type** icon and choose the required chart type to view the test case status data in the selected chart format.
7. Select the **Test case status** filter icon. The **Filter Test case** status dialog opens. In the **Filter Test case status** dialog, perform the following actions:

   1. Select a date from the **Date Range** date picker to choose the required start date and end date.
   2. Select the **Bitbucket integration** toggle to view data based on Bitbucket integration status.
   3. From the **Created by** multi-select dropdown, select the required user to filter and view data created by the specific user.

   **Note**: Use the **Select All** check box to select all available users.

   4. From the **Assigned to** multi-select dropdown, select the required user to filter and view data assigned to the specific user.

   **Note**: Use the **Select All** check box to select all assigned users.

   5. Select **Apply** to apply the selected filters.
   6. Select **Clear** to remove the applied filters.
8. In the **Test case trends** widget, you can view the trend of test cases created by each user over the selected time period.
9. Select the **Chart Type** icon and choose the required chart type to view the test case trends data in the selected chart format.
10. Select the **Test case trends** filter icon. The **Filter Test case trends** dialog opens. In the **Filter Test case trends** dialog, perform the following actions:

    1. Select a date from the **Date Range** date picker to choose the required start date and end date.
    2. Select the **Bitbucket integration** toggle to view data based on Bitbucket integration status.
    3. From the **Created by** multi-select dropdown, select the required user to filter and view data created by the specific user.

    **Note**: Use the **Select All** check box to select all available users.

    4. From the **Assigned to** multi-select dropdown, select the required user to filter and view data assigned to the specific user.

    **Note**: Use the **Select All** check box to select all assigned users.

    5. Select **Apply** to apply the selected filters.
    6. Select **Clear** to remove the applied filters.

After applying the required filters, the selected widgets display test case data based on the specified criteria.

<img src="/files/ek53duZytYkaNHlY6iF5" alt="" height="256" width="606">

## Viewing Execution Profile Data

The Execution Profiles section allows you to view execution list-related metrics, execution list status, and execution list trends.

To view and access the Execution Profile data, perform the following actions:

1. On the **Home** page, locate Dashboard.
2. In the **Dashboard** section, scroll to the Execution Profiles dropdown section.
3. In the **Total execution lists** widget, you can view the total number of executions based on the applied dashboard filters.
4. Select **Open executions**. The Execution page opens, and you can view the available execution lists.
5. In the **Execution list status** widget, you can view the execution [status ](/avo-assure/create-and-execute-tests-with-design-studio/test-artifacts-in-avo-assure)data.
6. Select the **Chart Type** icon and choose the required chart type to view the execution list status data in the selected chart format.
7. Select the **Execution list status** filter icon. The **Filter Execution list status** dialog opens. In the **Filter Execution list status** dialog, perform the following actions:

   1. Select a date from the **Date Range** date picker to choose the required start date and end date.
   2. Select the **Bitbucket integration** toggle to view data based on Bitbucket integration status.
   3. From the **Created by** multi-select dropdown, select the required user to filter and view data created by the specific user.

   **Note**: Use the **Select All** check box to select all available users.

   4. From the **Assigned to** multi-select dropdown, select the required user to filter and view data assigned to the specific user.

   **Note**: Use the **Select All** check box to select all assigned users.

   5. Select **Apply** to apply the selected filters.
   6. Select **Clear** to remove the applied filters.
8. In the Execution list trends widget, you can view the trend of execution list created by each user over the selected time period.
9. Select the Chart Type icon and choose the required chart type to view the execution list trends data in the selected chart format.
10. Select the **Execution list trends** filter icon. The **Filter Execution list trends** dialog opens. In the **Filter Execution list trends** dialog, perform the following actions:

    1. Select a date from the **Date Range** date picker to choose the required start date and end date.
    2. Select the **Bitbucket integration** toggle to view data based on Bitbucket integration status.
    3. From the Created by multi-select dropdown, select the required user to filter and view data created by the specific user.

    **Note**: Use the **Select All** check box to select all available users.

    4. From the **Assigned to** multi-select dropdown, select the required user to filter and view data assigned to the specific user.

    **Note**: Use the **Select All** check box to select all assigned users.

    5. Select **Apply** to apply the selected filters.
    6. Select **Clear** to remove the applied filters.

After applying the required filters, the selected widgets display execution list data based on the specified criteria.

<img src="/files/p6TG0dcmfLDrSNiC90aK" alt="" height="254" width="606">

## Viewing Execution Summary Data

The Execution Summaries section allows you to view execution run-related metrics, overall pass rates, and execution result summaries.

To view and access the Execution Summaries data, perform the following actions:

1. On the **Home** page, locate Dashboard.
2. In the **Dashboard** section, scroll to the **Execution Summaries** dropdown section.
3. In the **Total execution runs** widget, you can view the total number of execution runs based on the applied dashboard filters.
4. Select **Open** runs. The **Reports** page opens, and you can view the available execution runs.
5. In the **Overall pass rates** widget, you can view the overall percentage of passed test cases across execution runs.
6. Select the **Overall pass rates** filter icon. The **Filter Overall pass rates** dialog opens. In the **Filter Overall pass rates** dialog, perform the following actions:

   1. Select a date from the **Date Range** date picker to choose the required start date and end date.
   2. Select the **Bitbucket integration** toggle to view data based on Bitbucket integration status.
   3. From the **Created by** multi-select dropdown, select the required user to filter and view data created by the specific user.

   **Note**: Use the **Select All** check box to select all available users.

   4. From the **Assigned to** multi-select dropdown, select the required user to filter and view data assigned to the specific user.

   **Note**: Use the **Select All** check box to select all assigned users.

   5. Select **Apply** to apply the selected filters.
   6. Select **Clear** to remove the applied filters.
7. In the **Execution results** widget, you can view the execution result [summary ](/avo-assure/create-and-execute-tests-with-design-studio/working-with-reports-section/read-a-report#test-report-summary)based on result categories.
8. Select the **Chart Type** icon and choose the required chart type to view the execution results data in the selected chart format.
9. Select the **Execution results** filter icon. The **Filter Execution results** dialog opens. In the **Filter Execution results** dialog, perform the following actions:

   1. Select a date from the **Date Range** date picker to choose the required start date and end date.
   2. Select the **Bitbucket integration** toggle to view data based on Bitbucket integration status.
   3. From the **Created by** multi-select dropdown, select the required user to filter and view data created by the specific user.

   **Note**: Use the **Select All** check box to select all available users.

   4. From the **Assigned to** multi-select dropdown, select the required user to filter and view data assigned to the specific user.

   **Note**: Use the **Select All** check box to select all assigned users.

   5. Select **Apply** to apply the selected filters.
   6. Select **Clear** to remove the applied filters.

After applying the required filters, the selected widgets display execution run data based on the specified criteria.

<img src="/files/nPASj4iYOn2JG0c4UOoJ" alt="" height="250" width="606">

## Editing a Widget

To add or remove widgets in a dashboard section, perform the following actions:

1. In the required dashboard section, select the **Edit** icon. The **Edit** dialog box opens.

<img src="/files/OfHbc0D4ozx9ls9rCU5y" alt="" height="288" width="528">

2. Select the checkbox for the widgets that you want to display in the section.
3. Clear the checkbox for the widgets that you do not want to display in the section.
4. Alternatively, select the **Select all** checkbox to add all available widgets to the section.
5. Select **Save changes**. The dashboard section displays the selected widgets.

## Removing a Widget

To remove a widget, perform the following actions:

1. Locate the widget that you want to remove.
2. Select the **Remove** icon on the widget. The **Remove widget** confirmation dialog box opens.

<img src="/files/R0TlFA5GJV7EZ8QowDGG" alt="" height="172" width="605">

3. Select **Remove** to remove the widget. The selected widget is removed from the dashboard section.

{% hint style="info" %}
**Note**: Select **Cancel** to close the dialog without removing the widget.
{% endhint %}


# Accessing Avo Assure Instance

The first step is to set up instance for Avo Assure. Avo instance URL will be shared with the organization's spoc/Admin by Avo team, after approved license agreement.

The admin then will be able to create user profiles and share the following with them:

1. Avo Assure **instance URL** and **credentials to login**
2. **Token** unique to each user

### Viewing TnC and Changing Password

TnC stands for terms and conditions, it is mandatory for the user to accept the TnC (or End User License Agreement) before using the platform. This will strengthen the user experience from security perspective

1. Click the ***Activate your Account*** button in the email received to navigate to the **End User License Agreement** pop up. Click on **"Agree".**

<figure><img src="/files/OceQV7vf3SAewgCE5mxA" alt=""><figcaption></figcaption></figure>

2. Now, User will get prompted to the **Change Password window.**

{% hint style="info" %}
**Note:** Users must change their password during their first login and set a new password.
{% endhint %}

The new password must meet the following requirements:

a) It must contain **8-16 characters long**

b) It must contain at least an **uppercase and a lowercase letter**

c) It must contain **at least a number and a special character**

Once done, click the **Change Password button** and the system will generate a confirmation message that reads Password Changed Successfully

{% hint style="info" %}
**Note:** A validation error will pop up if the mentioned criterion for the new password is not met.
{% endhint %}

### Loging to the Avo Assure Instance

The steps to login to Avo Assure instance are:

{% tabs %}
{% tab title="Step 1" %}
Navigate to the Avo Assure server through a browser.

**Note:** Avo instance is supports Chrome, Edge and fire fox as default browsers
{% endtab %}

{% tab title="Step 2" %}
Accept the TnC (End User Agreement) and enter the valid Avo Assure credentials then Click **Login button.**

<figure><img src="/files/5RTOTvS6DecfeoAk9USE" alt="" width="277"><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Step 3" %}
Once done, The Avo Assure landing page will be displayed
{% endtab %}
{% endtabs %}


# Avo Assure Client

The **Avo Assure Client** is the core component of the Avo Assure platform. It acts as a bridge between the Avo Assure Server and the application under test (AUT), enabling element capture, test case execution, and generation of detailed logs for each executed test step. Before you install and configure the Avo Assure Client, ensure that your system meets the required prerequisites, including supported hardware and operating system requirements, network connectivity, and valid server credentials. This article guides you through downloading and installing the Avo Assure Client, introduces its key features, and explains how to manage the Avo Assure Client token.

## **Prerequisites**

Before you install and configure the Avo Assure Client, make sure the following requirements are fulfilled:

**System Requirements**

* **Operating System**: A supported OS such as Windows 10/11, Windows Server 2016/2019, or specified Linux distributions.
* **Hardware**: Minimum 8GB RAM and CPU as per Avo Assure Client specifications.
* **Disk Space**: Enough space for installation, logs, and temporary files (minimum **10 GB**).

**Network Connectivity**

* **Server Access**: Client must connect to the Avo Assure Server over the network.
* **Firewall and Ports**: Ensure firewalls allow traffic on required ports for Client-Server communication.

**Server Credentials**

* **Valid Credentials**: Required to register and connect the Client to the Avo Assure Server.


# Downloading Avo Assure Client

You can download the Avo Assure Client based on your user type:

* [**Downloading Client for New User**](#downloading-client-for-new-user)
* [**Downloading Client for Existing User**](#downloading-client-for-existing-user)

## Downloading Client for New User

To download the Avo Assure Client, perform the following actions:

1. On the **Avo Assure Login** page, enter your **Username** and **Password**.

{% hint style="info" %}
**Note**: If you enter an invalid password multiple times, then your account gets locked. To unlock your account, you must reach out to Admin.
{% endhint %}

2. Select **Login**. The **Accept Terms and Conditions** dialog opens.

{% hint style="info" %}
**Note**: Only users with the **Admin** role or the **Quality Manager** with Admin as a secondary role can create a new user. To learn more, [click here](/avo-assure/administration/authentication-configuration/authentication-configuration-1/privileges).
{% endhint %}

3. Select **I Agree** to accept the terms and conditions. Once confirmed, you are directed to the **Download Avo Assure Client** page.

<figure><img src="/files/MjwTDLyYh122ErJGvaeq" alt=""><figcaption></figcaption></figure>

4. Select **Download Avo Assure Client** to download the **AvoAssureClient.exe** file.

{% hint style="info" %}
**Note**: If you do not want to download the **AvoAssureClient.exe** file at this time, select **Skip for now**. You are then directed to the **Getting Started** page.
{% endhint %}

<figure><img src="/files/HDicRCuOHAQfgeJj3Tol" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Note**: After the download completes, the **AvoAssureClient.exe** file appears in the browser **Downloads** section.
{% endhint %}

<figure><img src="/files/ze709vUJQ6nH8gBF1VaE" alt=""><figcaption></figcaption></figure>

5. Select **Open**, **Save As**, or **Save** to save it in the **Downloads** folder on local machine.
6. On the **Setup Avo Assure Client** page, select the **>** icon to view the next setup steps.
7. Once the **Next** button appears, select **Next**. The **Getting Started** page opens.

{% hint style="info" %}
**Note**:

* If you do not want to view the setup steps, select **Skip** to direct you to the **Getting Started** page. For detailed installation instructions, [click here](/avo-assure/avo-assure-client/installing-avo-assure-client).
* If the download does not start automatically, you can get it from the **User Profile** dropdown on the **Home** page.
  {% endhint %}

<figure><img src="/files/ci0C1CybnEmLhaSAVwJF" alt=""><figcaption></figcaption></figure>

8. Select **Get Started** to complete the client download process.

<figure><img src="/files/4WlQk49B2ABIWV9uTMpE" alt=""><figcaption></figcaption></figure>

## Downloading Client for Existing User

To download the Avo Assure Client, perform the following actions:

1. On the **Home** page, select the **Profile** icon.
2. Select **Download**, and then select **Download** **Client**. The download automatically begins.

{% hint style="info" %}
**Note**: After the download completes, the **AvoAssureClient.exe** file appears in the browser **Downloads** section.
{% endhint %}

3. Select **Open**, **Save As**, or **Save** to save it in the **Downloads** folder on your local machine.
4. The **AvoAssureClient.exe** file is downloaded.


# Installing Avo Assure Client

You can install and relaunch the Avo Assure Client using the following options:

* [**Allowing Permission Before Installing Avo Assure Client**](#allowing-permission-before-installing-avo-assure-client)
* [**Installing Avo Assure Client**](#installing-avo-assure-client)
* [**Relaunching Avo Assure Client**](#relaunching-avo-assure-client)

## Allowing Permission Before Installing Avo Assure Client

During installation of the Avo Assure Client, windows display a security prompt that blocks the installer. Allow it to proceed to continue the setup.

To proceed with the installation, perform the following actions when the Windows SmartScreen dialog appears:

1. Go to the downloaded **AvoAssureClient.exe** file and double-click on **AvoAssureClient.exe** file. The **Windows protected your PC** dialog opens.
2. Select **More info** link which allows you to proceed with the installation.
3. Select **Run anyway** to allow the installer to proceed.

{% hint style="info" %}
**Note**: Do not select **Don’t run**, as this stops the installation of the Avo Assure Client.
{% endhint %}

## Installing Avo Assure Client

To install the Avo Assure Client, perform the following actions:

{% hint style="info" %}
**Note**: Use system’s File Explorer to perform all the following steps.
{% endhint %}

1. From **Downloads** folder, double-click on the **AvoAssureClient.exe** file. The **Setup-Avo Assure Client** dialog opens.

{% hint style="info" %}
Download the **AvoAssureClient.exe** file from your Avo Assure instance. To learn more, [click here](/avo-assure/avo-assure-client/downloading-avo-assure-client).
{% endhint %}

2. Select **Next** to direct to the **Select Destination Location** page.
3. Select the destination location to install and save the client.
4. After selecting destination location file, select **Next**.

{% hint style="info" %}
**Note**: To install the client in a different folder, select **Browse** and select destination folder.
{% endhint %}

5. After completing all the configurations, the installation process starts.
6. Select **Finish** to complete the setup process. The **Avo Assure Client Registration** dialog opens.
7. Copy the token provided by the Admin and paste it into the **Token** text box.

{% hint style="info" %}
**Note**: On the **Avo Assure Client Registration** dialog, the following details are displayed:

* **Host URL**: The **Host URL** of the instance is automatically populated in the text box.
* **Token**: When you receive a dedicated Avo Assure URL, you will also receive your login credentials and token from your Admin.
  {% endhint %}

{% hint style="info" %}
To generate token from Avo Assure, [click here](/avo-assure/avo-assure-client/managing-avo-assure-client-token).
{% endhint %}

8. After completing all required configurations, select **Submit**. The **Avo Assure Client** window opens.
9. On the **Avo Assure Client**, a success message appears confirming registration.
10. Select **Connect** to connect with your Avo Assure instance.

## Relaunching Avo Assure Client

To relaunch the Avo Assure Client after closing it, perform the following actions:

1. In system's File Explorer, go to the folder where you stored the client during installation.
2. Open **avo** folder.

<figure><img src="/files/gD7ClP9kEbd1mi3W1C2p" alt=""><figcaption></figcaption></figure>

3. Double-click the **run.bat** file to launch the Avo Assure Client. The **Client** opens.

{% hint style="info" %}
**Note**: You can also launch the client using the **console.bat** or **run\_mobile.bat** files.
{% endhint %}

<figure><img src="/files/ubuNVtlwfh82Orx8vHPJ" alt=""><figcaption></figcaption></figure>


# Features of Avo Assure Client

The Avo Assure client includes the following key features:

1. [**Monitoring and Managing Client**](/avo-assure/avo-assure-client/features-of-avo-assure-client/monitoring-and-managing-client)

* **Console Logs**
* **Configuration**

2. [**Managing Test Execution and Client Status**](/avo-assure/avo-assure-client/features-of-avo-assure-client/managing-test-execution-and-client-status)

* **Action Controls**
* **Debug Options**
* **Information**

<figure><img src="/files/cR5FuZoBk25loAh20XIS" alt=""><figcaption></figcaption></figure>


# Monitoring and Managing Client

This section allows you to manage the client's connectivity and maintenance. Use this section to manage server connections, monitor real-time execution status through console logs.

The Avo Assure Client includes the following tabs:

* [**Console Logs**](#console-logs)
* [**Configuration**](#configuration)

<figure><img src="/files/15e152cT5WUIuNcMdvWm" alt="" width="563"><figcaption></figcaption></figure>

## **Console Logs**

The Console Logs feature displays real-time records of the test execution. You use this interface to monitor the progress of your scenarios, verify successful operations, and immediately identify any errors or warnings.

<figure><img src="/files/IzTBti3LUrJucs6H7bqe" alt=""><figcaption></figcaption></figure>

The logs provide a detailed breakdown of the test execution flow. For each step, the console displays the following information:

* **Timestamp:** Displays the specific date and time when the action occurred.
* **Sequence Number:** Displays the order in which the step executes.
* **Element Properties:** Displays the details regarding the specific UI element interacted with during the step.
* **Action:** Displays the specific operation performed (such as clicking a button or entering text).
* **Execution Status:** Displays the outcome of the step marked as either Pass or Fail.

This detailed view allows you to analyze the specific actions taken at every stage and confirm the final result of your test scenario.

## Configuration

The Configuration feature manages the connection between the Avo Assure Client and the Avo Assure server. You use it to configure IP addresses, port numbers, and other required system settings for successful communication. It also lets you customize client behavior to suit your testing environment.

<figure><img src="/files/A9bugxCscni8Z0J30hJn" alt="" width="563"><figcaption></figcaption></figure>

The Configuration section contains the following options:

<details>

<summary><strong>Path Configuration</strong></summary>

This **Path Configuration** tab set up the connection between the client and the Avo Assure web application. You use this tab to tell the client where to find browsers, logs, and security certificates.

The **Path Configuration** tab contains the following options:

* **Server Address**: The system automatically fills this field with the Web Server hostname during registration. It matches the Avo Assure product URL.
* **Server Port**: The system automatically fills this field with the port number during registration. If you use a patch updater, enter the default port **443**.
* **Chrome Path**: Enter the installation location of the Google Chrome browser. If you type **default**, the client finds the location automatically.
* **Chrome Profile**: Enter the path to your specific Chrome user profile data. This setting applies only to Chrome-based applications.
* **Extension Path**: Enter the folder path for browser extensions. This applies only to Chrome and Chromium browsers. Use **default** if you do not need to configure extensions.
* **Firefox Path**: Enter the installation location of the Mozilla Firefox browser. If you type **default**, the client finds the location automatically.
* **Log File Path**: Select the folder where the client saves execution logs. You must create a folder named **Logs** and browse to it. If the file does not exist, the system creates it automatically.
  * **Default (Mac)**: `/Users/username/Desktop/AvoAssure_Avo Assure Client/logs/TestautoV2.log`
  * **Default (Windows)**: `C:/TestautoV2.log`
* **Server Certificate**: This field specifies the full path to the Avo Assure web server certificate file (**server.crt**). Use the **CA\_BUNDLE** folder inside the Avo Assure directory. The system automatically finds the `server.crt` file in that folder and fills in the path.
  * **Input**: Path to the server.crt file
  * **Default value**: ./Scripts/CA\_BUNDLE/server.crt

</details>

<details>

<summary><strong>Time-Out Configuration</strong></summary>

The **Time-Out Configuration** tab controls how long Avo Assure waits during test execution. These settings help prevent tests from getting stuck when an application, element, or system does not respond in time.

The following settings define the wait times used during test execution in Avo Assure:

* **Global Wait Time Out**: This sets how long Avo Assure waits for an element to appear in the application.
  * **Default Value**: **0** (In second).
  * Applies to all scraped elements across Web, Mobile Web and Desktop.
  * If a test step has its own wait time, that value is used instead.
* **Step Execution Wait**: Adds a short wait before moving to the next test step.
  * **Default Value**: **0.1** seconds.
* **Display Variable Timeout**: Controls how long the variable value popup stays visible.
  * **Default Value**: **1** second.

{% hint style="info" %}
**Note:** This setting applies to the **Display Variable Value** Action.
{% endhint %}

* **Connection Timeout**: Sets how long the client waits before disconnecting from the server.
  * **Default Value**: **0** (In Hours).
* **Max Retries for App Launch**: Defines how many times Avo Assure retries launching the PDF reader for **normalizePDF**.
  * **Default Value**: **20** seconds.
* **Time Out**: Sets how long Avo Assure waits for an element to visible on a page.
  * Used for Web and Android native waits.
  * **Default Value**: **1** second.
* **Delay**: Adds a wait before switching windows.
  * **Default Value**: **0.3** second.

{% hint style="info" %}
**Note:** This setting applies to only for **Web applications**.
{% endhint %}

* **Delay for String Input**: Sets the pause between each keystroke while entering text.
  * **Default Value**: **1** second.

{% hint style="info" %}
**Note**: This setting is applicable for the **Send Function Keys** Action.
{% endhint %}

* **Query Timeout**: Sets how long Avo Assure waits while connecting to a database.
  * **Default Value**: **3** seconds.
* **Element Load Timeout**: Specifies how long the system waits for an element to load.
  * **Default Value**: **30** seconds.

</details>

<details>

<summary><strong>Settings</strong></summary>

The **Settings** tab includes troubleshooting options and access controls. You use this page to choose different configurations based on your testing needs.

* **Custom Property**: Allows you to define a custom element attribute that the Avo Assure Client captures during element identification, such as data-testid, data-val-required or custom-id.

{% hint style="info" %}
**Note**: If the element contains the specified property, the system automatically captures it and assigns it the highest priority during identification. To know more about **Custom Property**, [click here](/avo-assure/create-and-execute-tests-with-design-studio/working-with-element-repository-section/features-in-element-repository/element-identifier-order/custom-property/configure-custom-property).
{% endhint %}

* **TLS Security Level**: Controls whether the system verifies website security certificates or allows you to bypass the checks when certificates are unavailable.
  * **High**: Checks both certificate and hostname.
  * **Med**: Checks the certificate but ignores the hostname.
  * **Low** (Default): Ignores both checks.
* **Ignore AUT Certificate**: Controls whether the system ignores security certificate warnings on the application under test (AUT). This setting applies to Internet Explorer only.
  * **Yes**: Ignores the warnings.
  * **No** (Default): Reports the warnings.
* **IE Architecture Type**: Selects the correct Internet Explorer driver based on your system type.
  * **64-bit** (Default): Uses the 64-bit driver.
  * **32-bit**: Uses the 32-bit driver.
* **Exception Flag**: Controls how the system behaves when an error occurs, such as Object not found).
  * **True**: Stops the current scenario when an error occurs and continues execution with the next scenario in the test case.
  * **False** (Default): Ignores the error and continues execution with the next test step.
* **Ignore Visibility Check**: Controls whether the system checks if an element is visible on the screen before interacting with it.
  * **Yes**: Skips the visibility check and attempts to interact with the element.
  * **No** (Default): Checks whether the element is visible before interacting with it.

{% hint style="info" %}
**Note**: This setting applies to Web applications.
{% endhint %}

* **HTTP Status Code Check**: Controls whether the test stops when the website returns a server error, such as 404 – Page Not Found.
  * **Yes** (Default): Stops the test when an error occurs.
  * **No**: Continues the test when an error occurs.
* **Browser Check**: Verifies whether the installed browsers are compatible with the current client version.
  * **Yes** (Default): Performs the compatibility check.
  * **No**: Skips the check.
* **Enable Security Check**: Automatically sets all Internet Explorer security zones to the same level.
  * **Yes**: Applies uniform security settings.
  * **No** (Default): Does not change security settings.
* **Highlight Check**: Highlights the item on the screen when the test verifies its existence.
  * **Yes**: Highlights the item.
  * **No** (Default): Does not highlight the item.
* **Prediction for IRIS Objects**: It enables or disables IRIS prediction based on its value.
  * **Yes**: Enables prediction.
  * **No** (Default): Disables prediction.
* **Hide Soft. Keyboard**: Indicates whether the keypad is hidden or displayed on Android devices.
  * **Yes**: Hides the keyboard.
  * **No** (Default): Shows the keyboard.

{% hint style="info" %}
**Note**: This option applies only for Android-based applications.
{% endhint %}

* **Extension Enable**: Controls whether the system pauses execution during debugging when an object is not found, allowing you to scrape the object and continue.
  * **Yes**: Pauses the execution and allows you to scrape the required object before continuing.
  * **No (Default)**: Does not pause the execution and continues even if the object is not found.
* **Update Check:** Automatically checks for ICE/Client updates when you connect to the server.
  * **Yes**: Checks for updates.
  * **No** (Default): Does not check for updates.
* **Clear Cache:** Deletes temporary browser files before starting the test.
  * **Yes**: Clears the cache.
  * **No** (Default): Keeps the cache.
* **Full Screenshot**: Controls whether the system captures full-screen screenshots.
  * **Yes**: Captures full-screen screenshots.
  * **No** (Default): Does not capture full-screen screenshots.
* **Close Browser Popup**: Controls whether the system uses a custom internal debug port to launch the browser.
  * **Yes** (Default): Automatically closes any pop-up windows generated by the browser.
  * **No**: Keeps the browser pop-up windows open.

{% hint style="info" %}
**Note**: This setting applies only to Web applications.
{% endhint %}

* **Use Custom Debug Port**: Controls whether the system uses a custom internal debug port to launch the browser.
  * **Yes**: It uses a custom debug port to launch the browser.
  * **No** (Default): It uses the system default port to launch the browser.

{% hint style="info" %}
**Note**: This setting applies only to Web applications.
{% endhint %}

* **Disable Screen Timeout**: Controls whether the system prevents the screen from locking or turning off during test execution.
  * **Yes**: Disables the screen timeout during execution.
  * **No** (Default): Keeps the system screen timeout unchanged.

{% hint style="info" %}
**Note:**

* If Avo Assure Client is run as admin, then the **Disable Screen Timeout** option is enabled.

* If Avo Assure Client does not run as admin, then the **Disable Screen Timeout** option is disabled.
  {% endhint %}

* **Incognito Private Mode**: Runs the test in a private browser window that does not save history.
  * **Yes**: Enables private mode.
  * **No** (Default): Disables private mode.

* **Kill Stale Process**: Controls whether the system closes old background processes started by Avo Assure before each execution.
  * **Yes** (Default): Closes old processes.
  * **No**: Keeps old processes running.

* **Browser Screenshots**: Controls how the system captures screenshots for web applications.
  * **Yes** (Default): Captures screenshots using the browser driver.
  * **No**: Captures generic screenshots using the operating system.

* **Logger Level**: The logger level determines how much detail appears in the test reports.
  * **Info** (Default): Shows the basic progress, including pass or fail status and reasons for failure.
  * **Debug**: Shows detailed technical logs. Use this for developer troubleshooting.
  * **Error**: Shows only the error messages

</details>

<details>

<summary><strong>Proxy Configuration</strong></summary>

This **Proxy Configuration** tab manages network connectivity and lets you enter proxy server details if your network requires a proxy to access the internet or the Avo Assure server. In networks with restricted access to certain URLs, you must configure a proxy to reach these URLs.

Avo Assure lets you enable or disable proxy configuration. When enabled, the following fields become editable:

* **Proxy URL**: Enter the proxy server address to access data or modify settings.
* **Proxy Username**: Enter the username required to authenticate with the proxy server.
* **Proxy Password**: Enter the encrypted password required to authenticate with the proxy server.

{% hint style="info" %}
**Note**: Use the **Encryption** option from utilities to encrypt the password. For more information, [click here](/avo-assure/utilities/encryption).
{% endhint %}

</details>

## Automatic Avo Client Updates

The Avo Client now manages updates automatically. When a new version is available, the client downloads and installs it for you. This helps you stay up to date with the latest features, improvements, and fixes without any manual effort.

To enable automatic updates, perform the following actions:

1. Open the **Avo Assure Client**.

{% hint style="info" %}
**Note**: If you are using an older version of the **Avo Client**, download and install the latest **Avo Client** to enable automatic updates.
{% endhint %}

2. Select **Configuration** > [**Settings**](#settings).
3. Select **Update Check** setting as **Yes.**

{% hint style="info" %}
**Note:** The **Update Check** setting must be set to **Yes** for automatic updates to work.
{% endhint %}

#### What Happens After Update

* Future **Avo Client** updates are downloaded automatically in the background.
* Updates are installed only when the client is idle.
* Running executions are not interrupted during the update process.
* The client automatically reconnects after the update is complete.

{% hint style="info" %}
**Note:** These instructions apply only to the **Avo Client** installed on your local machine. If the **Avo Client** is installed on an **Agent** machine, it updates automatically and does not require any manual action.
{% endhint %}


# Managing Test Execution and Client Status

This controls the test execution, debug errors, and view critical client information. You can start, pause, or stop test scenarios, inspect specific steps to troubleshoot issues, and monitor connection status, server details, and the installed client version.

The following options contain the client’s controls and information:

* [**Actions**](#actions)
* [**Debug Options**](#debug-options)
* [**Information**](#information)

<figure><img src="/files/djc2Qg5QGU4omdE5tfs9" alt=""><figcaption></figcaption></figure>

## Actions

Actions provide direct control over the test execution lifecycle. You can start, pause, or stop test scenarios directly from the client interface.

The Actions section enables you to perform the following operations:

* **Connect** or **Disconnect**: Establishes a connection between the Avo Assure Client and the Avo Assure Server. This connection is required before test execution begins.
* **Kill Stale Process**: Stops the previous execution and closes if any automation browsers still running in the background.
* **Terminate**: Stops the currently running test execution.
* **Clear Logs**: Removes the logs displayed in the console.
* **Do Not Disturb**: Prevents interruptions during execution. When it enabled, the system blocks notifications and user interactions that can interrupt the ongoing process.

## Debug Options

Debug Options help you troubleshoot errors during a test run. You can use these options to inspect specific test steps and identify the exact cause of a failure.

The Debug section enables you to perform the following operations:

* **Normal**: Analyzes all test steps from beginning to end and displays a final combined execution result.
* **Stepwise**: It debugs the designed Test steps from the start to end one by one to validate them individually.
* **Run from Step**: It debugs the Test steps from the provided Test step number mentioned in the text box, like 6-10 or 1-7.

## Information

Information displays important details about the client’s connection status and software version.

The Information contains the following options:

* **Connectivity Options**: This section displays the current network connection details. You can use it to verify the **Server Status** (Connected or Not Connected), the **Server address** (URL), and the communication **Port** number currently in use.
* **Avo Assure Client Information**: This section displays the installed software details. You can view the **Version** number and the **Last Updated** timestamp to confirm that you are running the correct application build.


# Managing Avo Assure Client Token

The Token Management feature in Avo Assure allows you to register or generate a new token whenever required. Use this feature to authenticate integrations securely and maintain uninterrupted access.

## Generating Avo Assure Client Token

To Generate the Avo Assure Client token, perform the following actions:

1. On the **Home** page, select **Profile** icon.
2. Select **Token Management**, The **Avo Assure Client Provision** dialog opens.
3. In the **Avo Assure Client Provision** tile and enter the client name in the **Avo Assure Client Name** text box.
4. Select **Generate** to create a new token.
5. Select **Copy** icon to copy the generated token and paste it in Avo Assure Client.

{% hint style="info" %}
**Note**: To know more how to register client with generated token, [click here](/avo-assure/administration/authentication-configuration/user-management/creating-new-user#registering-client-using-generated-token)
{% endhint %}

## Reregistering Avo Assure Client Token

To Reregister the Avo Assure Client token, perform the following actions:

1. On the **Home** page, select **Profile** icon.
2. Select **Token Management**. The **Avo Assure Client Provision** dialog opens.
3. From **Actions** column, select **Reregister**. The token is generated
4. Select **Copy** to use it into client.

## Deregistering Avo Assure Client Token

To Deregister the Avo Assure Client token, perform the following actions:

1. On **Home** page, select **Profile** icon.
2. Select **Token Management**. The **Avo Assure Client Provision** pop up opens.
3. From **Actions** column, select **Deregister** button.


# Avo Assure Installation Requirements

This section describes the necessary prerequisites for accessing Avo Assure on a user's local machine. It details the end-user system configuration required for optimal performance with the Avo Assure platform. You can also find the browser requirements here to get started with the Avo Assure platform.

### This topic covers:

* [End-User System Requirements](/avo-assure/avo-assure-installation-requirements/end-user-system-requirements)
* [Supported Technologies](/avo-assure/avo-assure-installation-requirements/supported-technologies)


# End-User System Requirements

Avo Assure requires a system environment that supports stable performance, secure network communication, and compatibility with its automation capabilities. It includes supported operating systems, hardware requirements, storage recommendations, network and firewall configurations, browser driver requirements, and execution security prerequisites. Use this information to prepare your environment and verify compatibility before installation and execution of Avo Assure.

## Supported Operating Systems

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top"><strong>Platform</strong></td><td valign="top"><strong>Supported Versions</strong></td></tr><tr><td valign="top">Windows Desktop</td><td valign="top">Windows 10 or later</td></tr><tr><td valign="top">Windows Server</td><td valign="top">Windows Server 2016 or later</td></tr><tr><td valign="top">macOS</td><td valign="top">macOS 13 Ventura or later</td></tr></tbody></table>

### Key Notes

* Avo Assure supports Apple Silicon devices.
* Windows 7, Windows 8, and Windows 8.1 are not supported.
* On macOS:
  * Only Web application automation is supported.
  * Desktop application automation and Agent execution is not supported.

## Minimum Hardware Requirements

The following table lists the minimum and recommended hardware requirements for each Avo Client or Virtual Machine (VM):

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top"><strong>Component</strong></td><td valign="top"><strong>Requirement</strong></td></tr><tr><td valign="top">Operating System</td><td valign="top">Windows 10, Windows Server 2016, or later versions. macOS 13 or later</td></tr><tr><td valign="top">Minimum RAM</td><td valign="top">8 GB</td></tr><tr><td valign="top">Recommended RAM</td><td valign="top">16 GB</td></tr><tr><td valign="top">Avo Client Runtime Allocation</td><td valign="top">Minimum 2 GB available memory for Avo Client processes</td></tr><tr><td valign="top">Free Disk Space</td><td valign="top">Minimum 2 GB excluding screenshots</td></tr><tr><td valign="top">Minimum CPU Cores (Single/Parallel Execution)</td><td valign="top">2 vCPU</td></tr><tr><td valign="top">Recommended CPU (Parallel Execution)</td><td valign="top">4 vCPU</td></tr><tr><td valign="top">Minimum Download Speed</td><td valign="top">10 Mbps</td></tr><tr><td valign="top">Minimum Upload Speed</td><td valign="top">10 Mbps</td></tr><tr><td valign="top">Recommended Latency</td><td valign="top">Less than 100 ms</td></tr></tbody></table>

## Virtual Machines and Virtual Desktop Infrastructure Requirements

In shared Virtual Machines (VMs), Virtual Desktop Infrastructure (VDI), Citrix, or Remote Desktop Services (RDS) environments, multiple users can run execution sessions simultaneously. Allocate sufficient RAM and CPU resources to support the combined workload of all active user sessions.

* Minimum system requirements apply to each active Avo execution session and are not shared across concurrent sessions.
* Allocate 8 GB RAM minimum for each active execution session.
* Allocate 16 GB RAM for optimal execution performance.
* Reserve the dedicated 2 GB Avo Client allocation for each concurrent execution session.
* Use dedicated execution VMs for better execution stability and performance.
* Additional resource requirements depend on the following factors:
  * Number of Concurrent Users
  * Parallel Executions
  * Browser Instances/Tabs
  * Application Complexity
  * Screenshot/Video capture usage
  * Background Processes

## Storage Requirements

### Local Machine Storage

Each client machine must have a minimum of 2 GB free disk space excluding screenshots.

The storage requirement includes the following components:

* Execution Logs
* Browser Drivers
* Runtime Artifacts
* Temporary Files
* Application Cache
* Execution Dependencies

### Shared or Centralized Storage

You can store screenshots and execution artifacts in either of the following locations:

* Avo-managed Storage (recommended)
* Customer-managed Shared Storage

#### Key Notes

* If you use customer-managed shared storage, allocate a minimum of 50 GB shared storage initially.
* Storage usage increases proportionally with execution volume, screenshot retention, and data retention policies.
* Shared storage locations must be accessible from all execution machines when centralized storage is configured.

## Execution Permissions & Security Requirements

Security tools such as antivirus software, Endpoint Detection and Response (EDR), application control tools, or execution policy frameworks must allow execution of the following:

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top"><strong>File</strong></td><td valign="top"><strong>Purpose</strong></td></tr><tr><td valign="top">Avoagent.exe</td><td valign="top">Agent Execution</td></tr><tr><td valign="top">Run.bat</td><td valign="top">Execution Launcher</td></tr><tr><td valign="top">Python.exe</td><td valign="top">Runtime Dependency</td></tr><tr><td valign="top">Powershell.exe</td><td valign="top">Script Execution</td></tr><tr><td valign="top">Avoassure.ps1</td><td valign="top">PowerShell Automation</td></tr></tbody></table>

## Certificate-Based Distribution

Configure certificate-based whitelisting for AminHoldings to prevent execution blocks during installation, client updates, agent updates, and runtime operations.

Ensure that the certificate trust chain is available across the following environments:

* VDI environments
* Shared VMs
* Endpoint Protection Platforms
* Application Control Policies
* Enterprise Software Deployment Tools

## Network & Firewall Requirements

Avo Assure modules require secure network connectivity to communicate with cloud and system components. Ensure that your IT team configures the necessary allowlist rules for the following URLs:

<table><thead><tr><th valign="top">URL</th><th valign="top">Purpose</th></tr></thead><tbody><tr><td valign="top">https://&#x3C;instancename>.avoassure.ai/</td><td valign="top">Application Access</td></tr><tr><td valign="top">https://avoirisprodapi.avoassure.ai</td><td valign="top">API Communication</td></tr><tr><td valign="top">https://downloads.avoassure.ai/driver</td><td valign="top">Browser Driver Downloads</td></tr><tr><td valign="top">https://&#x3C;instancename>.avoassure.ai/getAgentTask</td><td valign="top">Agent Task Retrieval</td></tr></tbody></table>

## Browser Driver Requirements

All execution systems must have permission to download, store, and execute browser drivers from the following location: <https://downloads.avoassure.ai/driver>

### Key Notes

Avo Assure updates browser drivers periodically to maintain browser compatibility.

## Supported Browser Drivers

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top"><strong>Driver</strong></td><td valign="top"><strong>Browser</strong></td></tr><tr><td valign="top">Chromedriver.exe</td><td valign="top">Google Chrome</td></tr><tr><td valign="top">msedgedriver.exe</td><td valign="top">Microsoft Edge</td></tr></tbody></table>

### Key Notes

Ensure drivers are not blocked by security policies.

## Preparing for Installation

You must complete the preparatory steps to ensure the Avo Assure Client is installed correctly and is ready for use. Here are the preparatory steps:

1. **Whitelist Instance URL**: Request your IT administrator to add the Avo Assure instance URL to the network allowlist.
2. **Enable .exe downloads**: Ensure your IT team allows or enables downloading of .exe files so the Client installer can be downloaded and installed.
3. **Validate Installation Setup**\
   Perform the following actions to validate the installation setup:
   1. Log in to the application.
   2. Create a new project.
   3. [Capture elements](/avo-assure/create-and-execute-tests-with-design-studio/working-with-element-repository-section/create-element-repository/capturing-elements-in-avo-assure).
   4. Run Test cases through the [Execution List](/avo-assure/create-and-execute-tests-with-design-studio/working-with-execution-section/creating-execution-list).

**Note**: If you are finding WebDriver version mismatch issues for Google Chrome, here is the Troubleshooting Guide:

{% file src="/files/WAOLOLLi2yTAXwfcfk17" %}


# Supported Technologies

Avo Assure supports multiple technologies across APIs, desktop applications, web platforms, enterprise systems, databases, and mainframe environments. This article describes the supported technology categories and versions that Avo Assure can interact with during automated testing. Use this information to understand how Avo Assure fits into your technology environment and to identify the systems you can include in your automation strategy.

## API Testing

| Components            | Types / Formats                                                                                                                                                                                                                                                                 |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| APIs Standards        | <ul><li>REST</li><li>SOAP</li></ul>                                                                                                                                                                                                                                             |
| Message Format        | <ul><li>JSON</li><li>XML</li><li>Form-data</li><li>x-www-form-urlencoded</li></ul>                                                                                                                                                                                              |
| Import API Definition | <ul><li>Swagger or OpenAPI - Version 2.x and 3.x (supports JSON format)</li><li>WSDL</li></ul>                                                                                                                                                                                  |
| Authentication        | <ul><li>Basic Authentication</li><li>OAuth 2.0 - Scope - Client Credentials</li><li>Bearer Token</li><li>API Key (Supports JWT Token)</li></ul>                                                                                                                                 |
| Certificate           | <ul><li>Server Certificate</li><li><p>Client Certificate<br>Below are the file types:</p><ul><li>Java KeyStore (JKS)</li><li>Privacy Enhanced Mail (PEM)</li><li>Personal Information Exchange (PFX)</li><li>Public Key Cryptography Standards #12 (PKCS12)</li></ul></li></ul> |

## Desktop

| Category                            | Type                                          |
| ----------------------------------- | --------------------------------------------- |
| Windows Desktop Applications        | <p>Win32</p><p>WPF</p><p>VB.net</p><p>UWP</p> |
| Cross-Platform Desktop Applications | <p>Java Swing</p><p>Qt-based</p>              |

## SAP

| Application        | Interface Version | Platform |
| ------------------ | ----------------- | -------- |
| SAP HANA           | SAP 740 and above | GUI      |
| SAP ECC            | SAP 740 and above | GUI      |
| SAP Ariba          | -                 | Web      |
| SAP SuccessFactors | -                 | Web      |
| SAP Concur         | -                 | Web      |

{% hint style="info" %}
**Note**: Avo Assure also supports automation of other SaaS-based SAP applications.
{% endhint %}

## Oracle

| Application                     | Version |
| ------------------------------- | ------- |
| Oracle Fusion                   | -       |
| Oracle Fusion Application Suite | -       |

## Salesforce

Avo Assure supports all applications built on Salesforce, including Lightning objects.

## Mainframes

| Emulator       | Version |
| -------------- | ------- |
| Bluezone       | 7       |
| PCOMM          | 13      |
| RUMBA          | 9.5     |
| Host On-Demand | 11 & 12 |
| Mocha          | 3270    |

## Databases

### Relational Databases

| Relational Database | Database Number |
| ------------------- | --------------- |
| MSSQL               | 4               |
| Oracle              | 5               |
| PostgreSQL          | 14              |

### Non-Relational Databases

| Non-Relational Database | Database Number |
| ----------------------- | --------------- |
| MongoDB                 | 9               |


# Manage Users

The **Manage Users** help you manage project access and collaboration in Avo Assure. From this page, you can update project information, add or remove users from a project, and assign appropriate roles to control user permissions. This article explains how to edit the project name and description, manage users within a project, and modify user roles to ensure the right level of access for each collaborator.


# Editing Project Details

## Editing Project Name and Description

To edit the project name in Avo Assure, follow the steps below:

1. On **Home** page, from **Projects** list, select required project.
2. Click **Manage Users.** This will open **Manage Project** window.
3. Below the **Project Name** field, Click the **Edit Icon.**
4. Provide Logical name.
5. Click **Description** textbox and edit it.
6. Click **Update** to update the name and description.

## Managing the User Roles in Project

To Manage the users in Avo Assure, follow the steps below:

1. On the **Home** page, from **Project collaborators** tile, select **Manage Users**.
2. On **Manage Project** page, From **drop-down arrow**, select role.

**Note:** Users can access different features based on their assigned roles.

<img src="/files/HtXvDBzFJa8bQNEpF1Dc" alt="" data-size="original">

4. Click on **Update button**

**Note:** To change a user's role with Admin access, go to **Admin tab > User Management > User > edit icon > User details > Change role.**

## Managing Users in Project

To Manage the users in Avo Assure, follow the steps below:

1. On homepage, Go to **Project collaborators** section
2. Click **Manage Users.** This will open **Manage Project** window.
3. Select the **Checkbox** beside the users and click on **> icon.**
4. All **selected users** will be added to the project.
5. Click on **Update button.**

**Note:** To manage users with Admin access, go to **Admin tab > User Management > User > edit icon > User details > Change role.**


# Design Studio

Design Studio is intuitive, all-in-one workspace equipped with a robust **Element Repository, Test case, Execution** and **Report**s. This feature allows to capture, and store captured elements to use them when creating Test cases hence executing and debug them with ease. It also has reporting tool features for users to get detailed report of the execution to get valuable insights and enhance the overall design and testing process.

## **Viewing Design Studio**

To view the Design Studio, perform the following actions:

1. On the Avo Assure home page
2. Select **Design Studio** Button. The All options are available.

<figure><img src="/files/7fK5hfpp4LCPV8YSyN0y" alt=""><figcaption></figcaption></figure>

## Learn More About the Design Studio

<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><a href="/pages/at3jmGAsSlOqc5CBDdqj">/pages/at3jmGAsSlOqc5CBDdqj</a></td><td><a href="/files/197Fi6gNe7ZcF6w9jkGG">/files/197Fi6gNe7ZcF6w9jkGG</a></td></tr><tr><td><a href="/pages/HJFdg2YYWGmzXS0UMX4D">/pages/HJFdg2YYWGmzXS0UMX4D</a></td><td><a href="/files/197Fi6gNe7ZcF6w9jkGG">/files/197Fi6gNe7ZcF6w9jkGG</a></td></tr><tr><td><a href="/pages/Y4VmObnppDSIuFzng7Pt">/pages/Y4VmObnppDSIuFzng7Pt</a></td><td><a href="/files/197Fi6gNe7ZcF6w9jkGG">/files/197Fi6gNe7ZcF6w9jkGG</a></td></tr><tr><td><a href="/pages/h8y236sflEvgbpdQrHJr">/pages/h8y236sflEvgbpdQrHJr</a></td><td><a href="/files/197Fi6gNe7ZcF6w9jkGG">/files/197Fi6gNe7ZcF6w9jkGG</a></td></tr><tr><td><a href="/pages/DsZWQWaCU7uJ8PKsZRCS">/pages/DsZWQWaCU7uJ8PKsZRCS</a></td><td><a href="/files/H5LRvbYAlmzvacJwrh0B">/files/H5LRvbYAlmzvacJwrh0B</a></td></tr></tbody></table>


# Test Artifacts in Avo Assure

In Avo Assure, test artifacts refer to the various entities used while creating, managing, and executing automation assets. The test artifacts include **Element Repositories**, **Test Cases**, **Execution Lists, Data Tables**, **Reusable Libraries**, and **End-to-End Flows**. Each of these artifacts serves a different purpose in the automation process and supports specific functionalities within the application.

## Understanding Different Statuses of Test Artifacts

The test artifacts move through different states that represent their lifecycle during creation, review, and version control. These states help users easily understand the current stage of an artifact while working with the application.

The available states are:

* New
* In Progress
* Under Review
* Approved
* Rejected
* Checked In/Approved
* Checked In/In Progress
* Checked In/Under Review
* Checked In/Rejected

For example, when a test artifact is created, it starts in the **New** state. After editing begins, the state changes to **In Progress**. When the test artifact is submitted for review, it moves to the **Under Review** state. Based on the reviewer’s decision, the state changes to either **Approved** or **Rejected**. After the test artifact is pushed to Bitbucket, the state updates to **Checked In/Approved**.

## Understanding Status Icons

<table><thead><tr><th width="203.07403564453125">Icon</th><th>Status</th><th>Description</th></tr></thead><tbody><tr><td><img src="/files/HdYcyguXdqLS65zOsaOL" alt=""></td><td>New</td><td>This indicates that the test artifact is created and is not edited.</td></tr><tr><td><img src="/files/O6l6UMqEYNtMmiNSPp6T" alt="" data-size="original"></td><td>In Progress</td><td>This indicates the test artifact is in progress.</td></tr><tr><td><img src="/files/0MwRDFzUMliYbl8inXbq" alt=""></td><td>Under Review</td><td>This indicates that the test artifact is under review.</td></tr><tr><td><img src="/files/qN3u3iDAdIEjnZL9XoNG" alt=""></td><td>Approved</td><td>This indicates that the test artifact is approved by the reviewer.</td></tr><tr><td><img src="/files/Mj0ZYD4x6dUo5OZQTNEb" alt=""></td><td>Rejected</td><td>This indicates that the test artifact is rejected by the reviewer.</td></tr><tr><td><img src="/files/HtfbXLL6Gp7dmTdym0iP" alt=""></td><td>Checked In/ Approved</td><td>This indicates that the test artifact is approved and pushed to Bitbucket.</td></tr><tr><td><img src="/files/9Kd9zrsV0Q4L1yCE4fME" alt=""></td><td>Checked In/ In Progress</td><td>This indicates that the test artifact is in progress and pushed to Bitbucket.</td></tr><tr><td><img src="/files/fFWHgnEFzHvjqxIkx2Vn" alt=""></td><td>Checked In/ Under Review</td><td>This indicates that the test artifact is under review and pushed to Bitbucket.</td></tr><tr><td><img src="/files/oMdgN92LtEjEmg3ZulBF" alt=""></td><td>Checked In/ Rejected</td><td>This indicates that the test artifact is rejected and pushed to Bitbucket.</td></tr></tbody></table>

## Viewing Status Icons in Avo Assure

You can find the test artifacts status icons in the following areas of Avo Assure:

* **Avo Assure Modules**: Element Repository, Test Case, Execution, and Test Data Management

<figure><img src="/files/Ae0pAsNKz2gzmH6f4PJ4" alt="" width="563"><figcaption></figcaption></figure>

* **Folder Structure**: Element Repository, Test Case, Execution, and Test Data Management

<figure><img src="/files/GxXbFCjtZfyXz37C04vO" alt=""><figcaption></figcaption></figure>

* **Element Repository Details**

<figure><img src="/files/h8WTt6YNfQW4EZksVMuu" alt=""><figcaption></figcaption></figure>

* **Notifications**

<figure><img src="/files/FXxRnSZkfPt4BzyOB5gN" alt=""><figcaption></figcaption></figure>

* **Bitbucket Push Page**

<figure><img src="/files/d4nhkHsqWeEAXBajVqIo" alt=""><figcaption></figcaption></figure>

## Enabling Show Status

The Show status option is available as a toggle. Enabling this toggle displays the status of test artifacts in folder structure, allowing you to quickly understand the current state of a test artifact.

To enable the show status of the Test Artifacts, perform the following actions:

1. On the **Home** page, select **Design Studio**.
2. On the **Element Repository** page, enable **Show Status** toggle. The icons are displayed.

{% hint style="info" %}
**Note**:

* Use this step for all test artifacts, including **Test Case**, **Execution**, and **Test Data Management** modules.
* Icons are not shown for **New** and **In Progress** artifacts.
  {% endhint %}

<figure><img src="/files/IrQbZhWzi8xyCDj1BIiF" alt=""><figcaption></figcaption></figure>


# Element Repository

The **Element Repository** in Avo Assure is a centralized location for creating, capturing, storing, and managing User Interface (UI) elements used across your tests. You can capture an element once, save it to the repository, and reuse it across multiple test cases. This reduces duplication of effort, simplifies test maintenance, and promotes consistency when building and updating automated tests. This article explains how to create and manage Element Repositories and introduces the key features available.


# Creating Element Repository

To create an Element Repository, users must capture the elements. This can be done using two methods:

1. [Creating Element Repository Manually](/avo-assure/create-and-execute-tests-with-design-studio/working-with-element-repository-section/create-element-repository/creating-element-repository-manually)
2. [Capturing Element in Avo Assure](/avo-assure/create-and-execute-tests-with-design-studio/working-with-element-repository-section/create-element-repository/capturing-elements-in-avo-assure)


# Creating Web Element Repository

Web element capture identifies the User Interface (UI) components from the Application Under Test (AUT) and adds them to a web element repository. The captured elements help you interact with UI components during test creation and execution. This article describes how to capture the web elements using Avo Assure.

## Prerequisite

Ensure that the Avo Assure Client is connected.

## Capturing Web UI Elements

To capture web elements, perform the following actions:

1. On the **Home** page, under **Projects**, select the required Project.
2. ​Select **Design Studio**.
3. ​On the **Element Repository** page, select the **Create Folder (+)** icon.

![](/files/RZixA1eyiVLq9qzUtslC)

4. Select **Create main folder** to create a new element repository folder. A new folder appears.
5. In the **New Folder** text box, enter the element repository folder name.
6. In the newly created folder, select the Ellipsis (**...**) icon next to the repository name, and then select **Create Repository** > **Web** to create the element repository.
7. Select **Capture Elements**. The **Select Browser** dialog box opens.
8. Select the required browser, and then select **Capture**. The **Avo Assure Client – Capture** window opens.
9. In **Step 1: Enter URL** box, enter the URL of the AUT.

<img src="/files/YOAEIxtOsaRAIDBu3dO6" alt="" width="563">

10. Select **Navigate**. You are redirected to the specified URL.
11. In **Step 2: Capture Element**, select one of the following capture methods:
    * **Visible**: Captures visible elements in the AUT.
    * **All**: Captures all elements in the AUT for every Capture Type, including hidden elements.
    * **Manual**: Allows you to manually navigate to AUT and capture elements.
12. Depending on the selected capture method, perform one of the following actions:
    * **Visible** or **All**: From the **Capture Type** dropdown, select the element types to capture.
    * **Manual**: From the **Delay** dropdown, select a delay duration to capture the elements with longer loading time.
13. Select **Capture** to start the element capturing process.
14. Select **Add**. The selected elements are added to the element repository.

{% hint style="info" %}
**Note**:

* Select **Locate** to highlight the corresponding elements in the application UI.
* Select **Delete** to remove the selected elements from the capture list.
  {% endhint %}


# Creating Element Repository Manually

In many projects, the user interface (UI) is built in stages, and not all screens or components are available during early test design activities. To avoid delays, expected UI elements can be defined early by adding them manually to the element repository.

Use manual element creation when application elements are not yet available for capture or when you want to define element details before the user interface is ready. This feature lets you add expected application objects directly to the element repository so that test design and repository preparation can continue independently of application readiness. After the actual interface becomes available, you can update or map these manually created elements to capture application objects.

## Key Benefits

* Enables Shift-Left Testing
* Parallel Test Development
* Faster Go-to-Market
* Effortless Maintenance
* Higher Sprint Productivity
* TDD-Test Driven Development

## Creating Elements Manually

Creating elements manually helps to define expected UI components before the actual interface is available. This allows test design to continue in parallel with development, ensuring faster readiness when the interface becomes accessible.

To create an element manually, perform the following actions:

1. On the **Home** page, under **Projects**, select the required **Project**.
2. ​Select **Design Studio**.
3. On the **Element Repository** page, locate the **Create Folder** (**+**) icon.

<figure><img src="/files/RZixA1eyiVLq9qzUtslC" alt=""><figcaption></figcaption></figure>

4. Select **Create Folder** (**+**) icon, and then select **Create main folder** to create a new element repository folder. A new folder is created.

{% hint style="info" %}
**Note**: To create a new parent folder in the **Element Repository**, select the workspace (blank space), and select the **Create Folder** (**+**) icon.
{% endhint %}

<figure><img src="/files/Xe2alfxQvEAG1Zx955B1" alt=""><figcaption></figcaption></figure>

5. In the **New Folder** text box, enter the element repository folder name.
6. In the newly created folder, select the **Ellipsis** (**...**) icon next to the repository name, and then select **Create Repository** > **Web** to create the element repository.

{% hint style="info" %}
**Note**: You can manually create elements only for Web and Desktop applications in Avo Assure.
{% endhint %}

7. In the **New Repository** text box, enter the element repository name.
8. Select the **Create Manually** button to create elements manually. The **Create Element** dialog appears.

<figure><img src="/files/jAbQ7js6BiPgKzfdQaP5" alt=""><figcaption></figcaption></figure>

8. In the **Create Element** dialog, enter the **Element Name** that you want to capture from the application under test.
9. Select the **Element Type** from the dropdown list.

{% hint style="info" %}
**Note**: **Element Name** and **Select Element Type** are mandatory details. All other element attributes are optional and can be added as required.
{% endhint %}

10. Select **Submit** to create the elements.

{% hint style="info" %}
**Note**:

* A **Manual** label appears next to elements that you create manually.
* You can edit and delete the manually created elements using the edit and delete icons.
  {% endhint %}

## Mapping Elements Manually

Mapping aligns the manually defined element with the actual UI element, ensuring that Avo Assure can locate and interact with it correctly during automated tests. Use this feature to link the manually created elements with corresponding captured elements in the element repository.

To map a manually created element, perform the following actions:

1. On the **Element Repository** page, select **Tools**.

<figure><img src="/files/jOMUUDfPGxF5yu2At36s" alt=""><figcaption></figcaption></figure>

2. Select **Map Element**. The **Replace custom elements** dialog appears.
3. Under **Manually Created Elements**, select **Link** to expand the list of manually created elements.
4. Under **Captured Elements**, drag and drop the required captured element to the corresponding manually created element under **Link**.
5. Select **Submit** to save the mapping.

{% hint style="info" %}
**Note**:

* Mapping is supported only between elements of the same object type.
* Select **Show All Elements** to display all available captured elements.
* Select **Un-Link** to remove an existing mapping.
  {% endhint %}

<figure><img src="/files/yYBdmD59G31XQAPEZjsx" alt=""><figcaption></figcaption></figure>


# Creating API Repository

{% content-ref url="/pages/kbPFxW8jzVUa1IrN7qNQ" %}
[Creating New API Request](/avo-assure/avo-assure-supported-technologies-for-automation/api-automation/creating-apis-in-element-repository/creating-new-api-request)
{% endcontent-ref %}


# Capturing Elements in Avo Assure

Avo Assure enables users to capture applications built on different technologies like Web, SAP, and Desktop etc. This section explains how elements are captured within the created Repository.

{% hint style="info" %}
Telerik elements can also be identified and captured for all the application types.
{% endhint %}

### The section covers:

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="/pages/llzIhhJMgkaJzqVDdTQp">Web</a></td><td><a href="/files/oLxnjHMfChQ2Jg3OHGEA">/files/oLxnjHMfChQ2Jg3OHGEA</a></td></tr><tr><td><a href="/pages/MkQpnt3sCIFGwnc0ten4">SAP</a></td><td><a href="/files/oLxnjHMfChQ2Jg3OHGEA">/files/oLxnjHMfChQ2Jg3OHGEA</a></td></tr><tr><td><a href="/pages/JOE1xGrtJRrXRPVKZGY8">Desktop</a></td><td><a href="/files/oLxnjHMfChQ2Jg3OHGEA">/files/oLxnjHMfChQ2Jg3OHGEA</a></td></tr><tr><td><a href="/pages/p9afqIgOaQeRqqyj14rr">Mainframe</a></td><td><a href="/files/oLxnjHMfChQ2Jg3OHGEA">/files/oLxnjHMfChQ2Jg3OHGEA</a></td></tr></tbody></table>


# Capturing SAP Elements

SAP element capture identifies the User Interface (UI) components from the Application Under Test (AUT) and adds them to SAP element repository. The captured elements help you interact with UI components during SAP automation test cases. Use this article to understand how to capture SAP application elements and add them to an element repository in Avo Assure.

## Prerequisite

Ensure that the Avo Assure Client is connected.

## Capturing SAP Application Elements

To capture SAP elements, perform the following actions:

1. On the **Home** page, under **Projects**, select the required Project.
2. Select **Design Studio**.
3. On the **Element Repository** page, select the **Create Folder** (**+**) icon.
4. Select **Create main folder** to create a new element repository folder. A new folder appears.
5. In the **New Folder** text box, enter the element repository folder name.
6. In the newly created folder, select the Ellipsis (**...**) icon next to the repository name, and then select **Create Repository** > **SAP** to create the element repository.
7. Select **Capture Elements**. The **Avo Assure Client – Capture** window opens.
8. In **Step 1: Enter SAP Application Path** box, enter the SAP Application Path. The path must include the application path, server name, and window name.\
   **Example**:

```
C:\Program Files (x86)\SAP\FrontEnd\SapGui\saplogon.exe;SAP HANA;SAP Logon 760
```

In this example:

* **Application Path**: C:\Program Files (x86)\SAP\FrontEnd\SapGui\saplogon.exe
* **Server Name**: SAP HANA
* **Window Name**: SAP Logon 760

9. Select **Launch**. You are redirected to the application.
10. In **Step 2: Capture Element**, select one of the following capture methods:
    * **Actionable**: Captures only the interactive elements in the AUT. Hidden and non-interactive elements are not captured.
    * **All**: Captures all elements in the AUT for every Capture Type, including hidden elements.
    * **Manual**: Allows you to manually navigate to AUT and capture elements.
11. Depending on the selected capture method, perform one of the following actions:
    * **Actionable** or **All**: From the **Capture Type** dropdown, select the element types to capture.
    * **Manual**: From the **Delay** dropdown, select a delay duration to capture the elements with longer loading time.
12. Select **Capture** to start the element capturing process.
13. Select **Add**. The selected elements are added to the element repository.

{% hint style="info" %}
**Note**:

* Select **Locate** to highlight the corresponding elements in the application UI.
* Select **Delete** to remove the selected elements from the capture list.
  {% endhint %}


# Capturing Desktop Elements

Capturing desktop elements allows you to identify and store UI elements from desktop applications in the Element Repository. These elements are used while designing and executing automated test scenarios in Avo Assure. This topic describes how to capture the desktop elements using the Avo Assure Client.

## Prerequisites

* Ensure that the target desktop application is installed on your system.
* Ensure that the Avo Assure Client is connected.

## Capturing Elements from Desktop Applications

To capture desktop elements, perform the following actions:

1. ​On the **Home** page, under **Projects**, select the required Project.
2. ​Select **Design Studio**.
3. On the **Element Repository** page, select the **Create Folder** (**+**) icon.

<img src="/files/RZixA1eyiVLq9qzUtslC" alt="" height="210" width="624">

4. Select **Create main folder** to create a new element repository folder. A new folder appears.
5. In the **New Folder** text box, enter the element repository folder name.
6. In the newly created folder, select the Ellipsis (**...**) icon next to the folder name, and then select **Create Repository** > **Desktop**. The desktop element repository is created.
7. Select **Capture Elements**. The **Avo Assure Client – Capture** window opens.
8. In **Step 1: Enter Window Name/Process ID** box, enter the window name or process ID of the desktop application.

<img src="/files/GhX1IJZqhMk3DcPR4YdU" alt="" height="330" width="520">

9. Select **Launch**. The specified desktop application is launched.
10. In **Step 2: Capture Element**, select an element capture method.\
    The following capture methods are available:

| Capture Method | Description                                                             |
| -------------- | ----------------------------------------------------------------------- |
| Visible        | Captures visible elements in the AUT.                                   |
| <p><br></p>    |                                                                         |
| All            |                                                                         |
| <p><br></p>    | Captures all elements in the AUT, including hidden elements.            |
| Manual         |                                                                         |
| <p><br></p>    | Allows you to manually navigate to AUT and capture elements.            |
| IRIS           | Captures elements based on screen coordinates and positions in the AUT. |

<details>

<summary><strong>Configuring Capture Settings</strong></summary>

* **Capture Type**: Select the specific element types to capture.
* **Method**:
  * **UI/UIA**: Use for modern applications that support Microsoft UI Automation. This method identifies elements with standard UI structures.\
    **Note**: Use the UI method by default. If it does not work, use UIA.
  * **Win32**: Use for legacy applications that do not fully support UI Automation. This method uses Windows API-based identification.
* **Option**: Select the type of capture option.

</details>

11. Select **Capture** to start the element capturing process.
12. Select **Add**. The selected elements are added to the element repository.

{% hint style="info" %}
**Note**:

* Select **Locate** to highlight the corresponding elements in the application UI.
* Select **Delete** to remove the selected elements from the capture list.
  {% endhint %}


# Finding Process Name or Process ID

When the window name of an application is not available, you can use the Process ID (PID) or Process Name to uniquely identify and target the correct running instance. Providing the PID or process name ensures that Capture targets the correct running application instance for automation. This article describes how to locate the PID or Process Name and use it in Avo Assure Capture to launch the desired application.

## Finding a Process Name or Process ID

To find a Process Name or PID, perform the following actions:

1. Right-click the taskbar, and then select **Task Manager**.
2. Select the **Details** tab.
3. Locate the application process you want to capture.

{% hint style="info" %}
**Note**: You can use the search box in **Task Manager** to quickly find the required application.
{% endhint %}

<figure><img src="/files/T8GimDQhNOWX4jCuiJ6N" alt=""><figcaption></figcaption></figure>

4. Note the **Name** or **PID** value for the application.
5. In the **Avo Assure Capture** window, enter the PID or process name into the **Enter Window Name/Process ID/Process Name** box.
6. Select **Launch** to open the specified application.


# Mainframe

{% content-ref url="/pages/brfurWkMP7oFKuUrrwEH" %}
[Mainframe Automation](/avo-assure/avo-assure-supported-technologies-for-automation/mainframe-automation)
{% endcontent-ref %}


# Manage Element Repository

This section provides details on managing, viewing, exporting, and working with elements.

### This section includes

* [**Operations in Element Repository**](broken://pages/EMmRC8WMhs0bbtMNtrhO)
* [**Operations on element(s)**](broken://pages/9JFnd18CfTudtuWcTd5C)
* [**Reordering Element Identifiers**](/avo-assure/create-and-execute-tests-with-design-studio/working-with-element-repository-section/features-in-element-repository/element-identifier-order/reorder-element-and-element-properties-in-repository)


# Searching Folders, Repositories, and Elements

## Searching Folders and Repositories

The **Search Folders / Repositories** feature allow you to search the created folders and repositories.

To search folders and repositories, perform the following actions:

1. On the **Home page**, select **Design Studio**.
2. Select **Element Repository** tab.
3. On the left pane, locate the **Search Folders / Repositories** search box.
4. Enter any keyword in the search box. The matching folders and repositories are highlighted.

<figure><img src="/files/fcDmlviT59GkE8aXqNlM" alt=""><figcaption></figcaption></figure>

## Searching Elements

The **Search Element** feature allows you to search the elements present in the Element Repository.

To search elements, perform the following actions:

1. On the **Home page**, select **Design Studio**.
2. Select **Element Repository** tab.
3. On the left pane, locate the **Folder** and **Repository** for which you want to view the elements.
4. Select the repository to open and view the elements.
5. Locate the **Search Element** search box.
6. Enter any keyword in the search box. The matching elements are highlighted.

<figure><img src="/files/CSTCnulpZmylEu82seLq" alt=""><figcaption></figcaption></figure>


# Operations on Element Repository and Elements

The Element Repository stores captured UI elements that are used during test creation and execution. This page describes how to manage repositories and captured elements, including renaming, copying, deleting, editing, and moving elements within the repository.

This section describes the following operations available in the Element Repository:

* **Operations on Element Repository**
* **Operations on Elements**

## **Operations on Element Repository**

Avo Assure provides options to manage repositories and folder. The following operations helps you to manage and organize the Element Repository efficiently.

<details>

<summary><strong>Rename Element Repository</strong></summary>

To rename an Element Repository, perform the following actions:

1. On the **Element Repository** page, select the required repository folder.

{% hint style="info" %}
**Note**: To know more about how to create Element Repository, [click here](/avo-assure/create-and-execute-tests-with-design-studio/working-with-element-repository-section/create-element-repository/creating-element-repository-manually#creating-elements-manually).
{% endhint %}

2. Select the **Ellipsis** (**...**) icon next to the repository name.
3. Select **Rename** from the dropdown list.
4. Enter a logical name for the folder.

{% hint style="info" %}
**Note**: You can also rename the sub-folder created under the repository.
{% endhint %}

![](/files/ENbTHL8EVZtQKUr8RK0P)

</details>

<details>

<summary><strong>Copy Element Repository</strong></summary>

To copy an Element Repository, perform the following actions:

1. Select the **Ellipsis** (**...**) icon next to the repository folder.
2. Select **Copy** from dropdown list.

{% hint style="info" %}
**Note**: You can also copy the repository using the **Shift + C** keyboard shortcut.
{% endhint %}

![](/files/ImEasrwitnIZ7AJ4Awe6)

</details>

<details>

<summary><strong>Paste Repository</strong></summary>

To paste a repository, perform the following actions:

1. On the **Element Repository** page, go to the folder where you want to paste the repository.
2. Select the **Ellipsis** (**...**) icon next to the folder name.
3. Select **Paste** from the list.
4. The system pastes the copied repository into the selected folder.

</details>

<details>

<summary><strong>Delete Element Repository</strong></summary>

To delete an Element Repository, perform the following actions:

1. On the **Element Repository** page, select the required repository folder.
2. Select the **Ellipsis** (**...**) icon next to the repository name.
3. Select **Delete** from the dropdown list. The **Safet to Delete** dialog box opens.

![](/files/22cdy85DTi3cKsYyOQmo)

4. Select **Yes** to confirm the deletion in the confirmation dialog.

{% hint style="info" %}
**Note**: You cannot delete a repository if it is used in any **Test case** or **Test Step Group**. Remove those elements from the listed Test cases before deleting it.
{% endhint %}

![](/files/roL63FYiW7XbfN9QZFx2)

</details>

<details>

<summary><strong>Assign Repository</strong></summary>

To assign a repository, perform the following actions:

1. On the **Element Repository** page, locate the required repository folder.
2. Select the **Ellipsis** (**...**) icon next to the repository name.
3. Select **Assign Repository** from the list. The **Assign Elements in Repository** dialog box opens.

![](/files/HDJJxqbhLrokIGP0Zo4Q)

4. Select the required user from the list.
5. Select **Assign** to assign repository to the selected user.

{% hint style="info" %}
**Note**: Only users with the **Quality Manager** or **Quality Lead** role can assign a repository to the user.
{% endhint %}

![](/files/X2IXpPFcnt5RbyEjkSnU)

</details>

<details>

<summary><strong>Make a Root Folder</strong></summary>

To make a sub-folder a root folder, perform the following actions:

1. On the **Element Repository** page, locate the required sub-folder.
2. Select the **Ellipsis** (**...**) icon next to the sub-folder name.
3. Select **Make a Root Folder** from the list. The **Confirmation** dialog box opens.

![](/files/klwVFB5QB7qHuGopfNBV)

4. Select **Yes**.

![](/files/aq25ycnTtOvryZSrDI7x)

5. The system moves the selected sub-folder to the root level of the Element Repository.

{% hint style="info" %}
**Note**: This option is available only for sub-folders.
{% endhint %}

![](/files/jLKZhj9Dyod3mlfUGpoO)

</details>

<details>

<summary><strong>Version History</strong></summary>

To view the version history, perform the following actions:

1. On the **Element Repository** page, locate the required repository.
2. Select the **Ellipsis** (**...**) icon next to the repository name.
3. Select **Version History** from the list.
4. The system displays the list of previous versions of the repository.

{% hint style="info" %}
**Note:** Version history lists are available only when version control (for example, **Bitbucket**, **Git** or **Assure DevOps**) is configured and changes are pushed to the repository.
{% endhint %}

</details>

<details>

<summary><strong>Send For Review</strong></summary>

To send a repository for review, perform the following actions:

1. On the **Element Repository** page, locate the required repository.
2. Select the **Ellipsis** (**...**) icon next to the repository name.
3. Select **Send for Review** from the list.
4. The system sends the repository for review.

{% hint style="info" %}
**Note:** Only users with the **Quality Manager** or **Quality Lead** role can send a repository for review.
{% endhint %}

</details>

## **Operations on Elements**

Avo Assure provides options to manage elements in repository. The following operations helps you to manage and organize the Element Repository efficiently.

<details>

<summary><strong>Rename Element</strong></summary>

To rename a captured element, perform the following actions:

1. On the **Element Repository** page, select the required repository.
2. Double-click on the name of the captured element.
3. Enter a logical name for the element.

</details>

<details>

<summary><strong>Delete Element</strong></summary>

To delete an element, perform the following actions:

1. On the **Element Repository** page, select the required repository.
2. In the **Element List**, select the element that you want to delete.
3. Select the **Delete** icon and then confirm the deletion in the confirmation dialog.

{% hint style="info" %}
**Note**:

* You can delete elements individually or delete multiple elements at once.
* You cannot delete an element if it is used in any Test case or Test Step Group. Remove the element from the listed test cases before deleting it.
  {% endhint %}

</details>

<details>

<summary><strong>Cut and Paste Elements</strong></summary>

To cut and paste elements, perform the following actions:

1. On the **Element Repository** page, open the required repository.
2. Select the element that you want to move.
3. Select the **Cut** icon at the top.
4. Navigate to the destination repository.
5. Select the **Paste** icon to add the element.
6. Select **Save** to save the changes.

{% hint style="info" %}
**Note**: You can move captured elements from one repository to another using the **Cut** and **Paste** options.
{% endhint %}

</details>

<details>

<summary><strong>Edit Element Properties</strong></summary>

To edit element properties, perform the following actions:

1. On the **Element Repository** page, select the required repository.
2. Select the element that you want to edit.
3. Hover over the empty column next to the element and select the **Edit** icon. The **Details** pane opens.
4. Modify the required property values.
5. Select **Save Properties** to save the changes.

{% hint style="info" %}
**Note:** You can also drag and drop properties to change their priority.
{% endhint %}

</details>

<details>

<summary><strong>View Test Cases for an Element</strong></summary>

To view the test cases for an element, perform the following actions:

1. On the **Element Repository** page, navigate to the required repository.
2. Locate the element for which you want to view the test case usage.
3. Select the **View Test Cases** icon next to the element.
4. The system displays the list of test cases where the selected element is used.

{% hint style="info" %}
**Note**: You can view the Test cases in which a specific element is used. This helps you identify where the element is referenced in your Test cases.
{% endhint %}

</details>


# Expanding and Collapsing Element Repository Folders

To expand and collapse the folders, perform the following actions:

1. On **Home** page, from **Projects** list, select required project.
2. Select **Design Studio**.
3. On **Element Repository** page, select expand (**>**). All the sub folders and element repositories display.

<figure><img src="/files/ChImgFg5unqfUj2oThXd" alt=""><figcaption></figcaption></figure>

4. Select collapse. All the sub folders and element repositories collapse.

<figure><img src="/files/8QWRV5HrOnvnbIv7RBya" alt=""><figcaption></figcaption></figure>


# Viewing Screenshot in Element Repository

The View screenshot feature allows users to highlight the elements captured from the application under test (AUT).

To view screenshot of the elements, perform the following actions:

1. On the **Home** page, from **Projects** list, select required project.
2. Select **Design Studio**.
3. On the **Element Repository** page, select folder and element repository.
4. From **Screenshots** column, select **View Screenshot** to view screenshot of that element.

<figure><img src="/files/dm3321g6UL82NmFnsjB9" alt=""><figcaption></figcaption></figure>

5. Select **View Screenshot** to view the screenshot of the element.

<figure><img src="/files/KScfB0gCRWwYApAieFwQ" alt=""><figcaption></figcaption></figure>


# Features in Element Repository

The element repository provides a set of features that help you efficiently manage, maintain, and reuse application elements for test automation. These features simplify repository management, improve element identification, and enhance test execution reliability. This article explains how to import and export Element Repositories, view Element Repository details and audit logs, configure the element identifier order, and use the self healing feature to handle application changes effectively.


# Element Identifier Order

**Element identifiers** are the attributes that Avo Assure uses to locate UI elements during test execution. Since an element can have multiple identifiers, you can configure their priority by defining the **Element Identifier Order**. Using an appropriate identifier order improves element recognition, enhances execution reliability, and helps reduce failures caused by changes in the application. This section introduces the available element identifiers, explains their purpose, and describes how to configure their order for individual elements or across an entire Element Repository. This article explains what element identifiers is and how reorder identifier priority using available options in the Element Repository.

* [Understanding Element Identifier and Attributes](/avo-assure/create-and-execute-tests-with-design-studio/working-with-element-repository-section/features-in-element-repository/element-identifier-order/understanding-element-identifier-and-attributes)
* [Reordering Element Identifiers](/avo-assure/create-and-execute-tests-with-design-studio/working-with-element-repository-section/features-in-element-repository/element-identifier-order/reorder-element-and-element-properties-in-repository)


# Understanding Element Identifier and Attributes

Every User Interface element has one or more attributes, such as ID, Name, or XPath, that help identify it. In Avo Assure, these attributes are stored as element identifiers and used to locate the element during test execution. You can configure the Element Identifier Order to define the [priority](/avo-assure/create-and-execute-tests-with-design-studio/working-with-element-repository-section/features-in-element-repository/element-identifier-order/reorder-element-and-element-properties-in-repository) in which these identifiers are used, improving element recognition and execution reliability.

## Element Identifiers for Web Application

For web application automation, Avo Assure supports the following element identifiers to locate and interact with UI elements during test execution.

* **CSS Selector**: Identifies an element using CSS selector syntax based on its attributes or hierarchy.
* **ID Attribute**: Identifies an element using its unique ID attribute.
* **Absolute X-Path**: Locates an element using its complete path from the root of the Document Object Model.
* **Relative X-Path**: Locates an element using a flexible path relative to other elements in the Document Object Model.
* **Name Attribute**: Identifies an element using its name attribute.
* **Classname Attribute**: Identifies an element using its class attribute.
* **Href Attribute**: Identifies a hyperlink using its href (destination URL) attribute.
* **Label**: Identifies an element using its associated label or displayed text.
* **Custom 1** and **Custom 2**: Identifies an element using user-defined custom attributes for specific application requirements.

## Element Identifiers for Desktop Application

For desktop application automation, Avo Assure identifies elements using a combination of properties to ensure reliable element recognition. The desktop-specific properties map to the element identifiers as follows:

* **Class Name → Absolute XPath**: Identifies an element based on its underlying control class in the desktop application.
* **Control Type → Relative XPath**: Identifies an element by its control type, such as Button, Text Box, or Check Box.
* **Automation ID → ID Attribute**: Identifies an element using its unique automation identifier assigned by the application.
* **Control Name → Name Attribute**: Identifies an element using its displayed or assigned control name.

{% hint style="info" %}
**Note:** **Control Type** typically remains constant. For reliable element identification, Avo Assure requires at least two additional properties that are unique and stable, such as **Automation ID**, **Control Name**, or **Class Name**. This combination helps accurately locate elements during test execution.
{% endhint %}

## Element Identifiers for SAP Application

For SAP application automation, Avo Assure uses the following SAP-specific attributes to identify and locate elements during test execution. These attributes capture the element's hierarchy and position within the SAP user interface, enabling accurate element recognition.

* **Absolute X-path**: Identifies an SAP element using its complete path within the SAP UI hierarchy.
* **Top**: Specifies the vertical position of the element relative to the top of its parent window or container.
* **Left**: Specifies the horizontal position of the element relative to the left side of its parent window or container.
* **Width**: Specifies the width of the element in pixels.
* **Height**: Specifies the height of the element in pixels.

{% hint style="info" %}
**Note**: **Mainframe** and **APIs** applications do not use element identifiers. Therefore, the Element Identifier Order feature is not applicable to these application types.
{% endhint %}


# Custom Property

### Overview

Avo Assure supports automation for web applications by using built-in properties to identify on-screen elements. In addition to the eight default properties (e.g., Id, Attribute Name, Class Attribute), two extra fields- Custom 1 and Custom 2 are available for added flexibility.

These fields are useful when the application uses unique attributes (e.g., data-testid, maxlength) that are not part of the standard set, enabling more reliable element identification even when default properties vary.

{% hint style="warning" %}
***Note:** Custom 1 and Custom 2 only work for **web applications.***
{% endhint %}

### Custom 1 – Standard Unique Identifier Property

**Custom 1** allows users to define a **unique element property** that is consistently used across the application. This is particularly useful when developers implement a unique attribute (e.g., data-testid, custom-id, etc.) throughout the application to help with element identification.

* This custom property acts as a replacement or extension of the default properties.
* It ensures that the automation scripts remain robust and maintainable by relying on a developer-defined, consistent element identifier.

### Custom 2 – Manual Unique Identifier

**Custom 2** gives users the **flexibility to manually assign** a unique or alternate identifier for an element.

* This can be helpful in scenarios where the standard properties and *Custom 1* do not provide sufficient identification.
* Users can input any attribute or identifier that reliably distinguishes the element in the current context.

**Manual Attribute Update Syntax**

When updating a custom attribute manually in the **Custom Property** settings page, please use the following syntax format:

`tagname[attributename="attributevalue"]`


# Configure Custom Property

### Ways to build Custom Property

**A.** Custom 1

**B.** Custom 2

#### **A. Steps to Configure Custom 1 Property form Avo Assure Client**

1. Launch the **Avo Assure Client.**
2. Navigate to the **Configuration** tab.
3. Select **Settings** option.
4. Enter **Element Property** in the **Custom Property** field.

{% hint style="info" %}
**Note:** Enter the unique property of the Element (e.g., data-testid, data-val-required, custom-id).
{% endhint %}

<figure><img src="/files/UpcYL98MlBtMoGb1TjhZ" alt="" width="563"><figcaption></figcaption></figure>

{% hint style="warning" %}
***Note:** When a custom property is defined in the Avo Assure Client settings, it is automatically captured during element identification—**provided the element contains that property**. Additionally, the captured custom property is placed **at the top of the priority list** for element identification.*
{% endhint %}

This tells Avo Assure to use this custom property during execution if the usual properties (like id or class) don’t work.

**B. Steps to Configure Custom 2 Property from Element Repository**

1. Navigate to the **Element Repository** tab.
2. Select the required element from the repository and click **Edit** icon. The **Details** panel will appear on the right side of the screen.

<figure><img src="/files/KCr4nxpIpPAxrg3MZGoc" alt=""><figcaption></figcaption></figure>

5. In the **Custom 2 Value** field, enter the unique property of the Element (e.g., data-testid, data-val-required, custom-id).
6. Click **Save properties** button to apply and save the changes.

<figure><img src="/files/1TUKz6MnsmlR1TedWozn" alt=""><figcaption></figcaption></figure>

### How to Use Custom Property with Self-Healing

Avo Assure also supports Self-Healing, which means it can update element properties automatically when something changes in the application. You can use Custom 1 in this self-healing process after doing a simple setup in the Avo Assure Client.

### How It Works During Execution

**Once you’ve added the custom property in Avo Assure Client settings, follow the steps below to use it during self-healing**:

1. Select the element that is not working during execution.
2. Choose both options:

* Adjust the broken element’s attributes
* Preserve the properties of reprioritized items for subsequent execution

**What will happen next**

* Avo Assure automatically maps Custom 1 to the previously entered property.
* If an element cannot be located using the default properties, the tool falls back on the custom property for identification.
* This ensures consistent identification of the same element across test executions.
* The test case proceeds without interruption, eliminating the need for manual intervention.

{% hint style="warning" %}
***Note:** Make sure the custom property you entered (e.g., data-val-requiredor, maxlength) is used throughout the application by your development team.*
{% endhint %}

#### **Example 1: Configure and Use Custom 1 Property**

**Scenario:**

In an application, elements are uniquely identified using the attribute **data-testid**, which is not part of the default properties captured by Avo Assure.

**Input:**

* Property Name to be configured: **data-testid**
* Element captured from the application using Avo Assure Client.

**Expected Result:**

The **data-testid** property is captured as **Custom 1** in the Element Repository and used during execution if default properties fail.

**Output:**

During execution, if the element is not found using **id, name,** or **class**, Avo Assure automatically uses the **data-testid** property defined in Custom 1 to identify the element and continue execution without failure.

#### **Example 2: Configure and Use Custom 2 Property**

**Scenario:**

An element in the application has a unique property **data-val-required.** The default attributes like `id` or **class** are dynamic and unreliable. The tester manually sets **data-val-required** as Custom 2 in the Element Repository.

**Input:**

* Property set in Custom 2: **data-val-required**
* All other attribute values set to **None** in the Element Repository.

**Expected Result:**

Custom 2 is used as the primary identifier to locate the element during execution.

**Output:**

Avo Assure identifies the element using the **data-val-required** value set in Custom 2 and executes the test steps successfully.


# Reordering Element Identifiers

Element identifiers help Avo Assure locate UI elements during test execution. Setting the correct identifier order improves element recognition and increases execution reliability. This article explains how to reorder identifier priority using available options in the Element Repository.

## Reordering Element Identifiers for Multiple Elements

To reorder the multiple elements, perform the following actions:

1. On the **Home** page, under **Projects**, select the required project.
2. Select **Design Studio**.
3. On the **Element Repository** page, select the required element repository for which you want to reorder the elements.
4. From **Elements List**, select the checkbox next to the required elements.
5. In the toolbar, select **Element Identifier Order**. A dialog box appears.

![](/files/upWcdPYqfaZ5SBGfQc9O)

6. Using the drag handle (**⠿**) on the left of each row, drag and drop the identifiers to reorder them according to the required priority sequence.
7. Select **Save**.

{% hint style="info" %}
**Note**:

* If you have reordered the element identifiers, you can view reordered elements only in the **Details** dialog.
* Reordering the **Element Identifier Order** applies the new order to all elements in the Element Repository.
  {% endhint %}

## Reordering Element Identifiers for Individual Element

To reorder an individual element, perform the following actions:

1. On the **Home** page, under **Projects**, select the required project.
2. Select **Design Studio**.
3. On the **Element Repository** page, select the required element repository for which you want to reorder the elements.
4. In the **Elements List**, hover over the required element and select the **Edit** icon. The **Details** pane opens on the right.

![](/files/VtGeDyLXOpdOPEeUzXLA)

5. Using the drag handle (**⠿**) on the left of each row, drag and drop the attribute rows to reorder them according to the required priority sequence.

![](/files/QxXbFg6qiE69l3UpruA9)

5. Select **Save** Properties.


# Element Repository Details and Audit Logs

The Element Repository Details provides information about an Element Repository and helps you track changes made to it over time. You can view key details such as the repository name, description, status, creation date and time, and the user who created it. You can also review audit logs to monitor changes made to the Element Repository and its elements. This section explains how to view Element Repository details and access its audit logs.


# Viewing Element Repository Details

To view the element repository **Details**, perform the following actions:

1. On the **Home** page, from **Projects** list, select the required project.
2. Select **Design Studio**.
3. On the **Element Repository** page, expand the required folder and select the element repository for which you want to see the details.
4. Select the **Open information** (**i**) icon. The **Details** tab opens.

<figure><img src="/files/SpXqGiZ74rOEOLQ4exel" alt=""><figcaption></figcaption></figure>

5. In the **Details** tab, you can view the following information:

* **Element Name**: The element repository name.
* **Description**: The element repository description.
* **Status**: The element repository status (New, In Progress, Under Review, Approved or Rejected).
* **Created On**: The element repository creation date and time.
* **Created By**: The username of the person who created the element repository.

<figure><img src="/files/G0253anWBWYMsjc3qfm7" alt=""><figcaption></figcaption></figure>


# Viewing Element Repository Audit Logs

## Viewing Element Repository Audit Logs

To view the Element Repository **Audit Logs**, perform the following actions:

1. On the **Home** page, from **Projects** list, select the required project.
2. Select **Design Studio**.
3. On the **Element Repository** page, expand required folder and select the element repository for which you want to see the Audit Logs.
4. Select the **Open information** (**i**) icon. The **Details** tab opens.

<figure><img src="/files/N6qrdj667vRAV69g4AVn" alt=""><figcaption></figcaption></figure>

5. Select the **Audit Logs** tab.

<figure><img src="/files/rl8qWwUejGzz6xUzq3cK" alt=""><figcaption></figcaption></figure>

6. Select **Date Range** to view the actions performed between the specified dates.

<figure><img src="/files/yBDPygcb3rumHa7J5fjO" alt=""><figcaption></figcaption></figure>

7. Expand the month to view the actions performed in the element repository.

<figure><img src="/files/WnQUtgrGJNdNNfiESzre" alt=""><figcaption></figcaption></figure>

### Audit Log Inclusions

The following actions are captured in the element repository audit logs:

* Creating an Element Repository
* Renaming the Element Repository
* Adding or Removing Self Heal Configurations
* Assigning Element Repository
* Requesting Review and the Status of Review
* Creating or Capturing Elements
* Mapping Elements
* Renaming Elements
* Deleting Elements
* Importing Elements
* Modifying Element Properties
* Copying and Pasting Elements

### Audit Log Exclusions

The following actions are currently not captured in the element repository audit logs:

* Creating or Moving Folders within Element Repository
* Deleting Repository
* Exporting Elements
* Reordering via Element Identifier
* Comparing Elements
* Replacing Elements
* Cutting Elements


# Self Heal

Self Healing improves the reliability of test execution by automatically identifying alternative matching elements when the originally captured element cannot be located. This helps reduce test failures caused by changes in the application under test (AUT) and minimizes script maintenance. This article explains the Self Healing feature, how it works, and how to enable and apply it during test execution.


# Understanding Self Healing

Avo Assure's next-generation Self Heal uses AI-based heuristic matching to capture contextual fingerprints and understand the UI during test execution and intelligently identify elements on the screen. Unlike traditional approaches that depend on locator-based identification captured during script creation, it can seamlessly adapt to many UI changes without requiring updates to the test script.

This advanced self healing capability goes beyond simply switching to alternative element properties or locator strategies. By leveraging the contextual fingerprints of UI elements, it helps recover from UI changes more effectively, reducing test maintenance effort, improving automation stability, and enabling faster release cycles.

### Prerequisites (For scripts built before Avo Assure v26.4.2)

Following are the prerequisites to perform self healing:

* For existing elements, test cases must consistently pass.
* For each element, at least one locator (preferably P1) should accurately identify the correct element.

### Scope

* Currently, it works only via Execution lists (not in debug) and runs in the background with no UI changes in Avo Assure.
* Only Web applications are supported.

### Self Healing Recovery Scenarios Inclusions

Following UI changes are handled when self heal is enabled:

* Element ID
* Name attribute
* Class name
* CSS selector
* in XPath
* Relative XPath
* Layout
* Element relocation within a page
* Iframe and nested Iframe elements

{% hint style="info" %}
**Note:** Any scenario outside this scope is not supported currently.
{% endhint %}


# Applying Self Healing

To apply self healing, perform the following actions:

1. On the **Home** page, from **Projects** list, select required project.
2. Select **Design Studio**.
3. In the **Element Repository** page, select the required element repository for which you want to apply self healing.
4. Select **Tools** > **Self Heal**. The **Self Heal** dialog opens.

<img src="/files/18gn2vyxRfu7GsmCDq9I" alt="" height="306" width="686">

3. In the **Self Heal** dialog, choose one of the following options:
   1. **Enable Self Heal**
      1. Select **Adjust the broken elements attributes** to update the attributes of elements that were not detected during execution.
      2. Select **Preserve the properties of reprioritized items** for subsequent execution to prioritize the most stable properties for future runs.
   2. **Disable Self Heal**
      1. Select this option to disable self heal.
4. Select one of the following actions:
   1. **Apply for all repositories** to apply the selected option across all repositories.
   2. **Apply to current repository** to apply the selected option only to the current repository.

{% hint style="info" %}
**Note**: Select **Cancel** to close the dialog without making changes.
{% endhint %}

5. After you apply self healing to the repositories, the **Self Heal** icon appears.

<figure><img src="/files/VJ9PgAQ3yG4704DKDer0" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Note**:

* Self-healing is only applicable to elements captured through the Avo Assure Client. It does not work for manually created elements.
* Successful element recovery in Self Heal does not necessarily update the visible properties in the Element Repository. This is expected behaviour, as self healing relies on more than just the displayed locators to identify elements.
  {% endhint %}


# Import and Export

The **Import and Export** feature helps you move Element Repositories between projects or environments, making it easier to reuse and share repository data. You can import an existing Element Repository into a project or export a repository for backup, migration, or collaboration. This article explains how to import and export Element Repositories in Avo Assure.


# Importing Element Repository

The Import Elements function allows you to retrieve elements from the local machine and store them in a project which can be reused, serving as a backup for future reference.

To import element repository, perform the following actions:

1. On the **Home** page, from **Projects** list, select required project.
2. Select **Design Studio**.
3. From folder, select ellipses (**...**) icon.
4. Select **Create Repository**.
5. Select technology and rename the Element Repository.
6. Select **Import Element Repository** icon. The **Import** dialog open.

{% hint style="info" %}
**Note:** Importing elements into an existing Element Repository replaces the previously available elements with the newly imported elements.
{% endhint %}

7. On the **Import** dialog, select **Choose file** and then choose .json file from your system.

{% hint style="info" %}
**Note:** Import elements using the `.json` file format.
{% endhint %}

8. Select **Import** to import element repository.


# Exporting Element Repository

The Export Elements function is used to retrieve elements from the element repository and save them to a local machine or directly export them into a new project for future reference or backup.

To export Element Repository, perform the following actions:

1. On the **Home** page, from **Projects** list, select required project.
2. Select **Design Studio**.
3. Expand folder and select required element repository to export.
4. Select **Export Element Repository** icon. The **Export** dialog opens.
5. On **Export** dialog, select **Export** button.
6. You can find exported file in your **Downloads** folder.


# Test Case

The **Test Case** section contains a collection of Test Cases used to validate application features and functionalities. Each Test Case includes one or more **Test Step Groups**, which consist of Test Steps that help verify the correct and smooth operation of a feature or program.


# Creating Test Case

To create a new Test Case in Avo Assure, perform the following actions:

1. On the **Home** page, under **Projects**, select the required Project.
2. Select **Design Studio**. Select the **Test Case** tab, locate the **Create Folder** (**+**) icon.
3. Select **Create Folder** (**+**) icon and select **Create main folder** to create a new folder for Test case. A new folder is created.

<figure><img src="/files/FRYIcAleCVzF3uK4nN8A" alt=""><figcaption></figcaption></figure>

4. In the **New Folder** text box, enter the Test case folder name.
5. In the newly created folder, select **Ellipsis** (**...**) icon > **Create Test case** > to create the Test case.

<figure><img src="/files/14eyhdFuDwWkjpBDXoEj" alt=""><figcaption></figcaption></figure>

6. In the **New Test case** text box, enter the Test case name.

<figure><img src="/files/VbQ596zraqDoXOn3UrBX" alt=""><figcaption></figcaption></figure>

7. Select **Create Test Step Group** and then choose one of the available methods to create the Test Steps.
   * [Adding New Test Step Group](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/create-test-case/create-test-step-group/add-new-test-steps-group)
   * [Add Test Step Group from Reusable Library](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/create-test-case/create-test-step-group/add-test-steps-group-from-reusable-library)
   * [Record Test Step Group Using Avo Genius](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/create-test-case/create-test-step-group/record-test-step-group-using-avo-genius)
8. Select **Save** to save the Test Steps.


# Creating Test Step Group

You can create a Test Step Group using any of the following methods:

* [**Adding New Test Step Group**](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/create-test-case/create-test-step-group/add-new-test-steps-group)
  * Use this option to manually create a new Test Step Group from scratch.
  * You can add individual Test Steps.
  * Once completed, the Test Step Group can be saved and used within Test Cases.
* [**Adding Test Step Group from Reusable Library**](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/create-test-case/create-test-step-group/add-test-steps-group-from-reusable-library)
  * This option allows you to add an existing Test Step Group from the **Reusable Library**.
  * It helps in maintaining consistency and reusing frequently used test steps across multiple Test Cases.
  * Simply select the required Test Step Group from the library, and it will be added to your current Test Case.
* [**Adding Test Step Group using Avo Genius**](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/create-test-case/create-test-step-group/record-test-step-group-using-avo-genius)
  * Use this option to record Test Steps automatically using **Avo Genius**.
  * Actions performed during recording are captured as Test Steps in the group, including element selection, input values, and actions performed.
  * This method simplifies Test Step creation for dynamic or complex scenarios.


# Adding New Test Steps Group

To add a Test Step Group in a Test case, perform the following actions:

1. On the **Home** page, select the required project and select **Design Studio**.
2. Go to the **Test Case** tab and select the created Test case.

{% hint style="info" %}
To learn more about how to create a Folder and Test case in **Test case** page, [click here](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/create-test-case).
{% endhint %}

3. On the **Test Case** tab, select **Create Test Step Group** and select **Add new test step group**. The **Test Step Group** dialog opens.

<figure><img src="/files/xrbFsOfa6hFy0UvgFi1P" alt=""><figcaption></figcaption></figure>

4. Enter the name in the **Test Step Group Name** text box and select the **Application Type**.
5. Select **Create** to add a new Test Step Group.

{% hint style="info" %}
**Note**: You can also add a **Test Step Group** from the [**Reusable Library**](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/create-test-case/create-test-step-group/add-test-steps-group-from-reusable-library).
{% endhint %}

<figure><img src="/files/12G1kNCLAY05OnP5whVt" alt=""><figcaption></figcaption></figure>

6. This creates a new Test Step Group inside the Test case.

<figure><img src="/files/STlvo8HGsWI9ZyMxtEpa" alt=""><figcaption></figcaption></figure>

7. Select the required options to add the Test Steps.\
   Here are the two ways to add steps:
   * **Add from repository**
   * **Add Manually**

<details>

<summary><strong>Add from repository</strong></summary>

To add elements from the Element Repository to the Test Step Group, perform the following actions:

1. On the **Test Case** tab, select the created Test Step Group and select **Add from Repository**. The **Element Repository** page opens.

<figure><img src="/files/pTkr8Lfg9BKl8vWNX9wv" alt=""><figcaption></figcaption></figure>

2. From the **Element Repository** page, drag-and-drop the captured elements into the **Test Step Group**.

{% hint style="info" %}
**Note**: Once you drag and drop the elements, the corresponding action automatically appears in the Test Steps.
{% endhint %}

3. Select **Save** to save the Test Steps.

{% hint style="info" %}
**Note:** After adding all elements to the **Test Step Group**, you can edit the steps.
{% endhint %}

<figure><img src="/files/Fi8LysOfoBP4nzKkmdhM" alt=""><figcaption></figcaption></figure>

</details>

<details>

<summary><strong>Add Manually</strong></summary>

To add elements manually to the Test Step Group, perform the following actions:

1. On the **Test Case** tab, select the created Test Step Group.
2. Select **Add Manually** to add a new Test Step.

<figure><img src="/files/wwfgGvM9VFvdPexCHhRR" alt=""><figcaption></figcaption></figure>

3. Select **Add Step** (**+**) icon and select **Add step manually** to add more steps to the **Test Step Group**.

<figure><img src="/files/hgWLeYvRP7zwOysAJ5a1" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Note**: You can also add a Test Step manually by selecting the **Add Step** (**+**) icon for an individual step.
{% endhint %}

4. A new **Test Step** is created. Select the required **Element Type** and **Action** from the dropdown.
5. Select **Save** to save the Test Steps.

<figure><img src="/files/JVl7r63Z3xF2fuDiT1Ly" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Note**: To run the created Test Steps, you can either select **Debug** or create an [**Execution List**](/avo-assure/create-and-execute-tests-with-design-studio/working-with-execution-section/execute-execution-list).
{% endhint %}

</details>


# Add Step Details

The **Add Step Details** feature allows you to provide additional information for each step within a Testcase. This helps in maintaining clarity, accurately record the results during test execution.

#### Steps to Add Step Details in Avo Assure:

1. On the **Home** page, under **Projects**, select the required project. Navigate to the **Testcase** tab in the **Design Studio**.
2. Select specific test step where you want to add details.
3. Select the Add Step Details **(...)** icon on the right panel.

<figure><img src="/files/M0U0SnXtdkvzY6eiQAPH" alt=""><figcaption></figcaption></figure>

4. Fill in the following fields:

* **Test Step description**: Clearly describe what the test step is meant to verify.\
  Example: This test case is used to open the given URL.
* **Expected Result**: Enter the expected outcome of test step.\
  Example: Browser should be navigated to the given URL.
* **Pass Result**: Define the message or value that should be shown when the step passes.\
  Example: URL opened successfully.
* **Fail Result**: Define the message or value that should be shown when the step fails.\
  Example: URL not opened.

<figure><img src="/files/pVCXMw0wCF4lfTcKRyM1" alt=""><figcaption></figcaption></figure>

5. Select **Save** to apply the details. A **Success** message appears displaying "Test case info saved"*.*

<figure><img src="/files/hxN7v1mDdY4lajV7C8pS" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Note:** After execution, you can view the step details in the **Remarks** section of the execution reports, refer to [Read a Reports](/avo-assure/create-and-execute-tests-with-design-studio/working-with-reports-section/read-a-report).
{% endhint %}


# Add Test Step Group from Reusable Library

Below is the stepwise process to create Test steps group from Reusable Library:

1. Click **Create Test Step Group** button and select **Add new test step Group.**
2. In the Test Step Group pop-up. Click on **drop-down icon** from **Add test step group from Reusable Library.**
3. **Select "Login"**

<figure><img src="/files/rczAEbrSgbOacdZmCph6" alt="" width="533"><figcaption></figcaption></figure>

4. Choose **Application Type**. Click **Create.**

<figure><img src="/files/7jsZvpX8OFTbIpXvL3DN" alt="" width="527"><figcaption></figcaption></figure>

5. Test Step group will be created with Reusable library.

<figure><img src="/files/vp741bDvjwWHUPRQYyvS" alt=""><figcaption></figcaption></figure>


# Record Test Step Group Using Avo Genius

To record test step group using Avo Genius follow the steps:

### Design Studio

**Web Application**

1. Click on **New test step group** and select **Record new test step group**

<figure><img src="/files/jRoS45k5klPFBOrvwdSc" alt="" width="563"><figcaption></figcaption></figure>

2. Avo genius window will pop-up. Select **Application type as WEB** and **Provide Application URL. Click Start Recording.**

<figure><img src="/files/UsshtYh0ukKyFhtvwKfQ" alt="" width="563"><figcaption></figcaption></figure>

3. Avo Genius recording window will pop up. Click on the elements to add them

<figure><img src="/files/AqzPlpBU12kDB4crMVBF" alt="" width="425"><figcaption></figcaption></figure>

4. Click on Finish and save.

<figure><img src="/files/zxiiajluNx765aE2qsID" alt="" width="437"><figcaption></figcaption></figure>

5. All elements will be captured in the test step group

<figure><img src="/files/Hw1TgPzfYMG8Iny7js9L" alt=""><figcaption></figcaption></figure>

### FOR SAP

1. Click on **New test step group** and select **Record new test step group**
2. Avo genius window will pop-up. Select **Application type as SAP** and **Provide Application Path. Click Start Recording.**

<figure><img src="/files/b1JC3EyRlqBhgMUcicP7" alt=""><figcaption></figcaption></figure>

3. Avo Genius(SAP) window will pop up with another window to enter username and password.

<figure><img src="/files/5vl4UklBLXMufdETTfzf" alt="" width="563"><figcaption></figcaption></figure>

4. Once recording is complete. Provide Folder name and testcase name and Click Save.

<figure><img src="/files/ZH1viuswp2LGw2oUSJsU" alt="" width="563"><figcaption></figcaption></figure>

5. All Elements will be saved in the test Case step.

<figure><img src="/files/dRxtxN8StoHzfFlnULnj" alt=""><figcaption></figcaption></figure>


# Recording a Test Case with Avo Genius

Avo Genius, a key feature of Avo Assure, it’s simplifying the creation of automated test cases. It works as an intelligent recorder, capturing user interactions with web or SAP applications and converting them into test cases automatically. This feature is designed to making it suitable for both technical users and those with little or no coding experience.

Please access the link [Prerequisites for Avo Genius](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/recording-a-test-case-with-avo-genius/prerequisite-to-work-with-avo-genius) and steps to obtain prerequisites


# Prerequisite to work with Avo Genius

Before using Avo Genius, ensure it is installed on your system. Below is the method to install Avo Genius.

* [**Install Avo Genius Extension Manually**](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/recording-a-test-case-with-avo-genius/prerequisite-to-work-with-avo-genius/install-avo-genius-extension-manually)
* [**Install Avo Genius from Store**](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/recording-a-test-case-with-avo-genius/prerequisite-to-work-with-avo-genius/install-avo-genius-from-store)
* [**Install Avo Genius from Avo Assure Platform**](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/recording-a-test-case-with-avo-genius/prerequisite-to-work-with-avo-genius/install-avo-genius-from-avo-assure-platform)


# Install Avo Genius Extension Manually

User can install the Avo Genius extension in chrome and edge browser manually.

Below is the step-by-step process to install Avo Genius Extension:

1. Click **three dots (...)** located on top right corner in browser.
2. Then, Click **Extensions** and select **Manage Extensions option** to add extension in browser.

**For Chrome:**

<figure><img src="/files/2TcjYnLbeoggrmNcBQS3" alt="" width="311"><figcaption></figcaption></figure>

**For Edge:**

<figure><img src="/files/Az9Ureu43pKIo2JweU4m" alt="" width="287"><figcaption></figcaption></figure>

<figure><img src="/files/iuqlUbYLLjFqRLYu2By0" alt="" width="375"><figcaption></figcaption></figure>

2\. Activate the **Developer mode** and click **Load unpacked** button to bring up extension directory of the system.

**For chrome:**

<figure><img src="/files/4JWw3cJ81fzudvWKG6VG" alt=""><figcaption></figcaption></figure>

**For edge:**

<figure><img src="/files/Zu2BDM8uzZsvO0SM9eIv" alt=""><figcaption></figcaption></figure>

3. Select **build file** from directory and extension will be loaded in browser.

<figure><img src="/files/thDeQkqdvwpXyVap3Vii" alt=""><figcaption></figcaption></figure>


# Install Avo Genius from Store

Here is the step-by-step process to Install Avo Genius from Web Store **for Chrome:**

1. Click **three dots (...)** located on top right corner in browser.
2. Then, Click **Extensions** and select **Manage Extensions option.**
3. On the top left, Select **Chrome Web Store**

<figure><img src="/files/pMaYAKauLP8H6PKF132B" alt="" width="325"><figcaption></figcaption></figure>

4. In **chrome web store**, Search **Avo Genius** and select the below extension.

<figure><img src="/files/Oh6RGkIQ9FRKGGuRunQ9" alt=""><figcaption></figcaption></figure>

5. Click **Add to chrome** button. A pop up will appear for adding the extension.

<figure><img src="/files/wxNcTp3Os514oc1MqgL4" alt=""><figcaption></figcaption></figure>

6. Click **Add Extension.** Avo Genius will now be visible in manage extension window.

   <figure><img src="/files/kGGQjWrYhcf4t5KT21jz" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Note:** For Edge, users cannot download the extension from the Web Store. They need to enable developer mode and manually upload the Genius package.
{% endhint %}


# Install Avo Genius from Avo Assure Platform

Below are the steps to install Avo Genius extension from Avo Assure platform

1. Login into the Avo Assure platform using credential
2. Click **Create Test Case** and select **Record with Avo Genius option**
3. On the Avo Genius window, Enter the application URL. Since the extension is not installed yet, an alert message will appear
4. Click on **here,** this will navigate to web strore

<figure><img src="/files/LITJJY7GWYQo0bmwzMaY" alt=""><figcaption></figcaption></figure>

5. Click **Get extension** to install Avo Genius on system

<figure><img src="/files/EEMVrgu1dxs7iWWmhih7" alt=""><figcaption></figcaption></figure>


# Ways to invoke and use Avo Genius

In Avo Assure you have three ways to use Avo Genius:

1. [**From landing page of Avo Assure**](#from-landing-page-of-avo-assure)
2. [**By Clicking + icon present in Test Cases window**](#by-clicking--icon-present-in-test-cases-window)
3. [**By clicking View more after creating Test case**](#by-clicking-view-more-after-creating-test-case)

### From landing page of Avo Assure

1. From **New Test case** card, select **Create new test case**.
2. Select **Avo Genius Record** option.

<figure><img src="/files/CbOFbsxmizU9mNlXz37b" alt=""><figcaption></figcaption></figure>

### By Clicking + icon present in Test Cases window

1. Click **Design Studio button** from top right corner of Assure instance and navigate to Test Cases tab.
2. Click **" +" icon** and select **Create new folder to** create a **unique** **folder**
3. Click **on three dots beside the folder** and select **Record with Avo Genius** option.

### By clicking View more after creating Test case

1. Click **Design Studio button** from top right corner of Assure instance and navigate to Test Cases window.
2. Create a **New Folder** with **Test case.**
3. Click **View more icon** and click **Record with Avo Genius button** to use Avo Genius.

<figure><img src="/files/9WG8u6Uwy9YVyQdZ7yUj" alt=""><figcaption></figcaption></figure>


# Recording Web & SAP test cases/test step group

Avo Genius allows to record the test cases using the interactive recording feature. Avo Genius works with Web and SAP.

Please Click [**Record test step group using Avo Genius**](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/create-test-case/create-test-step-group/record-test-step-group-using-avo-genius) to learn more.


# Managing Test Case

The Managing Test Cases section helps you organize and maintain test cases efficiently within a project. It provides features that simplify navigation and management of test case folders and their contents, making it easier to work with large test suites. This article explains how to search for folders, copy and paste test cases, rename test cases or folders, and expand or collapse folders for easier navigation.


# Searching Folders and Test Cases

The **Search Folders / TestCases** feature allow you to search the created folders and test cases.

To search folders and test cases, perform the following actions:

1. On the **Home page**, select **Design Studio**.
2. Select **Test Case** tab.
3. On the left pane, locate the **Search Folders / TestCases** search box.
4. Enter any keyword in the search box. The matching folders and test cases are highlighted.

<figure><img src="/files/PdkcGmnZuIPS89zNR7xA" alt=""><figcaption><p>Viewing the search results</p></figcaption></figure>


# Copy Pasting Test Case Folders

Steps to copy and paste the unassigned Test Case Folder:

1. Navigate to **Test Case** Tab
2. Click **Ellipses(...)** icon and select **Copy** from context menu
3. Select another folder where this copied folder should be pasted.
4. Click **Ellipses(...)** icon and select **Paste** from context menu


# Assigning Test Case

## Assign Testcases

The "Assign Testcases" feature allows you to assign Testcases to specific user or roles within the testing. This ensures comprehensive test coverage and efficient test execution.

{% hint style="info" %}
**Note:** The steps shown below are for the Testcase. Follow the same process for other modules (e.g., Element Repository, Execution List, Data Table, Re-usable Library).
{% endhint %}

Follow the steps below to assign users in the Testcase:

1. On the **Home** page, under **Projects**, select the required project. Navigate to the **Testcase** tab in the **Design Studio**.
2. Select the **Folder** you want to assign.
3. Select the ellipsis icon **(…)** and then select **Assign Testcases** from the options.

<figure><img src="/files/1agiminJozLOKsXMRRQA" alt=""><figcaption></figcaption></figure>

4. Select **Search Testcases** and enter the Testcase name to locate the desired Testcase.

<figure><img src="/files/DX2jRnsQRNJkCcrRTCQo" alt=""><figcaption></figcaption></figure>

5. Search or select a user from the dropdown to assign.

<figure><img src="/files/PuFSLZGBNDoO2jfKrL9y" alt=""><figcaption></figcaption></figure>

6. Select **Assign** to assign the test case to the selected user.

<figure><img src="/files/6Yjn3kjRO546zfG6HNOF" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Note:** When you assign a Testcase to another user, the assigned Testcase becomes locked for you.
{% endhint %}

## View Test Step Details

Follow the steps below to view the Test Step Details in read-only mode:

1. Navigate to the assigned Testcase in the **Testcase** tab.
2. Select **Add Step Details** to view the test step details.

{% hint style="info" %}
**Note:**

* To understand how to Add Step Details, refer to the [Add Step Details](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/create-test-case/create-test-step-group/add-step-details).
* After assigning the Testcase, you can **Copy** the Test Steps Groups from the assigned test case and use them in a different folder.
  {% endhint %}

<figure><img src="/files/bF6nfMdNPAvUr63Les8t" alt=""><figcaption></figcaption></figure>

3. The **Step Details** window appears in the right panel.

<figure><img src="/files/hps3c47RpdV6UNWnSKAn" alt=""><figcaption></figcaption></figure>


# Skipping Test Steps

The Skip option allows you to bypass unnecessary Test step during execution.

Step-by-step process to import test steps:

1. Navigate to Test cases window and select Test step
2. Click the skip icon to <img src="/files/1zug9KRqE8TPzFPtQoei" alt="" data-size="line"> to skip the selected Test step during execution

<figure><img src="/files/nKrF54jXFkQmi4D8ur5T" alt=""><figcaption></figcaption></figure>


# Copying & Pasting Test Case, Test Step Group and Test Step

**Copy Test steps**

Step-by-step process to copy test steps in Test case

1. Navigate to Test Cases window
2. Select Test step and click Copy icon located in top right pane of screen

**Paste Test steps**

Step-by-step process to paste Test steps

1. Navigate to Test Cases window
2. Select the desired Test step and click Paste icon from the top right pane of screen


# Copying Link

The Copy Link option helps you generate a shareable URL for a specific artifacts in Avo Assure. Opening the copied URL takes you directly to the selected artifact, eliminating the need to navigate through the application manually.

This option allows you to share artifacts with other users and provides quick access to frequently used artifacts. This article covers how to copy and use links for Test Cases.

{% hint style="info" %}
**Note**:

* Ensure you have the required permissions to access the artifact. Users without the necessary access cannot open the linked artifact.
* To open a copied link, you must be logged in to **Avo Assure** in the browser where you open the link.
* The procedure described below is the same for the following artifacts:
  * Element Repository
  * Reusable Library
  * End-to-End (E2E) Flow
  * Execution
    {% endhint %}

To copy a link for a Test Case, perform the following actions:

1. On the **Home** page, under **Projects**, select the required project.
2. Select **Design Studio** > **Test Case**.
3. Select the **Ellipses icon** (**...**).
4. Select **Copy Link**. The link is copied to the clipboard.

<figure><img src="/files/ybvGCgZEt7SJsxxYc7Td" alt="" width="563"><figcaption></figcaption></figure>

{% hint style="info" %}
**Note**:

* The **Copy Link** option is available for both folders and test artifacts.
* You can also copy the URL directly from the browser's address bar.
  {% endhint %}

5. Paste the copied link into a supported browser or share it with other users.
6. Open the link to navigate directly to the selected artifact in Avo Assure.


# Opening Artifacts in New Tab

The Open in new tab option helps you open a duplicate of the current Avo Assure instance in a new tab within the same browser. This feature allows you to work on multiple pages simultaneously without navigating from your current page. This article covers how to open the current Avo Assure instance in a new browser tab.

To open Avo Assure page in a new tab, perform the following actions:

1. On the **Home** page, under **Projects**, select the required project.
2. Select **Design Studio**.
3. Select the **Ellipses** (**...**) menu for the required artefact.
4. Select **Open in new tab**. The selected artefact opens in a new browser tab.

{% hint style="info" %}
**Note**: You can also open the current page in a new browser tab by copying the URL from the browser's address bar and pasting it into a new tab.
{% endhint %}

<figure><img src="/files/8FL5OKC6KBmNeGwXqp5f" alt="" width="563"><figcaption></figcaption></figure>


# Deleting Test Case, Test Step Group and Test Step

### Deleted

The stepwise process to add Test steps are

1. Navigate to Test cases window
2. Select Test step
3. Click the delete icon <img src="/files/2Hf4cqtSUyQfonscMC8l" alt="" data-size="line">

<figure><img src="/files/CvhOSEbJ7uM4TubksXuo" alt=""><figcaption></figcaption></figure>

OR

Select the Test step by selecting the checkbox and hit the delete icon from the top option pane

<figure><img src="/files/tMCUBJ5RbgXJagqTdIZS" alt=""><figcaption></figcaption></figure>


# Renaming Test Case and Test Step Group

## Renaming Test Case

To rename the Test case, perform the following actions:

1. On the **Home** page, from **Projects** list, select required project.
2. Select **Design Studio**.
3. Select **Test Case** page.
4. Expand required folder and select the Test case.
5. Select ellipses(**...**) icon.

<figure><img src="/files/HHExTEjf1sqQUdtJA2fo" alt=""><figcaption></figcaption></figure>

6. Select **Rename** to rename the Test case.

<figure><img src="/files/1Mhm5qKW2y8MXJwAnq5r" alt=""><figcaption></figcaption></figure>

## Renaming Test Step Group

To rename the Test Step Group, perform the following actions:

1. On the **Home** page, from **Projects** list, select required project.
2. Select **Design Studio**.
3. Select **Test Case** page.
4. Expand required folder and select the Test case.
5. Single click on Test Step Group and rename it.

<figure><img src="/files/aFI8bjgybhXufEagBB1w" alt=""><figcaption></figcaption></figure>


# Expanding & collapsing Test Case Folders

1. Click on the Arrow Icon beside the folder to Expand. This will make all the test cases inside that folder visible.

<figure><img src="/files/7vVRIIOjWKr77svlSXrC" alt=""><figcaption></figcaption></figure>

2. Use the same arrow icon to collapse the section.


# Alert on Deleted Elements

When elements are deleted from a Test Step Group, a warning message appears each time you view that Test Step Group.

To locate and edit the Deleted Object’s step perform the following actions:

1. On **Home** page, under **Projects**, select required project.
2. From upper right corner, select **Design Studio** to open the **Test Case** page.
3. Select the **Test Case** for which an element is deleted, and you can see the Warning message.

<figure><img src="/files/Zi1zVEWHo6uR7c4Yl4LJ" alt=""><figcaption></figcaption></figure>

3. Locate the Test Step Group which have **Warning** icon.

<figure><img src="/files/mBNWy72mVEG1bhIxgH1I" alt=""><figcaption></figcaption></figure>

5. Select the **Warning** icon. Deleted Elements steps are automatically selected.

<figure><img src="/files/cPEkAl05edopmGzRnZlY" alt=""><figcaption></figcaption></figure>

6. Modify the step with correct element.
7. Select **Save** button

{% hint style="info" %}
**Note**:

* If a Test Step Group is reused, the icon appears in the **Reusable Library** section.
* If a reused Test Step Group is detached, the icon will appear on both - the Test Step Group in the Reusable Library and the detached Test Step Group.
  {% endhint %}


# Features in Test Case

The Features in Test Case section introduces the capabilities that help you manage, organize, and execute test cases more efficiently in Avo Assure. These features improve collaboration, simplify test case management, and enhance the overall testing experience. This article explains how to review test cases, tag test cases for better organization, debug test cases to identify and resolve issues, and import or export test cases for reuse and migration.


# Review Test Case

The Send for Review feature in Avo Assure enables you to submit a test case for evaluation or validation by another team member. It supports a structured review workflow that helps ensure test case quality and accuracy before execution or finalization. Authors can send test cases for review, while reviewers can evaluate the test case, provide feedback, and decide whether to approve or reject it. This article explains how to send a test case for review and how reviewers can review, accept, or reject the submitted test case.

{% hint style="info" %}
**Note:**

* A Testcase is always sent to review only to a user with the role As Quality Manager or Quality Lead in Avo Assure.
* Ensure that the selected reviewer is a member of the same project.
  {% endhint %}


# Sending Test Case for Review

To send test case for review, perform the following actions:

1. On the **Home** page, under **Projects**, select the required project.
2. Navigate to **Design Studio** and select the **Testcase** for which you want to view the version history.
3. Select Ellipsis **(...)** icon.
4. Select **Send for review** from the dropdown.

<figure><img src="/files/LmSZgIUJXs1p6dUCqkQD" alt=""><figcaption></figcaption></figure>

5. Select **Reviewer** from the dropdown.
6. Add review comments in the text box and select **Send for review**.

{% hint style="info" %}
**Note:** Once the Testcase is sent for validation to the manager or lead, it gets locked as the **locking mechanism feature** in Avo Assure gets activated. It gets unlocked only after the manager or lead decline it. Only then, the user who had requested the review can **delete** or **modify** the Testcase.
{% endhint %}

When a Testcase is sent for review, the user requesting the review loses access to it as the **locking mechanism feature** in Avo Assure gets activated for the Test Case.

<figure><img src="/files/Z5LyBFOkifaiKNStYwPz" alt=""><figcaption></figcaption></figure>


# Reviewing Test Case

{% hint style="info" %}
**Note:** To review the Element Repository, Execution List, and Data Table, follow the same steps as described below.
{% endhint %}

#### Steps to Approve or Decline the Testcase (For reviewer):

When a sender sends a Testcase for review, the reviewer can access it in two ways:

### **A. Manual Navigation**

1. On the **Home** page, under **Projects**, select the desired project. 
2. Select **Design Studio**, navigate to the **Testcase** tab.
3. Select Test case which is sent for review. A pop-up titled **Review Test Case** appears.

<figure><img src="/files/apjC7YyEFqTcAvazufeI" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Note**:

* When a Test case shared for review is deleted, renamed, or moved to a different folder, the system shows a notification explaining the reason for the change.
* The system clears the notification after displaying the message and selecting **OK**, ensuring that reviewers do not access invalid or outdated Test case links. As shown in below image.
  {% endhint %}

<figure><img src="/files/eDhij3MgUysDVdqrnwBk" alt=""><figcaption></figcaption></figure>

4. Select **Approve**/**Decline** action

**i. Approve:**

1\. Select **Approve** to approve the test case.

{% hint style="info" %}
**Note**: After a reviewer approves, the Testcase dose not reassign to the sender. The sender can reassign it to themselves if needed.
{% endhint %}

**ii. Decline:**

1\. Select **Decline** to reject the test case. The **Reason for Rejection** pop-up appears.

2\. Enter the rejection reason and select **Submit**.

{% hint style="info" %}
**Note:** When a reviewer declines, Avo Assure reassigns the Testcase to the sender along with the rejection reason for further action.
{% endhint %}

<figure><img src="/files/Kxthgq4xer0ZuAE4YV0g" alt=""><figcaption></figcaption></figure>

### B. Via Notification

1. On the **Home** page, navigate to the **Review Notification** icon available in the upper-right corner, and the receiver can view all assigned test case review requests.
2. Select **Review** option from the notification list for the specific Testcase to review.

{% hint style="info" %}
**Note:**

* The total number of review requests displays above the icon and updates automatically when Testcases are approved or declined.
* Each review request shows the Testcase name, Project name, Requester name, and Timestamp.
* For each request, the reviewer can choose **Review**, **Approve Changes**, or **Decline Changes** directly from the notification.
* When a Test case shared for review is deleted, renamed, or moved to a different folder, the system shows a notification explaining the reason for the change.
* The system clears the notification after displaying the message and selecting **OK**, ensuring that reviewers do not access invalid or outdated Test case links.
  {% endhint %}

3. The selected Test case tab opens, and the test case Information Panel displays the relevant details for review.

The following section provides a detailed description of the information displayed in the panel:

* **Created On**: Shows the date and time when the Testcase was created. Helps track when the Testcase was developed.
* **Created By**: Displays the name of the user who created the Testcase. Useful for knowing who created it.
* **Modified On**: Indicates the most recent date and time the Testcase was modified. Helps reviewers to check for recent changes before reviewing.
* **Modified By**: Shows the name of the user who last modified the Testcase. Useful to identify who made the most recent changes.
* **Status**: Displays the current review state of the test case, such as Under Review, Approved or Decline. This helps track the progress in the review process.
* **Comments**: A custom message added by the user who requested the review, usually to describe the purpose, functionality, or specific points to be checked in the test case.

<figure><img src="/files/YD6UbjFrKDVKqE5mlMrh" alt=""><figcaption></figcaption></figure>

4. Select **Approve**/**Decline** action to Approve or Decline the request.

{% hint style="info" %}
**Note:**

* **Approve**: After a reviewer approves, the Testcase dose not reassign to the sender. The sender can reassign it to themselves if needed.
* **Decline**: When the reviewer declines, the Avo Assure reassigns the Testcase to the sender along with the rejection reason for further action.
  {% endhint %}

5. After selecting **Approve** or **Decline**, a pop-up message appears confirming the action: **The Test case has been approved** or **The Test case has been rejected**.


# Debug Test Case

Debug involves executing the Test steps of different technologies to determine whether the expected execution results detect any error in the Test step.

Step-by-step process to debug the Test steps in Avo Assure:

1. Select **Test step Group** by expanding the folder located in left pane of the screen
2. Click **Debug** button.

<figure><img src="/files/wJTBb4kXnhDs80O93yWj" alt=""><figcaption></figcaption></figure>

3. **Debug pop-up will appear.**
4. Select individual checkbox or Click **Select Teststep Group(s)** to select all the element&#x73;**.**

{% hint style="info" %}
Note: To deselect all the elements, click on "**Select Teststep Group(s)**" again.
{% endhint %}

5. Again, Click **Debug.**

<figure><img src="/files/tBrEPRzjWzKLwQv1ihfE" alt="" width="428"><figcaption></figcaption></figure>

6. Debugging will start.

{% hint style="warning" %}
***Note:** while debugging user can navigate to other tab or make any changes in Test Case but these changes or modification will be applied in the next debug.*
{% endhint %}

7. Once the debug is successfully executed. User can check its status on the Avo Assure Client.

<figure><img src="/files/hHmEATU5eJ5fNPZ4sujb" alt=""><figcaption></figcaption></figure>


# Tag Test Case

### **Tag Test cases**

The Tag a Test case functionality helps users to tag test cases for easy identification like Grouping the test case and further streamlining the selection of Test cases for execution configurations. 

#### Step-by-step process to tag Test case in Avo Assure:

1.Navigate to Test cases window and click information panel ![](/files/rCxO6zO49gFGIhrtyKPc)

<figure><img src="/files/gPBUlxCkVGDszIpjbO3b" alt=""><figcaption></figcaption></figure>

2. Click +New tag to tag as Test case in test step group

<figure><img src="/files/BmmQHPsS8pdfCEarCwpA" alt="" width="240"><figcaption></figcaption></figure>


# Test Case Details and Audit Logs

The test case details page provides information about a test case and helps you track changes made to it over time. You can view key details such as the test case name, description, tags, status, creation date and time, and the user who created it. You can also review audit logs to monitor changes made to test cases and test case folders. This article explains how to view test case details and access its audit logs.


# Viewing Test Case Details

To view the test case details, perform the following actions:

1. On the **Home** page, from **Projects** list, select required project.
2. Select **Design Studio**.
3. Select **Test Case**.
4. On the **Test Case** page, expand the required folder and select the test case for which you want to see the details.
5. Select the **Information Panel** (**i**) icon. The **Details** tab opens.

![](/files/GilJ5JJWUOlStKbIcLkm)

6. On the **Details** tab, you can view the following information:

* **Test Case Name**: The test case name.
* **Description**: The test case description.
* **Tags**: The test case tags.
* **Status**: The test case status (New, In Progress, Under Review, Approved or Rejected).
* **Created On**: The test case creation date and time.
* **Created By**: The username of the person who created the test case.

![](/files/988Zz5jntOY1vzlSXRmv)


# Viewing Test Case Audit Logs

To view the test case audit logs, perform the following actions:

1. On the **Home** page, from **Projects** list, select required project.
2. Select **Design Studio**.
3. Select **Test Case**.
4. On the **Test Case** page, expand a folder and select the test case for which you want to see the details.
5. Select the **Information Panel** (**i**) icon. The **Details** tab opens.

![](/files/GilJ5JJWUOlStKbIcLkm)

6. Select the **Audit Logs** tab.

![](/files/MC34wEoVy5wZhRdh3zrE)

7. Select **Date Range** to view the actions performed between the specified dates.

![](/files/qL4VIoDv3vZ6QlX3G1Pn)

8. Expand the month to view the actions performed in the test case.

![](/files/RzbMdOX8tSBYxGFjOJvg)

### Audit Log Inclusions

The following actions are captured in the test case audit logs:

* Creating Test Case
* Renaming Test Case
* Adding or Updating Details
  * Description
  * Tags
* Creating Test Step Group (Non Avo Genius and Non-Reusable)
  * Adding Test Step Group (Test Case Name, Application type, Add from Repository or Add Manually)
  * Adding or Updating Step Details (Description, Expected Result, Pass Result or Fail Result)
* Creating Test Step Group (Reusable Library)
  * Adding Test Step Group from Reusable Library
  * Removing or Detaching Reusable Test Step Group
* Creating Test Step Group (Avo Genius)
  * Adding Test Step Group via Avo Genius Recording
* Performing Actions on Test Steps
  * Skipping Test Step
  * Copy Pasting Test Step
  * Deleting Test Step
  * Reordering Test Step Groups within Test Case
  * Reordering Test Steps
* Creating Recovery Steps
* Deleting Recovery Steps
* Importing Test Case
* Debugging Test Case
* Reviewing of Test Case (Including comments)
  * Assigning Test Case
  * Sending For Review
  * Approve
  * Reject
* Actions on Test Case in Bitbucket (Test Case, Reusable Library and End-to-End Flow)
  * Overwriting Test Case
  * Creating Test Case
  * Creating Folder
  * Pushing Test Case
  * Pulling Test Case

### Audit Log Exclusions

The following actions are currently not captured in the test case audit logs:

* Folder Level Actions
* Export
* Detailed Report-level Audit for Debug Executions
* Reused Test Step Groups
  * Delete
  * Test Step Group Description
  * Add Test Step
  * Add/Update Step Details (description, expected result, pass result, fail result)
  * Skip Test Steps
  * Copy/Paste Test Steps
  * Delete Test Steps
* E2E
  * Delete E2E
  * Deleted Test Cases
  * Added Test Cases
* Bitbucket
  * Compare


# Edit Element Attributes in Test Case

To edit the attributes perform the following action:

1. On **Home** page, under **Projects**, select required project.
2. From upper right corner, select **Design Studio** to open the **Test Case** page.
3. Select Test Case from folder.
4. Navigate to **Test Step Group**.
5. Under **Elements** column, hover over any captured element.
6. Select **i** icon. Details pane opens on the right side of the Test Case page.

<figure><img src="/files/GZvxgrfRNw8pDFmPTQX4" alt=""><figcaption></figcaption></figure>

6. On the **Details** pane, select Repository Path to navigate to Element Repository.

<figure><img src="/files/xBeHzJspmePI8ydIGI2B" alt=""><figcaption></figcaption></figure>

7. On the **Element Repository** page, hover over the element for which you want to edit the attribute.
8. Select the **edit** icon, **Details** pop up window appears.

<figure><img src="/files/3mR4MSd7u2jYbxbHs94S" alt=""><figcaption></figcaption></figure>

9. On the Details pane, edit the attributes and select **Save Properties**.

<figure><img src="/files/OOO1ZWacU3GhPGpLGn1I" alt=""><figcaption></figcaption></figure>

10. Select **Redirect to test case** button to redirect to the Test Case window.

<figure><img src="/files/zGhwPwrGTjIdmML5uVhe" alt=""><figcaption></figcaption></figure>


# Import & Export Test Case

The Import and Export Test Cases feature helps you move test cases between projects or environments, making it easier to reuse, share, and back up test assets. You can import existing test cases into a project or export test cases for migration or collaboration. This article explains how to import and export test cases in Avo Assure.


# Importing Test Case

The process to import Test steps are:

1. Navigate to Test cases window in design studio
2. Select Test step group by expanding the folder located in left pane of the screen and click import icon ![](/files/Mi1JgDc6HzLmO5L1iEpa)
3. Click Choose File button, select Json file from your system and click Import button.

<figure><img src="/files/nLRNbXgKyQhV1ur3Ree8" alt=""><figcaption></figcaption></figure>


# Exporting Test Case

### **Export Test Steps**

Step-by-step process to import test steps:

1. Navigate to Test cases window
2. Select Test step group by expanding the folder located in left pane of the screen and click Export icon ![](/files/SeWrGBTgkwXC5WROUpQ6)
3. Click Export button and exported file will be saved in downloads folder in local machine  

<figure><img src="/files/URin0kpWtVq3MBPUjNV3" alt=""><figcaption></figcaption></figure>


# Data Parametrization

Data parametrization in Avo Assure allows you to create flexible test scripts by replacing hardcoded values with variables. This enables the reuse of the same test script with different inputs, enhancing test coverage, flexibility, efficiency, and scalability.

### This document includes:

**Prerequisites**

The pre-requisites to follow for performing Data Parametrization

**Ways to Achieve Data Parametrization**

Different ways to perform data parametrization in Avo Assure

### Pre-requisites

1. Avo Assure Client must be installed and connected with Avo Assure
2. Excel sheet/Data Table should be created
3. Ensure Excel path/Data Table path is ready for access

### Ways to Achieve Data Parametrization

In Avo Assure, there are two different ways to achieve Data Parametrization:

1. [Through Excel Sheet](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/features-in-test-case-section-1/data-parametrization/through-excel-sheet)
2. [Through Data Table](/avo-assure/create-and-execute-tests-with-design-studio/working-with-test-case-section/features-in-test-case-section-1/data-parametrization/through-data-table)


# Data Parametrizing through Excel Sheet

User need to add three mandatory steps to the Test Step Group for performing Data Parameterization

1. Navigate to **Test Case** window, select Test Case where data needs to be parametrized
2. Click **+** icon and add new step

<figure><img src="/files/EeCaMbGVmJAy5cwLDqid" alt=""><figcaption></figcaption></figure>

3. Select **@Generic** as element and **Get Param** as action and enter **Excel path** in Input Value

Syntax for Excel file: `<Excel file path>;<Sheet Name>`

<figure><img src="/files/4VeLiad8B24c1ZTW5GzT" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
**Note:** Excel sheet must be in unrestricted folder
{% endhint %}

4. Add new step, select **@Generic** as element and **Start Loop** as action

<figure><img src="/files/RzXsESVrdz0XHv62ox7H" alt=""><figcaption></figcaption></figure>

5. Add variables in pipe operator in Input Value column to fetch the value from excel sheet

{% hint style="warning" %}
**Note:** Variable name should match with Excel sheet Variables
{% endhint %}

<figure><img src="/files/aL5zR8Eqm7fr8c3GFgBz" alt=""><figcaption></figcaption></figure>

6. Add new step where the iteration process should be halted, select **@Generic** as element and **End Loop** as action

{% hint style="warning" %}
**Note:** If End Loop is not added then user will get Dangling error while execution
{% endhint %}

<figure><img src="/files/zoETBIRfklZRcTDTWnZ1" alt=""><figcaption></figcaption></figure>


# Data Parametrizing through Data Table

Avo Assure have the in-house data table by which user can perform data parametrization by creating table in Test Data Management.

{% hint style="info" %}
**Note:** There was no option to write in data tables. With new enhancement, users can write back to a data table by providing syntax in the input field available in a Test Step under the Test Step Group
{% endhint %}

**Step-by-step process to copy Data Table path for using it in Data parametrization:**

1. Create Data Table

{% hint style="info" %}
**Note**:

* You can add up to 100 columns, and there is no limit on rows in the Data Table.
* For creating Data Table in Avo Assure refer this [Data Table | Avo Assure](/avo-assure/integrations-in-avo-assure/versioning/bitbucket/reviewing-test-artifacts/data-table)
  {% endhint %}

2. Click **(…)** icon and **Copy datatable path** for using it in test step for data parametrization.

<figure><img src="/files/6oBB86NwUh8gMkZ5inrA" alt=""><figcaption></figcaption></figure>

User need to add three mandatory additional steps to the Test Step Group for performing Data Parameterization of Data Table

1. Navigate to **Test Case** window, select Test Case where data needs to be parametrized
2. Click **+** icon and add new step

<figure><img src="/files/EeCaMbGVmJAy5cwLDqid" alt=""><figcaption></figcaption></figure>

3. Select **@Generic** as element and **Get Param** as action and enter copied **Datatable path** in Input Value

<figure><img src="/files/gEifSURScJbkM0ICcYIG" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Note:** Data Table must be created in same project
{% endhint %}

4. Add new step, select **@Generic** as element and **Start Loop** as action

<figure><img src="/files/RzXsESVrdz0XHv62ox7H" alt=""><figcaption></figcaption></figure>

5. Add variables in pipe operator in Input Value column to fetch the value from excel sheet

{% hint style="info" %}
**Note:** Variable name should match with Data table Variables
{% endhint %}

<figure><img src="/files/aL5zR8Eqm7fr8c3GFgBz" alt=""><figcaption></figcaption></figure>

6. Add new step where the iteration process should be halted, select **@Generic** as element and **End Loop** as action

{% hint style="info" %}
**Note:** If End Loop is not added then user will get Dangling error while execution
{% endhint %}

<figure><img src="/files/zoETBIRfklZRcTDTWnZ1" alt=""><figcaption></figcaption></figure>




---

[Next Page](/llms-full.txt/1)