Cartridge installation

Install the HeyLight SFRA cartridge (int_heidipay) on your Salesforce Commerce Cloud store, then build the assets and import the metadata.

📘

Compatibility

The cartridge supports the latest Storefront Reference Architecture (SFRA) version, currently 6.3.0. It uses the hosted payment page approach, so no card data is stored on the SFCC side.

1. Install & assign the cartridge

1. Install the int_heidipay cartridge in the standard way (see the SFCC documentation, Add Custom Cartridges).
2. In Business Manager, go to Administration > Sites > Manage Sites, select the site and open the Settings tab.
3. Add int_heidipay to the Cartridges field (the effective site cartridge path) and click Apply.

2. Build JavaScript & CSS

If necessary, update the base SFRA path in package.json from the same root folder. Normally you would have a top-level folder containing the SFRA base cartridge and other plugins and LINK cartridges. If you cloned the HeyLight cartridge into that folder this is not required; otherwise set the base path to the relative path of your local SFRA directory. The default value is:

"paths": {
    "base": "../storefront-reference-architecture/cartridges/app_storefront_base/"
}

Once the correct path is configured, run the following from the root folder of the HeyLight cartridge:

npm run compile:js
npm run compile:scss

3. Import the metadata

The site-template folder in the installation package contains the metadata files.

1. Review the site_template folder and make the necessary modifications. The only required change is renaming SiteID to your site's ID (clone the folder for each additional site).
2. Archive the site_template folder into site_template.zip.
3. Import it in Administration > Site Development > Site Import & Export.

Next: configure the cartridge

With the cartridge installed and the metadata imported, continue to Cartridge configuration to set your site preferences, API keys, service credentials and the reconciliation job.