Deploying Custom Themes in NetSuite Commerce

TL;DR

Deploying custom themes in NetSuite Commerce allows you to personalize your website's appearance. After testing a theme locally, it's essential to deploy it, making it available for activation on your desired domain.

What Happens When You Deploy a Theme?

When you deploy a theme using the Gulp command, several steps take place:

• Your theme files and any extension overrides are uploaded to the NetSuite File Cabinet.
• The deployment process verifies your customizations and compiles your theme source files.
• The manifest file is updated with necessary overrides, ensuring a consistent integration.

Steps to Deploy Your Theme

1. Open the Command Line: In your local development environment, navigate to the top-level directory of your project.

2. Deploy Command: Execute the following command:

   bashCopy

   gulp theme:deploy

   Note: For accounts with account-specific domains (2021.2.1 and later), include your account number with the command for proper authentication.

   Important: The deployment process updates the manifest.json file. If you've made manual changes to this file that you want to preserve, run:

   bashCopy

   gulp theme:deploy --preserve-manifest

3. Input Required Information: During the first deployment, you will need to provide:

   • Authentication ID: Represents your NetSuite account and role.
   • Account and Role: Select the NetSuite account and role needed for authentication.
   • Website: Choose the associated website for your theme.
   • Vendor: Name of the vendor involved in the theme build.
   • Theme Name: A name for your custom theme (no special characters or spaces).
   • Fantasy Name: A display name for the theme in the NetSuite interface (can include spaces and special characters).
   • Version: Assign a version to your theme using the format dd.dd.dd.
   • Description: A brief description that will be displayed in NetSuite.
   • Supported Products: Identify the products your theme will apply to (e.g., SuiteCommerce Online).
   • Target Version: Specify compatibility versions for your theme.

The Deployment Process

When you run the command:

• The developer tools validate your customizations and copy files to a DeployDistribution directory, creating it if it does not exist.
• The theme files are uploaded in chunks to the NetSuite File Cabinet, preserving the organizational structure.

Activation of Your Theme

After deploying your theme, the next critical step is activating it for your website domain. Refer to the instructions on Activating Themes and Extensions for guidance on applying your newly deployed theme.

Key Takeaways

• Deploying themes allows for website customization in NetSuite.
• Use the gulp theme:deploy command for deployment and remember to include your account number when necessary.
• Ensure you enter the correct details during the deployment prompts to avoid errors.