logoBack to home screen

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. 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
  8. 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.

  9. 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.

PropertyDescriptionIs this property mandatory?Default value
NameRepository nameYesNone

Description

This section contains the repository description.

PropertyDescriptionIs this property mandatory?Default value
DescriptionRepository descriptionNoNone

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:

PropertyDescriptionIs this property mandatory?Default value
Content databaseConfiguration of the database where content metadata is stored. You can enter default values for database configuration in the installation settings file before installation. Click in the text field to open the form where you can change the configuration. For details, check Configuring Repository Database.YesDefault values can be configured before installation in the installation settings file using ADX_DEFAULT_DB properties.
Content storageConfiguration of binary file storage. Click in the text field to open the form where you can change the configuration - see Configuring Storage.YesYou can enter default values for content storage before ADx installation in the installation settings file using ADX_DEFAULT_STORAGE_CONTENT properties.

CMIS Repository Connection

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

PropertyDescriptionIs this property mandatory?Default value
Repository IdID of the CMIS repository being connectedYesDefault value can be set by ADX_DEFAULT_CMIS_REPOID property.
Service URLURL of the CMIS repository, such as http://documentumServer.com/emc-cmis/browserYesDefault value can be set by ADX_DEFAULT_CMIS_SERVICEURL property.
UsernameUser name to authenticate to CMIS repositoryOnly if authorization is requiredDefault value can be set by ADX_DEFAULT_CMIS_USER property.
PasswordPassword to authorize access to CMIS repositoryOnly if authorization is requiredDefault value can be set by ADX_DEFAULT_CMIS_PASSWORD property.
Authentication MethodAuthentication method expected by the CMIS serverYeshttp_basic
Binding TypeBinding type configured on the CMIS repositoryYesbrowser
Type DefinitionsCollection of representations of CMIS types (for example types representing documents or folders) available in target repository.NoNone
Role mappingsIf not configured, ADx users will authenticate to CMIS using the credentials provided in Username and Password. If configured, ADx users will authenticate using credentials mapped to their role.NoNone

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:

PropertyDescriptionIs this property mandatory?Default value
Repository IdID of the Documentum repository being connectedYesDefault value can be set by ADX_DEFAULT_DCTM_REPOID property.
Service URLURL of Documentum service, such as http://documentumServer.com/emc-cmis/browserYesDefault value can be set by ADX_DEFAULT_DCTM_SERVICEURL property.
UsernameUser name to authenticate to Documentum repositoryOnly if authorization is requiredDefault value can be set by ADX_DEFAULT_DCTM_USER property.
PasswordPassword to authorize access to Documentum repositoryOnly if authorization is requiredDefault value can be set by ADX_DEFAULT_DCTM_PASSWORD property.
Is Version 6.xSelect this option if the target Documentum service is running on version 6. When selected, this option changes ADx requests sent to Documentum server to match the SOAP API of Documentum 6.NoDisabled
Type DefinitionsCollection of representations of Documentum types (for example types representing documents or folders) available in target repository.NoNone
Role mappingsIf not configured, ADx users will authenticate to CMIS using the credentials provided in Username and Password. If configured, ADx users will authenticate using credentials mapped to their role.NoNone

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)

PropertyDescriptionIs this property mandatory?Default value
Cache DatabaseDatabase configuration defining where to store cached files metadata. For details, check Configuring Repository Database.YesDefault cache database can be set on runtime by ADX_DEFAULT_CACHE properties, entered in the installation settings file.
Name Space PrefixThe name space prefix for this repository, used together with the technical name to build the actual name space.Yesadx.custom.model
Cache StorageConfiguration of cached binary file storage. You can enter default values for cache storage during ADx installation. Click in the text field to open the form where you can change the configuration. For details, see Configuring Repository StorageYesDefault cache storage can be set on runtime by ADX_DEFAULT_STORAGE_CACHE properties, entered in the installation settings file.
Cache as PDFIf selected, the original content is automatically converted to PDF after upload and content representation in PDF format is created. This option is needed to download files as pdf and print documents from WebReader.NoEnabled
Cache for PreviewIf selected, document representations are created by default when creating a content. Specifically, this includes representations for the WebReader, HOCR representation, fulltext extraction, TOC (table of contents) information (if TOC is available), and a thumbnail of the first page (shown as preview in the UI).NoEnabled
Cache OriginalIf selected, the original content is cached by default when creating a content representation.NoEnabled
Representations TTLTime after which content representations are deletedYes3y
WebReader URLURL of the WebReader service when WebReader is started from this repositoryNoNone
Data modelCustom data model - see Configuring Custom TypesNoNone
Service modelCustom service model. Currently, there are no documented examples of customized service model implementation.NoNone

