Design guidelines
When you create new service requests, follow these guidelines when designing an application with DX APIs. The out-of-the-box case types implement these guidelines.
- Ensure that conditional visibility consist of references to when rules only.
- Ensure that sections are auto-generated.
- For sections, use one of the following layouts:
- Table
- Dynamic layout
- Repeating dynamic layout (not sourced from data pages)
- Embedded section
- If a flow action uses editable pages (named pages, thread-level data pages, or requestor-level data pages), the edited values are not available in post-processing data transforms or activities. In such cases, use the pattern of auto-populated properties (which obtain data from data pages) and savable data pages in the post-processing of flow actions.
- Because case processing occurs in a stateless manner, always configure applications to use optimistic locking.
DX API recommendations
The following table lists some common observations about the DX API and the recommendations associated with them:
|
Feature |
Comments |
Recommendations |
|
Property validations |
When you use a non-Pega desktop, page validation occurs when you save the service request. (Validation does not occur if you create the case in the Interaction Portal). |
Ensure that the case data adheres to the property validations before service request submission. |
|
Pre-processing in flow actions |
In a stateless architecture, avoid setting any fields that the UI does not manage. This data is not committed to the case and is missing in subsequent requests. |
Call the preprocessing data transform in the flow by using the Run data transform shape. |
|
Named pages |
Avoid using temporary pages because these pages are not available for the API call that fetches the section metadata for the specified assignment. |
Copy the temporary page data to a page property. |
|
Use page defined on property or use data page as the page context |
For any embedded section, the use of page defined on property or data page is not suitable for a stateless architecture. |
Use the clipboard page or the current page context. |
|
Visibility conditions using expressions |
If you use expressions as visibility conditions in sections, the service request does not work as expected. |
Change the visibility condition from expression to a when rule. |
|
Default values in section |
Parameterized data pages as default values for any control in a section is currently not supported by the API. |
Set the value by using the Run data transform shape in the flow. |
|
Support for Master-details in table layout |
DX API does not support Master-details options such as modal dialog boxes or expandable rows in Pega Platform version 8.7. |
Add an embedded section in the rows of the table to display additional details. |
|
Support for circumstancing |
DX API does not support circumstancing. |
Avoid circumstancing. |
This Topic is available in the following Module:
Want to help us improve this content?