Skip to main content



Suggest edit Updated on December 1, 2021

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




Not applicable.


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.
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"

Did you find this content helpful? YesNo

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

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