ONBOARDING

Pega Client Lifecycle Management

for Financial Services
Upgrade Guide
8.4
 ©2020 Pegasystems Inc., Cambridge, MA. All rights reserved.

Trademarks
For Pegasystems Inc. trademarks and registered trademarks, all rights reserved. All other trademarks or
service marks are property of their respective holders.
For information about the third-party software that is delivered with the product, refer to the third-party
license file on your installation media that is specific to your release.

Notices
This publication describes and/or represents products and services of Pegasystems Inc. It may contain
trade secrets and proprietary information that are protected by various federal, state, and international
laws, and distributed under licenses restricting their use, copying, modification, distribution, or transmittal
in any form without prior written authorization of Pegasystems Inc.
This publication is current as of the date of publication only. Changes to the publication may be
made from time to time at the discretion of Pegasystems Inc. This publication remains the property
of Pegasystems Inc. and must be returned to it upon request. This publication does not imply any
commitment to offer or deliver the products or services described herein.
This publication may include references to Pegasystems Inc. product features that have not been licensed
by you or your company. If you have questions about whether a particular capability is included in your
installation, please consult your Pegasystems Inc. services consultant.
Although Pegasystems Inc. strives for accuracy in its publications, any publication may contain
inaccuracies or typographical errors, as well as technical inaccuracies. Pegasystems Inc. shall not be liable
for technical or editorial errors or omissions contained herein. Pegasystems Inc. may make improvements
and/or changes to the publication at any time without notice.
Any references in this publication to non-Pegasystems websites are provided for convenience only and
do not serve as an endorsement of these websites. The materials at these websites are not part of the
material for Pegasystems products, and use of those websites is at your own risk.
Information concerning non-Pegasystems products was obtained from the suppliers of those products,
their publications, or other publicly available sources. Address questions about non-Pegasystems
products to the suppliers of those products.
This publication may contain examples used in daily business operations that include the names of
people, companies, products, and other third-party publications. Such examples are fictitious and any
similarity to the names or other data used by an actual business enterprise or individual is coincidental.
This document is the property of:
Pegasystems Inc.
One Rogers Street
Cambridge, MA 02142-1209, USA
Phone: 617-374-9600 Fax: 617-374-9620
www.pega.com
Document: Pega Client Lifecycle Management for Financial Services Upgrade Guide
Publication date: October 30, 2020

Feedback
If you have comments for how we can improve our materials, send an email to AppDocBug@pega.com.

ii |
 Contents

Contents

Completing the prerequisite tasks..........................................................................................................................................................4

Backing up your system........................................................................................................................................................................... 5

Upgrading the application........................................................................................................................................................................6

Importing the application file................................................................................................................................................................... 6
Optional: Importing the sample data...................................................................................................................................................... 7
Optional: Enabling sample operator accounts....................................................................................................................................... 7
Changing the access group of existing operators..................................................................................................................................8
Optional: Asynchronous processing.........................................................................................................................................................8
Post-upgrade review................................................................................................................................................................................... 8

| iii
Completing the prerequisite tasks

Completing the prerequisite tasks

Before you upgrade the application, ensure that you complete all of the following tasks.

1. Before starting an upgrade, and before backing up your system, review the database policies and
application permissions that are used by your Pega Platform upgrade. Determine whether the
application is permitted to update the database automatically or if you must generate the database
scripts that your organization will use to manually make schema changes.
2. Determine which language packs are applicable to your product and check for availability. For
additional information, see Pega Marketplace.
3. Upgrade to the latest available release of Pega Platform 8.4, and ensure that you can log in as an
administrator. For more information, see the Pega Platform Upgrade Guide for your environment on the
Deploy Pega Platform page.
4. Upgrade Pega Foundation for Financial Services 8.4. For information, see the Pega Foundation for
Financial Services 8.4 Installation Guide on the Foundation for Financial Services product page. Apply any
hotfixes for this application. For the list of the required hotfixes, see the Pega Foundation for Financial
Services hotfixes page.
5. Upgrade Pega Product Designer for Financial Services 8.4. For information, see the Product Designer
for Financial Services 8.4 Installation Guide on the Pega Foundation for Financial Services product page.
Apply any hotfixes for this application. For the list of the required hotfixes, see the Pega Product
Designer for Financial Services hotfixes page.
6. Upgrade Pega Know Your Customer for Financial Services 8.4. For information, see the Pega Know Your
Customer for Financial Services 8.4 Installation Guide on the Pega Know Your Customer for Financial
Services product page. Apply any hotfixes for this application. For the list of the required hotfixes, see
the Pega Know Your Customer for Financial Services hotfixes page.
7. Upgrade Pega Know Your Customer Regulatory Compliance for Financial Services 20.1. For more
information, see the Pega Know Your Customer Regulatory Compliance for Financial Services 20.1
Installation Guide on the Pega Know Your Customer Regulatory Compliance for Financial Services
product page. Apply any hotfixes for this application. For the list of the required hotfixes, see the Pega
Know Your Customer for Financial Services hotfixes page.
8. Obtain the latest Pega Client Lifecycle Management for Financial Services application media.

4|
 Backing up your system

Backing up your system

When upgrading an application, back up your system after each step to ensure that you can revert to the
last working version of the system if you encounter an issue.
Note: The deployment process modifies both the data schema and the rules schema. Use a
backup procedure that preserves both schemas.

