NetSuite Changelog
SuiteCloud Development FrameworkSuiteCommerceCustomization

Extension Metadata for SuiteCommerce Development

Extension metadata details for SuiteCommerce, including versioning, naming conventions, and required fields in the manifest file.

·2 min read·View Oracle Docs

TL;DR: Extension metadata is vital for SuiteCommerce development, detailing required fields like name, vendor, and versioning in the manifest file.

What is Extension Metadata?

Extension metadata is the foundational information included at the beginning of the manifest file for a SuiteCommerce extension. This data is automatically populated when you execute the command gulp extension:create.

Required Fields

The following fields must be defined in your extension's metadata to ensure proper functionality and identification within the NetSuite platform:

Field NameTypeDescription
namestringUniquely identifies the extension; required, alphanumeric without spaces.
fantasyNamestringThe display name of the extension, allowing special characters.
vendorstringIdentifies the vendor; this field is required.
typestringIdentifies the type as an extension; required field.
targetstring (comma-separated)Indicates the SuiteCommerce or SCA applications supported; required field.
target_versionarraySpecifies supported SuiteCommerce or SCA application versions; required field.
versionstringDefines the version of the extension, following the format dd.dd.dd; this field is required.
descriptionstringAn optional field that provides a description of the extension as it appears in NetSuite.

Important Versioning Note

For extensions to stay up-to-date with the platform requirements, ensure that version numbers adhere to the format: dd.dd.dd, where d represents a single digit. This format helps maintain compatibility across different SuiteCommerce versions.

Key Takeaways

  • Extension metadata is crucial for identifying and defining SuiteCommerce extensions.
  • Essential fields must be filled accurately to avoid deployment issues.
  • Following the standardized versioning format is critical for extension updates and compatibility.

Frequently Asked Questions (4)

What are the essential fields required in the metadata of a SuiteCommerce extension?
The essential fields required in the metadata are 'name', 'fantasyName', 'vendor', 'type', 'target', 'target_version', and 'version'. These ensure proper identification and functionality within NetSuite.
What is the significance of the 'target' field in extension metadata?
The 'target' field indicates the SuiteCommerce or SCA applications supported by the extension. It is a required field and must list applications the extension is compatible with.
Does the version number for a SuiteCommerce extension need a specific format?
Yes, the version number must follow the format 'dd.dd.dd', where 'd' represents a single digit. This ensures compliance and compatibility with platform requirements.
Is it mandatory to include a description in the extension metadata?
No, the 'description' field is optional. However, it allows you to provide a brief explanation of the extension as it appears in NetSuite.
Source: Extension Metadata — 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 SuiteCloud Development Framework

View all SuiteCloud Development Framework articles →