Skip to main content

Update Process Instance State

UiPath.Oracle.IntegrationCloud.Process.Activities.UpdateProcessInstanceStateActivity

The Update Process Instance State activity uses the Oracle Integration Update Process State API to suspend, resume, cancel, or recover and take action on faulted instances (Action and Fault Action) of a specific process (Process Id).

After completing the put operation, the activity outputs the API call status (Status) and response message (Response Message).

How it works​

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Oracle Process Scope activity to your project.
  3. Add an activity or run an external process that outputs the process identifier (e.g., Start Process, Get Processes).
  4. Add the Update Process Instance State activity inside the Oracle Process Scope activity.
  5. Enter values for the input properties.
  6. Create and enter String variables for the output properties.
  7. Run the activity.

    • Your input properties are sent to the Update Process State API.

    • The API returns the String values to your output property variables.

      docs image

Properties​

Common​

  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Input​

  • Process Instance Id - The identifier assigned to the process that you want to update. Enter a String or String variable. To get the Process Id value, add an activity or run an external process that outputs the process identifier (e.g., Start Process, Get Processes).
  • Action - The action that you want to take to update the specified process. Use the drop-down list to select your action. There are 4 options: Suspend, Resume, Cancel, RecoverFaultedInstances.
  • Fault Action - The action that you want to take to update faulted instances. Use the drop-down list to select your action. The drop-down list is enabled when RecoverFalutedInstances is selected in the Action property. There are 3 options: Continue, Abort, Retry.
  • Comment - The comment that you want to associate with the state update. Enter a String or String variable.

Misc​

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

Output​

  • Response Message - The API response message. This field supports only String variables.
  • Status - The status of the request. Enter a String variable. Possible values are Success or Failure.

Example​

The following image shows an example of the activity dependency relationship and input/output property values.

docs image