Importing an Application Configuration File

This section describes importing application configuration parts using the web client.

Note:

Note that the selected application elements of the current application will be replaced by those coming from the file. Therefore, it is recommended to back up the current application configuration before importing an application configuration file. That way the current configuration is easier to restore if any issues should arise from importing an external application configuration file. For more details, please refer to Section Exporting an Application Configuration File

The app-config.json file can be used in a deployment to load application configuration automatically. For more details, please refer to Section Deploying the Application.

After the import elements were selected, if the application has no workspaces or permission rules, the Application Initialization Bean is called. For more details, please refer to Section Setting Advanced Initialization.

To Import an Application Configuration File

  1. Connect to the web client as a user with permission to change the application settings. For more details, please refer to Section Accessing the Web Client.

  2. In the Topbar Menu Settings, click on Settings > Application Configuration > Reset from File. For more details, please refer to Section Understanding the Topbar Settings Menu. A dialog opens.

    Importing the Application Configuration File

  3. Select the JSON configuration file to import and click on NEXT. The next page opens.

    Selecting the Application Elements to Reconfigure

  4. By default, all the options are checked. Untick the elements for which you do not want to reset the configuration. At least one should be selected.

    Note:

    Note that:

    • If the corresponding workspaces and folders are not defined in the import file, resetting the application configuration moves the "orphan" scenarios to workspace Lost and found. To prevent this, untick the option Workspaces and Folders. For more details, please refer to Section Addressing Orphan Scenarios.

    • The version of the selected configuration file is displayed. If it says legacy, it means that the file was created with a DOC version prior to 4.0.1-fp2. In this case, the Permission Rules checkbox is unticked.

  5. Tick the confirmation checkbox.

  6. Click on RESET to replace the current element configuration with the one from the imported file. The dialog closes.

  7. The web client reloads to reflect updated settings, workspaces, and permissions. In some cases, you may need to refresh the web page.