Skip to main content

Resolving pre-update issues for Next-Best-Action Designer

Suggest edit
Updated on December 20, 2021

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

Before you update your Pega Marketing or Pega Customer Decision Hub application, run the Pre-Upgrade Check on your system to help you identify issues that might cause a failure during an update. Some of the checks are related to Next-Best-Action Designer. Resolve the reported issues to prepare your application for an update.

Pega Customer Decision Hub Update Guide

The Pre-Upgrade Check can identify the following types of issues related to a Next-Best-Action Designer update:

Issue: .pzIsPrivateCheckout rule is set to true

If the rule is not currently checked out by an operator, but the pzISPrivateCheckout flag is set to True, open the rule and save it to resolve the issue.

Issue: Generated rules are in multiple rulesets

Generated artifacts are expected to be maintained in one ruleset, but can be present in multiple ruleset versions. Remove the extra rulesets, or remove the rules that are currently duplicated in the ruleset other than AccesGroup's destination ruleset.

Issue: Rule is checked out by other operators

Log in as a different operator and discard the checkouts before proceeding with the update. You can also log in as an Admin and release the lock on the rulesets that have been checked out.

Issue: Ruleset defined in the Access Group has opened versions above it

The access group destination ruleset should use the latest ruleset version. If the latest open ruleset version is not specified on the access group, the Next-Best-Action Designer update may fail. Make sure the latest unlocked version of the ruleset is specified on the access group.

  1. Log in to Dev Studio with a user account that is associated with an access group.
  2. In the navigation pane of Dev Studio, click the Operator menu, and then click Access group.
  3. Click the Advanced tab.
  4. In the Design time configuration section, change the Version to be the latest unlocked ruleset version.
  5. Click Save.

Issue: Unlocked ruleset version unavailable for editing

To perform an update, there must be an unlocked ruleset version available for editing. If there is not, the Next-Best-Action Designer update may fail. To make a ruleset available for editing, navigate to the default destination ruleset defined in your access group and unlock the desired ruleset version.

  1. Log in to Dev Studio with a user account that is associated with an access group.
  2. In the navigation pane of Dev Studio, click the Operator menu, and then click Access group.
  3. Click the Advanced tab.
  4. In the Design time configuration section, click the Target icon next to the Default destination ruleset field.
  5. On the Versions tab, click the arrow next to the ruleset version that you want to unlock.
  6. Click Unlock and Save.
  7. In the Unlock RuleSet Version window, enter your password, and then click Submit.

Issue: Saving the Context Dictionary

If the Context Dictionary is not saved or is saved with errors, the Next-Best-Action Designer update may fail. Try saving the Context Dictionary again. If any errors appear in the Context Dictionary, you must address them and try saving the Context Dictionary again. For more information, see Setting the context for your customer class.

Issue: The primary level class defined on the Context Dictionary is not accessible by your application

If the primary level class defined in the Context Dictionary is not accessible by your application, the Next-Best-Action Designer update may fail. Change the primary level class defined in the Context Dictionary to one that exists and is accessible by your application and save the Context Dictionary. For more information, see Understanding multilevel decisioning and the Context Dictionary.

Issue: Proposition filter validation has encountered errors

Failure of validating proposition filters may lead the Next-Best-Action Designer update to fail. Address any errors relating to the proposition filter.

  1. Log in to your application as an operator with access to Pega Customer Decision Hub.
  2. In the header of Pega Customer Decision Hub click ConfigurationPre-Upgrade Check.
  3. In the Next-Best-Action Designer issues section, click the name of the Proposition Filter to open the specified Proposition Filter.
  4. Fix all errors.

Issue: Context Dictionary ruleset is not specified

If the Context Dictionary ruleset is not specified, the Next-Best-Action Designer update may fail. Specify the ruleset and save Context Dictionary.

  1. Log in to your application as an operator with access to App Studio.
  2. In the navigation pane of App Studio, click SettingsContext Dictionary.
  3. Specify the contexts and ruleset/ruleset version and click Save.

Issue: Context dictionary is in legacy mode

Next-Best-Action Designer cannot be updated using the legacy mode of Context Dictionary, but must be migrated to standard mode. To migrate Context Dictionary from legacy mode, see Migrating the Context Dictionary from Legacy mode to Standard mode.

Issue: Next-Best-Action Designer model is checked out

A checked-out Next-Best-Action model can interfere with the Next-Best-Action Designer update and can cause it to fail. Check-outs need to be discarded or checked in.

  1. Log in to your application as the operator with access to Pega Customer Decision Hub, who checked out the Next-Best-Action model.
  2. In the navigation pane of Pega Customer Decision Hub, click Next-Best-ActionDesigner.
  3. Either save or cancel the Next-Best-Action.

Issue: Next-Best-Action Designer config is checked out

A checked-out Next-Best-Action config can interfere with the Next-Best-Action Designer update and can cause it to fail. The check-out needs to be discarded or checked in.

  1. Log in to your application as the operator with access to Pega Customer Decision Hub, who checked out the Next-Best-Action config.
  2. In the navigation pane of Pega Customer Decision Hub, click Next-Best-ActionDesigner.
  3. On the Engagement Policy tab, navigate to the Issue or Group that is displaying the EDITING flag, and either cancel or save the config.

Issue: Next-Best-Action Designer strategy is checked out

An auto-generated Next-Best-Action Designer strategy that is checked out can cause the update to fail. Discard any check-outs before proceeding.

  1. Log in to your application as the operator with access to Pega Customer Decision Hub, who checked out the Next-Best-Action strategy.
  2. Open the strategy using the link in the Pre-Upgrade checker tool.
  3. Discard the check-out strategy by clicking the Discard button.

Issue: Next-Best-Action Designer associated campaign is running

Any outbound schedule configured in Next-Best-Action Designer generates a campaign. A Next-Best-Action Designer update can involve updating the strategy that the campaign refers to. Having a running outbound schedule can interfere with the Next-Best-Action Designer update and can cause failure. It is recommended to suspend the outbound schedule before updating.

  1. Log in to your application as an operator with access to Pega Customer Decision Hub.
  2. In the navigation pane of Pega Customer Decision Hub, click CampaignsCampaigns.
  3. Navigate to the campaign ID given in the Pre-Upgrade checker, and then click the campaign ID to open it.
  4. Suspend the campaign by clicking ActionsSuspend.

Issue: Customer Contact Policy has a Quarterly or Yearly policy period defined

If you are updating to Pega Customer Decision Hub version 8.7, the Quarterly and Yearly policy periods will no longer be supported and therefore will not be updated. If you would like to keep these contact policies, you will need to switch their policy periods to Monthly, Semimonthly, Weekly, or Daily. If you do not wish to keep the Quarterly and Yearly contact policy periods, no action is needed.

Change Quarterly and Yearly Next-Best-Action policy periods:

  1. In the navigation pane of Pega Customer Decision Hub, click Next-Best-ActionDesigner.
  2. On the Constraints tab, click Edit customer contact policy.
  3. Click Check out.
  4. Remove the Yearly and/or Quarterly contact policy periods and replace them with Monthly, Semimonthly, Weekly, or Daily policy periods.
  5. Click Check in.

Issue: Customer Contact Policy is not currently in use

If you are updating to Pega Customer Decision Hub version 8.7, and if a customer contact policy is defined within Next-Best-Action Designer, even if it is marked as unavailable, the policy end date has passed, or the policy start date is in the future, it will be migrated to 8.7 as current policy and will be in use. If you do not want to migrate the customer contact policy to 8.7, you can delete it before updating.

Did you find this content helpful? YesNo

Have a question? Get answers now.

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

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