Cancel Process Smart Service (17.3)

This page contains information related to an old version of the Cancel Process Smart Service.

Old versions do not appear in category lists; only the newest versions are listed.

To take advantage of the latest features and improvements, we always recommend you use the latest versions of Smart Services whenever possible. See the latest version's page for information about what's been changed.

Overview

The Cancel Process Smart Service allows you to halt all process flow and cancel all tasks associated with a process.

Permissions Needed

The user running the smart service must have administrator rights to the selected process. Attempting to complete this task without the proper user rights generates an error message for the process administrator and pauses the process.

Properties

  • Category: Process Management

  • Icon: Cancel Process Icon

  • Assignment Options: Unattended/Attended

Configuration Options

This section contains tab configuration details specific to this smart service. For more information about common configurations see the Process Node Properties page.

Data Tab

Node Inputs

Input Data Type Description Required Multiple
Process Id Number (Integer) The Id of the process to cancel Yes No

a!cancelProcess_17r3()

The Cancel Process smart service is available as an expression function that can be executed inside a saveInto on a Interface Component or as part of a Web API.

Syntax

a!cancelProcess_17r3(processId, onSuccess, onError)

Inputs

  • processId (Number(Integer)): The id of the process to cancel.
  • onSuccess (Any Type): A list of saves or an HTTP response to execute after the smart service executes successfully. Created with a!save() or a!httpResponse().
  • onError (Any Type): A list of saves or an HTTP response to execute when the smart service does not execute successfully. Created with a!save() or a!httpResponse().

Run-Time Behavior

When this smart service runs, the specified process will be canceled. This matches the behavior as if the user clicked the Cancel button from the Monitoring view, which means that all process flow stops, all tasks for the process are removed from user's task lists, and the end events of the process do not execute. The user who executed the smart service will be listed in the process's history as having canceled the process.

FEEDBACK