Published Release Notes

New Java API improves JSON serialization

By using a Java API, you can serialize a Page or Property clipboard object to a JSON string for faster JSON serialization. You can also create a map between API responses and an application's internal data model that improves integration performance and maintainability.

For more information, see Using the mapping API for high-performance JSON serialization and Using the mapping API for high-performance JSON deserialization.

Log file description in web.xml incorrect after upgrade to Apache Log4j 2

As a result of the upgrade from the Apache Log4j 1 logging service to the Apache Log4j 2 logging service, it is recommended that you update the log file description in the web.xml file from location of prlogging.xml file to location of prlog4j2.xml file. The description indicates which log file is in use. Updating the description avoids confusion about which log file is current. Change the description as shown in the following example.

<resource-ref id="ResourceRef_5">
<description>location of prlog4j2.xml file</description>
<res-ref-name>url/pegarules.logging.configuration</res-ref-name>
<res-type>java.net.URL</res-type>
<res-auth>Container</res-auth>
<res-sharing-scope>Shareable</res-sharing-scope>
</resource-ref>

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.

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

Experimental high-speed data page support

An experimental implementation of high-speed, read-only data pages is available. This implementation is useful when data pages are used to hold static data that is used repeatedly. You can enable this feature for a specific read-only data page from the Load Management tab of the data page rule form by clicking Enable high-performance read-only data page. This feature does not support full clipboard page functionality; use with caution.

The following functionality is supported:

• Basic page and property access (read and write properties) for all normal data types
• Hierarchical data page structure (pages within pages)
• Dictionary validation mode
• Read-only data pages

The following functionality is not supported:

• Declarative rules
• Page messages
• Complex property references
• Saving pages to a database
• API access to the data page

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.