openProcessAction(actionID, options)
Opens the configured process action.
Returns
A Promise associated with the action.
Parameters
| Name | Type | Description | Required |
| actionID | object | The ID of the process action. | ✅ |
| options | object | The JSON object containing the container target in which the process action is displayed. | ✅ |
The following table contains the properties of the options object:
| Name | Type | Description | Required |
| caseID | string | The unique ID of the case. If this ID is not provided, it will be obtained using the current context. | ❌ |
| actionTitle | string | The title of the process action. This is used as the modal header title when the process action is displayed in the modal dialog. | ❌ |
| type | string | The type of the process action. The values are Case or
Stage.Example: | ✅ |
Usage example
In this example, the success callback is called if the process action is launched successfully.
const processActionPromise = getPConnect().getActionsApi().openProcessAction("VendorAddition_Flow", { type: "Case" });
processActionPromise.then(() => {
// open process action success handling
}).catch(() => {
// open process action failure handling
});Previous topic openLocalAction(actionID, options) Next topic openWorkByHandle(workID, className)