logoBack to home screen

ADx Administration Area

This area is a simple entry point for managing your repositories and database connections. Repository configuration is separated from deployment - you need to map each repository to its configuration and, upon activation, ADx automatically creates all necessary components of those repositories.

You can access Administration Area from the landing page:

As a result, the following landing page opens:

Admin Operations

You can perform a number of operations as an administrator, related to repository management, monitoring sessions and logs, and user management. Click on the link to get in-depth information for each operation:

Repositories

This view lists all available repositories and provides the necessary tools for their management.

Using the entry points on the left, you can filter repositories by their status and type:

The menu on the bottom allows you to perform actions on a currently selected repository:

The following actions are available:

ActionDescription
OpenOpens the detailed view of a repository. The detailed view presents the repository configuration and is available in the grid and list modes.
EditOpens the configuration dialog.
DeleteDeletes the selected repository.
RefreshRefreshes the Admin Access view.
SynchronizeCreates the individual repository configuration elements according to the repository configuration. See this section for more information.
DeactivateDeactivates an active repository.
ReactivateDeactivates an active repository and then activates it again.
ReindexRe-index contents of a repository so that they are picked up by full-text search. For information when this is necessary, see Content Re-indexing
HealthOpens a menu where you can run either a basic Connection Check that tests database connection or Deep Check which tests the content operations on a repository.
ExploreOpens the contents of the repository.

Repository Configuration

When you open repository Details or double-click on a repository, you can see the following information:

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, all resources uploaded to this repository are automatically converted to PDF and cached as PDFNoEnabled
Cache for PreviewIf selected, document representations are created by default for all contents uploaded to this repositoryNoEnabled
Cache OriginalIf selected, download requests will result in cached resources being downloadedNoEnabled
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, full-text 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 full-text content of a Resource is also taken into consideration when searching for Content.NoEnabled
Cluster SniffWhen this is set to true, full-text 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 parameter 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 asynchronous 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 asynchronous 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.

Logs

This view displays the available log files. If you don't want to display them in the browser, you can download them. You can also access this view any time from ADx landing page:

Once inside, you have the following options:

Download Log Bundles

  1. Select a bundle from the Available Log Bundles menu.
  2. Click Download. The bundle is downloaded as a .zip package.

Change Log Directory

This section lists all currently available logs with the option to change their directory. To do so, enter a new directory next to a log file, then click Change. Log directory is now changed.

Change Log Level

Find the Log File list with Log Level next to it. Use the buttons next to each row to change the Log Level.

Browse Individual Logs

Find the Individual Logs View at the bottom of the page. Select a log from the list to browse it in the provided browser.

API

Administrator services are exposed via a REST API. For more information about the available endpoints, see REST.