- Getting started
- Best practices
- Tenant
- About the Tenant Context
- Searching for Resources in a Tenant
- Managing Robots
- Connecting Robots to Orchestrator
- Storing Robot Credentials in CyberArk
- Storing Unattended Robot Passwords in Azure Key Vault (read only)
- Storing Unattended Robot Credentials in HashiCorp Vault (read only)
- Storing Unattended Robot Credentials in AWS Secrets Manager (read only)
- Deleting Disconnected and Unresponsive Unattended Sessions
- Robot Authentication
- Robot Authentication With Client Credentials
- Configuring automation capabilities
- Audit
- Resource Catalog Service
- Automation Suite Robots
- Folders Context
- Automations
- Processes
- About Processes
- Managing Processes
- Managing Package Requirements
- Recording
- Jobs
- Apps
- Triggers
- Logs
- Monitoring
- Queues
- Assets
- Storage Buckets
- Orchestrator testing
- Integrations
- Troubleshooting

Orchestrator user guide
Managing Package Requirements
linkOverview
linkAn RPA journey starts in Studio, the realm of workflows and activities. In designing workflows developers can use various objects, which are typically managed centrally from Orchestrator using folders, which enable you to maintain fine-grained control over your automations and the associated objects.
These objects are essential for a successful process execution. Lacking any of the indicated objects prevents the process from executing successfully.
The Package Requirements tab allows you to identify missing objects and manually add them at the process level. This helps with:
- educating users about process dependencies,
- reducing manual workflow debugging,
- identifying missing objects without the need to switch between Studio and Orchestrator UI.
Figure 1. Package Requirements page
- This feature is compatible with processes that have been created using Studio version 2021.10 and later, in conjunction with activity packs version 2021.10 and later.
- For objects such as connections where the workflow developer specified the purpose of the connection, this information appears in the Description field of the dependencies grid. For example, a workflow may use two Outlook 365 connections to download emails and send an email auto-reply, respectively. In this case, the developer may use the Description field to label the connections as Download emails and Send email.
How Package Requirements Work
link.xaml
files and aggregates their intrinsic objects, such as:
Depending on whether the respective objects are detected or not, there are two Package Requirements tab behaviors:
- Tab turns red - the workflow has some dependencies that are not present in Orchestrator, therefore you need to add them.
-
Tab is empty, displaying that "This package version contains no requirements." - the uploaded package does not have any requirements.
Note: Orchestrator does not automatically detect the requirements for the packages that stored in external feeds.
Package Requirements Statuses
linkGeneral statuses
-
Available - the object is present in Orchestrator. No further action needed.
-
Missing - the object is not present in the current folder in Orchestrator. You can either link it or add it into the corresponding Orchestrator folder, provided you have the proper permissions.
-
Folder not found - the object supposedly exists in an Orchestrator folder that was referenced in the Folder path field of an activity, but:
-
the folder does not exist in Orchestrator. You should add the folder in Orchestrator, use the same name as indicated in the Folder path column, and assign users to it.
-
you do not have access to that folder. You should ask for access to the Orchestrator folder indicated in the Folder Path column.
-
-
Unknown - the object name could not be determined. No available actions to perform. There are several scenarios which may result in an Unknown status:
-
you do not have the correct permissions set for that type of object;
-
a workflow activity references a queue item, for example, which cannot be linked to its queue.
Note: The unknown status of an object does not prevent the process from executing successfully.
-
Trigger statuses
In addition to the general statuses, triggers display the following statuses:
-
Pending creation - adding a trigger requires associating it to an existing process. While the process gets created, the trigger resides in Orchestrator memory and it becomes active after the process creation. You can edit triggers from the package requirements tab while they have this status. Later on, you have the option to edit them from the Triggers page.
-
Invalid configuration - the selected runtime is not available.
-
Duplicate name - the trigger name is duplicated.
Permissions
linkTo manage package requirements, you need the following permissions:
I want to ... |
I need ... |
The folder access I need ... |
---|---|---|
... see the available packages |
View permissions on Packages (tenant level) |
Not applicable, as Packages permissions are set at tenant level. |
... upload a package |
Create permissions on Packages (tenant level) |
Not applicable, as Packages permissions are set at tenant level. |
... see the available objects |
View permissions on the specified object |
Get access to the folder(s) that contains the object. |
... add an object |
Create permissions on the specific type of object |
Get access to the folder(s) you want to add the object to. |
... import an object from a different folder |
Create and View permissions on the specific type of object |
Get access to:
|
Managing Missing Objects
linkFor each missing object, except action catalogs, you have the option to add it or to import it in the current folder, provided you have the necessary permissions.
Adding a Missing Object
Prerequisites: Make sure you have Create permissions on the specific object and access to the folder you want to add the object to.
- To add a missing object, click the corresponding Add button. The Create [object] page opens.
- Configure the object as needed. The name field is prefilled with the missing object name and cannot be edited. This restriction applies to respect the object name used in the workflow.
Importing a Missing Object
If you suspect the missing object exists in the current tenant, but in a different folder, you can import it into the current folder.
Prerequisites: Make sure your have View and Create permissions on the specific object, and access to both the folder you are importing from, and the folder you are importing the object to.
- To import an object from a different folder, click the corresponding Import button. The Link [objects] from other folders page opens, displaying two tabs:
- If the object exists in other folder(s), it appears on the Select [object] tab. Select it.
- Click Continue to navigate to the Folder validation tab.
After selecting the object, the Folder validation tab displays the source folder(s) you can import from.
- If the object exists in multiple folders and you have selected all copies in the previous step, you are now prompted to keep only one source folder.
- Remove the object copies associated to the folders that you do not need to import from.
- Click Link to import the object into the folder indicated in the Folder Path column.
- After adding or importing an object, you are redirected to the Package Requirements tab to continue adding or importing the missing ones. Notice the statuses changed for the objects that have been added or imported.
In the case of multi-layered process dependencies, Orchestrator detects and shows only the first level dependency for a given process.
For example, process A needs process B to start, and process B needs process C to start. The dependency hierarchy is A > B > C. In this case, when checking package requirements for process A, Orchestrator detects and displays the first level of dependency for it, that is process B. If process B is missing, you can add it from the Package Requirements tab, but if process C is missing, you need to identify it as missing yourself and add it manually.
Adding Action Catalogs
Orchestrator detects the action catalogs required to execute the process, but you cannot add the missing ones from the Package Requirements tab, as action catalogs are objects configurable via Action Center.
Prerequisites: Make sure you have Create permissions on the specific object and access to the folder you want to add the object to.
Proceed with the following steps:
- Head over to the corresponding Action Center instance.
- Access the Admin Settings page.
- Select the process folder .
- Click Add new catalog. Make sure to use the name detected as missing in the Package Requirements tab.
- Click Create.
Adding time and queue triggers
- Go to Automations > Processes and click Add process.
- Select the package that contains the time trigger activity.
- Input the required runtime arguments, then click Next.
- The package requirements page displays the time trigger with the Missing status. Select the Add trigger button to configure the time trigger.
- Configure the trigger properties as instructed on the Creating time triggers/Creating queue triggers page. The time/queue trigger status changes to Pending creation.
-
Select Next to continue configuring the process, and then select
Create.
Once the process is created, the time/queue trigger appears in the Time/Queue Triggers grid in Orchestrator.
You have the option to add a queue during the creation of a missing queue trigger. Be aware that doing so restricts you from adding SLAs to the queue until the trigger is created.
Figure 2. Adding queues from the queue trigger creation page
Adding event triggers
- Go to Automations > Processes and click Add process.
- Select the package that contains the event trigger activity.
- Input the required runtime arguments, then click Next.
- The package requirements page displays the event connection identified in the package. Select a connection or add a new one.
- The event trigger shows up under the corresponding connection, having the Pending creation status. Click the pencil icon to edit your event trigger.The Edit Event Trigger page opens.This step is optional. Default selections apply if ignored.
- Configure the trigger properties as instructed on the Creating an event trigger page.
Customizing User Configurations
linkWhen an event trigger has the Configurable by users option selected, your users can set their own connections at runtime, in UiPath Assistant.
The Custom user configurations page lists the event trigger configurations set by your users.
Exploring the personal workspace of a user
-
Setting a configuration for your users implies exploring the personal workspace of the selected user.
-
To add connections on behalf of your users, you need to see their personal connections, which reside in their Personal Workspace folder.
-
Users receive an alert whenever you begin or end exploring their personal workspace.
User configuration statuses
These statuses help you identify which users has a faulty configuration:
Configured - the user has a working configuration.
Partially configured - the user has a faulty configuration, which may imply missing connections.
Accessing the Custom user configurations page
You can access the Custom user configurations page from both the Processes and the Event Triggers pages.
- In the selected folder, go to:
Option Description Automations > Triggers > Event triggers A list of all available event triggers is displayed. Automations > Processes A list of all available processes is displayed. - For the desired process/event trigger, click the More Actions button, and then select Custom user configurations. This redirects you to the Custom user configurations page.
Adding a new user configuration
- For the desired process or event trigger, access the Customer user configurations page.
- In the Package requirements configurations per user account section, click Add user configuration. The Configure process requirements for user account wizard opens.
- From the User account dropdown, select the user for which you want to configure the process or the event trigger, then click Add user.Note:
- The selected user must be in the same folder as the process/event trigger. Otherwise, you are prompted to assign the user in the folder.
- If, in the meantime, you remove users from the folder, their user configuration continues to show up in the list.
- A pop-up message informs you about the need to explore the personal workspace of the selected user.
- Provide the required details, such as connections or activity filters.
- Save the configuration.
Overriding an existing user configuration
- For the desired process or event trigger, access the Customer user configurations page.
- For the desired user account, click Edit configuration.
- Modify the required details, such as connections or data filters.
- Update the configuration by clicking Save.
In Assistant, users with proper Resource Overwrites permissions can always update the settings you have configured.
Removing the event trigger configuration of a user
To remove the event trigger configurations of your users:
- For the desired process or event trigger, access the Customer user configurations page.
-
For the desired user account, click Clear configuration. This operation
clears the configurations of the selected user.
If a user has their configurations removed, the process may not run as expected.Note:
To make changes on the Customer user configurations page, the following permissions are required:
- At the event trigger level, this operation requires Edit permissions on Resource overwrites, and View permissions on Triggers.
- At the process level, this operation requires Edit permissions on Resource overwrites, View and Edit permissions on Processes.
- Overview
- How Package Requirements Work
- Package Requirements Statuses
- General statuses
- Trigger statuses
- Permissions
- Managing Missing Objects
- Adding a Missing Object
- Importing a Missing Object
- Adding Action Catalogs
- Adding time and queue triggers
- Adding event triggers
- Customizing User Configurations
- Exploring the personal workspace of a user
- User configuration statuses
- Accessing the Custom user configurations page
- Adding a new user configuration
- Overriding an existing user configuration
- Removing the event trigger configuration of a user