LinkedIn
Copied!

Table of Contents

openLocalAction

Version:

Only available versions of this content are shown in the dropdown

Launches a local action in a modal dialog box in the context of a list item.

Signature

openLocalAction(options)

Returns

Not applicable.

Parameters

Name Description Type Required
flowAction Specifies the name of the flow action that the API launches. String
event Specifies the event that launches the activity. DOM event object
onLaunch Specifies which rows the system refreshes after the flow action ends. The following values are available:
  • pega.api.ui.constants.REFRESH_ALL_ITEMS
  • pega.api.ui.constants.REFRESH_CURRENT_ITEM: The default and recommended value.
Constant
disableWorkProcessing Specifies whether the system creates an action on a work item on a list that runs in a temporary work processing thread. The default value is false. Boolean
template Specifies the template for the modal dialog box. The default value is pzGridModalTemplate. String
var options = {
                flowAction: “flowActionName ",
                event: eventObject,
                onLaunch: pega.api.ui.constants.REFRESH_CURRENT_ITEM / pega.api.ui.constants.REFRESH_ALL_ITEMS,
                disableWorkProcessing: boolean,      
                template: "templateName"
            };

            pega.api.ui.actions.list.openLocalAction(options);
Did you find this content helpful?

Have a question? Get answers now.

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