NetSuite Changelog
GeneralSuiteCommerceCustomizationConfigurationeCommerce

Edit Theme Manifest in NetSuite Commerce

Edit the manifest.json to manage NetSuite Commerce theme customizations and extension overrides. Each theme in NetSuite Commerce includes a manifest.json file

·2 min read·View Oracle Docs

Each theme in NetSuite Commerce includes a manifest.json file within the Workspace directory, vital for managing resources in an active theme. This file is crucial for compiling resources and should be edited to include any HTML, Sass, or assets created during theme customization.

What Does the manifest.json Include?

The manifest.json file organizes various elements:

  • Theme Metadata: Automatically populated upon deploying a theme. It contains important fields such as name, vendor, type, target, version, and description.
  • Overrides: Manages extension overrides. Using Gulp.js commands, any HTML or Sass file overrides are automatically included during deployment.
  • Templates: Lists HTML template files for applications like shopping, myaccount, and checkout. Custom templates must be manually added.
  • Sass: Defines paths to Sass entry points. New Sass files should be added in the logical order of their hierarchy.
  • Skins: These are automatically updated when running theme development commands. You can customize the name of these skins for clarity.
  • Assets: Manages theme directory asset paths, facilitating the integration of new images and fonts.
  • Record Paths: Details the theme, extension record, and activation IDs within NetSuite.

Customizing Your Theme

To customize your theme effectively, you should manually update this file. Note that Gulp.js tools assist in some updates, particularly when deploying your theme or handling theme overrides.

For more examples and guidance on customizing themes, consider checking related resources such as "Add a New File to a Theme," "Test and Deploy Your Theme," and best practices documentation.

Who This Affects

  • Developers working on theme customization
  • Administrators managing SuiteCommerce configurations
  • eCommerce teams seeking to implement unique themes on their storefronts

Key Takeaways

  • manifest.json is central to theme resource management in NetSuite Commerce.
  • Theme customizations require manual entries for new HTML, Sass, and assets.
  • Tools like Gulp.js automate some of the processes, but manual edits are essential for custom files.
  • The manifest file allows for extensive customization and management of themes, from metadata to assets.

Frequently Asked Questions (4)

When should I manually edit the manifest.json file in a theme?
You should manually edit the manifest.json file when adding new HTML, Sass, or assets to your theme customizations. It is also necessary to edit this file to introduce new template or Sass files for proper organization within the theme.
How are extension overrides included in the manifest.json file?
Extension overrides are included in the manifest.json file automatically when you use the Override method and deploy using the `gulp theme:deploy` command. The Gulp.js tools detect any overrides and include them as part of the deployment process.
What is required for the `templates` object in the manifest.json file?
The `templates` object lists all HTML template files included in the theme, organized by application such as `shopping`, `myaccount`, and `checkout`. You must manually add any new template files introduced as part of your theme customizations in the `files` array for each application.
How does the Sass section in manifest.json handle files?
In the Sass section, you should manually declare paths to each application entry point and include all Sass files in the `files` array. Each new Sass file must be listed in a semantically logical order within the Sass hierarchy to ensure proper styling and functionality.
Source: Workspace/<THEME_DIRECTORY>/manifest.json — Oracle NetSuite Help Center. This article was generated from official Oracle documentation and enriched with additional context and best practices.

Was this article helpful?

More in General

View all General articles →