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:

From there, you can perform a number of operations:

Repositories

This view lists all available repositories and provides the necessary tools for their management. Repositories store the instances of the RepositoryEntry entity, which is a part of the adx-content-model - a foundation for content management in ADx.

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 previously selected repository:

The actions include:

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

General properties are visible only in Details view.

PropertyDescription
NameThe unique name of this repository. This is the base name for all the components that will be deployed for this repository.
StatusIndicates whether the repository is up and running. Available values:
ACTIVE
INACTIVE
TypeThe connector type of this repository. Available values:
STANDARD
CMIS
DCTM (Documentum)
ModifiedIndicates whether this repository has local changes which are not applied/synchronized yet.

Description

Description is visible only in Details view.

PropertyDescription
DescriptionA description of this repository.

Connection

PropertyDescription
Authentication MethodMethod of authentication
Binding TypeAvailable types:
webservices
atompub
browser
PasswordThe default password to be used to create a CMIS connection in case no mapping matches.
Repository IDId of the repository.
Service URLURL to the database.
UsernameUsername used to connect.

Cache

Technically, a cache is an access associated to the content access.

PropertyDescription
Cache DatabaseDefines the connection for the meta-data (model instances).
Cache StorageDefines where the resource binaries are stored (file system or a database).
Representations TTLTime to live of content representations before they are deleted. The format is the time value followed by time unit: d - days, m - months, y - years.
Cache as PDFIndicates if the content resource should be converted and cached as PDF on upload.
Cache for PreviewIndicates whether the document representation creation should be triggered (async) for this content at creation time.
Cache OriginalIndicates whether the cached copy of the original resource is cached.
WebReader URLThe base URL for the WebReader. If not set, defaults to the value of the ADX_WEBREADER_BASE_URL property.

Fulltext

PropertyDescription
Cluster NameName of the fulltext search cluster.
HostHost where the fulltext server is running.
PortPort the fulltext server is running on.

Conversion

PropertyDescription
Conversion AccessIdAccess ID of the conversion service.
Conversion PasswordPassword for the conversion service.
Conversion Services URLURL for the conversion service.
Conversion UsernameUsername for the conversion service.

Content

PropertyDescription
Base Content TypeAn optional base content type. If not set, defaults to tribefire.adx.model.content.Content.
Base Folder TypeAn optional base folder type. If not set, defaults to tribefire.adx.model.content.Folder.
Deleted Entries TTLTime to live of logically deleted entries before they are deleted physically. The format is the time value followed by time unit: d - days, m - months, y - years.
Download StrategyDefines the download/streaming strategies for Content.
forceStorage - always download from the content storage
forceCache - always tries to download the original from cache, if doesn’t exist it throws an error
preferCache - tries to download the original from cache, if doesn’t exist downloads it from content storage
Name Space PrefixUsed together with the technical repository name to build the actual namespace.
Custom Content ModelAn optional custom content model to be used by the Content access.
Custom Content Service ModelAn optional custom service model to be used by the Content access.
Default Page SizeDefault page size used in queries when no additional pagination information is provided.

Async

PropertyDescription
Request Persistence StrategyDefines the persistence strategy for asynchronous requests.
always means
onEnqueue means asynchronous requests are only persisted if they get enqueued in the pool for later processing
never means
Core Pool SizeDefines the initial thread pool size.
Keep Alive TimeDefines the time the requests are kept alive.
Max Pool SizeDefines the maximal thread pool size.

Deployables

PropertyDescription
Binary PersistenceThe processor responsible for persisting the binary content.
Binary RetrievalThe processor responsible for retrieving the binary content.
Callback ProcessorThe processor responsible for handling asynchronous callbacks.
Content AccessThe access responsible for serving the content model of this repository.
Content ModelThe content model to be used by this access.
Content ProcessorThe processor responsible for serving the content API.
Content Representation AccessThe access responsible for serving the content representation model of this repository.
Content Service ModelThe content service model to be used by the content access.
Conversion ConnectionAn optional connection to a remote Tribefire instance. If not set, it is assumed that a local conversion access is to be used.
RepositoryThe back link to the Adx repository.
Endpoint MappingsDDRA Mappings (Swagger/REST) automatically created for this repository.
Managed DeployablesThe full collection of all the deployables managed by the operations on the repository.

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.