JSON Configuration Files for SuiteCommerce and SCA Setup

When setting up a Commerce website using SuiteCommerce or SuiteCommerce Advanced (SCA), understanding JSON configuration files is crucial. These files facilitate changes to the SuiteCommerce Configuration record, allowing seamless customization of properties for various domains.

How Do JSON Configuration Files Work?

Overview

JSON configuration files serve as the backbone of the SuiteCommerce Configuration record's user interface. As you make modifications, these files list the properties and metadata applicable to individual modules, stored within a specific Configuration subdirectory. Here’s a breakdown of the key components:

• Individual JSON Files: Each module with configurable properties contains a JSON file that details those properties and associated metadata.
• configurationManifest.json: When an extension is activated, the application compiles all related JSON files into this comprehensive file in the File Cabinet. This manifest governs the display and functionality of the SuiteCommerce Configuration record.

JSON Configuration Process

1. File Collection: As noted, individual JSON files compile into the configurationManifest.json. This file controls the visibility and organization of settings within the SuiteCommerce Configuration record, detailing tab locations, titles, possible values, and defaults.
2. Runtime Operation: During runtime, the default values established in configurationManifest.json populate the configuration properties unless overridden by saved changes.
3. Saving Changes: Any modifications made in the SuiteCommerce Configuration record save as a custom record, which reconfigures the values for the specific domain. If these values match with those in configurationManifest.json, the custom entries will take priority.

Important: If no updates are saved, the settings derived from configurationManifest.json remain in effect.

Example Use Case

JSON files play a significant role in how properties like Case feature settings appear within the user interface of the SuiteCommerce Configuration record. This encompasses aspects such as default values and organizational tabs. Furthermore, deploying and activating an extension ensures the individual JSON components come together in the manifest file to control the user interface upon interacting with the SuiteCommerce Configuration record.

Transitioning Between SuiteCommerce Releases

Should you be utilizing an SCA version prior to Aconcagua, be aware that configuration processes differ during deployment. Specific details can be found in the section on Creating JSON Configuration Files to effectively manage your setup across various releases.

Who This Affects

• Developers who handle SuiteCommerce customizations.
• Administrators responsible for configuring domains and properties.
• Users interacting with SuiteCommerce Configuration record for website settings.

Key Takeaways

• JSON configuration files are essential for customizing the SuiteCommerce Configuration record’s user interface.
• The configurationManifest.json file aggregates properties from individual JSON files to determine UI presentation.
• Changes made in SuiteCommerce Configuration are saved as custom records, allowing for domain-specific configurations.
• Understanding the differences in configuration processes across SCA releases is crucial for effective implementation.

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