Skip to main content

Local action UI action in DX API

Suggest edit Updated on June 8, 2021

The Local action action loads the local or local & connector flow action and presents it as a modal dialog, overlay, or in an action section. Learn about the JSON structure and elements of a sample Local action action, to understand how you can integrate it into your custom application.

The following JSON code is a sample API response for a Local action action with the Target set to Replace Current:

{
  "actionSets": [
    {
      "actions": [
        {
          "actionProcess": {
            "localAction": "Step1",
            "target": "replaceCurrent"
          },
          "action": "localAction"
        }
      ],
      "events": [
        {
          "event": "click"
        }
      ]
    }
  ]
}

A Local action with the Target set to Replace Current
Note:
  • The actionSets, actions, and events elements are arrays.
  • DX API v1 does not support the when conditions in the action set.
  • If the configured action is not included in the assignment's action list during run time, a HTTP 404 error occurs.
Note:

For the Angular starter kit, note the following statements:

  • When you submit a Local action action, the PUT /assignments/{ID}/actions/{actionID}/refresh endpoint is invoked. This endpoint updates the case page with the data entered by the user and returns the updated page. The Angular starter kit implementation displays the form from which the Local action action was launched. The data entered by the user is not saved in the database.
  • When multiple actions are configured on a control, they are invoked in parallel.

The following JSON code is a sample API response for a Local action action with the Target set to Modal Dialog:

{
  "actionSets": [
    {
      "actions": [
        {
          "actionProcess": {
            "localAction": "Step1",
            "localActionFormat": "Standard",
            "customTemplate": "pzModalActionAreaContainer",
            "target": "modalDialog"
          },
          "action": "localAction"
        }
      ],
      "events": [
        {
          "event": "click"
        }
      ]
    }
  ]
}

A Local action with the Target set to Modal Dialog
Note:
  • The actionSets, actions, and events elements are arrays.
  • DX API v1 does not support the when conditions in the action set.
  • If the configured action is not included in the assignment's action list during run time, a HTTP 404 error occurs.
Note:

For the Angular starter kit, note the following statements:

  • When you submit a Local action, the PUT /assignments/{ID}/actions/{actionID}/refresh endpoint is invoked. This endpoint updates the case page with the data entered by the user and returns the updated page. The Angular starter kit implementation displays the form from which the Local action action was launched. The data entered by the user is not saved in the database.
  • When multiple actions are configured on a control, they are invoked in parallel.

    The following JSON code is a sample API response for a Local action action with the Target set to Overlay:

    {
      "actionSets": [
        {
          "actions": [
            {
              "actionProcess": {
                "localAction": "Step1",
                "localActionFormat": "Standard",
                "customTemplate": "pzModalTemplate",
                "target": "overlay"
              },
              "action": "localAction"
            }
          ],
          "events": [
            {
              "event": "click"
            }
          ]
        }
      ]
    }

    A Local action with the Target set to Overlay
    Note:
    • The actionSets, actions, and events elements are arrays.
    • DX API v1 does not support the when conditions in the action set.
    • DX API v1 supports the out of the box Overlay formats. Configured user-defined overlay formats are also returned in the response.
    • If the configured action is not included in the assignment's action list during run time, a HTTP 404 error occurs.
    Note:

    For the Angular starter kit, note the following statements:

      • The Angular starter kit does not support Overlay.
      • The Click event is supported by the Angular starter kit. However, the DX API response returns any configured event.
      Did you find this content helpful? YesNo

      0% found this useful

      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.com is not optimized for Internet Explorer. For the optimal experience, please use:

      Close Deprecation Notice
      Contact us