activities
latest
false
Workflow Activities
Last updated Oct 31, 2024

Wait For Job And Resume

UiPath.Persistence.Activities.Job.WaitForJobAndResume

Description

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:
  • docs image 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).
  • docs image Running - A job is in this state if it has established a connection to the Robot which started executing the designated process.
  • docs image 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.
  • docs image Faulted - A job is in this state if it failed to start or the process threw an unhandled error during execution.
    Note: Faulted jobs must be restarted manually.
  • docs image 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.
  • docs image 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 Faulted the jobs that have been in a Terminating state for at least one day.
  • docs image 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.
  • docs image 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.

Project compatibility

Windows - Legacy | Windows | Cross-platform

Windows, Windows - Legacy configuration

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 only JobData 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 only JobData 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.

Cross-platform configuration

  • 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 only JobData 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.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.