Skip to content
Menu

Articles

UiPath Orchestrator: Complete guide [2021]

Complete UiPath Orchestrator guide: Connect your robot, publish packages, create processes, run jobs, schedule triggers, and manage queues and assets.

Anders Jensen Automation & AI Instructor

Archive article, published in 2022. This content is preserved as a historical record and has not been updated for current product versions, prices, or terms.

Login to Orchestrator

  1. Open a browser and go to the UiPath Automation Cloud https://cloud.uipath.com
UiPath Automation Cloud: Home page with the tenant under Orchestrator Services highlighted
Fig 1.1 - Automation Cloud

2a. Under 'Orchestrator Services', click your tenant (Fig 1.1). You're now logged into UiPath Orchestrator and can go to Step 3. If you couldn't do this, go to Step 2b.

UiPath Automation Cloud: Create New under Orchestrator Services when no tenant exists yet
Fig 1.2 - Create new tenant

2b. In case you see the 'Create New' under Orchestrator Services (Fig 1.2), it means you haven't created a tenant yet. Don't worry; we'll do that very easily. Click 'Create New'.

UiPath Automation Cloud Admin: Tenants page with the Add Tenant button highlighted
Fig 1.3 - Add tenant

2c. Click the blue 'Add Tenant' in the upper right corner.

UiPath Automation Cloud: Add Tenant panel with tenant name and selected services
Fig 1.3 - Give your tenant a name

2d. A pop-up window will open to the right (Fig 1.3). Give your tenant a name. Make sure you have ticked 'Actions' and 'Processes'. 'Data Service', which is an easy and secure way to store your business's data, is optional, and it doesn't matter to this guide (if you untick, you can very easily tick it later). Remember to click the blue 'Save' in the lower right corner.

UiPath Automation Cloud: New tenant in the list with the Orchestrator link highlighted
Fig 1.4 The Created tenant

2e. The tenant is created and click the blue 'Orchestrator' next to your tenant name to enter UiPath Orchestrator.

UiPath Orchestrator: Home dashboard for My Workspace with no processes or jobs yet
Fig 1.5 - UiPath Orchestrator

3. You're now logged into UiPath Orchestrator.

Connect UiPath with Orchestrator

The connection between Orchestrator and UiPath/a robot can be made manually or automatically. This guide will show how to do it automatically since we try to avoid manual work.

Windows 10 Start menu with an arrow pointing to the Start button
Fig. 2.1 - Start Menu
  1. Go to your start menu (Fig. 2.1).
Windows search: Typing uipath assistant shows the UiPath Assistant app as best match
Fig. 2.2 - Search for UiPath Assistant

2. Type "UiPath Assistant" and open the application (Fig. 2.2).

UiPath Assistant open on the desktop, with an arrow pointing to the Windows tray
Fig. 2.3 - An Open UiPath Assistant

3. UiPath Assistant will now be visible. If not go find it in the Windows tray (red arrow in Fig. 2.3).

UiPath Assistant: Sign in button highlighted on the Please sign in to your account screen
Fig. 2.4 - Click sign in

4. Click the blue 'Sign In' button (Fig. 2.4) and a browser will open.

UiPath Sign In page in the browser with Google, Microsoft, LinkedIn and email options
Fig. 2.5 - Sign in

5. Sign in to your UiPath account, you've created when you've downloaded UiPath (Fig. 2.5).

Browser dialog Open UiPath? with the Open UiPath button highlighted
Fig. 2.6 - Click Open UiPath

6. Click 'Open UiPath' in the pop-up message in your browser (Fig. 2.6).

UiPath Assistant connected to Orchestrator, shown by the green status dot
Fig. 2.7 - Connected

7. If you see the green light in your UiPath Assistant (Fig. 2.7), you have now successfully connected Orchestrator with UiPath and are ready to run your robots. If you see an error message, please go to User authentication troubleshooting below and solve it.

User authentication troubleshooting

If you get the error message "Interactive sign-in is not enabled for this tenant, Enable it from the Orchestrator settings, or connect using the machine key", we need to enable the interactive sign-in.

UiPath Assistant error: Interactive sign-in is not enabled for this tenant, with OK highlighted
Fig. 2.8 - Interactive sign-in is not enabled
  1. Click 'OK' to the error message (Fig. 2.8). Then open a browser and go to https://cloud.uipath.com.
