Connector Quick Start

Start Connector

Unpack the distribution and run the start script located in the installation bin directory.

LINUX

./connector

WINDOWS

./connector.bat

Login to Connector

Once the Connector has started, navigate to the Admin UI and login with the default username and password, admin/admin:

Configure Connector

Follow the description and instruction in the Basic Configuration Menu to configure the mandatory settings.

OpenText Documentum Configuration

Configure the URL of your Documentum instance. This value is not used to establish the connection to your Documentum server but for constructing the Click URL of crawled items.
Documentum Configuration
Configure the list of DQL queries to specify the document type and condition of items which should be crawled by the connector.
Documentum Queries
Configure the Database where the items should be queried from. Specify the credentials for the query user. Note, that this user requires read access to all items which should be crawled by the connector
Documentum Connections
Upload the dfc.properties file. Skip the dfc.keystore file upload unless you are using a custom keystore.
Documentum Files

Custom Security Manager Configuration

Configure URL of the CSM instance to connect to.
csm endpoint
Configuration options required for the connector to authenticate to the CSM.
csm credentials
Configuration namespace under which to ingest principals.
csm namespace

Microsoft Azure Cognitive Search Configuration

Configure the Microsoft Azure Cognitive Search instance to push documents against.
cognitive search config instance

Upload License

  • Contact Raytion and obtain a license for your connector

  • Login to the Admin UI

  • Select License in the menu:

uploadlicense 1
  • Upload the license file by browsing for the file or simply dragging a dropping the license onto the license page

  • The Status of the license will be displayed as valid, and the expiration and item quota will also be displayed:

uploadlicense 2

Synchronizing Content Information

Once, the connector is configured and license uploaded, you can start synchronize content information using the traversal feature in the dashboard.

Content Traversal

In order to synchronize items from source system, the Connector provides different types of execution:

  • Ramp-Up: All items from source system are processed to the search engine. This includes also previously synchronized unchanged items. Note, that Ramp-Up will not delete deprecated items.

  • Incremental: All items are from source system are compared against the state in the connector from previous synchronization runs. Only changed items (this includes newly added, modified and moved items) will be processed to Microsoft Azure Cognitive Search. This type can be used to reduce the load on the search engine. Incremental Runs will also synchronize delete information by deleting all removed items from the search engine index.

content dashboard

Principal Synchronization

Principal Synchronization processes Principal Information from Source System into Search Engine. The connector applies early binding of Access Control List for our content items. Hence, the items processed by Content Synchronization is protected by Access Control reflecting the equivalent Security Policy defined in the Source System. Security Information required by Search Engine to resolve the early bound items during search will be provided by Principal Synchronization. In case of Principal Synchronization, there is only a single execution type:

  • Ramp-Up: All principal information from source system is processed to Microsoft Azure Cognitive Search. This includes also information about deleted principal (deleted groups or deleted group membership relation).

Schedule Traversal

Scheduled traversals can also be configured through the menu.

From this button a Schedule can be configured.
schedule button
From upper right corner you can choose the traversal type and then click on NEW SCHEDULED TRAVERSAL.
schedule type
Configure the frequency that the Traversal will be executed and click Save.
schedule frequency