{"title":"Upgrade the cartridge","category":"default","creationDate":1671463980,"content":"<p>We recommend that you upgrade when we have a major release.<\/p>\n<p>If you are on a version that is not maintained according to our <a href=\"\/pt\/plugins\/salesforce-commerce-cloud\/#support-levels\">cartridge support schedule<\/a>, we recommend that you upgrade to the <a href=\"https:\/\/github.com\/Adyen\/adyen-salesforce-commerce-cloud\/releases\/latest\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">latest version available<\/a>.<\/p>\n<p>To stay up to date on the released fixes and features, subscribe to our <a href=\"https:\/\/github.com\/Adyen\/adyen-salesforce-commerce-cloud\/releases\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">releases on GitHub<\/a>.<\/p>\n<p>The integration effort involved in upgrading depends on whether you have made any <a href=\"\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/customization-guide\">customizations<\/a> to the cartridge.<\/p>\n<p>There are different steps to follow for:<\/p>\n<ul>\n<li><a href=\"#default-integration\">Default integration<\/a><\/li>\n<li><a href=\"#customized-integration\">Customized Integration<\/a><\/li>\n<\/ul>\n<h2 id=\"default-integration\">Default Integration<\/h2>\n<ol>\n<li>Check which <a href=\"\/pt\/plugins\/salesforce-commerce-cloud\/sfra#supported-versions\">SFRA version<\/a> is required for this upgrade and migrate if necessary. We recommend you use the latest version of SFRA.<\/li>\n<li>Download the Adyen cartridge version that you want to install from <a href=\"https:\/\/github.com\/Adyen\/adyen-salesforce-commerce-cloud\/releases\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">GitHub<\/a>.<\/li>\n<li>Reupload the metadata:\n<ol>\n<li>Include your customizations in the metadata file.<\/li>\n<\/ol><\/li>\n<li>Open the\u00a0<strong>package\/metadata\/site_import\/sites\/<\/strong>\u00a0folder.<\/li>\n<li>Rename the\u00a0<strong>yourSiteId<\/strong> (RefArch) folder to the ID of your site in your Salesforce Business Manager.<\/li>\n<li>Open the <strong>package\/metadata\/site_import\/jobs.xml<\/strong> file.<\/li>\n<li>Rename the <code>site-id<\/code> to the ID of your site in your Salesforce Business Manager.<\/li>\n<li>Zip the\u00a0<strong>site_import<\/strong>\u00a0folder.\u00a0<\/li>\n<li>In the Business Manager, go to <strong>Administration<\/strong> &gt; <strong>Site Development<\/strong> &gt; <strong>Site Import &amp; Export<\/strong>\u00a0and\u00a0import the zipped file.<\/li>\n<li>Run to following command from the root directory to transpile, compile and upload the compatible, auto-generated code:\n<pre><code class=\"language-bash\">npm run build<\/code><\/pre><\/li>\n<li>\n<p>Adjust your cartridge path setup:<\/p>\n<ol>\n<li>In the Salesforce Business Manager, go to <strong>Administration<\/strong> &gt; <strong>Sites<\/strong> &gt; <strong>Manage Sites<\/strong> &gt; <strong>[yourSite]<\/strong> &gt; <strong>Settings<\/strong>.<\/li>\n<li>\n<p>In the <strong>Cartridges<\/strong> field for SFRA, enter, your cartridge path. <a href=\"\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/set-up-the-cartridge\">The cartridge path<\/a> depends on the version you are upgrading to:<\/p>\n<table>\n<thead>\n<tr>\n<th>v23.3.2 or earlier<\/th>\n<th>v24.1.0 or later<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>int_adyen_SFRA:int_adyen_overlay:app_storefront_base<\/td>\n<td>app_adyen_SFRA:int_adyen_SFRA:app_storefront_base<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n<h2 id=\"customized-integration\">Customized Integration<\/h2>\n<p>Before you begin, check if there are any <a href=\"#breaking-changes-for-customized-integrations\">breaking changes<\/a> that affect your custom code.<\/p>\n<ol>\n<li>\n<p><a href=\"\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/customization-guide#extract-custom-code-from-the-default-cartridge\">Extract any custom code you have added to the cartridge<\/a>.<\/p>\n<\/li>\n<li>\n<p><a href=\"\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/customization-guide#add-custom-code-in-a-separate-cartridge\">Add the extracted custom code in a separate cartridge<\/a>. For example, <strong>int_custom_cartridge<\/strong>.<\/p>\n<\/li>\n<li>\n<p>Check which <a href=\"\/pt\/plugins\/salesforce-commerce-cloud\/sfra#supported-versions\">SFRA version<\/a> is required for this upgrade and migrate if necessary. We recommend you use the latest version of SFRA.<\/p>\n<\/li>\n<li>\n<p>Download the Adyen cartridge version that you want to install from <a href=\"https:\/\/github.com\/Adyen\/adyen-salesforce-commerce-cloud\/releases\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">GitHub<\/a>. Create a folder with the downloaded cartridge.<\/p>\n<\/li>\n<li>\n<p>Re-upload the metadata:<\/p>\n<ol>\n<li>Include your customizations in the metadata file.<\/li>\n<\/ol>\n<\/li>\n<li>\n<p>Open the\u00a0<strong>package\/metadata\/site_import\/sites\/<\/strong>\u00a0folder.<\/p>\n<\/li>\n<li>\n<p>Rename the\u00a0<strong>yourSiteId<\/strong> (RefArch) folder to the ID of your site in your Salesforce Business Manager.<\/p>\n<\/li>\n<li>\n<p>Open the <strong>package\/metadata\/site_import\/jobs.xml<\/strong> file.<\/p>\n<\/li>\n<li>\n<p>Rename the <code>site-id<\/code> to the ID of your site in your Salesforce Business Manager.<\/p>\n<\/li>\n<li>\n<p>Zip the\u00a0<strong>site_import<\/strong>\u00a0folder.\u00a0<\/p>\n<\/li>\n<li>\n<p>In the Business Manager, go to <strong>Administration<\/strong> &gt; <strong>Site Development<\/strong> &gt; <strong>Site Import &amp; Export<\/strong>\u00a0and\u00a0import the zipped file.<\/p>\n<\/li>\n<li>\n<p>Run the following command from the root directory of the unmodified Adyen cartridge to transpile, compile and upload the compatible, auto-generated code:<\/p>\n<pre><code class=\"language-bash\">npm run build<\/code><\/pre>\n<\/li>\n<li>\n<p>Run the following command from the root directory of your customized cartridge to transpile, compile and upload the compatible, auto-generated code:<\/p>\n<pre><code class=\"language-bash\">npm run build<\/code><\/pre>\n<\/li>\n<li>\n<p>Check if the custom code is compatible with the new version and apply changes if needed.<\/p>\n<\/li>\n<li>\n<p>Adjust your cartridge path setup:<\/p>\n<ol>\n<li>In the Salesforce Business Manager, go to <strong>Administration<\/strong> &gt; <strong>Sites<\/strong> &gt; <strong>Manage Sites<\/strong> &gt; <strong>[yourSite]<\/strong> &gt; <strong>Settings<\/strong>.<\/li>\n<li>\n<p>In the <strong>Cartridges<\/strong> field for SFRA, enter: <strong>int_custom_cartridge:YOUR_CARTRIDGE_PATH<\/strong>. <a href=\"\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/set-up-the-cartridge\">The cartridge path<\/a> depends on the version you are upgrading to:<\/p>\n<table>\n<thead>\n<tr>\n<th>v23.3.2 or earlier<\/th>\n<th>v24.1.0 or later<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td>int_adyen_SFRA:int_adyen_overlay:app_storefront_base<\/td>\n<td>app_adyen_SFRA:int_adyen_SFRA:app_storefront_base<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n<\/li>\n<li>\n<p>Re-enable the <a href=\"\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/set-up-the-cartridge?plugin=Salesforce%20SFRA&amp;integration=cartridge&amp;version=24.3.1#set-up-the-business-manager\">Salesforce Business Manager configuration page<\/a>.<\/p>\n<\/li>\n<\/ol>\n<p>Watch how to upgrade your customized SFCC cartridge:<\/p>\n<iframe src=\"https:\/\/player.vimeo.com\/video\/843123446\" width=\"640\" height=\"360\" frameborder=\"0\" allow=\"autoplay; fullscreen; picture-in-picture\" allowfullscreen><\/iframe>\n<h3>Breaking changes for customized integrations<\/h3>\n<p>New versions may include changes that affect <a href=\"\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/customization-guide\">custom code<\/a>, these are documented in our <a href=\"\/pt\/plugins\/release-notes\">release notes<\/a> as <strong>Breaking Changes<\/strong>. To see an overview of all breaking changes introduced between versions, use the <strong>What's changed?<\/strong> feature in our release notes.<\/p>\n<p>The changes you must consider depends on the cartridge version you are upgrading from. For example, when upgrading from v21.2.0 to v23.1.0, you must not only consider the breaking changes in the v23.1.0, but all the breaking changes that were introduced between these versions.<\/p>","url":"https:\/\/docs.adyen.com\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/upgrade","articleFields":{"feedback_component":true,"parameters":{"plugin_type":"cartridge","github_url":"https:\/\/github.com\/Adyen\/adyen-salesforce-commerce-cloud\/releases","latest_major_version":"23.1.0","latest_major_version_path":"\/plugins\/release-notes?plugin=salesforce_commerce_cloud&version=23.1.0"},"last_edit_on":"04-01-2024 14:57","filters_component":false,"page_id":"c853469f-69d8-4aa9-9a52-0cf08c463bdc","decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/upgrade","title":"Upgrade the cartridge","content":"We recommend that you upgrade when we have a major release.\nIf you are on a version that is not maintained according to our cartridge support schedule, we recommend that you upgrade to the latest version available.\nTo stay up to date on the released fixes and features, subscribe to our releases on GitHub.\nThe integration effort involved in upgrading depends on whether you have made any customizations to the cartridge.\nThere are different steps to follow for:\n\nDefault integration\nCustomized Integration\n\nDefault Integration\n\nCheck which SFRA version is required for this upgrade and migrate if necessary. We recommend you use the latest version of SFRA.\nDownload the Adyen cartridge version that you want to install from GitHub.\nReupload the metadata:\n\nInclude your customizations in the metadata file.\n\nOpen the\u00a0package\/metadata\/site_import\/sites\/\u00a0folder.\nRename the\u00a0yourSiteId (RefArch) folder to the ID of your site in your Salesforce Business Manager.\nOpen the package\/metadata\/site_import\/jobs.xml file.\nRename the site-id to the ID of your site in your Salesforce Business Manager.\nZip the\u00a0site_import\u00a0folder.\u00a0\nIn the Business Manager, go to Administration &gt; Site Development &gt; Site Import &amp; Export\u00a0and\u00a0import the zipped file.\nRun to following command from the root directory to transpile, compile and upload the compatible, auto-generated code:\nnpm run build\n\nAdjust your cartridge path setup:\n\nIn the Salesforce Business Manager, go to Administration &gt; Sites &gt; Manage Sites &gt; [yourSite] &gt; Settings.\n\nIn the Cartridges field for SFRA, enter, your cartridge path. The cartridge path depends on the version you are upgrading to:\n\n\n\nv23.3.2 or earlier\nv24.1.0 or later\n\n\n\n\nint_adyen_SFRA:int_adyen_overlay:app_storefront_base\napp_adyen_SFRA:int_adyen_SFRA:app_storefront_base\n\n\n\n\n\n\n\nCustomized Integration\nBefore you begin, check if there are any breaking changes that affect your custom code.\n\n\nExtract any custom code you have added to the cartridge.\n\n\nAdd the extracted custom code in a separate cartridge. For example, int_custom_cartridge.\n\n\nCheck which SFRA version is required for this upgrade and migrate if necessary. We recommend you use the latest version of SFRA.\n\n\nDownload the Adyen cartridge version that you want to install from GitHub. Create a folder with the downloaded cartridge.\n\n\nRe-upload the metadata:\n\nInclude your customizations in the metadata file.\n\n\n\nOpen the\u00a0package\/metadata\/site_import\/sites\/\u00a0folder.\n\n\nRename the\u00a0yourSiteId (RefArch) folder to the ID of your site in your Salesforce Business Manager.\n\n\nOpen the package\/metadata\/site_import\/jobs.xml file.\n\n\nRename the site-id to the ID of your site in your Salesforce Business Manager.\n\n\nZip the\u00a0site_import\u00a0folder.\u00a0\n\n\nIn the Business Manager, go to Administration &gt; Site Development &gt; Site Import &amp; Export\u00a0and\u00a0import the zipped file.\n\n\nRun the following command from the root directory of the unmodified Adyen cartridge to transpile, compile and upload the compatible, auto-generated code:\nnpm run build\n\n\nRun the following command from the root directory of your customized cartridge to transpile, compile and upload the compatible, auto-generated code:\nnpm run build\n\n\nCheck if the custom code is compatible with the new version and apply changes if needed.\n\n\nAdjust your cartridge path setup:\n\nIn the Salesforce Business Manager, go to Administration &gt; Sites &gt; Manage Sites &gt; [yourSite] &gt; Settings.\n\nIn the Cartridges field for SFRA, enter: int_custom_cartridge:YOUR_CARTRIDGE_PATH. The cartridge path depends on the version you are upgrading to:\n\n\n\nv23.3.2 or earlier\nv24.1.0 or later\n\n\n\n\nint_adyen_SFRA:int_adyen_overlay:app_storefront_base\napp_adyen_SFRA:int_adyen_SFRA:app_storefront_base\n\n\n\n\n\n\n\nRe-enable the Salesforce Business Manager configuration page.\n\n\nWatch how to upgrade your customized SFCC cartridge:\n\nBreaking changes for customized integrations\nNew versions may include changes that affect custom code, these are documented in our release notes as Breaking Changes. To see an overview of all breaking changes introduced between versions, use the What's changed? feature in our release notes.\nThe changes you must consider depends on the cartridge version you are upgrading from. For example, when upgrading from v21.2.0 to v23.1.0, you must not only consider the breaking changes in the v23.1.0, but all the breaking changes that were introduced between these versions.","type":"page","locale":"pt","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Plugins","lvl2":"Salesforce Commerce Cloud - B2C Commerce","lvl3":"Storefront Reference Architecture (SFRA)","lvl4":"Upgrade the cartridge"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/plugins","lvl2":"https:\/\/docs.adyen.com\/pt\/plugins\/salesforce-commerce-cloud","lvl3":"https:\/\/docs.adyen.com\/pt\/plugins\/salesforce-commerce-cloud\/sfra","lvl4":"\/pt\/plugins\/salesforce-commerce-cloud\/sfra\/upgrade"},"levels":5,"category":"Plugins","category_color":"green","tags":["Upgrade","cartridge"]}}