Editing Extension Manifest in NetSuite

The extension manifest in NetSuite is crucial as it contains necessary information to compile extension resources effectively. Making manual edits to this file is often required when you need to update or introduce new components, such as JavaScript, HTML templates, and Sass files.

What Is the Extension Manifest in NetSuite?

The manifest.json file in your extension's Workspace directory encapsulates all essential resources, including JavaScript, JSON, SuiteScript, HTML templates, Sass, and other assets. Generated automatically via the gulp extension:create command, this file assembles everything required to compile and activate your extension.

Important: Use gulp extension:local --preserve-manifest or gulp extension:deploy --preserve-manifest to avoid overwriting manual changes during testing or deployment.

Key Components of the Manifest File

Metadata

The manifest begins with metadata about the extension, like its name, vendor, and target versions. Properly defining these fields is crucial since they describe the fundamental nature and compatibility of your extension:

• name: Unique extension identifier (without spaces).
• fantasyName: Display label with special characters allowed.
• vendor: Identifies the extension vendor.
• target: Supported SuiteCommerce or SCA applications.
• target_version: Versions of the applications supported.
• version: Extension version in format dd.dd.dd.
• description: Optional description visible in NetSuite.

Assets

Define paths for image, font, and service assets. The system treats detected service files as assets, automatically deploying them to the backend when activated.

JavaScript

Declare JavaScript file paths for each application entry point. This includes defining comprehensive lists of files needed for applications like shopping, myaccount, and checkout.

Sass

List all Sass files and entry points. Proper ordering is critical, especially when dependencies affect the rendering sequence.

Who This Affects

• Developers: Need to ensure all resources are correctly listed and paths are maintained.
• Administrators: Must manage deployment settings and manual file integrity.
• Customization Teams: Handle unique naming conventions and integration specifics.

Key Takeaways

• Ensure manifest.json accurately reflects the extension's resources.
• Use --preserve-manifest to protect manual changes from being overwritten during deployments.
• Verify the correct order and dependency resolution in Sass and JavaScript file listings.