> For the complete documentation index, see [llms.txt](https://releaseowl.gitbook.io/releaseowl-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://releaseowl.gitbook.io/releaseowl-docs/releaseowl-user-guide/test-automation/uipath.md).

# UiPath

Efficient integration of tools like UiPath with ReleaseOwl enhances automation and testing workflows, enabling seamless operations and better management of RPA and DevOps pipelines. This guide provides a detailed step-by-step walkthrough to help you integrate UiPath with the ReleaseOwl dashboard, from setting up UiPath Orchestrator to configuring test cases and connecting UiPath Assistant to the cloud.

### **1. Setting Up UiPath Orchestrator**

#### Step 1: Sign In to UiPath Orchestrator

* Open UiPath Orchestrator in your browser.
* Sign in using your credentials.

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

#### Step 2: Access Orchestrator

* Click on the **Orchestrator** button located in the top-left corner of the interface.

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

#### Step 3: Create a New Folder

* Navigate to **Tenant** in the side menu.
* Create a new folder by following the on-screen instructions.

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

#### Step 4: Set Up an Unattended Robot

* Go to **Robots** and select **Unattended Setup**.
* Click on **Self-Hosted (Unattended Robot)** and then click **Next**.

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

* Select **Create New Machine Template** and click **Next**.

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

* Fill in the necessary details and click the **Next** button.

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

#### Step 5: Configure Domain/Username and Password

* Open the **Command Prompt (CMD)** on your system.
* Type `systeminfo` to retrieve your Logon Server (Domain URL).
* Find your username in the command prompt before the `>` symbol (e.g., `C:\Users\<YourUsername>`).

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

* Enter the following:
  * **Domain\Username:** Your domain name (from the Logon Server) and your username (from the command prompt).
  * **Windows Password:** Your system's password.
* Click the **Next** button.

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

#### Step 6: Finalize the Robot Setup

* After clicking **Next**, select the created unattended robot account.

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

* Click **Next**.
* Copy the **Client ID** and **Client Secret** generated in this step.
* Click the **Close** button.

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

### **2. Installing and Using UiPath Studio**

#### Step 7: Install UiPath Studio

* Open the **App Launcher** in UiPath Orchestrator.
* Click on **Studio** and install it locally on your machine.

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

{% hint style="info" %}
**Note:** UiPath Studio is a powerful IDE used to design, build, and develop automation workflows for RPA.
{% endhint %}

#### Step 8: Publish Test Cases to Orchestrator

* Launch the locally installed UiPath Studio.
* Create your test cases.

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

* Click the **Publish** button to upload the test cases to your UiPath Orchestrator cloud account.

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

#### Step 9: Manage Test Cases in Orchestrator

* In UiPath Orchestrator, navigate to the folder you created earlier.
* Click on **Testing** to view the published test cases.

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

#### Step 10: Create a Test Set

* Click **Add Test Set** in Orchestrator.
* Fill in the necessary details for the test set.
* Save the information.

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

### **3. Connecting UiPath Assistant to UiPath Cloud**

#### Step 1: Open UiPath Assistant

* Open **UiPath Assistant** on your machine.
* In your UiPath Assistant account, go to **Preferences** and navigate to **Orchestrator Settings**.

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

#### Step 2: Configure Connection Details

* Select your **Connection Type**, **Machine Name**, and **Orchestrator URL**.
* To find the Orchestrator URL:
  * Go to UiPath Orchestrator in your UiPath Cloud account.
  * Copy the URL provided (e.g., `https://cloud.uipath.com/releaijylebf/DefaultTenant/orchestrator_/monitoring/overview?tid=1972132&fid=6150923`).
  * Modify the URL by removing everything after `orchestrator_/`, so it looks like this:

    ```
    https://cloud.uipath.com/releaijylebf/DefaultTenant/orchestrator_/
    ```

#### Step 3: Obtain and Enter Machine Key

* Go to the folder where you created the machine.

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

* Click on the machine you created and select the three dots (**...**) (also known as the "**ellipses**" or "**more options**").

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

* Click on **Edit Machine**.

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

* You will see the Machine Key. Copy this key.

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

* Paste both the **Orchestrator URL** and **Machine Key** into UiPath Assistant and click **Connect**.

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

**Note:** UiPath Assistant is a desktop application that acts as an interface between the user and the UiPath robots running on the machine. It allows users to interact with and manage their robots, monitor running processes, and trigger automation tasks.

### **4. Integrating UiPath with ReleaseOwl**

#### Step 1: Register Credential

* **Access Credential Manager:**
  * In the **Administration** section, click on **Credential Manager**.
* **Click on Register Credential:**
  * In the Credential Manager, click on **Register Credential**.
* **Fill in the Credential Details:**
  * **Credential Name:** Enter a name for your credential.
  * **Credential Type:** Select the appropriate credential type.
  * **Token URL:** <https://account.uipath.com.>

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

#### Step 2: Obtain Client ID and Client Secret

* Log in to your **UiPath Orchestrator** account.
* Click on your profile icon and select **Preferences**.

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

* In **Preferences**, go to the **Privacy & Security** section.

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

* Click on **View API Access**.
* Here, you will find your User Key, which acts as both the Client ID and Client Secret.

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

#### Step 3: Register the Credential in ReleaseOwl

* Copy the **Client ID** and **Client Secret** from the View API Access section in UiPath.
* Return to the **Register Credential** page in ReleaseOwl.

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

* Paste the **Client ID** and **Client Secret** into the appropriate fields.
* Click **Save** to register the credential.

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

### **5. Test Configuration in ReleaseOwl**

#### Step 1: Go to Project View

* Navigate to your **Project View** in ReleaseOwl.
* Click on **Test Configurations** and create a new test configuration.

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

#### Step 2: Fill in Necessary Details

* Enter the required details such as **Name**, **Test System**, etc.

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

#### Step 3: Find and Modify Orchestrator URL

* Go to UiPath Orchestrator in your UiPath Cloud account.
* Copy the provided URL and modify it to look like this:

  ```
  https://cloud.uipath.com/releaijylebf/DefaultTenant/orchestrator_/
  ```

#### Step 4: Select Folder and Test Sets

* In the test configuration, select the appropriate **Folder** and **Test Sets**.

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

#### Step 5: Submit and Run the Test

* Click the **Submit** button to save the test configuration.
* Click the **Run** button. A message will confirm that the test execution was successful.

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

#### Step 6: View Test Run Details and Report

* Click on **View Test Run** to see the details of the executed test cases, including the total number of test cases run and their statuses (Passed or Failed).

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

* To view a detailed report, click the **Report** button. The report will include:

  * **Test set details**
  * **Start time**
  * **End time**

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