Categories Navigate Adapter Event Removed in SMT

In the 18.2 release of SuiteCommerce Advanced, the categories:navigate adapter event in SMT was removed. Consequently, SMT admins cannot preview current and future dated categories, as well as the preview of the category structure and the items in the categories. The patch instructions described below correct this problem.

To implement this patch, create a custom module to override CMSadapter.Impl.Categories.v3.js, which is part of the CMSadapter module. You can download the code samples described in this procedure here: CategoriesNavigateAdapterEventRemovedinSMT.

Note:

In general, NetSuite best practice is to extend JavaScript using the JavaScript prototype object. This improves the chances that your customizations continue to work when migrating to a newer version of SuiteCommerce Advanced. However, this patch requires you to modify a file in a way that you cannot extend, and therefore requires you to use a custom module to override the existing module file. For more information, see Develop Your SCA Customization.

Step 1: Create the Override File

Create an extensions directory to store your custom module. Depending on your implementation, this directory might already exist.
Within this directory, create a custom module with a name similar to the module being customized.

For example: Modules/extensions/CMSadapterExtension@1.0.0.
In your new CMSadapterExtension@1.0.0 directory, create a folder titled JavaScript.

For example: Modules/extensions/CMSadapterExtension@1.0.0/JavaScript

Copy the following source file and paste into the correct location:

Copy This File:	Place a Copy Here:
Modules/suitecommerce/CMSadapter@X.Y.Z/JavaScript/	Modules/extensions/CMSadapterExtension@1.0.0/JavaScript

Copy This File:

Place a Copy Here:

Modules/suitecommerce/CMSadapter@X.Y.Z/JavaScript/

Modules/extensions/CMSadapterExtension@1.0.0/JavaScript

In this example, X.Y.Z represents the version of the module in your implementation of SuiteCommerce Advanced.

Open your new copy of CMSadapter.Impl.Categories.v3.js and locate the listenForCMS() method.

Inside the listenForCMS() method, add the following event:

                self.CMS.on('categories:navigate', function (promise, data)
{
  Backbone.localCache = {};

  Backbone.history.navigate(url, { trigger: false });
  Backbone.history.loadUrl(url);

  self.reloadCategories({ 'dontRefresh': true }).then(function()
  {
    promise.resolve();
     });
});

Locate the following header of the reloadCategories() method:

                CMSadapterImplCategories3.prototype.reloadCategories = function () {

Change the header of the reloadCategories() to the following code:

                CMSadapterImplCategories3.prototype.reloadCategories = function (options) {

Locate the following line in the reloadCategories() method:

                self.refreshPLP();

Replace this line with the following code:

                if (!(options && options.dontRefresh))
{
  self.refreshPLP();
}

Save the file.

Step 2: Prepare the Developer Tools For Your Customization

Open your Modules/extensions/CMSadapterExtension@1.0.0 module directory.
Create a file in this directory titled ns.package.json.

Modules/extensions/CMSadapterExtension@1.0.0/ns.package.json

Paste the following code in your new ns.package.json file:

Important:

You must replace the string X.Y.Z with the version of the module in your implementation of SuiteCommerce Advanced.

                {
   "gulp": {
      "javascript": [
         "JavaScript/*.js"
      ]
   },
   "overrides": {
      "suitecommerce/CMSadapter@X.Y.Z/JavaScript/CMSadapter.Impl.Categories.v3.js" : "JavaScript/CMSadapter.Impl.Categories.v3.js"
   }
}

Open the distro.json file. This file is located in your root directory.

Add your custom module to the modules object.

Your code should look similar to:

                 {
    "name": "SuiteCommerce Advanced 2018.2.0 (sc-2018.2.0)",
    "version": "2.0",
    "isSCA": true,
    "buildToolsVersion": "sc-2018.2.0",
    "folders": {
        "modules": "Modules",
        "suitecommerceModules": "Modules/suitecommerce",
        "extensionsModules": "Modules/extensions",
        "thirdPartyModules": "Modules/third_parties",
        "distribution": "LocalDistribution",
        "deploy": "DeployDistribution"
    },
    "modules": {
        "extensions/CMSadapterExtension": "1.0.0",
        "suitecommerce/Account": "sc-2018.2.0",
            ...

This step ensures that the Gulp tasks include your module when you deploy. In this example, the custom modules are added at the beginning of the list of modules. However, you can add the modules anywhere in the modules object. The order of precedence in this list does not matter.

Save the distro.json file.

Step 3: Test and Deploy Your Customization

Test your source code customizations on a local server (see Test SCA Customizations on a Local Server) or deploy them to your NetSuite account (see Deploy SCA Customizations to NetSuite). If you are currently running SCA on a local server, your changes should appear on your local site immediately.
Confirm your results.

Upon successful deployment, you can go to to both current and future dated categories in SMT.

Step 1: Create the Override File

Step 2: Prepare the Developer Tools For Your Customization

Step 3: Test and Deploy Your Customization

Related Topics