Specify a Target Version for Extensions

You should specify version compatibility in your extension to ensure that it can only be installed and activated on a compatible SuiteCommerce website. If the extension is not compatible with the website, it is hidden on the Activate Themes and Extensions page in the NetSuite account. To specify version compatibility, use the target_version key in the extension manifest file.

json

"target_version": {
  "SCA": ">=21.2.0",
  "SCS": ">=21.2.0"
}

See Edit the Extension Manifest for more information about manifest metadata.

When creating an extension for SuiteCommerce Advanced, you should also check the extensibility API to determine if a component or method is available in a particular version of SCA. In addition, when you instantiate a component, you can verify that it is available by checking its return value. If a component is not available, its return value is null.

javascript

var userProfile = container.getComponent('UserProfile');
 
if (userProfile) {
  // Component is available
}

Frequently Asked Questions (4)

How do I specify a target version for SuiteCommerce Advanced extensions?

Specify the target version in the extension's manifest file using the `target_version` key, ensuring it matches the version of the SuiteCommerce website where it will be installed.

What happens if the extension is not compatible with the SuiteCommerce website version?

The extension will be hidden on the Activate Themes and Extensions page in NetSuite, preventing it from being installed or activated.

Is it necessary to manually edit the manifest.json file for specifying version compatibility?

The manifest.json file is auto-generated, but you may need to manually update it if adding SASS entry points or changing CCT labels, especially if preserving manual changes is important.

How can I ensure that a SuiteCommerce Advanced component is available in a particular version?

Check the extensibility API to determine component availability, and verify by checking the return value when you instantiate a component. If the return value is `null`, the component is not available.

Specify a Target Version for Extensions

Frequently Asked Questions (4)

More in General