- 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
- Solutions
- Audit
- Settings
- Cloud robots
- Folders Context
- Automations
- Processes
- About Processes
- Managing Processes
- Managing Package Requirements
- Recording
- Jobs
- Apps
- Triggers
- Logs
- Monitoring
- Queues
- Assets
- Business Rules
- Storage Buckets
- Orchestrator testing
- Resource Catalog Service
- Integrations
- Troubleshooting

Orchestrator user guide
Managing Package Requirements
An 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.
.xaml
files and aggregates their intrinsic objects, such as:
- storage buckets
- assets
- queues
- queue, time, and event triggers
- other processes
- action catalogs
- connections
- business rules
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.
-
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.
-
-
Invalid filters - the filters of a connection are unconfigured.
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.
To 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:
|
For each missing object, except action catalogs and connections, you have the option to add it or to import it in the current folder, provided you have the necessary permissions.
Prerequisites: Make sure you have Create permissions on the specific object and access to the folder you want to add the object to.
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.
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.
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.
- In the folder context, navigate to Automations and select Processes, then Add process.
- Select the package that contains the event trigger activity.
- Select the entry point and enter the required runtime arguments, then select Next.
- The Package Requirements page displays the event connection identified in the package. Select a connection or add a new one. For details, refer to Configuring connections.
- The event trigger shows up under the
corresponding connection, and has the Pending creation status. To edit the
event trigger, select the pencil icon. The Edit Event Trigger page opens.
Note: This step is optional. If you skip it, the default selections apply.
- Enter a unique name for your trigger in the Name field. If the trigger name already exists, you receive an error message and must change the name.
- From the Job Priority dropdown menu, select the priority of the job. The default value is Inherited, meaning that the job priority is the same as the one defined for the selected process.
- From the Runtime type dropdown menu, select the runtime for executing the jobs that the trigger launches. If you want to use an unattended runtime, we recommend not setting the connection as Configurable by users.
- In the Execution Target
section, to select a job termination strategy, enable the Schedule ending of job
execution toggle.
Note:
The amount of time you specify elapses according to the specifications, even if the job is queued. For example, if you schedule a job to run at 1 p.m. and set it to stop after 20 minutes, the job stops at 1:20 p.m. even if it had been in a queue until 1:15 p.m., and then started.
Additionally, if you opt to stop a pending or running job after two hours and kill the same job after three hours, the job is killed after five hours. This happens because, first, Orchestrator receives the signal that the job was stopped after two hours. Upon receiving the signal, Orchestrator times the kill action to occur in three hours, thus resulting in a total of five hours.
You have the following options:
- Select Stop from the dropdown menu: This option initiates an attempt to gracefully end the job execution when the job has been in a pending or running state for the amount of time you set. You can set a minimum interval of one minute, and a maximum interval of 10 days, 23 hours and 59 minutes.
- Select Kill from the dropdown menu: This option initiates an attempt to forcefully end the job execution when the job has been in a pending or running state for the amount of time you set. You can set a minimum interval of one minute, and a maximum interval of 10 days, 23 hours and 59 minutes.
- Select Stop from the dropdown menu and enable the If the job does not stop, kill it option. This option initiates an attempt to gracefully end the job execution when the job has been in a pending or running state for the amount of time you set for the stop action. If the attempt results in the job remaining in a stopping state, Orchestrator then attempts to kill the job after the amount of time you set for the kill action. You can set a minimum interval of one minute, and a maximum interval of 10 days, 23 hours and 59 minutes.
-
To receive an alert if a job has remained in a pending or resumed state for a
certain amount of time, enable the Generate an alert if the job is stuck in
pending or resumed status toggle and set the acceptable duration for the
job to remain in a pending or resumed state. The minimum configurable duration
is one minute, and the maximum duration is eleven days. If the job exceeds the
configured duration, an error-severity alert pop-up appears, with the following
text: "N jobs for #process {process_number} have been pending or resumed for
more than X hours and Y minutes.", where:
N
is the number of jobs that triggered the alert.{process_number}
is the process identifier.X
is the configured number of hours that the job exceeded while in a pending or resumed state. Days are converted to hours.Y
is the configured number of minutes that the job exceeded while in a pending or resumed state.
-
To receive an alert if a job has not completed within a set interval, enable
the Generate an alert if the job started and has not completed toggle and
set the acceptable duration for the job to complete. The minimum configurable
duration is one minute, and the maximum duration is eleven days. If the job
exceeds the configured duration, an error-severity alert pop-up appears, with
the following text: "Job for #process {process_number} has been running for more
than X hours and Y minutes.", where:
{process_number}
is the process identifier.X
is the configured number of hours that the job exceeded without completing. Days are converted to hours.Y
is the configured number of minutes that the job exceeded without completing.
- To keep the same account-machine context configured for starting the job, select Keep Account/Machine allocation on job resumption. Selecting this option optimizes your license and resource usage.
- In the Runtime Arguments section, select an entry point from the dropdown menu and provide appropriate values for process arguments, then select Update to save the event trigger configuration.
- To continue configuring the process, select Next. When you are done, select Create.
Execution-based trigger disabling applies only to event triggers published from Studio Web to personal workspaces.
-
Triggers - Connected triggers - Disable when job execution fail count
-
Triggers - Connected triggers - Grace period when job execution keeps failing count (days)
Once the process is created, the event trigger appears in the Event Triggers grid, with the Connected value in the Type column.
Orchestrator allows specifying the account used in a connection when creating a new process or editing an existing one.
-
View permissions on Connections
-
View, Edit permissions on Personal Workspaces
-
View, Edit permissions on Resource Overwrites
When 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.
-
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.
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.
- 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
- Configuring connected event triggers
- Configuring Connections
- 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