action-center
2023.10
true
- 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
Wait For Job And Resume
Action Center
Last updated Oct 3, 2024
Wait For Job And Resume
UiPath.Persistence.Activities.Job.WaitForJobAndResume
Suspends the execution of the current workflow until a specified Job is completed. To designate a Job, a
JobData
object, retrieved from the Start Job and Get Reference activity, must be supplied. When the Job is completed, the execution of the workflow is resumed.
Jobs can have the following states:
- Pending - A job is in this state if it is queued on the same Robot or it is trying to establish a connection with the Robot (only different jobs on the same Robot can be queued).
- Running - A job is in this state if it has established a connection to the Robot which started executing the designated process.
- Successful - A job is in this state if it has been executed correctly by the Robot and it has finished running or has been stopped using the Stop button.
- Faulted - A job is in this state if it failed to start or the process threw an unhandled error during execution.
- Stopping - An intermediary state that is triggered if you click the Stop button in Orchestrator. The job is canceled as soon as it is safe. This can be implemented in a workflow using the Should Stop activity.
- Terminating - An intermediary state that is triggered if you click the Kill button in Orchestrator. By default, a cleanup background job runs once every three hours and transitions to Failed the jobs that have been in a Terminating state for at least one day.
- Suspended - An intermediary state that is triggered with the purpose of allowing user intervention or completion of an intermediary process. It is triggered by the corresponding activities in Studio. Details here.
- Resumed - An intermediary state that is triggered if the conditions (user intervention, intermediary process completion) of a fragmented workflow have been met. It is triggered by the corresponding activities in Studio. Details here.
- Stopped - A job is in this state if it stopped (by using the Kill button, or by canceling it from the system tray) before it finished executing without throwing any errors.
After a Job is resumed it transitions to the Running state.
Designer panel
- Job Object (Input) - The Job you want to suspend, stored in a
JobData
variable. This variable can be obtained from a Start Job and Get Reference activity, This field supports onlyJobData
variables. - Job Object - The updated Job object obtained from Orchestrator after the execution of this activity.
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.
Note: If this activity is included in Try Catch and the value of the ContinueOnError property is True, no error is caught when the project is executed.
- DisplayName - The display name of the activity.
- StatusMessage - The message specified in this property field is displayed in Orchestrator alongside the workflow that is suspended by this
activity. This field supports strings and
String
variables only. - 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
- Job Object (Input) - The Job you want to suspend, stored in a
JobData
variable. This variable can be obtained from a Start Job and Get Reference activity, This field supports onlyJobData
variables.
Misc
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
Output
- Job Object - The updated Job object obtained from Orchestrator after the execution of this activity.
- Job Object (Input) - The Job you want to suspend, stored in a
JobData
variable. This variable can be obtained from a Start Job and Get Reference activity, This field supports onlyJobData
variables. - Job Object - The updated Job object obtained from Orchestrator after the execution of this activity.
Advanced options
- 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.
Note: If this activity is included in Try Catch and the value of the ContinueOnError property is True, no error is caught when the project is executed.
- 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).
- StatusMessage - The message specified in this property field is displayed in Orchestrator alongside the workflow that is suspended by this
activity. This field supports strings and
String
variables only.