UiPath Automation Cloud: Click the tenant under Orchestrator Services to open Orchestrator
Fig. 2.9 - Click tenant

2. Click your tenant (Fig. 2.9).

UiPath Orchestrator: Tenant in the left menu and Settings in the top menu highlighted
Fig. 2.10 - Settings

3. Make sure you click the 'Tenant' in the upper left corner and then 'Settings' in the upper right corner (Fig. 2.10).

UiPath Orchestrator Settings: Security tab with Allow both user authentication and robot key authentication
Fig. 2.11 - Allow user authentication

4. Click the 'Security' button, then make sure 'Allow both user authentication and robot key authentication' is activated, and finally click 'SAVE'. You can now take this chapter again and succeed in automatically connecting Orchestrator and UiPath.

Publish a project to Orchestrator

UiPath Studio: Input Dialog and Message Box workflow with the Publish button highlighted
3.1 - Publish your workflow to Orhcestrator
  1. Create a workflow in UiPath Studio. I'm using this workflow with an Input Dialog and a Message Box to show later that we have a connection both ways. When you're done with the first version, click 'Publish' (Fig 3.1).
UiPath Studio Publish Process: Package properties with name and version, Publish options highlighted
Fig 3.2 - Publish properties

2. Give your package a name (or leave it the same as your workflow). You can choose an optional icon for better identification later in Orchestrator and release notes. When finished, click 'Publish options'.

UiPath Studio Publish Process: Publish to dropdown with Orchestrator Tenant Processes Feed
Fig 3.3 - Publish options

3. In the 'Publish to' click the dropdown menu, choose 'Orchestrator Tenant Processes Feed' and click 'Publish' in the lower right corner.

UiPath Studio Info dialog: Project published successfully, version 1.0.1
Fig 3.4 - Project published succesfully

4. You've now published your project to Orchestrator.

Assets

