Important Considerations for Extensions Development

Understand key factors for developing extensions in SuiteCommerce, including file management and API requirements.

·2 min read·View Oracle Docs

The initial steps in developing extensions for SuiteCommerce require understanding several crucial factors that impact the development process significantly.

What to Consider Before Starting Extension Development?

Before you dive into extension development, keep the following points in mind:

  • The gulp extension:fetch command retrieves:

    • HTML and Sass files related to the active theme for the specified domain.
    • Development files for custom extensions that are currently active on the domain. Note that files for published extensions cannot be downloaded.
  • Your login parameters, such as NetSuite email, account, role, and domain specifics, are securely stored in the .nsdeploy file when you create an extension. To reset your login and deployment details, simply delete this file located at:

    • <LOCAL_SOURCEFILES_ROOT>/gulp/config/.nsdeploy
  • Key extension details—including the extension name, fantasy name, version, and description—are documented within the Manifest.json file. This manifest file is situated here:

    • <LOCAL_SOURCEFILES_ROOT>/Workspace/<EXTENSION_DIRECTORY>/manifest.json

Development API Considerations

When building extensions, developers should leverage the Extensibility API available for both SuiteCommerce and SuiteCommerce Advanced (SCA). Here are some best practices and requirements:

  • For SuiteCommerce and SuiteCommerce MyAccount, using the Extensibility API is essential for creating extensions.

  • With SuiteCommerce Advanced (Aconcagua and later), extending functionalities using this API is highly recommended. However, if your SCA customizations require deeper access to JavaScript or SuiteScript functionalities beyond what this API offers, explore utilizing SCA developer tools for optimal customization practices.

  • Note that SuiteCommerce Advanced (Kilimanjaro and earlier) implementations do not support the Extensibility API. For accessing advanced features like themes and extensions, migrating to the latest SCA release is necessary. Alternatively, utilize SCA developer tools for your site customizations.

Conclusion

These considerations help ensure a smoother development experience when creating extensions for SuiteCommerce, providing essential guidance on file management and API utilization.

Frequently Asked Questions (4)

Can I download files for published extensions using the `gulp extension:fetch` command?
No, the `gulp extension:fetch` command only retrieves development files for custom extensions that are currently active on the domain, not for published extensions.
Where are my login and deployment details stored when I create an extension?
Your login parameters are stored in the `.nsdeploy` file located at `<LOCAL_SOURCEFILES_ROOT>/gulp/config/.nsdeploy`. To reset these details, you can delete this file.
Do SuiteCommerce Advanced implementations prior to Aconcagua support the Extensibility API?
No, SuiteCommerce Advanced implementations prior to Aconcagua, such as Kilimanjaro and earlier, do not support the Extensibility API. It's recommended to migrate to the latest SCA release to access advanced extension features.
Is the Extensibility API mandatory for extensions in SuiteCommerce MyAccount?
Yes, using the Extensibility API is essential for creating extensions in SuiteCommerce MyAccount.
Source: Useful Information to Know Before You Begin 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 →