Skip to navigation

Upgrade the Salesforce Commerce Cloud Enforcer

Overlay a new cartridge ZIP on a Salesforce code version.

HUMAN ships each Salesforce Commerce Cloud Enforcer release as a cartridge ZIP from HUMAN Support. Upgrading replaces the HUMAN cartridges in a code version with that ZIP. Complete the overlay on sandbox or staging first, then repeat on production. See Installation for details.

Upgrade

1

Overlay the cartridges

  1. Get the latest SFCC cartridge ZIP from HUMAN Support.
  2. Create or select a non-active code version. Production cannot upload into the active version.
  3. Unzip the file and upload the HUMAN cartridge folders onto that version, replacing the existing HUMAN folders. Leave your storefront cartridges in place. Import the cartridge covers the upload methods.
  4. If you customized files inside the HUMAN cartridges, copy those changes into the new folders after the overlay. From 22.0.0, custom functions belong in pxCustomFunctionsConfig.js at /int_perimeterx/cartridge/scripts/config. See Enrich Custom Parameters for more information.
2

Confirm the cartridge path

In Administration > Sites > Manage Sites > Settings, confirm the Effective Cartridge Path still lists the HUMAN cartridges at the front.

If this release adds a cartridge you did not have before, add it. Sites that use SCAPI (Composable Storefront/PWA Kit) need int_perimeterx_SCAPI as of 22.2.0. Register the cartridge has the full path order.

3

Re-import metadata

Import metadata.zip from the new ZIP the same way as install: Upload, then Import. Then, open PXConfig and confirm any required fields such as the App ID, Server Token, and Cookie Key.

If you are upgrading across 22.0.0, route lists in PXConfig (sensitive, monitored, enforced, and path whitelist) are a single regular expression instead of a comma-separated list, and the deprecated *RoutesRegex fields are removed. Configuration options has the version-specific formats.

4

Activate

Activate the code version that contains both your storefront cartridges and the new HUMAN cartridges. See Deploy for details.

Upgrading from versions before 20.1.0

Beginning with version 20.1.0, the storefront cartridge uses Salesforce’s onRequest hook and evaluates every site route automatically. If you are still on a version that called HUMAN from storefront controllers (pxManager), choose one:

  • To use onRequest, remove every pxManager integration point from your controllers. Leaving both in place can run HUMAN twice.
  • To keep the controller integration, delete hooks.json at int_perimeterx/cartridge/scripts/services/hooks.json. That file is what registers the onRequest hook.

If you are already on 20.1.0 or later, you can skip this section.