Configuring repositories
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 D1, CMIS, and Documentum standard. Properties described on this page are ordered based on D1 UI:
General
This section contains the repository name.
| Property | Description | Is this property mandatory? | Default value |
|---|---|---|---|
| Name | Repository name | Yes | None |
Description
This section contains the repository description.
| Property | Description | Is this property mandatory? | Default value |
|---|---|---|---|
| Description | Repository description | No | None |
Connection
When you are adding standard D1 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).
D1 standard repository connection
Connection configuration in a standard D1 repository consists 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
The 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 D1 installation, you only need to change these settings in D1 if the repository is supposed to use a different database or file storage.
Connection properties are configured in their separate forms:
| Property | Description | Is this property mandatory? | Default value |
|---|---|---|---|
| Content database | Configuration 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. | Yes | Default values can be configured before installation in the installation settings file using ADX_DEFAULT_DB properties. |
| Content storage | Configuration of binary file storage. Click in the text field to open the form where you can change the configuration - see Configuring repository storage. | Yes | You can enter default values for content storage before D1 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:
| Property | Description | Is this property mandatory? | Default value |
|---|---|---|---|
| Repository Id | ID of the CMIS repository being connected | Yes | Default value can be set by ADX_DEFAULT_CMIS_REPOID property. |
| Service URL | URL of the CMIS repository, such as http://documentumServer.com/emc-cmis/browser | Yes | Default value can be set by ADX_DEFAULT_CMIS_SERVICEURL property. |
| Username | User name to authenticate to CMIS repository | Only if authorization is required | Default value can be set by ADX_DEFAULT_CMIS_USER property. |
| Password | Password to authorize access to CMIS repository | Only if authorization is required | Default value can be set by ADX_DEFAULT_CMIS_PASSWORD property. |
| Authentication Method | Authentication method expected by the CMIS server | Yes | http_basic |
| Binding Type | Binding type configured on the CMIS repository | Yes | browser |
| Type Definitions | Collection of representations of CMIS types (for example types representing documents or folders) available in target repository. | No | None |
| Role mappings | If not configured, D1 users will authenticate to CMIS using the credentials provided in Username and Password. If configured, D1 users will authenticate using credentials mapped to their role. | No | None |
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:
| Property | Description | Is this property mandatory? | Default value |
|---|---|---|---|
| Repository Id | ID of the Documentum repository being connected | Yes | Default value can be set by ADX_DEFAULT_DCTM_REPOID property. |
| Service URL | URL of Documentum service, such as http://documentumServer.com/emc-cmis/browser | Yes | Default value can be set by ADX_DEFAULT_DCTM_SERVICEURL property. |
| Username | User name to authenticate to Documentum repository | Only if authorization is required | Default value can be set by ADX_DEFAULT_DCTM_USER property. |
| Password | Password to authorize access to Documentum repository | Only if authorization is required | Default value can be set by ADX_DEFAULT_DCTM_PASSWORD property. |
| Is Version 6.x | Select this option if the target Documentum service is running on version 6. When selected, this option changes D1 requests sent to Documentum server to match the SOAP API of Documentum 6. | No | Disabled |
| Type Definitions | Collection of representations of Documentum types (for example types representing documents or folders) available in target repository. For detailed information, see Type definitions. | No | None |
| Role mappings | If not configured, D1 users will authenticate to CMIS using the credentials provided in Username and Password. If configured, D1 users will authenticate using credentials mapped to their role. For detailed information, see Role mappings. | No | None |
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)
| Property | Description | Is this property mandatory? | Default value |
|---|---|---|---|
| Cache Database | Database configuration defining where to store cached files metadata. For details, check Configuring repository database. | Yes | Default cache database can be set on runtime by ADX_DEFAULT_CACHE properties, entered in the installation settings file. |
| Name Space Prefix | The name space prefix for this repository, used together with the technical name to build the actual name space. | Yes | adx.custom.model |
| Cache Storage | Configuration of cached binary file storage. You can enter default values for cache storage during D1 installation. Click in the text field to open the form where you can change the configuration. For details, see Configuring repository storage. | Yes | Default cache storage can be set on runtime by ADX_DEFAULT_STORAGE_CACHE properties, entered in the installation settings file. |
| Cache as PDF | If 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. | No | Enabled |
| Cache for Preview | If 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). | No | Enabled |
| Cache Original | If selected, the original content is cached by default when creating a content representation. | No | Enabled |
| Representations TTL | Time after which content representations are deleted | Yes | 3y |
| WebReader URL | URL of the WebReader service when WebReader is started from this repository | No | None |
| Data model | Custom data model - see Configuring custom types. | No | None |
| Service model | Custom service model. Currently, there are no documented examples of customized service model implementation. | No | None |
Fulltext
These properties relate to configuration of the elastic search component of this repository. Normally, you should be fine using the default values.
| Property | Description | Is this property mandatory? | Default value |
|---|---|---|---|
| Fulltext enabled | When selected, fulltext search is enabled on this repository | No | Enabled |
| Cluster name | Elastic search cluster name | Yes | elasticsearch |
| Host | Elastic search service host | Yes | 127.0.0.1 |
| Port | Elastic search service port | Yes | 9300 |
| Indexing Threads | Number of indexing threads | No | 2 |
| Max Result Size | Maximum allowed search result size | No | 100 |
Conversion
These properties define how D1 is using Conversion. You can provide connection settings to a remote Conversion service and define conversion restrictions for this repository.
| Property | Description | Is this property mandatory? | Default value |
|---|---|---|---|
| Conversion AccessId | Service domain ID where Conversion service can be found. Please use the default value. | Yes | conversion.access |
| Conversion Services URL | If remote Conversion is used, enter the URL of the remote service. | Only needed if remote conversion is used | Default value can be set by DOCUMENTS_CONVERSION_TFS_URL property. |
| Conversion Username | Used to authenticate to the remote Conversion service. | Only needed if remote conversion is used | Default value can be set by DOCUMENTS_CONVERSION_USERNAME property. |
| Conversion Password | Used to authorize access to the remote Conversion service. | Only needed if remote conversion is used | Default value can be set by DOCUMENTS_CONVERSION_PASSWORD property |
| Conversion Restriction | See Setting up 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. | No | Default 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.
| Property | Description | Is this property mandatory? | Default value |
|---|---|---|---|
| Name Space Prefix | You 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. | Yes | adx.custom.model |
| Download Strategy | Defines how a content download request should be executed - either from repository cache or storage. | Yes | preferCache |
| Deleted Entries TTL | Time counted from deleting an entry in D1. After this time has passed, database, cache, and storage records of this entry are deleted. | Yes | 5d |
| Default Page Size | This parameter defines how many results can be displayed in a single page in D1. | Yes | 100 |
| Auditing Enabled | Defines whether technical auditing should be enabled for content-related changes. | Yes | Enabled |
| Base Content Type | Default data type for uploaded contents. | Yes | Content for D1 repository, CmisContent for CMIS, DctmContent for Documentum |
| Base Folder Type | Default data type for created folders | Yes | Folder for D1 repository, CmisFolder for CMIS, DctmFOlder for Documentum |
| Storing Metadata Enabled | If enabled, content specification is exported from this repository. See Exporting repository entry metadata for details. | Yes | Disabled |
| Data Model | Data model for the repository | No | adx-content-data-default-model |
| Service Model | Service model for the repository | No | adx-content-service-default-model |
| WOPI configuration | Configuration of the WOPI service | No | D1 WOPI Configuration |
Async
Properties related to handling asynchronous calls.
| Property | Description | Is this property mandatory? | Default value |
|---|---|---|---|
| Persistence Strategy | Defines 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. | Yes | always |
| Core Poolsize | The minimum number of threads that will be held alive, ready to be used anytime when a new request is received. | Yes | 5 |
| Max Poolsize | The 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). | Yes | 5 |
| Keep Alive Time | Time (in ms) for which an idle thread should be kept alive before it is closed to save resources. | Yes | 180000 |
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.
| Property | Description | Is this property mandatory? | Default value |
|---|---|---|---|
| Connect Default | Defines the default access policy for this repository | Yes | Grant |
| ACL Entries | Shows currently configured Access Control List entries - see User management for more details. | No | None |
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.