Fulltext

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

PropertyDescriptionIs this property mandatory?Default value
Fulltext enabledWhen selected, fulltext search is enabled on this repositoryNoEnabled
Cluster nameElastic search cluster nameYeselasticsearch
HostElastic search service hostYes127.0.0.1
PortElastic search service portYes9300
Cascading AttachmentWhen this is set to true, the fulltext content of a Resource is also taken into consideration when searching for Content.NoEnabled
Cluster SniffWhen this is set to true, fulltext search will automatically try to find other nodes and build a cluster.NoDisabled
Indexing ThreadsNumber of indexing threadsNo2
Max Result SizeMaximum allowed search result sizeNo100
Max Result WindowMaximum number of search results per pageNo10000
Node NameThe name of the Client (i.e. ADx) node that is connected to the Server (which is also hosted in ADx). If empty, it will take a random name. This property should be empty in a cluster environment.NoNone

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.

PropertyDescriptionIs this property mandatory?Default value
Conversion AccessIdService domain ID where Conversion service can be found. Please use the default value.Yesconversion.access
Conversion Services URLIf remote Conversion is used, enter the URL of the remote serviceOnly needed if remote conversion is usedDefault value can be set by DOCUMENTS_CONVERSION_TFS_URL property.
Conversion UsernameUsed to authenticate to the remote Conversion serviceOnly needed if remote conversion is usedDefault value can be set by DOCUMENTS_CONVERSION_USERNAME property.
Conversion PasswordUsed to authorize access to the remote Conversion serviceOnly needed if remote conversion is usedDefault value can be set by DOCUMENTS_CONVERSION_PASSWORD property
Conversion RestrictionSee Setting Conversion Restrictions on Repository for details on how to set repository restrictions for conversion jobs. If restrictions are not set on a repository, Conversion restrictions are used instead.NoDefault values for Conversion can be configured by related runtime properties set in the installation settings file.

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.

PropertyDescriptionIs this property mandatory?Default value
Name Space PrefixYou shouldn't change the default value. The name space prefix for this repository, used together with the technical name to build the actual name space.Yesadx.custom.model
Download StrategyDefines how a content download request should be executed - either from repository cache or storage.YespreferCache
Deleted Entries TTLTime counted from deleting an entry in ADx. After this time has passed, database, cache, and storage records of this entry are deleted.Yes5d
Default Page SizeThis parametr defines how many results can be displayed in a single page in ADx.Yes100
Auditing EnabledDefines whether technical auditing should be enabled for content-related changes.YesEnabled
Base Content TypeDefault data type for uploaded contents.YesContent for ADx repository, CmisContent for CMIS, DctmContent for Documentum
Base Folder TypeDefault data type for created foldersYesFolder for ADx repository, CmisFolder for CMIS, DctmFOlder for Documentum
Storing Metadata EnabledIf enabled, content specification is exported from this repository. See Exporting Repository Entry Metadata for detailsYesDisabled
Data ModelData model for the repositoryNoadx-content-data-default-model
Service ModelService model for the repositoryNoadx-content-service-default-model
WOPI configurationConfiguration of the WOPI serviceNoADx WOPI Configuration

Async

Properties related to handling asynchronous calls.

PropertyDescriptionIs this property mandatory?Default value
Persistence StrategyDefines what should happen when an Async-Request is received. Should we store it in the DB immediately (always), only when there is no execution thread available immediately (onEnqueue) or never? Consequently, when an Async Request gets persisted and the node is crashing while executing the request, another node might try a retry after a while. Requests that are not persisted will be simply lost in the case of a crash. So, always is the safe bet here, but it might be sometimes the case that the Jobs are not that important and it does not matter if they are lost.Yesalways
Core PoolsizeThe minimum number of threads that will be held alive, ready to be used anytime when a new request is received.Yes5
Max PoolsizeThe maximum number of threads that are created to process Async Requests in parallel. Any further request will be internally queued in memory (not persisted as in the sense described in Persistence Strategy).Yes5
Keep Alive TimeTime (in ms) for which an idle thread should be kept alive before it is closed to save resources.Yes180000

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.

PropertyDescriptionIs this property mandatory?Default value
Connect DefaultDefines the default access policy for this repositoryYesGrant
ACL EntriesShows currently configured Access Control List entries - see User Management for more details.NoNone

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. We recommend that you consult your infrastructure team before doing so.

REST API

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