Skip to main content


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

openLocalAction

Updated on December 13, 2022

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

Signature

openLocalAction(options)

Returns

Not applicable.

Parameters

NameDescriptionTypeRequired
flowActionSpecifies the name of the flow action that the API launches.String✅
eventSpecifies the event that launches the activity.DOM event object✅
onLaunchSpecifies 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❌
disableWorkProcessingSpecifies 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❌
templateSpecifies the template for the modal dialog box. The default value is pzGridModalTemplate.String❌
For example: 
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);

Tags

Pega Platform 8.7 User Experience

Have a question? Get answers now.

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

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us