Cancel Process Smart Service (17.3)

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:

• 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 )

Parameters

Keyword	Type	Description
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().

Runtime 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 Monitor 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.

Feature compatibility

The table below lists this smart service function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Partially compatible	Can be used with Appian Portals if it is connected using an integration and web API.
Offline Mobile	Incompatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.
Process Autoscaling	Compatible

Feedback