Migrate SuiteCommerce Advanced to the Latest Release

This topic applies to

Applies to

SuiteCommerce Advanced

Watch a Related Video

This section describes how to migrate from a previous version of SuiteCommerce Advanced to a new release. It does not apply to SuiteCommerce implementations, which are managed bundles that are automatically updated with each release.

Because SuiteCommerce Advanced SuiteApps are unmanaged bundles, updates are not automatically pushed to installed bundles. You must explicitly update the bundle to receive the latest changes. This is important to ensure that existing implementations with customizations are not impacted unexpectedly by an update.

Important

Before migrating to a new release of SuiteCommerce Advanced, refer to the SuiteCommerce Release Notes for information on enhancements and fixes in that release.


With SuiteCommerce Advanced, there are two types of releases:

  • Minor Releases: with these releases, the existing bundles are updated. No new bundle IDs are generated.

  • Major Releases: with these release, a new bundle is available and must be installed separately from your existing SuiteCommerce Advanced bundle.

Versioning

Important

Before an initial installation or when migrating to a new bundle version, refer to the SuiteCommerce Release Notes for information on enhancements and fixes in that bundle.


SuiteCommerce Advanced releases are generally available as unique SuiteApps, with unique bundle IDs, unless explicitly stated otherwise. Each bundle has a version number appended to the folder name. You can install multiple versions of the same bundle into your account.

There are three different types of SuiteCommerce Advanced bundle updates that can occur. Bundle updates use the following naming conventions:

  • X.01.0: These updates include major updates, new features, and enhancements. These bundles have a unique IDs and generally correspond with other NetSuite core releases.

  • 1.0X.0: These updates include bug fixes and small enhancements. These bundles will have a unique ID and be released on a frequent basis.

  • 1.01.X: These updates include critical bug fixes. A new bundle ID is not created for these fixes. Upgrading existing bundles with these releases should have little to no impact on existing customizations.

In addition to versioning of the SuiteCommerce Advanced SuiteApp, each Module within the application has its own unique version following the same convention outlined above. You can easily determine if a specific module has been updated by checking your existing version against the version in the updated release. Because of this versioning of Modules, when migrating to a new release you can easily stage the migration as needed. For example, you may have Address@1.0.0 in your existing implementation and the updated release has Address@2.0.0. You can choose to migrate just the Address module to take advantage of its new features, leaving the other modules for future migration.

Minor Releases

Minor releases generally include bug fixes, developer tool updates, or small new features with no impact on existing features. The effort to migrate existing customizations is minimal. These releases are delivered as unmanaged bundle updates. To take advantage of enhancements and fixes in the release, you need to do a bundle update from the Installed Bundle record in NetSuite.

Warning

Performing a bundle update causes all files in the existing Source and Development directories to be replaced with the updated set of files. If you have previously deployed customizations to the Development SSP application, those customizations must be redeployed from your local environment before any domain pointing to the Development SSP applications reflects the customizations.


To migrate to a new minor release:

  1. Review the SuiteCommerce Release Notes for details on changes included in the release and important notifications.

  2. Update the existing bundle installation.

    1. Go to Customization > SuiteBundler > Search & Install Bundles > List.

    2. Hover over the icon in the first column and select Update.

      The bundle update begins. This may take a while. While updating, a pending message displays in the status column. Refresh the screen during the process to see when the installation is complete.

  3. Download the new Source code from the file cabinet to your local environment.

    The source zip file is located at Web Site Hosting Files > Live Hosting Files > SSP Applications > NetSuite Inc. — SCA <version> > Source > _Sources. After downloaded, unzip the file into a new working directory.

  4. In your local environment, migrate existing customizations to the new source code directory.

    1. Create a duplicate of your custom module folder in the new source code directory.

    2. Copy your existing custom modules into the new custom module folder.

    3. Update the new distro.json file to include references to any custom modules and to define any custom application dependencies.

      Important

      Do NOT copy the existing distro.json file contents directly into the new distro.json file. Doing this causes overwrites to changes made in the distro.json file to support the new release. For example, a new module may be referenced. We suggest you do a DIFF of the files to ensure that you migrate all changes from your local distro.json file into the new distro.json file.


  5. Deploy your local files to NetSuite.

    For details, see Deploy to NetSuite.

    Tip

    Remember, any domain pointing to the Development SSP application will not reflect existing customizations until you re-deploy migrations from your local environment.


Major Releases

Major releases may include significant product enhancements and new features or bug fixes. When migrating to a new release with a new bundle ID, you install the new bundle and then merge existing customizations to the new bundle before pointing your live site domain to the new bundle.

The following procedure also applies to administrators who want to test a new major release by deploying to a development SSP within a site record.

To migrate to a new major release:

Important

Before migrating to a new release, review the SuiteCommerce Release Notes for important notifications and details regarding changes included in the release.


  1. Install the new bundle.

    1. Go to Customization > SuiteBundler > Search & Install Bundles.

    2. Enter the bundle ID for the version of the bundle you want to install. Bundle IDs are listed in the Release Notes.

    3. Select the bundle in the results list and then click Install. Follow any on-screen prompts to continue the install.

      The bundle installation may take a while. A pending message displays in the status column of the Installed Bundles page. Refresh the screen during the process to see when the installation is complete.

  2. Download the new Source code from the file cabinet to your local environment.

    The source zip file is located at Web Site Hosting Files > Live Hosting Files > SSP Applications > NetSuite Inc. — SCA [version] > Source > _Sources. After downloading is complete, unzip the file into a new working directory.

  3. In your local environment, migrate existing customizations to the new source code directory.

    1. Create a duplicate of your custom module folder in the new source code directory.

    2. Copy your existing custom modules into the new custom module folder.

    3. Update the new distro.json file to include references to any custom modules and to define any custom application dependencies.

      Important

      Do not copy the existing distro.json file contents directly into the new distro.json file. Doing this causes overwrites to changes made in the distro.json file to support the new release. For example, a new module may be referenced. NetSuite recommends evaluating the DIFF between files to ensure that you migrate all changes from your local distro.json file into the new distro.json file.


    4. Any module that changed in the new release bears a higher version number from its previous release. Compare module version numbers to assess which modules have been updated and migrate the changes to any existing customizations as necessary. Refer to the SuiteCommerce Release Notes for details on which modules were changed and why.

      Important

      Migrating to a new release requires testing to ensure any existing customizations remain viable. Evaluate differences in code against your existing customizations and test thoroughly before deploying to your live site. See Best Practices for Customizing SuiteCommerce Advanced.


  4. Deploy your local files and test appropriately.

    Testing may consist of various scenarios depending on your setup. You can deploy your local files to any of the following locations:

    For example, you can deploy your customizations to a local server or to a Netsuite sandbox account for testing. If you do not have a Sandbox account, you can deploy to an SSP Application linked to a development domain in NetSuite. After testing, deploy your files to the SSP Application linked to the primary domain.

To deploy your new implementation to a development SSP Application:

  1. Go to Setup > SuiteCommerce Advanced > SSP Applications and click View next to the SuiteCommerce Advanced Dev <version> application.

  2. Click Link to Domain.

  3. Select the development domain for this SSP Application.

Related Topics