Skip to main content


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

Complete the prerequisite tasks

Updated on December 20, 2021

This content applies only to On-premises and Client-managed cloud environments

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

Pega Customer Decision Hub Update Guide
  1. Ensure that there are no open change requests in your application, including requests created through Revision Management and through Pega 1:1 Operations Manager.
    Caution: If any change requests are in status other than Resolved-Completed or Withdrawn during the upgrade, they may fail.
  2. Ensure that any existing responses to adaptive models are updated.
  3. Run the Pre-Upgrade Check component to assess if your application is ready for an upgrade. If the check reports any issues, resolve them.
  4. Ensure that you can stop and start the application server.
  5. Before starting an update, and before backing up your system, review the database policies and application permissions that are used by your Pega Platform update. 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.
  6. Finalize any in-use database templates.
    For more information, see the "Templates" chapter of the Pega Customer Decision Hub User Guide on the Pega Customer Decision Hub product page.
  7. If the following agents are enabled, disable them:
    • ServiceLevelEvents agent in the Pega-ProCom ruleset
    • RevalidateAndSave agent in the Pega-ImportExport ruleset
  8. Unlock all artifacts rulesets that contain any artifacts which you want to continue using after the upgrade.
  9. Before you start the upgrade, ensure that you have the following database information available:
    • Such database connection information as:
      • Hostname or IP address
      • Database port
      • Database name
    • JDBC driver JAR file for your database type
    • PegaRULES schema name
    • If using split schema, PegaDATA schema name
    • Ensure that the Pega Marketing or Pega Customer Decision Hub external schema meets the following requirements:
      • This is the schema that contains your customer data repository and other marketing assets.
      • This schema must exist in the same database as the PegaDATA and PegaRULES schemas.
      • This schema must have the database privileges to create views and to select from tables in the PegaDATA schema.
    • Ensure that the Pega Marketing or Pega Customer Decision Hub external user and password meet the following requirements:
      • This user must already exist.
      • This is the user that Pega Platform uses to connect to the Pega Marketing or Pega Customer Decision Hub external schema.
      • This user must have full privileges to the Pega Marketing or Pega Customer Decision Hub external schema.
      • This user must have the database privileges to create views and to select from tables in the PegaDATA schema.
    • Ensure that the Pega Deployment user and password meet the following requirements:
      • This user must already exist.
      • This is the user that the setup utility will use to connect to the database.
      • This user must have permissions to create and modify objects in all Pega schemas.
      • If using Oracle, this user must have permission to create materialized views.
    • Ensure that the user associated with PegaDATA DB rule meets the following requirements:
      • This user must be set in application server configuration.
        • For Tomcat, this would typically be in the context.xml file.
      • The user that is mapped to the PegaDATA DB rule must already exist.
      • This user must have the following privileges on the PegaDATA schema:
        • Select, Create, and Drop on tables, indexes, and views
        • Insert, Update, and Delete on tables
        • Alter on tables and indexes
    • Ensure that the user associated with PegaRULES DB rule meets the following requirements:
      • This user must be set in application server configuration.
        • For Tomcat, this would typically be in the context.xml file.
      • The user that is mapped to the PegaRULES DB rule must already exist.
      • This user must have the following privileges on the PegaRULES schema:
        • Select, Create, and Drop on tables, indexes, and views
        • Insert, Update, and Delete on tables
        • Alter on tables and indexes
      • This user can be the same as the PegaDATA user, provided the user has permissions to both schemas.
  10. For IBM Db2 databases, if you use JDBC URL to connect to your external database, add the following parameters to the template URL and the prweb.xml file where the Pega DB connections are defined:
    • resultSetHoldability=1;
    • resultSetHoldabilityForCatalogQueries=1;
    • allowNextOnExhaustedResultSet=1;
    See below for an example of the syntax. The database in the example is set to MYDB and the marketing external schema is set to MKTDATA.
    jdbc:db2://localhost:50000/MYDB:fullyMaterializeLobData=true;
    fullyMaterializeInputStreams=true;
    progressiveStreaming=2;
    progressiveLocators=2;
    useJDBC4ColumnNameAndLabelSemantics=false;
    currentSchema=MKTDATA;
    resultSetHoldability=1;resultSetHoldabilityForCatalogQueries=1;
    allowNextOnExhaustedResultSet=1;
    Note:

    The setting values also apply to the PegaDATA and PegaRULES connections created by Pega Platform.

  11. Check in all checked out rules and log off all users.
  12. Back up existing database and app-server level application data. For more information, see Backing up your system.
  13. Log in as an operator with an administrator access group:
    • If you are upgrading from Pega Customer Decision Hub 8.1 or later, the access group is your application:CDHAdmins.
    • If you are upgrading from Pega Marketing 8.1-8.4, the access group is your application:MKTAdmins.
  14. Edit the your application:CDHAdmins or your application:MKTAdmins access group, or another access group with administrator privileges which your application uses, and add the PegaRULES:SecurityAdministrator user role.
    Note: The PegaRULES:SecurityAdministrator role is required to manage operator access in Pega Customer Decision Hub. At least one administrator access group in your application must include this role.
  15. Click ConfigureDecisioningDecisionsData flowsBatch Processing and ensure there are no data flow runs in progress.
  16. Disable agent schedules by performing the following actions:
    1. Click RecordsSysAdminAgent Schedule.
    2. Open all Pega Marketing or Pega Customer Decision Hub agent schedules, including the following:
      • PegaMKT-Engine
      • PegaMKT-PushNotification
      • PegaMKT-Install
      • PegaMKT-FieldMarketing (if installed)
    3. Uncheck Enable this agent and ensure that each individual agent is disabled.
    4. Click Save.
    Note: If you do not disable agent schedules, the agents will automatically restart after the upgrade, with existing scheduled queue items trying to run, unsuccessfully. This will result in a list of broken queue items that you will need to be address manually.
  17. Update to the latest version of Pega Platform 8.5, and ensure that you can log in as an administrator. For more information, see the Pega Platform Update Guide for your environment on the Deploy Pega Platform page.
  18. Important: Perform this step if you are upgrading from Pega Customer Decision Hub 8.4 and you have customized prediction strategies that set properties for the deprecated pyCampaignOptimization flags.
    Remove the pyCampaignOptimization flags and other associated properties from your prediction strategies.
  • Previous topic Pega Customer Decision Hub or Pega Marketing 8.x to Pega Customer Decision Hub 8.5 Update Guide
  • Next topic Pre-Upgrade Check for Pega Customer Decision Hub

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