1. Verify that all rules are checked in.

2. Shut down the Pega Platform application server.
3. Use your database utilities to complete an offline backup of the Pega database.
4. Back up the configuration and environment files.
If you edited any of the following Pega Platform configuration files in the APP-INF\classes directory
of an EAR deployment or the WEB-INF\classes directory of a WAR deployment, include these files in
the backup:
• prbootstrap.properties
• prconfig.xml
• logging file: prlogging.xml or prlog4j2.xml
• web.xml
• pegarules.keyring or any other .keyring files
5. Back up any third-party or custom JAR files that you installed.
Redeploying the Pega Platform applications might delete these files from your application server.
Note: The import of the new version of the application may require the execution of column
and declare-index population jobs. These jobs run in the background populating new columns
and declare-indexes imported with the application, what can involve the update of a great
number of records. In PostgreSQL installations, this massive update of records may require
additional temporary disk space - ensure that there is enough disk available for the database to
grow.

|5
Upgrading the application

Upgrading the application

To upgrade Pega Client Lifecycle Management for Financial Services, import the application file, and then
complete additional procedures in this guide.

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

• Importing the application file

• Optional: Importing the sample data
• Optional: Enabling sample operator accounts
• Changing the access group of existing operators
• Optional: Asynchronous processing
• Post-upgrade review

Importing the application file

The system data and rulesets for Pega Client Lifecycle Management for Financial Services are loaded
during this task.

1. Log in to Pega Platform (https://<hostname>:<port>/prweb) by entering the administrative ID and

password that you used during Pega Platform installation, for example, administrator@pega.com.
2. In the header of Dev Studio, click Configure > Application > Distribution > Import.
3. Select the Rules\PegaCLMFS.jar file from your distribution media, and then follow the wizard
instructions.
The wizard identifies the differences between the database schema of your system and the schema of
Pega Client Lifecycle Management for Financial Services 8.4.
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. When the import is complete, click Done.
6. Repeat the previous steps for the following files:
• Rules/PegaCLMFSCIB.jar
• Rules/PegaCLMFSRet.jar
7. Apply the required hotfixes by using Hotfix Manager. For more information about applying hotfixes,
see Applying hotfixes to an on-premises system.
8. Optional: Verify the application rules.
a. In the navigation pane of Dev Studio, click Records > Application Definition > Application.
b. Confirm that the following application rule or rules are displayed in the list:
• PegaCLMFS, PegaCLMFSCIB, PegaCLMFSRet, PegaCLMFSUnified 8, and PegaCLMFSWSS 8

6|
 Upgrading the application

What to do next: 
Complete the additional post-upgrade tasks described in this guide, if applicable.

Optional: Importing the sample data

The Pega Client Lifecycle Management for Financial Services distribution media includes sample data to
help you explore the default 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 data 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 Client Lifecycle Management for
Financial Services application file.

To import the sample configuration for Pega Client Lifecycle Management for Financial Services, complete
the following steps.

1. In the header of Dev Studio, click Configure > Application > Distribution > Import.

2. Select the SampleData\PegaCLMFSSampleBasic.jar file from your distribution media.
3. Follow the wizard instructions to import the sample data.
4. To import sample data and operators, repeat the previous steps for SampleData/
PegaCLMFSSampleCustomers.jar.
Note: Importing this package may result in the override of some 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.

Optional: Enabling sample operator accounts

If you imported the sample data, operators are included that allow you to access the sample data. For
security purposes, sample operators are disabled by default.

Before you begin: Ensure that you have already imported the sample data that contains the sample
operators.

To enable the sample operators, complete the following steps.

1. In the header of Dev Studio, click Configure > Org & Security > Authentication > Operator Access.
2. In the Disabled operators section, select the check box next to the operator ID to enable.
3. Click Enable selected.
The Enable Operator dialog is displayed.

|7
Upgrading the application

4. Click Submit to confirm that you want to enable the selected operator ID.
5. Click OK to close the dialog box.

Changing the access group of existing operators

If you have the john.johnson@uplusfs.com operator in the system and you want to start or continue
using the operator, you should change its access group to CLMFSCIB_RM.
Note:
All other existing other operators are not affected by this upgrade. Only
john.johnson@uplusfs.com needs an access group update.

1. In the header of Dev Studio, click Configure > Org & Security > Organization > Operators.
2. Search for the john.johnson@uplusfs.com operator and change the access group to CLMFSCIB_RM.

Optional: Asynchronous processing

Versions 8.2 and newer of the application change the way that certain operations are executed at different
points of the case lifecycle. Heavy operations such as the transition between Capture and Enrich stage
or the creation of KYC cases have been moved to background processes to improve the user experience.
After upgrading to this new version from versions 8.1 and older, users will experience a change in the
behavior of the application. For more information on how to configure the processes that will be run in
asynchronous mode or to deactivate asynchronous processing, see the Pega Client Lifecycle Management
for Financial Services Implementation Guide on the product page.

Post-upgrade review
Review the following changed or deprecated rules in this task to ensure that they do not impact your
implementation of Pega Client Lifecycle Management for Financial Services. These changes do not affect
standard implementations, but may affect customized implementations.

1. Review the Relationship codes and entity type codes Community page.
2. Review the Deprecated rules Community page.

8|