Skip to main content


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

Creating custom screens with the DX API

Updated on January 20, 2022

Incorporate elements and results of Pega Platform processing into external web pages and applications by using Pega digital experience (DX) REST API. When you use the Pega DX API, your application users can access Pega business functionality in a familiar interface.

For example, you can configure your non-Pega application to display a list of case types or open assignments for workers.

Pega Platform refers to a set of specific REST API endpoints as DX API endpoints because they use Pega Platform user interface elements, such as harnesses and sections, together with Pega business processing to return JSON-equivalent structures that you can render with your native interface. By using DX API you can enrich your application with Pega elements in a flexible way that matches your unique business needs. You can incorporate the following elements:

  • Case types
  • Cases
  • Collaboration tools, such as documents, spaces, messages, and notifications
  • Attachments
  • Data pages
For detailed specifications of the DX APIs, refer to the Application category in the Pega API documentation.
Before you begin:
  • Ensure that a harness that you want to embed into an external application uses a screen layout as the top container, as in the following example:
    Screen layout as the top section container
    Screen layout as the top section container
  • To retrieve all of the relevant records of a case by using the DX API, ensure that the harness that you want to embed into an external application includes the pyNewCaseMain section.
  • Ensure that visibility expressions consist of When rules only.
  • Ensure that sections are auto-generated.
  • Ensure that section rules use one of the following layout options:
    • Dynamic layout
    • Repeating dynamic layout
    • Table
    • Embedded section

The following sample scenarios describe how you can enrich your custom UI by using Pega DX API:

Managing cases with DX API

Provide users of your external application with tools to manage case types and cases that you store in Pega Platform by applying DX API. DX API endpoints help you take advantage of tools and processing that Pega Platform offers in an environment that is familiar to your customers.

Before you begin: Enable cases for creation through DX API. For more information, see Enabling cases for creation through web and chat channels.
  1. In the navigation pane of App Studio, click Channels.
  2. In the Current channel interfaces section, click API.
  3. In the Service package list, select V1 Pega API.
  4. Expand the Application section.
  5. Select the DX API endpoints that you want to use in your external application:
    ChoicesActions
    Integrate case types
    1. From the casetypes section, select the endpoint that you want to use.For example: To get details about a specific case type, use GET /casetypes/{caseTypeID}.
    Integrate cases
    1. From the cases section, select the endpoint that you want to use.For example: To submit values that a user provides on the creation screen of a case, use POST /cases.

Completing assignments with DX API

Incorporate tools to manage assignments into non-Pega applications by using DX API. When you integrate the results of Pega Platform processing with external applications, you reach wider audiences and ensure that users can reach their business objectives in a familiar interface.

For example, you can use DX API to create a screen for a user to submit a bug that is a part of the uPlusTelco application. The screen includes the following elements:
  • A list of assignments for a current user
  • Breadcrumb navigation
  • The assignment instructions
  • The button to submit the assignment
  • The gadget that displays additional tools, such as the Pulse feed
  1. In the navigation pane of App Studio, click Channels.
  2. In the Current channel interfaces section, click API.
  3. In the Service package list, select V1 Pega API.
  4. Expand the Application section.
  5. Select the DX API endpoints that you want to use to build the screen:
    • To include a list of the current assignments for the current user, use GET /assignments.
    • To display breadcrumb navigation through assignment stages by selecting GET /cases/{caseID}.
    • To get the instructions and list of actions for a specific assignment, use GET /assignments/{assignmentID}.
    • To display the view for the chosen action, use GET /assignments/{assignmentID}/actions/{actionID}.
    • To refresh the form when a user populates the fields, use PUT /assignments/{assignmentID}/actions/{actionID}/refresh.

      You refresh the form to validate When conditions and repeating lists.

    • To include a button that a user clicks to submit the form, use POST /assignments/{assignmentID}?actionID=[actionID].

Creating a custom dashboard with DX API

Create an application that meets your unique business requirements and incorporate the exact UI elements that are relevant to your business process by using DX API.

For example, you can create a custom dashboard that is a part of an external website but displays elements that you process in Pega Platform, such as case types, cases, and assignments. By using DX API, you merge tools and possibilities that Pega Platform provides with an interface that is familiar to the users of your application.
Before you begin: Enable case creation through DX API. For more information, see Enabling cases for creation through web and chat channels.
  1. In the navigation pane of App Studio, click Channels.
  2. In the Current channel interfaces section, click API.
  3. In the Service package list, select V1 Pega API.
  4. Expand the Application section.
  5. Select a DX API endpoint that you want to use in your custom dashboard:
    • To embed a button to get the next assignment, use GET /assignments/next.
    • To build a list of case types that a user can create, use GET /casetypes.
    • To embed a text field that users can use to search for cases by ID, use GET /cases/{ID}/pages/Review.
    • To get a list of recently accessed cases, use GET /data/Declare_pxRecents.
    • To get information about the current user, use GET /data/D_OperatorID.
    • To build a worklist for the current user, use GET /data/D_Worklist.

Tags

Pega Platform 8.7 DX API

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