NexJ Logo

Exporting and importing application settings using JSON

You can export existing application settings to JSON files and import modified application settings using JSON files in NexJ Admin Console for Cloud-deployed environments.

This functionality is only available in NexJ Admin Console for environments where the jsonConfig environment file property has been set to "true", the user has the appropriate privileges (jsonConfig:AdminJSONImportConfig, jsonConfig:AdminJSONExportConfig, or both with the jsonConfig:gAdminJSONSeeder privilege group), and the environment is a "cloud" environment where the environment variable applicationType=wm (not ecrm).

To export application settings to JSON files, you must have been granted the jsonConfig:AdminJSONExportConfig privilege, and to import JSON files back into the application you must have been granted the jsonConfig:AdminJSONImportConfig privilege.

You can export and import application settings for templates, object types (for example, Entity, Address), custom fields, and system preferences.

The following screenshot shows the Tools menu options for performing the export or import.

NexJ Admin Console showing Tools menu options

After you select Export application configuration, you can choose to open the generated .zip file or save it locally. The .zip file contains JSON files that can be modified and imported. The following example shows a code snippet from the 01.SystemPreference.json file that is included in the .zip file:

{
   "Configuration": {
      "SystemPreference": [
         {
            "group.value": "HAM",
            "key": "HAM",
            "type": "boolean",
            "readOnly": true,
            "valBool": true
         },
...

In this example, "key": "HAM" represents a field: value pairing of the SystemPreference metaclass, where the field corresponds to an attribute on the SystemPreference metaclass. The HAM value refers to the Hierarchical Access Model that restricts user access to data records by organizational hierarchy. For more information about the Hierarchical Access Model, see System and object level security.

When you select Import application configuration, select the JSON file that contains the required application settings, and click Import. The following example shows a code snippet from the 01.SystemPreference.json file that has been modified prior to importing it:

{
   "Configuration": {
      "SystemPreference": [
         {
            "group.value": "HAM",
            "key": "HAM",
            "type": "boolean",
            "readOnly": true,
            "valBool": false
         },
...

When the applicationType environment file property has been set to "wm", the JSON files in the /meta/configurations/wm folder will be imported on a reseed.