Theme Deployment Process in SuiteCommerce Development

Deploying a theme in SuiteCommerce allows you to activate your design for a website domain after thorough local testing. This guide covers the deployment process, detailing necessary commands and steps for a successful implementation.

How Do You Deploy a Theme?

To deploy your theme to NetSuite, follow these steps:

1. Open Terminal: Access your command line or terminal within the top-level development directory of your theme.
2. Run the Deployment Command: Execute the command:
   bashCopy

   gulp theme:deploy

   Note: For accounts with account-specific domains (2021.2.1 and later), include your account number using the argument --account to authenticate your access.
3. Respond to Prompts: The first deployment will require you to enter several parameters:
   • Authentication ID: An ID representing your NetSuite account and role. For previously created IDs, no prompt will appear.
   • Account and Role: Specify the NetSuite account and role for authentication. Administrator and SCDeployer roles typically have the necessary permissions to deploy.
   • Website: Choose the website linked with your domain.
   • Vendor: Name of the vendor constructing the theme.
   • Name: Specify your custom theme name (no special characters).
   • Fantasy Name: The display name for your theme in the NetSuite UI.
   • Version: Provide a version number (format: dd.dd.dd). This is crucial for tracking updates.
   • Description: Write a brief description for visibility in NetSuite.
   • Supported Products: Select the appropriate products (e.g., SuiteCommerce Online).
   • Target Version: Indicate the target versions for your theme compatibility.

Deployment Process Steps

When executing the gulp theme:deploy command, the following actions occur:

• Your custom theme files are validated and copied to a local DeployDistribution folder.
• The manifest.json file is updated, capturing any overrides.
• The source files are uploaded into your NetSuite File Cabinet in a bundled format.
• An Extension record for your custom theme is created, making the files available for activation.

Important Considerations

• Chunk Size: The command uploads files in chunks, defaulting to 80 files per chunk. Adjust this setting if necessary.
• Extension Overrides: If your theme includes overrides from extensions, note that these must be activated to take effect. Without activation, they won’t apply if new extensions are added later.

Example Scenario

Let's say you have customized the SuiteCommerce Base Theme along with an active extension PublishedExtension1. After thorough testing, you decide to deploy your changes:

1. You run gulp theme:deploy.
2. The tools update your manifest.json, validate customizations, and prepare files for upload.
3. The command prompts you to name your theme, which you name MyCustomTheme1. Your local directory is subsequently renamed, preparing for the new deployment.

Next Steps

After deploying, ensure to activate your theme to apply it to your selected website domain. Reference the activation guide for detailed instructions.

Key Takeaways

• Deploy your theme using gulp theme:deploy for file validation and upload.
• Respond to prompts for authentication and theme details during the first deployment.
• Manage extensions carefully to ensure your overrides apply correctly.

Source: This article is based on Oracle's official NetSuite documentation.