Published Release Notes

Data and integration troubleshooting enhancements

Identify how data is loaded in user interface (UI) elements, discover the data sources used, and navigate to the relevant rules by using the new Live Data tool. Use the Live Data tool to quickly troubleshoot data and integrations by providing data page information or autopopulate properties from the UI without searching through the clipboard.

For more information, see Troubleshooting data in UI elements.

Retrieve a flat list of fields from Pega Digital Experience APIs

You can now use the flatListOfFields parameter to retrieve a list of the fields in a case or flow action. With this parameter, you avoid parsing all the layout information for the Pega Digital Experience API, making it easier for you to see only what you need to build your user interface.

The following Pega Digital Experience APIs support the flatListOfFields parameter:

• GET /casetypes/{ID}
• GET /assignments/{ID}/actions/{actionID}
• GET /cases/{ID}/actions/{actionID}

For more information, see Retrieve a flat list of fields from Pega APIs.

Attachment migration from Pega database storage to a repository

You can now migrate case attachments from Pega database storage to a repository by using a wizard from Pega Platform™. This ability is useful, for example, when you migrate from an on-premises deployment to a Pega Cloud Services environment and you want to reduce the size of your Pega database and manage all your case attachments in a single location.

For more information, see Migrating case attachments to a repository.

Specify a queue of user operations in Pega Digital Experience APIs

You can now specify a queue of page instructions for user operations on embedded pages, page lists, and page groups in Pega Digital Experience APIs. The page instructions allow your client application to more accurately model users’ actions.

Pega Digital Experience APIs support the following operations:

• For embedded pages: DELETE, REPLACE, and UPDATE.
• For page lists: DELETE, REPLACE, UPDATE, APPEND, INSERT, and MOVE.
• For page groups: DELETE, REPLACE, UPDATE, and ADD.

For more information, see Page-related operation queuing with page instructions in Pega APIs.

Simple associations for quickly joining classes

Associations now have a simple mode. Use a simple association to quickly and easily join a class to another class. The simple association defines a left join, using a foreign key in the source class and the class key in the target class. Use an advanced association for all other conditions. In addition, simple associations are drawn in the Visual data model reporting mode to visualize the relationships that are available for reporting.

Upgrade impact

The new simple mode draws a map of where all the classes defined in the application rule are drawn as nodes. Relationships between the nodes that are defined by relevant properties are drawn as lines linking the two classes. This feature only includes Case and Data classes that are defined on the Application rule form's Cases and Data tab. It also only includes relevant fields for those classes in order to define the relationships from one class to another.

What steps are required to update the application to be compatible with this change?

After a successful upgrade, add the data and case type classes to the application rule in Dev Studio to have the selected classes appear as a node. In addition, if you want a relationship to display as relevant, set the properties (of the class that defines that relationship) as relevant.

For more information, see Exploring the data model.

Association changes after upgrade

Associations now have a simple mode. Simple associations are those that join to only one class, use a left join, and have one filter condition to a class key in the target class. Existing associations that define a simple foreign key relationship are upgraded to simple associations when opened; all others are treated as advanced associations. All associations continue to work in reporting.

Making an association simple changes only one piece of metadata; all other data on the association rule is not affected.

Upgrade impact

The new simple mode draws a map of where all the classes defined in the application rule are drawn as nodes. Relationships between the nodes that are defined by relevant properties are drawn as lines linking the two classes. This feature only includes Case and Data classes that are defined on the Application rule form's Cases and Data tab. It also only includes relevant fields for those classes in order to define the relationships from one class to another. 

What steps are required to update the application to be compatible with this change?

After a successful upgrade, add the data and case type classes to the application rule in Dev Studio to have the selected classes appear as a node. In addition, if you want a relationship to display as relevant, set the properties (of the class that defines that relationship) as relevant.

For more information, see Associations.

Create and view application settings in App Studio

View your application settings on the new Application settings landing page in App Studio. The landing page displays the categories that you specified for your application settings. If you did not specify a category for an application setting, the application setting appears in the Uncategorized category. Additionally, when you create a new data type, the Data type wizard automatically creates an application setting for the base URLs and the authentication profile. On the Environment settings page, you can edit the application setting to specify a new name or category or accept the default values.

For more information, see Viewing application settings in App Studio and Preparing your data for production.

Upgrade impact

After a successful upgrade, you see the new Application Settings option under Settings in App Studio. 

What steps are required to update the application to be compatible with this change?

1. If the label (Application Settings) conflicts with your existing extension, change the label by overriding the following field value:
   PEGA-EXT- EXPEXPLORER-SETTINGS-APPSETTINGS PYCAPTIONIEXTENSION!LABEL
2. If you need to disable the landing page and prevent it from appearing in App studio, change the following toggle to No:
   PegaRULES: DisableSettingsLandingPage

BIX ruleset is now included with Pega Platform

The Pega Business Intelligence Exchange™ (BIX) ruleset is now included with Pega Platform™, which eliminates the need for additional provisioning for Pega Cloud customers and for a separate BIX installation for on-premises customers. To add BIX to your application, add the Pega-BIX:<version> ruleset to your application rulesets.

For more information, see Data extraction.

Upgrade impact

After a successful upgrade, the BIX ruleset is available within Pega Platform. You should synchronize the BIX ruleset and Pega rules to avoid extraction errors.

What steps are required to update the application to be compatible with this change?

After the upgrade is complete, change the ruleset version for Pega Platform and BIX to use the same, latest version.

Automatically generate OpenAPI Specification documentation for application REST APIs

You can now access a clear, standard view of all the REST APIs in your application by using autogenerated OpenAPI Specification (OAS) documentation. In App Studio, you can view the OAS documentation generated for application-specific REST APIs by using the new Application tab in the API channel. Additionally, service package rules now include an OpenAPI tab where you can view the automatically generated OAS documentation for all the REST services included in the service package. With these enhancements, you can easily find, visualize, and test the REST APIs in your application.

For more information, see Generating OpenAPI Specification documentation for application-specific REST APIs.

Data migration enhancements

Ensure a successful data migration by using a configuration template for setting up your environment before you migrate data into your application. From the new Migration settings landing page, configure dynamic system settings for migration and turn off database indexes and processes that might affect data migration performance. After you have finished migrating data, you can revert your system to its normal working state.

For more information, see Creating a migration configuration template.