logoBack to home screen

Exporting and Importing Repository Configuration via ADx UI

ADx provides the possibility to export and import repository configuration. Repositories and users are exported as JSON assembly files in a .zip package, which can be imported later.

You need administrator privileges to export and import repositories. Make sure you log out and log in each time you import repository configuration. This makes sure the new configuration is applied correctly.

On this page

  1. Exporting Repositories and Users from ADx
    1. Video
    2. Procedure
  2. Importing Repositories and Users to ADx
    1. Video
    2. Procedure
  3. REST API

Exporting Repositories and Users from ADx

Follow the video below or the procedure (with full explanation of each option) to export repositories and/or users from ADx.

Video

Procedure

  1. Log in to ADx. Open Administration area:

  2. Select Export from the settings menu:

  3. Define how to export users and add repositories to be exported from the list:

    • Export Users: none - do not export users; all - export all users and their roles/groups; repositoryRelated - export only users, roles, and groups related to exported repositories, based on Access Control settings of exported repositories.
    • Status: use this field to export repositories based on their activity status (Active or Inactive).
    • Repositories: use this transfer list to select repositories to be exported.

  4. Click Execute. Repository configuration is downloaded to your file system as a .zip archive with the following contents:

    • repositories folder containing assembly.json file describing the configuration and delta.man file describing performed manipulations.
    • users folder containing another assembly.json file describing the users. This folder is only written if you select the Export Users option.

    Repository names are written into the .zip package name, for example adx-config-asset-document-management_202006152056570990.zip if you export repository called Document Management.

Importing Repositories and Users to ADx

Video

Procedure

  1. Log in to ADx. Open Administration area:

  2. Select Import from the settings menu:

  3. Configure import options and click Execute. Repositories and users are imported to ADx in accordance with your configuration.

    OptionPurpose
    Auto SyncSynchronize the repository after import.
    Import Repository Optionnone - do not import repositories; delta - import only non-existent repositories and users AND update repository properties if there is a configuration difference (use the package property); full - import all repositories, override all properties based on package content when updating existing repository.
    Import Users OptionSelect how to import users from the package. None - do not import users at all; delta - import only users/roles not present in ADx; full - import all users/roles from the package, override the properties of existing users.
    Use Runtime ValuesWhen selected, repository properties are set to the runtime property values defined in tribefire.properties file (which is written upon installation, based on your installation-settings.yaml file). You can check current runtime values in the about page (go to Operations/Runtime/About in the landing page).
    Resource.zip archive containing ADx repository configuration to be imported.

  4. Log out, and then log in. This makes sure the new configuration is applied correctly.

REST API

Services described on this page are described via REST API. See Exporting and Importing Repository Configuration via REST for more information.