Skip to main content

Table of Contents

Public JavaScript APIs


Only available versions of this content are shown in the dropdown

Public JavaScript APIs provide you with tools to integrate custom controls into Pega Platform.

Creating non-auto generated controls requires markup that contains specific attributes to represent events and actions. When these attributes are used, Pega Platform routes actions and events through the same infrastructure as the auto-generated controls.

The APIs are available in the pega.api.ui.actions and pega.api.ui.actions.list namespaces. All APIs must be invoked with complete namespaces, for example: pega.api.ui.actions.refreshSection(params).

Discover more about Pega-supported public JavaScript APIs in the following articles:

  • addListItem

    Adds a new item to a table or a repeating dynamic layout.

  • editListItem

    Enables editing of the active row in a table, hierarchical list, hierarchical table, or repeating dynamic layout.

  • getDataPage

    Retrieves data page information from the clipboard in JSON format.

  • launchHarness

    Launches a harness. You can configure this API to replace the current harness, open a new harness, or launch the harness in a pop-up window.

  • launchLocalAction

    Launches a local action as a modal dialog, an overlay, or by replacing the current section.

  • openLocalAction

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

  • openURLInWindow

    Opens an external or internal URL in a browser window. The URL can be accessed through an activity or a data transform.

  • refreshHarness

    Refreshes the current harness.

  • refreshSection

    Refreshes a section. When refreshing a target section, the system refreshes all sections that share the name of the target section.

  • runActivity

    Runs an activity from a script.

  • setValues

    Sets the value of a target property from a source property or a literal constant. Supports setting multiple target properties through a single call.

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.

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.

Pega Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice
Contact us