Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

openProcessAction(actionID, options)

Updated on July 20, 2021

Opens the configured process action.


A Promise associated with the action.


actionIDobjectThe ID of the process action.
optionsobjectThe JSON object containing the container target in which the process action is displayed.

The following table contains the properties of the options object:

caseIDstringThe unique ID of the case. If this ID is not provided, it will be obtained using the current context.
actionTitlestringThe title of the process action. This is used as the modal header title when the process action is displayed in the modal dialog.
typestringThe type of the process action. The values are Case or Stage.


{caseID: "", actionTitle: "Vendor Addition", type: "Case" / "Stage"}

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

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us