Stop Job

Important: This activity is available starting with v2018.1.

UiPath.Core.Activities.StopJob

Enables you to stop or kill a job on Orchestrator. Please note that in order to execute this activity in Studio, the Robot has to be connected to Orchestrator and the Robot role needs to also have the Create and Edit rights on jobs, as well as View permissions on processes and environments. The activity runs under the Robot it executes it.

Properties

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.

Input

• Job - Specify the job to be stopped or killed. This property supports OrchestratorJob variables.

• Strategy - Select how to stop the job:

  • Stop - Stop the job in a safe manner, when a Should Stop activity is encountered in the workflow.
  • Kill - Forcefully stop the job, regardless of where the execution is.

Misc

• FolderPath - The path of the folder where the specified job is located, if different from the folder where the process is running. This field only supports string values, with / as the separator to indicate subfolders. For example "Finance/Accounts Payable".
  Note:

  The FolderPath parameter does not work for processes executed by robots in classic folders. Only robots in modern folders have the ability to pass data outside of their folder.

  Relative folder paths are supported in an X-UIPATH-FolderPath-Encoded header, as follows:

  -right: Path starting with / - starts from the root folder of the tree the ambient folder is part of.

  -right: Path starting with . - starts from the ambient folder.

  -right: Path starting with .. - starts one level up in the hierarchy of the ambient folder for each .. in the path (e.g. ../ for one level up, ../../ for two levels up in the hierarchy).

  Note that trailing slashes are not accepted.

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.