An asset is stored in Orchestrator. That can be a name (e.g. NewsletterURL) and a corresponding value (e.g. https://andersjensen.org/email-newsletter). This asset can be retrieved by multiple UiPath workflows. What's even more useful is that assets can be stored as a credential (username/password) and securely stored in Orchestrator (encrypted with AES 256). Once a password is typed in for a credential asset, it can be accessed further - convenient if multiple users have access to the same Orchestrator tenant.

String Assets

Create a string asset in Orchestrator

UiPath Orchestrator: Assets tab highlighted in a folder with no assets yet
Fig. 4.1 - Click 'Assets' in the folder
  1. Assets can be limited to a folder or can be shared amongst folders. Here an asset in the Hafnia folder is created. In your chosen click 'Assets' (Fig. 4.1).
UiPath Orchestrator: Assets page with the blue plus button highlighted
Fig. 4.2 - Click the '+'

2. Click the blue/white '+' icon to the right (Fig. 4.2).

UiPath Orchestrator Assets: Expanded plus menu with the add asset button highlighted
Fig. 4.3 - Click the '+' icon to add a new asset.

3. To add a new asset click the blue/white '+' icon again (Fig. 4.3).

UiPath Orchestrator Add Asset: Text asset NewsLetter with a newsletter URL as global value
Fig. 4.4 - Add values for the asset you want to create

4. Now, fill in the name you want to give your asset in 'Asset name' (Fig. 4.4). Please give it a describing name. I've chosen the name "NewsLetter". In the drop-down menu, choose "Text" as the type. Text here is the same as a string in UiPath/.NET. The description of your asset is optional. If Global Value is enabled, every user will receive the asset unless overridden in the table below. If Global Value is disabled, only the users specified in the table below will receive it. Under 'Text *', fill in the value of your asset. That could, e.g., be a folder name or a phone number that you want to share among projects. When finished, click 'Create'.

UiPath Orchestrator Assets: The new NewsLetter text asset listed with its URL value
Fig. 4.5 - Asset is created

5. Your asset is now created and you can call it in UiPath by referring to its name "Newsletter" (Fig. 4.5).

Credential Assets

Create a credential asset in Orchestrator

UiPath Orchestrator: Assets tab highlighted in a folder with no assets yet
Fig. 4.6 - Click 'Assets' in the folder
  1. Assets can be limited to a folder or can be shared amongst folders. Here an asset in the Hafnia folder is created. In your chosen click 'Assets' (Fig. 4.6).
UiPath Orchestrator: Assets page with the blue plus button highlighted
Fig. 4.7 - Click the '+'

2. Click the blue/white '+' icon to the right (Fig. 4.7).

UiPath Orchestrator Assets: Expanded plus menu with the add asset button highlighted
Fig. 4.8 - Click the '+' icon to add a new asset.

3. To add a new asset click the blue/white '+' icon again (Fig. 4.8).

UiPath Orchestrator Add Asset: Credential asset LinkedInLogin with username and password fields
Fig. 4.9 - Add values for the credential asset, you want to create

4. Give your asset a name (Fig. 4.9). This is the name you will use in UiPath to get the Asset from Orchestrator. In the drop-down menu, choose "Credential" as the type. You can give the asset an optional description. If Global Value is enabled, every user will receive the asset unless overridden in the table below. If Global Value is disabled, only the users specified in the table below will receive it. Under "Username*" and "Password*" specify the username and password you want to use in the credential asset. When finished, click 'Create'.

UiPath Orchestrator Assets: Credential asset LinkedInLogin stored in the credential store
Fig. 4.10 Credential Asset is created

5. Your credential asset is now created and you can call it in UiPath by referring to its name "LinkedInLogin" (Fig. 4.10).

Robots

How to create an unattended robot

An unattended robot can run without the user starting the automation (clicking Start in the UiPath Assistant). The unattended robot can be started by a trigger (e.g., at a certain time, which can be recurring or when a new item has been added to an Orchestrator queue).

To create an unattended robot make sure you have:

UiPath Orchestrator: Tenant in the left menu and the Folders tab highlighted
Fig 5.1 - Click Tenant and Folders

1. Click 'Tenant' in the upper right corner and then 'Folders' (Fig 5.1)

UiPath Orchestrator Folders: Manage Folders with the create folder icon highlighted
Fig 5.2 - Create a new folder

2. Create a new folder by clicking the icon showed in Fig 5.2.

UiPath Orchestrator: New Folder dialog with a folder name and the Create button
Fig 5.3 - Name folder

3. Give your folder a name you like and click 'Create' (Fig 5.3).

UiPath Orchestrator: Users tab with Edit in a user's menu highlighted
Fig 5.4 - Edit User

4. Click 'Users', find your user, click the three dots to the right and click 'Edit' (Fig 5.4).

UiPath Orchestrator Edit User: Roles dropdown highlighted with no role selected
Fig. 5.5 - Roles dropdown

5. Click the 'Roles' dropdown (Fig. 5.5).

UiPath Orchestrator Edit User: Allow to be Automation User ticked, Unattended Robot highlighted
Fig. 5.6 - Allow to be Automation User

6. Tick 'Allow to be Automation User' and aftwards click 'Unattended Robot' (Fig. 5.6).

UiPath Orchestrator Edit User: Automatically create an unattended robot for this user switched on
Fig. 5.7 - Automatically create an unattended robot for this user

7. Slide the button at 'Automatically create an unattended robot for this user' so it becomes blue (Fig. 5.7).

Windows 10 Start menu with an arrow pointing to the Start button
Fig. 5.8 - Start Menu

8. Now go to your start menu (Fig 5.8).

Windows search: Typing cmd shows Command Prompt as best match
Fig. 5.9 - Comand Prompt

9. Search for 'cmd' and click to open it (Fig. 5.9).

Windows Command Prompt: The whoami command returns the machine and user name
Fig. 5.10 - whoami

10. In the command prompt, type in "whoami" and click Enter. Underneath, select the 'desktop-kgjkmkhanders jensen' (yours will be named after your desktop) and copy it (ctrl+c) (Fig. 5.10).

UiPath Orchestrator Edit User: Domain\Username and Password filled in for the unattended robot
Fig. 5.11 - Fill in the information for the Unattended Robot

11. Paste it (ctrl+v) into 'DomainUsername' and type your Windows password in 'Password'. Now you can click Update (Fig. 5.11).

UiPath Orchestrator: Machines tab with Edit Machine in the machine's menu highlighted
Fig. 5.12 - Edit Machine

12. Click 'Machines', then the three dots to the right and 'Edit Machine' (Fig 5.12).

UiPath Orchestrator Edit Machine: Unattended Runtimes set to 1 and the Update button
Fig. 5.13 - Assign an Unattended Runtime

13. Assign an Unattended Runtime under 'License - Unattended Runtimes' by typing in 1. Click 'Update' (Fig. 5.13).

UiPath Orchestrator Folders: A folder's Machines tab with the manage machines button highlighted
Fig. 5.14 - Manage Machine

14. Click back to 'Folders', click 'Anders' (or your folder name), then 'Machines' and finally the 9 white dots on the blue (Fig. 5.14).

UiPath Orchestrator: Manage Machines in Folder with the machine ticked and Update highlighted
Fig. 5.15 - Add machine

15. Tick the box next to your machine and click 'Update' (Fig. 5.15).

UiPath Orchestrator: Folder selected, with the Automations tab and plus button highlighted
Fig. 5.16 - Add Package

16. Click your folder, then 'Automations' and the '+' sign (Fig. 5.16).

UiPath Orchestrator Add Process: Package UnattendedRobotDemo chosen, with Continue highlighted
Fig. 5.17 - Choose Package

17. Choose the package you want to run and then click 'Continue' (Fig. 5.17).

UiPath Orchestrator Add Process: Additional Settings with the Create button highlighted
Fig. 5.18 - Create Process

18. Click 'Create' (Fig. 5.18).

UiPath Orchestrator Processes: UnattendedRobotDemo listed with the play icon highlighted
Fig. 5.19 - Run the Unattended Robot

19. Click the play icon to run your unattended robot (Fig. 5.19).

UiPath Orchestrator Start Job: Job type set to Unattended and the Start button highlighted
Fig. 5.20 - Start

20. Make sure you have selected 'Unattended' in Job type and then click 'Start' (Fig. 5.20).

UiPath Orchestrator: Command sent, and the unattended robot opens the Your name input dialog
Fig. 5.21 - Succes

21. Congratulations, you've now made your unattended robot (Fig. 5.21).

Queues and Transactions

Questions about Orchestrator

Get help with your UiPath Orchestrator questions in I Love Automation.

Comments (9)

  1. Priyanka Pandey

    Great article for those who are new to UiPath. This is the 1st article I found where someone has given the detail of how to create robot in 2021 version.

    1. Anders Jensen Author

      Thanks a lot, Priyanka. Let me know if you have any questions in the process. I'll try to update the article over the next weeks. Have a great weekend. Kind regards, Anders

  2. Thomas Allweyer

    Thanks for this useful tutorial! The UIPath Orchestrator is very confusing for a beginner, and there isn't any helpful explanation on the offical website.

    1. Anders Jensen Author

      Hey Thomas. I'm happy you could use the tutorial. My aim is always to make it as simple as possible. Sometimes that cost a bit on the theoretical side, but then we can turn to the documentation :) Kind regards, Anders

  3. Prabu

    Hello Anders.. Nice Article. Can you please post Orchestrator 2021 upgrade steps ? We need to know any prerequisite is required before upgrading. Currently we are using 2019 version. It would be great, if we get step by step upgrade process.

    1. Anders Jensen Author

      Thanks a lot, Prabu. I'm working on an update

  4. Mazhar

    Thanks a lot Anders, awsome job, very helpful. Can you please tell me, if you have four tanents, to connect with other tanent, what will be the procedutre. I tried but still working on it.

  5. Cansu

    Hi Anderson, I follow the very useful videos and articles of the shares with interest. How should we prepare a checklist to ensure that Uipath Orchestrator progresses in a healthy way, how should we be prepared for error and trouble situations? Can you help with this?

    1. Anders Jensen Author

      Hey Cansu. Thanks a lot for writing You're more than welcome on my Discord. It's free, and we're more than 3100 RPA developers ready to help you (and each other): https://andersjensen.org/#community Kind regards, Anders

Write a comment

Your name and comment are shown publicly once approved. Your email is not shown. Read more in the privacy policy. Once approved, the comment may be machine-translated for the other language version. The original is always available.

More articles

  • How to extract data with RegEx in UiPath

    RegEx is a sequence of characters that defines a search pattern. As UiPath RPA developers, we use it to extract data from emails and invoices. Here is how.

    Read more →
  • How to Type Into Applications/Web with UiPath

    Learn everything about the Type Into activity in UiPath: simulate keystrokes, send window messages, handle special keys, and pick the right input method.

    Read more →
  • UiPath: Excel vs Workbook activities

    When you work with Excel in UiPath, you can use Excel or Workbook activities. Here are the pros and cons, so you can choose the right one for your robot.

    Read more →