{"title":"Install the cartridge and import the metadata","category":"default","creationDate":1677244080,"content":"

Prerequisites<\/h2>\n

Before you install the Adyen cartridge, make sure that you:<\/p>\n

    \n
  1. Have access to the Salesforce Sandbox.<\/li>\n
  2. Installed the Storefront Reference Architecture (SFRA) repository on GitHub<\/a>. You need developer access to access the repository on GitHub.<\/li>\n
  3. Downloaded the Adyen cartridge from our GitHub repository<\/a>.<\/li>\n
  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<\/a>.<\/li>\n<\/ol>\n

    Step 1: Set your credentials and version<\/h2>\n

    In your cartridge's root directory, create a dw.json<\/code> 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<\/a>.<\/p>\n

    {\n    \"hostname\": \"YOUR-SANDBOX-HOSTNAME.demandware.net\",\n    \"username\": \"*@example.com\",\n    \"password\": \"YOUR_WEBDAV_ACCESS_KEY\",\n    \"code-version\": \"VERSION_TO_UPLOAD_TO\"\n}<\/code><\/pre>\n
    Step 2: Install Node modules<\/h2>\n
    From your cartridge's root directory, install Node modules using your command line:\u00a0<\/p>\n
    npm install<\/code><\/pre>\n
    Step 3: Build the code<\/h2>\n
    The source files in the \/src<\/strong> 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:<\/p>\n
    npm run build<\/code><\/pre>\n
    This command does the following:<\/p>\n
      \n
    • Transpiles the JavaScript ES6+ code so that it is compatible with ES5.<\/li>\n
    • Compiles the modern JavaScript modules.<\/li>\n
    • Outputs deployable code in the \/cartridges<\/strong> directory<\/li>\n<\/ul>\n
      Step 4: Import the metadata<\/h2>\n
      To add new configuration items,\u00a0import the predefined metadata:\u00a0<\/p>\n
        \n
      1. Include your customizations in the metadata file.<\/li>\n
      2. Open the\u00a0package\/metadata\/site_import\/sites\/<\/strong>\u00a0folder.<\/li>\n
      3. Rename the\u00a0yourSiteId<\/strong> (RefArch) folder to the ID of your site in your Salesforce Business Manager.<\/li>\n
      4. Open the package\/metadata\/site_import\/jobs.xml<\/strong> file.<\/li>\n
      5. Rename the site-id<\/code> to the ID of your site in your Salesforce Business Manager.<\/li>\n
      6. Zip the\u00a0site_import<\/strong>\u00a0folder.\u00a0<\/li>\n
      7. In the Business Manager, go to Administration<\/strong> > Site Development<\/strong> > Site Import & Export<\/strong>\u00a0and\u00a0import the zipped file.<\/li>\n<\/ol>\n
        After the import, attributes named\u00a0Adyen[attributeName]<\/strong>\u00a0are added to:\u00a0<\/p>\n
          \n
        • Administration<\/strong>\u00a0>\u00a0Site Development<\/strong>\u00a0>\u00a0System Object Types<\/strong>\u00a0>\u00a0Site Preferences<\/strong>\u00a0>\u00a0Attribute Definitions<\/strong><\/li>\n
        • Administration<\/strong>\u00a0>\u00a0Site Development<\/strong>\u00a0>\u00a0System Object Types<\/strong>\u00a0>\u00a0Order<\/strong>\u00a0>\u00a0Attribute Definitions<\/strong><\/li>\n
        • Administration<\/strong>\u00a0>\u00a0Site Development<\/strong>\u00a0>\u00a0Custom Object Types<\/strong>\u00a0<\/li>\n<\/ul>\n
          Also, the following services are added to\u00a0Administration<\/strong>\u00a0> Operations<\/strong>\u00a0> Services<\/strong>:<\/p>\n
            \n
          • AdyenPayment<\/strong><\/li>\n
          • AdyenRecurring<\/strong><\/li>\n
          • AdyenRecurringDisable<\/strong><\/li>\n
          • AdyenPosPayment<\/strong><\/li>\n
          • AdyenOriginKeys<\/strong><\/li>\n
          • AdyenCheckoutPaymentMethods<\/strong><\/li>\n
          • AdyenPaymentDetails<\/strong><\/li>\n<\/ul>\n
            \n
            Make sure that you do not change the version numbers of the endpoints in the above services. Doing so could lead to errors in your integration.<\/p>\n<\/div>\n
            Watch how to import the metadata:<\/p>\n