Customize Configuration Manifest in SuiteCommerce Advanced

The configuration manifest in SuiteCommerce Advanced (SCA) defines how customizable properties are presented and processed within the application. Understanding how to customize this manifest is crucial for developers looking to enhance functionality and interface elements in SCA.

Importance of Customizing the Configuration Manifest

This approach allows developers to add new properties or modify existing ones, tailoring the SuiteCommerce configuration record's user interface for specific business needs. Customizations can range from changing default values to implementing entirely new features through custom modules.

Best Practices for Customization

When customizing the manifest, you should adhere to best practices to ensure the longevity and compatibility of your changes:

• Never alter or delete the configurationManifest.json file directly. Instead, focus on customizing individual JSON files associated with the manifest.
• Use JSON Schema V4: When creating new properties, structure them properly to ensure they integrate smoothly into the configuration record.
• Monitor Upgrades: Following best practices aids in upgrading to newer SCA versions without issues, as your customizations will coexist with newer updates.

Create a New Property

To introduce new properties into the manifest, follow these steps:

1. Create a custom module, defining necessary files and directories.
2. Utilize JSON Schema V4 to declare the new attributes.
3. Deploy your module to NetSuite.

Example Structure for New Properties

Here’s a simplified structure of how your custom module could be organized:

MyCustomModule  
 ├── config  
 │   └── custom_property.json  
 └── module.js  

Customize Existing Properties

If you wish to modify existing properties, the Configuration Modification method should be employed. This involves adjusting the source JSON configuration files associated with properties existing in the configuration manifest. You can add, replace, or remove metadata as needed while also spreading changes across several custom modules.

Existing Property Modification Steps:

• Identify the target JSON configuration file.
• Apply changes using the Configuration Modification method.
• Validate your changes by testing the configuration in a development environment.

Conclusion

Understanding how to manipulate the configuration manifest is essential for any SCA developer. By following structured best practices and careful modification of JSON files, developers can ensure that their customizations are sustainable and compatible with the evolving SuiteCommerce landscape.

Key Takeaways

• Never edit the configurationManifest.json file directly; use individual JSON files.
• New properties require creating a custom module with JSON Schema V4.
• The Configuration Modification method allows tailored changes to existing properties.
• Following the best practices will help ensure compatibility with future SCA updates.