Skip to main content


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

Updating the application

Updated on January 18, 2022

To update Pega Government Platform, import the application file, and then complete additional procedures in this guide.

Before you begin: Ensure that you complete the prerequisites for this application update.

Importing the modularized application file

The system data and rulesets for Pega Government Platform are loaded during this task.

Note: If you are upgrading from 7.22 or later, to avoid potential import errors, search for the safs_work_p2p table and rename the ISEXTERNALSYSTEMOFRECORD column before starting the import.
  1. Log in to Pega Platform (https://<hostname>:<port>/prweb) by entering the administrator ID, for example, [email protected] and the password that you used during Pega Platform installation.
  2. In the header of Dev Studio, click ConfigureApplicationDistributionImport.
  3. Select the /Rules/PegaGP.jar file from your distribution media, and then follow the wizard instructions.
  4. For schema changes, depending on your site's requirements, select either Automatic or Manual, and then continue following the wizard instructions.
    If you select Manual, see Viewing and applying schema changes.
  5. On the Aged Updates screen, select the Import aged updates check box, and then click Next.
  6. When the import is complete, click Done.
  7. Apply the required hotfixes by using Hotfix Manager. For more information about applying hotfixes, see Applying the latest on-premises patch.
  8. If you are using the CSCEndUser skin for your existing application, update the application to use the CSEndUser skin.
  9. Optional: Verify the application rules.
    1. In the navigation pane of Dev Studio, click RecordsApplication DefinitionApplication.
    2. Confirm that the following application rule is displayed in the list:
      • PegaGPCosmos 8
      • PGPICMCosmos 8
      • PegaGP 8
      • PGPICM 8
      • PGPContracts 8
      • PGPComplaints 8
What to do next:

Complete the additional post-update tasks described in this guide, if applicable.

Creating operator accounts

Create all of the operators from the following table in your Pega Government Platform application:

For UI-Kit apps:

Operators

OperatorIDAccess GroupWork GroupStarting activity
ExternalUserPGP PegaGP:CaseworkerDefaultData-Portal.ShowDesktop
ExternalUserCompPegaGP:ComplaintsWorkerDefaultData-Portal.ShowDesktop
ExternalUserICMPegaGP:ICMAgentDefaultData-Portal.ShowDesktop
ExternalUserProcPegaGP:ProcurementsWorker DefaultData-Portal.ShowDesktop
ICMInvestigationListenerPegaGP:ICMAdmindefault@PegaPSData-Portal.ShowDesktop
For Cosmos apps:
OperatorID Access Group Work Group Starting activity
ICMInvestigationListener PGPICMCosmos:Administrator default@PegaPS Data-Portal.ShowDesktop
  1. Log in to Pega Platform by using the administrator credentials, and switch to the respective applications and create the corresponding operators listed above.
  2. In the header of Dev Studio, click CreateOrganizationOperator ID.
  3. Enter the Operator ID from the corresponding column in the Operators table and click Create and open.
  4. Add the Access group from the corresponding column in the Operators table.
  5. Click the Work tab. Under Organizational unit, click Update.
  6. Click PegaPSGovernmentOperations, and then click Submit.
  7. Add the Work group from the corresponding column in the Operators table.
  8. On the Security tab, add the starting activity to execute from the corresponding column in the Operators table.
  9. Click Update password, enter a new password, and then click Submit.
  10. Click Save to save the rule.

Optional: Importing the sample data application

The Pega Government Platform distribution media includes sample dataa sample application to help you explore the application capabilities. The sample data includes disabled sample operators that you can enable to learn about the workspaces for each operator role. Importing the sample dataapplication is optional, and the sample data that is provided might not align with your business needs.

Before you begin: Ensure that you have already imported the Pega Government Platform application file.
To import the sample data for Pega Government Platform, complete the following steps.
  1. In the header of Dev Studio, click ConfigureApplicationDistributionImport.
  2. Select the /SampleData/PegaGP_SampleData.jar file from your distribution media.
  3. Follow the wizard instructions to import the sample data.
What to do next: Enable the sample operators that you will use to explore the different workspaces. For more information, see Optional: Enabling sample operator accounts.

Updating data from the integration layer to the data layer

The Pega Government Platform integration layer has been refactored in the 8.3 release. All tables are now mapped to their respective classes in the data layer. Refactoring activities are provided for each of the applications that are shipped and for each class that is refactored.

To ensure a successful update of your application from Pega Government Platform 8.2 and earlier, review the topics in this section.

Optional: Enabling backward compatibility with the integration layer

By default, Pega Government Platform 8.3 only works with the data layer. For backward compatibility purposes, you can update two dynamic system settings to enable Pega Government Platform to point back to the integration layer.

Caution: Do not use the integration layer with data tables as a source.
  • PGP/MasterDataIntegrationRefactor – to point the Pega Government Platform master data, such as AddressTypes, CommTypes, and so on to the integration layer, change this value to false
  • PGP/IntegrationRefactor – to point the Pega Government Platform non-master data, such as entities, addresses, and so on to the integration layer, change this value to false

Refactoring wrapper activities

For backward compatibility, Pega Government Platform provides an option to resave instances of integration classes as instances of data classes. To perform this refactoring, a few wrapping activities are available. The following table lists the refactoring wrapper activities that are provided for each application. Each activity invokes the refactoring activities of specific classes.

Note: Before executing the activities, be sure that you have admin operators for each application pointing to the access group that is specified in the table.

To run the activities, launch the application that is specified in the table and access the respective rulesets from the production rulesets of the access group.

ApplicationActivityRulesetAccess groupDescription
PGPICMPegaPS.Refactor_IntToDataPegaPSRefactoring:08-03-01PegaGP:ICMAdminRefactors the Int classes for the PGP and ICM applications
PGPICMPegaPS.RefactorMasterInfo_IntToDataPegaPSRefactoring:08-03-01PegaGP:ICMAdminRefactors the master Int classes for the PGP and ICM applications
PGPComplaintsPegaPS.RefactorMasterInfo_IntToDataPegaPSComplaintsRefactoring:08-03-01PegaGP:ComplaintsAdminRefactors the master Int classes for the Complaints application
PGPContractsPegaPS.RefactorMasterProcInfo_IntToDataPegaPSProcurementsRefactoring:08-03-01PegaGP:ProcurementsAdminRefactors the master Int classes for the Procurement application

After running the wrapper activities, clear all the node level data pages in all the applications.

Adding properties to the integration and data layers

When adding properties to the integration and data layers in the Pega Government Platform implementation layer, before executing the activities listed in Refactoring wrapper activities, update the mappings in the Refactor_CopyIntToData data transform, which is specific to the respective data class.

Customizing report definitions in the implementation layer

When a report definition from an integration class is specialized into the Pega Government Platform implementation layer, perform the same changes to the corresponding report definition of the data layer class.

For example: For example: if any changes are made to the PersonList report definition (PegaPS-Int-Entity-Person), perform the same changes to the PersonList (PegaPS-Data-Entity-Person) report definition in the implementation layer-specific ruleset.

Customizing data pages in the implementation layer

When data pages are customized in the Pega Government Platform implementation layer, update the same data page with another data source that retrieves the data from the data layer with data layer-specific report definitions and response data transforms, if required. Use the IsIntegrationRefactored when rule to retrieve data from the data layer in the data page.

Note: To find the report definition and response data transforms, refer to the data page of the latest Pega Government Platform version.

Customizing data page response data transforms in the implementation layer

When data page response data transforms are customized in the Pega Government Platform implementation layer, make the same changes to the new response data transforms only if required.

Note: To find the new response mapping data transforms for the data pages, refer to the latest Pega Government Platform version data pages.
For example: For example: if the response data transform CopyPersonIntToData is customized for the D_PersonList data page, perform the same steps in the new data transform FetchPersonListDetails.

Adding classes to communications and identifiers in the implementation layer

When classes are added to the communications and identifiers wrapper classes in the Pega Government Platform implementation layer, customize the Refactor_Identifier and Refactor_Comm refactoring activities accordingly to meet your requirements.

For example: For example: if a new class PegaPS-Data-Comm-Twitter is added for capturing Twitter account details, customize the code of the Refactor_Comm activity to set the respective data class names to the instances of the Twitter class.

Modifying the State drop-down menu source

If data refactoring is performed by following the preceding sections, modify the source of the State drop-down menu.

For the sections that are overridden that use the StateList report definition (PegaPS-Int-Config-State), replace the source by using the D_StatesList data page.

Modifying the Country drop-down menu source

In Pega Government Platform 8.3, the Country drop-down menu source has been changed from a report definition to a data page.

To use the Pega Government Platform out-of-the-box address-related sections, customize the corresponding data page in the implementation layer.

State label configuration

In Pega Government Platform 8.3, state labels specific to each country have been moved from the StateLabel decision table (PegaPS-Data-Address) to the Country data type.

After upgrading your application, any customizations to the decision table in the implementation layer must be also done in the Country data type. Customizations can be performed by using the Internationalization menu, which is accessed from the Pega Government Platform configuration in App Studio.

App Studio compliance changes

The Pega Government Platform has been refactored to be in compliant with App Studio in 8.5 release. As part of that, sections that are included in a wrapper section or harness or flow actions with the user level page context have been modified to use the editable data page.

To ensure a successful update of your application from previous releases, Revisit the following rule types that are overridden in implementation layers and which uses the user level pages and make the necessary changes by referring to the corresponding latest rule in the platform.

  • Section
  • Data transform
  • Harness
  • Activity

Extending new case types in the implementation layer

In the 8.7 release, PGP includes the Application request, Product and License case types. To include this case in an implementation application that was built prior to Pega Government Platform 8.7, complete the following steps:

  1. Create a class record by using the format: <OrgName>-<AppName>-Work-ApplicationRequest, <OrgName>-<AppName>-Work-Program, <OrgName>-<AppName>-Work-Program-License. For the class group, use the format: <OrgName>-<AppName>-Work.
  2. For the directed parent class, based on the case type, use the format: for Application request entities - PegaPS-Work-ApplicationRequest. Similarly, use PegaPS-Work-Program and PegaPS-Work-Program-License , and select the Find by name first (Pattern) box.
  3. Optimize the properties for the newly created classes that are present in the external mappings of their corresponding directed parent class.
  4. Save the class rule forms.

Modifying the class context data transform rule

In Pega Government Platform 8.7, in the LoadClassContext data transform (PegaPS-Data-Context- Application)(PegaGPCosmos:08-07-01), in steps 62-64, new work classes are added.

In the LoadClassContext data transform (PegaPS-Data-Context- Application) (PegaGPCosmos:08-07-01), in steps 137-140, new data classes are added.

Add these steps to your implementation layer-specific data transform, if present.

Modifying the business context data transform rule

In Pega Government Platform 8.7, in the LoadBusinessContext data transform, (PegaPS-Data- Context-Application) (PGPCosmos:08-06-01), new steps: from steps 96 to 99 are introduced.

Enabling operator creation in user registration functionality

For security reasons, Pega Platform operator creation is disabled in Pega Government Platform 8.4 and later. To enable the creation of an operator, save the CreatePGPOperator application setting with owning ruleset PegaPS to the implementation application ruleset, and set the value to True.

Optimized properties

A few properties are optimized in 8.6 for the PegaPS-Work-Event-Initiate, PegaPS-Work-ICM-Subject-Initiate, and PegaPS-Work-ICM-Investigation-Initiate classes.

Follow the same for the implementation layer specific classes to avoid issues in running the report definitions.

Elasticsearch

In Pega Government Platform 8.6, Elasticsearch is supported for improving the performance of the application for Person, Business, Vehicle, Facility, and Entity data classes and Investigation-Initiate work classes.

The existing list type data pages like D_PersonList, D_BusinessList, and so on of the corresponding classes are added with a new data source to fetch the details using Elasticsearch, and this is handled by a single DSS PGP/ElasticSearch which is by default set to False. Change it to True to enable Elasticsearch.

Alternatively, in App Studio go to PGPApplication to change the settings.

You can configure the number of results that Elasticsearch returns by updating the PGP/DefaultElasticResultCount DSS, which is by default set to 100 results.

Performance mode

In 8.6, a new DSS PGP/PerformanceMode is introduced to improve the performance of loading the entity pages.

When this DSS is enabled to true (by default its set to false), the entity data pages use Report definition instead of lookup to open the object.

Now entity data pages like D_Person, D_Business, and so on use data transform as the source and the corresponding D_PersonLookup and D_BusinessLookup has multiple sources defined, based on the setting which sets the data back to D_Person and D_Business.

Event life cycle changes in PGP Cosmos

In 8.6, a couple of stages are introduced to support the latest functionality. You must make the corresponding changes in the implementation layer-specific Event case, based on your business scenarios.

IACAuthentication authentication service

Pega included IACAuthentication till the Pega Platform 8.6 release. Pega Platform 8.7 release does not include IACAuthentication, and the recommended approach is to use web mashup. This effects user registration related features like Registration, and the Forgot Password features of PGP Ui-Kit application. Implementation teams must make necessary changes to adopt to the latest Pega Platform 8.7 release changes.

IACAuthentication activity

In Pega Government Platform 8.7, the IACAuthentication activity is withdrawn from PegaPS ruleset. The IACAuthentication activity is moved to the UI-Kit specific PGPOverride ruleset, because the Cosmos application does not use the IACAuthentication activity. Create a copy of this in your implementation ruleset if its being used in implementation application built on Pega Government Platform Cosmos application.

For enhancing security, a new step 6 is added in the IACAuthentication activity to check for password validation. To skip this step, save the CreatePGPOperator application setting with the owning ruleset PegaPS, to the implementation application ruleset, and set the value to True.

Updates to the US State codes

In Pega Government Platform 8.7, the following state codes are corrected. Implementation teams need to make sure of backward compatibility, while upgrading, if these are being used as-is from the PGP application.

State Old value New value
Colorado CL CO
Delaware DL DE
Maryland MR MD

Changes to entity search data pages in PGP Cosmos

In Pega Government Platform 8.7, the following search data pages are updated to support AND logical condition along with the existing OR logical condition. The default behavior is updated to AND from OR, because OR condition is applicable only in the search landing pages.

If the search landing pages are updated in implementation layer or the data page is being used elsewhere for OR scenario , update them by passing the value true to UseOROperator parameter of the data page.

Data pages
D_PersonList
D_BusinessList
D_FacilityList
D_VehicleList

Updates to case edit actions

In Pega Government Platform 8.7, Edit case details , which is a default behavior of Pega Platform, is removed for Transfer ownership, Task, and Request access cases as they are not implemented. To enable the edit action, override the DisplayEditAction when condition to the implementation layer with the appropriate condition and add pyUpdateCaseDetails flow action to the case type rule. Else, remove the flow action from the case type rule, if present.

Changes to Registration.js

In PGP 8.7, the goToLoginURL and showHomePage functions in Registration.js file are updated to navigate the URL specific to the invoking application based on the application alias and this is supported by adding a new parameter alias to both the functions.

All the applications consuming these functions as-is need to send the alias parameter to the function where it is being invoked using the Application.pyProductAlias property. If the property is empty, set the alias on the application definition rule.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

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