Import/Export configuration

Owned by Denny Miller
Last updated: Jun 25, 2024
4 min read

As a System Admin, you will have the ability to Import and Export your CSUMCloud configuration.

How to export configuration

 

  1. From the Manage Apps page, select ‘Configure’ on the CSUMCloud app to be taken to the Global Settings module.

  2. At the top of the configuration page, the following buttons will be available:

image-20240625-090749.png

  1. On ‘Export’, a .json file will be downloaded, including app configuration for:

  • Group Settings

  • User Settings

  • General Settings

  • Permissions Schemas (Default, plus any User/Group permission schemas)

Privileged User Configuration is not exported to prevent exposure of shared API tokens.

 

How to import configuration

Importing will overwrite your existing configuration for Permission Schemas.

If you wish to retain your configuration, please view ‘import settings but not permissions’ below.

  1. From the Manage Apps page, select ‘Configure’ on the CSUMCloud app to be taken to the Global Settings module.

  2. At the top of the configuration page, the following buttons will be available:

image-20240625-090749.png

  1. On ‘import’, select your .json configuration file. A comprehensive report of the settings imported will be presented to you:

 

  1. Any warnings or errors are clearly indicated, to allow manual changes to

 

Import Configuration limitations

The following limitations are put in place when importing configuration - these limits are also applied when manually adding configuration:

  • Up to 50 valid user permission schemas can be imported.

    • If a user permission schema does not match a valid user account, it is ignored and the report will indicate the accountId that was failed to be found.

  • Up to 50 valid group permission schemas can be imported.

    • If a group permission schema does not match a valid group, it is ignored and the report will indicate the groupId that was failed to be found.

  • Up to 50 Auto-Join Group groupIds can be imported.

    • If a group does not match a valid group, it is ignored and the report will indicate the groupId that was failed to be found.

 

Import settings but not permissions

If you are importing configuration, any default permissions and user/group permissions will be copied over.

If you wish to keep the existing permissions being used, please follow these steps:

  1. With your exported .json file, open with an editor of your choice.

  2. Remove the following json nodes (If you are unsure, it is advised to not alter your import configuration).

  • permissions

  • userPermissions

  • groupPermissions

They will look similar to the output below:

  1. After deleting these nodes, you can import your configuration, and the permissions import will be ignored. The report will indicate permissions configuration not found, so existing configuration was left untouched.

Example before deletion

Example after deletion

Example before deletion

Example after deletion

 

 

 

 

Do I need to export (or re-import) my configuration?

For the majority of use-cases, this setting is purely for sanity purposes, to be able to keep an up-to-date copy of your CSUMCloud configuration stored externally, in the case of issues with Forge Storage.

Marketplace migration

Customers using the historic marketplace listing (See Marketplace listing migration) can use this feature to transfer configuration to their new app

Custom Domains or Site renames

Customers that have changed their custom domain siteUrl can cause conflicts with Default groups for Atlassian products.

https://jira.atlassian.com/browse/CONFCLOUD-78804 covers the need to find these default groups without relying on the original siteUrl. (Seehttps://thepluginpeople.atlassian.net/wiki/x/BIAvAQE for more information if you have renamed your site, or use custom domains)