How to use Robolytix with UiPath

Robolytix is the key online analytic and monitoring tool for Robotic Process Automation using Sonar technology to evaluate, audit, monitor and improve performance of robots operating on any application or RPA platform. This tutorial will guide you to analyze you processes in UiPath.

UiPath platform for robotic process automation. It is a complete software solution that enables you to automate your back office repetitive tasks. It converts tedious tasks into complete UI automation, thus, making your work easier and faster. It allows you to create a Workflow that will help you model processes of your business operations. They are a great way to setup automation with little or no knowledge about programming.


To use Robolytix with UiPath, it is necessary to have a Robolytix account. If you do not have one, you can create the account at and make basic settings using the onboarding wizard. 

Video Tutorial

Use Robolytix library package

We have prepared library containing Robolytix connector for UiPath. You can install it by Packages Manager which is part of UiPath Desktop.

  1. Click on Manage Packages button in top menu and open manager.
  2. Search for "Robolytix".
  3. Select Robolytix library and click install.
  4. Click Save button and close manager.

Connect UiPath to the Robolytix

To connect your Robolytix account to UiPath, you must provide access to processes in your account. In UiPath, the best way to do it is by using variables. Create three following variables:

  • robolytix_apikey - Stores key for validating API requests
  • robolytix_processid - Identification of selected process in Robolytix
  • robolytix_runid - Identification of one process execution
Create variables for storing identifiers

You must obtain API key for setting up the connection. To get your key, log in to your Robolytix account and generate it in settings menu. See detailed walkthrough Obtain API key.

  1. From the left navigation menu, select Settings. On the Settings page, select API keys in the menu and then click on New API key button. 
  2. Copy the unique key and set value of robolytix_apikey to this key. 
Creating API Key In Robolytix

Now create process in Robolytix and set value of robolytix_processid to process GUID. It is located in Settings ->Process -> General tab. You can create new process in Robolytix by following detailed guide Setting up processes in Robolytix.

Keep default value of robolytix_runid empty. The first Sonar in process will set its value.

Use Sonars in UiPath

Process monitoring is performing by using Sonar checkpoints. The Sonars are at the beginning of the process, at all ends of the process, and at main branches in the process.  Each Sonar embedded in the process contains the following settings:

  • Name 
    The name of the Sonar should reflect the state of the process and clearly describe surrounding step in the process. 
  • Process 
    Select a process from the list. The list contains all processes from your Robolytix account. If you don’t see your process in the list, make sure the process you want is already existing in your Robolytix account. 
  • Type 
    The type of Sonar determines its location within the process and must be one of the following values:
    | Start | is the first checkpoint in the process. 
    | Continuous | are checkpoints anywhere in the process. Of course, more continuous Sonars means more advanced statistics. 
    | End | is the last checkpoint in the process. The process can have one or more “end” Sonars in different branches of the process. 
    | Error | is special type designed to receive error information about process exceptions.
  • Run identification
    For advanced reporting, we recommend identifying each separate run process by a unique identifier. The unique identifier can be a variable generated by “start” Sonar and passed to all other Sonars in the process.
Process with implemented Sonars

Add Sonar action to your processes

Now you can add Sonars to your processes. First step is to add Sonar with type start to the beginning of the process. Set field Name properly with clear description and choose your process in Robolytix. You can create new process in Robolytix by following detailed guide Setting up processes in Robolytix.

Properties window for Sonar action

Second step is to mark end of the process. Add Sonar with type end and set value for parameter Run identification to variable robolytix_runid.

Sonar in UiPath

Now you can add as many Sonars as you want. Good practice is to add Sonar to each important branch and each big loop in you process. Use Sonar type common, or type error for handling errors.

Show your data in Robolytix

Robolytix messages list
Robolytix messages list

After proper process execution go to Robolytix platform and check process statistics. It is possible to show all recent messages sent to specified process. Go to Settings -> Processes menu and select list of process messages.

When you have any problems with implementation look at the Robolytix Demo task. There is also Robolytix Support Forum for following questions.

Robolytix is a real-time management analytic tool for business processes operating in any application or custom solution.

Stay in touch

Microsoft AwardsAI Awards 2019 logo
envelopeearth linkedin facebook pinterest youtube rss twitter instagram facebook-blank rss-blank linkedin-blank pinterest youtube twitter instagram