Install the cartridge and import the metadata

Prerequisites

Before you install the Adyen cartridge, make sure that you:

1. Have access to the Salesforce Sandbox.
2. Installed the Storefront Reference Architecture (SFRA) repository on GitHub. You need developer access to access the repository on GitHub.
3. Downloaded the Adyen cartridge from our GitHub repository.
4. v25.3.0 or later: the Adyen cartridge uses modern JavaScript ES6+. If your Salesforce environment requires ES5 compatibility, you must transpile the source code.

Step 1: Set your credentials and version

In your cartridge's root directory, create a dw.json file that includes the information required to establish a server connection and the code version that you want to upload your cartridge to. Read more about WebDAV authentication in the Salesforce documentation.

{
    "hostname": "YOUR-SANDBOX-HOSTNAME.demandware.net",
    "username": "*@example.com",
    "password": "YOUR_WEBDAV_ACCESS_KEY",
    "code-version": "VERSION_TO_UPLOAD_TO"
}

Step 2: Install Node modules

From your cartridge's root directory, install Node modules using your command line: 

npm install

Step 3: Build the code

The source files in the /src directory use modern Javascript ES6+ syntax and modern tooling that Salesforce Commerce Cloud does not natively support. You must run the following to generate output that is compatible with JavaScript ES5:

npm run build

This command does the following:

• Transpiles the JavaScript ES6+ code so that it is compatible with ES5.
• Compiles the modern JavaScript modules.
• Outputs deployable code in the /cartridges directory

Step 4: Import the metadata

To add new configuration items, import the predefined metadata: 

1. Include your customizations in the metadata file.
2. Open the package/metadata/site_import/sites/ folder.
3. Rename the yourSiteId (RefArch) folder to the ID of your site in your Salesforce Business Manager.
4. Open the package/metadata/site_import/jobs.xml file.
5. Rename the site-id to the ID of your site in your Salesforce Business Manager.
6. Zip the site_import folder. 
7. In the Business Manager, go to Administration > Site Development > Site Import & Export and import the zipped file.

After the import, attributes named Adyen[attributeName] are added to: 

• Administration > Site Development > System Object Types > Site Preferences > Attribute Definitions
• Administration > Site Development > System Object Types > Order > Attribute Definitions
• Administration > Site Development > Custom Object Types 

Also, the following services are added to Administration > Operations > Services:

• AdyenPayment
• AdyenRecurring
• AdyenRecurringDisable
• AdyenPosPayment
• AdyenOriginKeys
• AdyenCheckoutPaymentMethods
• AdyenPaymentDetails

Watch how to import the metadata: