Adding Repositories

This document explains how to create repositories in ADx 2.x. You need administrator privileges to add repositories (see User Management for more details).

You can add the following repositories in ADx:

• ADx standard repository - this is the ADx native solution
• CMIS repository, when you want to integrate external CMIS-compatible service with ADx (such as Alfresco or SharePoint)
• Documentum repository, when you want to integrate a Documentum service with ADx (Documentum 6 and newer versions only)

Follow the process described below to add repositories (regardless of their type). If you (or another administrator) configured the default properties for ADx repositories in the installation settings file, adding new repositories should be very quick and simple. Otherwise, you'll need to add repository properties manually after you have created it.

Adding New Repository with Default Properties

Check the video and the instructions below it to learn how to add new repository in ADx.

1. Log in to ADx. Go to the Administrator page:

   

2. Click Repositories to open the repositories query view.

3. Click New. The ADx Repository pop-up opens.

4. Select the type of the repository (ADx, CMIS or Documentum) to be added.

5. Select Storage Type. You can use a database, file system or cloud storage. ADx provides native connection support to both Google Cloud Platform and Amazon Web Services (you will need to provide service details later).

   This option is not available for external CMIS and Documentum repositories, because content storage of external repositories is configured on their end, and not in ADx.

6. Select Cache Storage Type. Specify how cached data should be stored - in a database, file system or cloud storage.

7. Optionally, select a Policy Operation from the list:

   Important: Adding policies to a repository means that they can be used in this repository, NOT that they are effective immediately. For more information on policies in ADx, read Configuring Policies.

   • ADD_DEFAULT (default option) - adds system policies to this repository

8. Optionally, select a Post Operation from the list:

   • none - ADx doesn't perform any action after you add this repository
   • synchronize - repository configuration is synchronized after you add it
   • synchronizeAndActivate - repository configuration is synchronized and the repository is activated after you add it

9. Click Execute!. Your repository is now created with the default properties:

   

   Your repository can now be explored and used (if default properties were configured on your ADx installation and you selected synchronizeAndActivate option in step 3). If you want to change the default values, see Changing Repository Default Properties.

10. If you're happy with the default configuration, you can now move on to Synchronizing and Activating Repositories. If you want to change the default properties, see Changing Repository Default Values first.

Changing Repository Default Properties

Repository default properties are set based on ADX_DEFAULT runtime properties, which you can set when installing ADx.

1. Highlight your newly created repository and click Details. Repository editing view opens and the following sections are available:

   

   This is a collapsed view. Click on the headings to expand and collapse the properties inside.

2. Edit the properties as required - see Properties for information about every property. In general, properties marked in bold must be set.

3. Click Apply to save your changes and close the window.

4. Commit your changes.

5. Synchronize and activate the repository.

Synchronizing and Activating Repositories

Having added a new repository, follow the steps below to activate it and make sure it's working:

1. Run a connection health check on the repository (click Health in the bottom menu, then Connection Check). The resulting report should be all green.

2. Select your newly added repository and click Synchronize in the bottom panel. Synchronization brings your configuration into the current runtime and therefore is required before you can use your repository after making changes.

3. Activate the repository (click Activate in the bottom menu). This action enables the Content Area and brings all endpoints online.

4. Run a deep health check on the repository (click Health in the bottom menu, then Deep Check). The resulting report should be all green. If the report is OK, you can now start using your repository!

   For more information about health checks, see Running Conversion and Platform Health Checks

5. Click Explore to open the repository and start using it.

Configuring Repository Properties

This section describes all repository properties. They are the same for all repository types, the only exception are the connection properties, which are described separately for ADx, CMIS, and Documentum standard. Properties described below are ordered based on ADx UI:

General

This section contains the repository name.

Description

This section contains the repository description.

Connection

When you're adding standard ADx repository, connection refers to content database and storage system for this repository. In case of CMIS and Documentum, connection refers to an external server, where the CMIS or Documentum repository is running. In both cases, default values for connection properties can be set during installation in the installation settings file. If these values were set on your system, you don't have to set them now when adding a repository (unless the repository is supposed to run on other settings than default).

ADx Standard Repository Connection

Connection configuration in a standard ADx repository consist of the following:

• Database connection configuration (content metadata is always stored in a database)
• File storage connection configuration (either in file system, cloud service or database)

Note that default repository connection values can be configured as part of the installation settings, in which case they are set automatically on runtime! If this is the case in your ADx installation, you only need to change these settings in ADx if the repository is supposed to use a different database or file storage.

Connection properties are configured in their separate forms:

CMIS Repository Connection

You need to enter the following properties when connecting to a CMIS repository:

Documentum Repository Connection

You can add repositories using Documentum version 6.0 or newer. You need to enter the following properties when connecting to a Documentum repository:

Cache

Cache configuration includes the following items:

• Database connection configuration (cached files metadata is always stored in a database)
• File storage connection configuration (either in file system, cloud service or database)
• Other properties related to cache configuration (described below)

Fulltext

These properties relate to configuration of the elastic search component of this repository. Normally, you should be fine using the default values.

Conversion

These properties define how ADx is using Conversion. You can provide connection settings to a remote Conversion service and define conversion restrictions for this repository.

Content

These properties are related to contents uploaded to this repository. They are mostly technical - in most cases it's not necessary to change the default values.

Async

Properties related to handling asynchronous calls.

Processing

Please do not configure these fields.

Access Control

These properties define if the repository is visible to users by default and, potentially, lower-level access rights for users.

Technical

These properties show modification timestamps on this repository. GlobalId is the repository's Technical Name (used by certain REST services). You don't have to make any changes in this section.

Configuring Repository Storage

You can configure the following storage properties:

• Both cache and content storage for ADx standard repository
• Cache storage for external CMIS and Documentum repositories (content storage in this case is configured outside of ADx, on the external repository side)

Default values for both cache and content storage can be configured with runtime properties in the installation settings file. See ADx Storage Runtime Properties for detailed information on available properties. If you have these defaults configured in your ADx installation, you can skip this configuration, unless you want to use different storage than configured by default.

1. Highlight your newly created repository and click Details. Repository editing view opens.

2. In the editing view, click on Content Storage. Provide the required information (use tooltips to get information on each field):

   Google Cloud Platform

   

   Amazon Web Services

   

   Database

   Note: in case of database storage, you need to click on the database name to open the form.

   

   File System

   In case of file system storage, simply provide the file system storage directory for repository contents.

3. Repeat the above process for Cache Storage.

Configuring Repository Databases

ADx standard repository requires a content database and cache database. CMIS and Documentum require a cache database at the minimum. Additionally, you can use a database to store resources (both content and cache resources in case of ADx standard repository, cache resources only in case of CMIS/Documentum repository).

Databases should normally be configured with runtime properties when installing ADx. However, if necessary, you can also configure the database from ADx UI:

1. Highlight your newly created repository and click Details. Repository editing view opens.

2. Select the database you want to edit:

   

3. Provide database information in General section.. Properties marked as bold are mandatory.

   

4. If necessary, you can change the default database technical settings in the Advanced section. For detailed information on these settings, see HikariCP Configuration. We recommend that you consult your infrastructure team before changing the advanced settings.

REST API

You can add repositories using Repository Administration endpoints exposed via ADx REST API. For more information, see REST API documentation