Skip to main content

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

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

openLocalAction: Public JS API for control actions

Updated on April 6, 2017


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


var options = {
flowAction: “flowActionName ",
event: eventObject,
onLaunch: pega.api.ui.constants.REFRESH_CURRENT_ITEM / pega.api.ui.constants.REFRESH_ALL_ITEMS,
disableWorkProcessing: true/false,
template: "templateName"



This API accepts a JavaScript object which can have the following key-values.

  • flowAction: This string specifies the flow action name to launch.
  • event: The event refers to a DOM event object which is used by framework to get grid context.
  • onLaunch: Optional. This is a string and it can be either pega.api.ui.constants.REFRESH_CURRENT_ITEM or pega.api.ui.constants.REFRESH_ALL_ITEMS. The default value is pega.api.ui.constants.REFRESH_CURRENT_ITEM (recommended) and only the current row will be refreshed after the flow action has ended. Set it as refresh all items to refresh the entire layout.
  • disableWorkProcessing: Optional. This is a Boolean. The default value is false. An action on a work item in a list is created in a temporary work processing thread. To disable the default behavior, set this to true.
  • template: Optional. which specifies the template name to display the modal dialog. The default value is pzGridModalTemplate.

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