Creating New Properties with SuiteCommerce Custom Modules

Learn to create new properties in SuiteCommerce using custom modules and JSON Schema. Boost your application's configuration capabilities.

·2 min read·View Oracle Docs

Creating new properties in SuiteCommerce involves establishing custom modules to define their location and behavior in the configuration record. This process enables developers to augment SuiteCommerce's functionality through clear and structured modifications. Here’s how to effectively create a new property in SuiteCommerce.

TL;DR Opening

To create a new property in SuiteCommerce, you should establish a custom module and define the property using JSON Schema V4. This approach enhances maintainability and integration with the SuiteCommerce configuration record.

Steps to Create a New Property

Creating a new property requires the following steps:

  1. Create a custom module: Set up a new custom module with necessary files and directories to house your configurations.
  2. Define using JSON Schema V4: Use JSON Schema V4 to declare the new properties that will appear in the configuration manifest.
  3. Deploy changes: After establishing the necessary configurations, deploy the changes to NetSuite.

These steps will ensure that your custom properties are properly integrated into the SuiteCommerce environment, allowing for effective management and functionality.

Important Considerations

  • Always create properties in the context of a custom module to ensure separation and ease of updates in the future.
  • Utilize JSON Schema V4 as it provides a standardized method for defining your properties, which helps maintain compatibility with SuiteCommerce’s ongoing development.

Custom Module Structure

When structuring your module, it’s good practice to keep related properties organized. For instance:

none
CustomModule
├── properties.json
└── config
├── manifest.json

This structure clarifies the organization of your property files, making maintenance simpler.

Conclusion

By following these guidelines for creating new properties in SuiteCommerce, developers can effectively enhance their applications' configurations while ensuring adherence to best practices that facilitate future upgrades and compatibility.

Key Takeaways

  • Use custom modules to create new SuiteCommerce properties.
  • Define properties with JSON Schema V4 for better compatibility.
  • Deployment of changes is essential after defining your properties.

Source: This article is based on Oracle's official NetSuite documentation.

Frequently Asked Questions (4)

What is the importance of using a custom module when creating new properties in SuiteCommerce?
Using a custom module ensures separation and organizational clarity, making updates and maintenance easier in the future. It isolates new configurations from existing ones, facilitating smoother upgrades.
How does JSON Schema V4 support the creation of new properties in SuiteCommerce?
JSON Schema V4 provides a standardized method for defining new properties, ensuring compatibility with SuiteCommerce's ongoing development and simplifying integration with the configuration manifest.
What is the recommended directory structure for organizing a custom module?
The recommended structure includes a main directory for the custom module, with subdirectories and files such as 'properties.json' and a 'config' directory containing 'manifest.json' to keep related property files organized.
Is deployment necessary after defining new properties in SuiteCommerce?
Yes, deploying the changes is essential after defining new properties to ensure they are integrated into the NetSuite environment and function as expected.
Source: Create a New Property 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 →