- Release notes
- Installation and upgrade
- Before you begin
- Getting started
- Activities
- Designing long-running workflows
- Start Job And Get Reference
- Wait For Job And Resume
- Add Queue Item And Get Reference
- Wait For Queue Item And Resume
- Create Form Task
- Wait For Form Task And Resume
- Resume After Delay
- Assign Tasks
- Create External Task
- Wait For External Task And Resume
- Complete Task
- Forward Task
- Get Form Tasks
- Get Task Data
- Add Task Comment
- Update Task Labels
- Actions
- Processes
- Audit
Create External Task
UiPath.Persistence.Activities.ExternalTask.CreateExternalTask
Creates an External Action with the given data, task title, task priority, and task catalog.
Designer panel
- TaskTitle - The title of the action you want to create. This field supports strings and
String
variables only. - TaskPriority - Enables you to select the priority level of the action. By default, this property is set to TaskPriority.Medium The following options are available: TaskPriority.Low, TaskPriority.Medium, TaskPriority.High, TaskPriority.Critical.
- TaskCatalog - An optional business classification of task items. This field supports strings and
String
variables only. - TaskData - A collection of business data, in the form
Dictionary<String,Argument>
, that you want to store in a given action. ModifyingOut
andIn/Out
arguments maps them back to the workflow after the action is completed. This field supportsDictionary<String,Argument>
objects only. - TaskObject(Output) - The task object that is returned from Orchestrator as an
ExternalTaskData
object after the action is created. This object can be passed to the Wait for External Task and Resume activity in order to suspend the execution of the workflow until the action is completed.
Properties panel
Common
- ContinueOnError - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
- DisplayName - The display name of the activity.
- TimeoutMS - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).
Input
- External Tag - A tag that can be used to identify the external system which is the source for the data in the given action. This field
supports strings and
String
variables only. - Labels - The robot adds the inputted labels to the action, allowing future filtering. This field supports string values only and has naming restrictions.
- Orchestrator Folder Path - The path to an Orchestrator Folder different to the one the current process operates in, where you want to create the task. To read more on Orchestrator Folders,
go here. For Classic folders, this property can only be used with Floating Robots and only if the current user has the correct task privileges in the target folder. For Modern folders, folder path overriding is not supported. This field supports strings and
String
variables only.
- TaskCatalog - An optional business classification of task items. This field supports strings and
String
variables only.
- TaskData - A collection of business data, in the form
Dictionary<String,Argument>
, that you want to store in a given action. ModifyingOut
andIn/Out
arguments maps them back to the workflow after the action is completed. This field supportsDictionary<String,Argument>
objects only. - TaskPriority - Enables you to select the priority level of the action. By default, this property is set to TaskPriority.Medium The following options are available: TaskPriority.Low, TaskPriority.Medium, TaskPriority.High, TaskPriority.Critical.
- TaskTitle - The title of the action you want to create. This field supports strings and
String
variables only.
Misc
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
Output
- TaskObject(Output) - The task object that is returned from Orchestrator as an
ExternalTaskData
object after the action is created. This object can be passed to the Wait for External Task and Resume activity in order to suspend the execution of the workflow until the action is completed.
- TaskTitle - The title of
the action you want to create. This field supports strings and
String
variables only. - TaskPriority - Enables you to select the priority level of the action. By default, this property is set to TaskPriority.Medium The following options are available: TaskPriority.Low, TaskPriority.Medium, TaskPriority.High, TaskPriority.Critical.
- TaskCatalog - An optional
business classification of task items. This field supports strings and
String
variables only.
- TaskData - A collection of
business data, in the form
Dictionary<String,Argument>
, that you want to store in a given action. ModifyingOut
andIn/Out
arguments maps them back to the workflow after the action is completed. This field supportsDictionary<String,Argument>
objects only. - TaskObject(Output) - The
task object that is returned from Orchestrator as an
ExternalTaskData
object after the action is created. This object can be passed to the Wait for External Task and Resume activity in order to suspend the execution of the workflow until the action is completed.
Advanced options
Common
- ContinueOnError - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
- TimeoutMS - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).
Input
- Labels - The robot adds the inputted labels to the action, allowing future filtering. This field supports string values only and has naming restrictions.
- Orchestrator Folder Path -
The path to an Orchestrator
Folder different to the one the current process operates in,
where you want to create the task. To read more on Orchestrator Folders, go
here. For
Classic folders, this property can only be used with Floating
Robots and only if the current user has the correct task privileges in
the target folder. For Modern folders, folder path overriding is not
supported. This field supports strings and
String
variables only.
- Reference - A tag that you
can use to identify the external system which is the source for the data in the
given action. This field supports strings and
String
variables only.
Creating external actions
To create an External Action choose between the following procedures:
-
Add a Create External Task activity into your workflow and provide information for the following property fields:
- Task Title
- Task Priority
- Task Data (Collection)
- External Tag - Specify a tag to uniquely identify batches of external tasks that you want to retrieve from a third-party system. You can use this tag to sync External Tasks with an external system. Also, you can use this tag to complete tasks based on the actions a user takes in the third party system.
- Create External Action using APIs.
Syncing external actions with third-party tools
To sync External Actions with other external systems, you need to first create a corresponding object for it inside the external system, and then retrieve the task, or batch of tasks, created by the third-party system, using an API call.
-
Create an object inside an external system, such as:
- Create an issue in Jira.
- Create a contact in Salesforce.
-
Call the following API in Swagger: GET
/odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFolders
.For example: GET<ORCH_URL>/odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFolders?$filter=(Type eq 'ExternalTask') and (IsDeleted eq false) and (ExternalTag eq 'JiraTasks') and (Status ne 'Completed')&$count=true
.
/tasks/GenericTasks/GetTaskDataById
. You can use the retrieved
details to create a similar task in a third-party system.
The screenshots below show the API parameters and responses in Swagger. To access your tenant inside Swagger, follow the Accessing your Swagger file procedure.
/tasks/GenericTasks/CompleteTask
.
Visit the Complete External Task procedure from the Orchestrator API guide for more details.