Published Release Notes

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.

Support for application-specific REST API calls

You can now call an authenticated REST API in the context of any application that is listed on an operator record by using the application alias URL. With the application alias URL, you can also develop REST services without changing the access group in the service package. REST services run in the context of the access group that points to the provided application, instead of the access group that is specified in the service package.

For more information, see Invoking a REST service rule.

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

Data APIs support data exploration in React UI tables

Data APIs have been enhanced to support filtering, sorting, paging, and aggregation in React UI tables. You can use that functionality to access your data quickly and intuitively. For example, by using paging, you can query a data page to retrieve the second page of an employee contact list and specify the number of results that are displayed on the page.

For more information, see Data API performance and limitations.

Failed Robotic Assignments work queue type changed to Standard

The default Failed Robotic Assignments work queue type is now Standard. In previous releases, the default type was Robotic. For usage information, see Configuring a work queue for robotic automation.

Upgrade impact

After upgrading to Pega Platform 8.5 and later, you cannot save case types in which you configure the Queue for robot smart shape to route new assignments to the Failed Robotic Assignments work queue. Existing assignments that you routed to the Failed Robotic Assignments work queue are not affected.

How do I update my application to be compatible with this change?

As a best practice, do not use the Failed Robotic Assignments work queue in your custom implementations. Instead, configure the Queue for robot smart shape to route new assignments to a Robotic work queue. When possible, update existing case types to use the robotic work queues that you created in your application.

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.

Savable data pages support loading pages individually from a page list

You can now load individual pages in a page list from single object data pages to your case and data types. This functionality allows you to save autopopulated properties with the Load each page individually option using a flow action, save data page smart shape, or the activity method.

For more information, see Saving data in a data page as part of a flow.