Connector Configuration
Configuration for OpenText Content Server
Please note that certain settings affect the performance of content traversals, see the Performance section of the FAQ for details.
OpenText Content Server Connection Settings
Configuration options related to establish connection to the target OpenText Content Server instance.
Name | Property Key | Description | ||
---|---|---|---|---|
Instance Name |
|
An identifier of the source system that is automatically added to the metadata of each document. |
||
REST API Base URL |
|
Base URL of OpenText Content Server’s REST API. This URL is also used to create URLs for people to click on in search result. Adding the This URL can point to a different host than the other API (base) URLs, as long as all hosts represent the same OpenText Content Server. |
||
SOAP APIs Base URL |
|
Base URL of OpenText Content Server’s main SOAP APIs. This URL must point at the base directory (usually ending in This URL can point to a different host than the other API (base) URLs, as long as all hosts represent the same OpenText Content Server. |
||
Records Management URL |
|
Full URL of OpenText Content Server Records Management Security Management SOAP API. This URL is only needed if Records Management is used, see Records Management Security Management SOAP API in OpenText Content Server Setup for the installation. Unlike for other SOAP APIs, no auto-detection for needed suffixes are done for this URL; this URL needs to be specified in its entirety. This URL can point to a different host than the other API (base) URLs, as long as all hosts represent the same OpenText Content Server. |
||
Technical User |
|
Technical user who will be used for traversing OpenText Content Server. See Needed Permissions and Privileges in OpenText Content Server Setup for the permissions needed by this user. |
||
Password |
|
Password for the technical user. |
||
Security Cache Expiration Duration |
|
Maximum time to live of cached principal- and security clearance-related values after the last update. |
||
HTTP Timeout |
|
The duration after which HTTP calls (both to the OpenText Content Server REST and the OpenText Content Server SOAP API) time out. |
||
Maximum number of retries for HTTP requests |
|
The maximum number of retries in case of OpenText Content Server API timeouts. |
||
Retry Delay |
|
The delay after which a retry is performed in case of an OpenText Content Server timeout. |
||
Maximum REST API calls per second |
|
The maximum number of OpenText Content Server REST API calls made per second.
|
OpenText Content Server Content Traversal Settings
Configuration related to what to traverse for content.
Name | Property Key | Description |
---|---|---|
Start node IDs |
|
Root nodes where traversal starts. The default is 2000 (Enterprise Workspace). |
Exclude node IDs |
|
The subtrees of exclude nodes will not be traversed, unless specific start node IDs are configured. |
Type IDs |
|
IDs of node (sub)types to convert into items for the index. The defaults are 144 (Document), 130 (Topic), 134 (Reply), 208 (News), 5574 (Wiki Page), 123470 (Forum Entry), and 123476 (FAQ Entry). |
Fetch users as items |
|
Whether to fetch users not only as principals, but also as content items. If this option is selected, then the user profiles are indexed as well so that the profile information becomes searchable. |
OTCS-local time zone |
|
The time zone the OpenText Content Server uses internally, used for some timestamp clarifications. The default value is the local time zone of the connector. |
OpenText Content Server Item Settings
Optional configuration related to what data the items will contain.
Name | Property Key | Description |
---|---|---|
Fetch categories |
|
Whether to fetch categories attached to nodes and their data values. |
Fetch classifications |
|
Whether to fetch non-Records Management classifications attached to those nodes that can have them. |
Fetch Records Management classifications |
|
Whether to fetch metadata about Records Management classifications attached to nodes. |
Fetch full (Records Management) classifications paths |
|
Whether to also fetch the ancestors' names of all classifications and Records Management classifications. |
Fetch holds |
|
Whether to fetch metadata of holds applied to those nodes that can have them. |
Fetch RSIs |
|
Whether to fetch the record series identifiers assigned to nodes. |
Fetch cross references/XRefs |
|
Whether to fetch some metadata about cross references (a.k.a XRefs) for those nodes that can have them. |
Maximum content size |
|
For items with content larger than this size, only the metadata will be indexed. If the size of the content is known to be bigger than this size in advance, the connector will not fetch it from OpenText Content Server. Setting this to zero (0) bytes is supported and will result in:
|
Metadata Cache Expiration Duration |
|
Maximum time to live of cached metadata values after the last update. |
OpenText Content Server Change Processing Settings
Configuration related to the data source for change processing.
Name | Property Key | Description | ||
---|---|---|---|---|
Change Processing Audit LiveReport ID |
|
Node ID of the LiveReport that queries the audit table to fetch the recent changes, which are then processed by the connector. If no LiveReport ID is provided (default), then changes are fetched using the OTCS-internal search engine.
|
||
Calculate cascading deletions for Audit LiveReport |
|
Change Processing by Audit LiveReport detects deletions, but in case of deleted container items, it does not detect that the container’s contents were also deleted. Select this option to let the connector calculate the cascading deletions of container items (based on information collected during previous traversals / change processing iterations). For example, if a folder has been deleted which contained subfolders and documents, then selecting this option ensures that all the deleted sub-items are also deleted from the search index. If this option is deselected, then only the deleted folder item itself is removed from the index. This might be useful if you want change processing to capture single-item changes quickly, while bulk deletions shall be covered by incremental traversals. |
||
Use separate Exclude node IDs for change processing |
|
Whether to use separate Exclude node IDs for change processing. The default is false, meaning the Exclude node IDs configured under OpenText Content Server Content Traversal Settings are used for change processing, too. This option allows to specify Exclude nodes which differ from the Exclude nodes used for Ramp Ups and Incremental Traversals. So you can apply change processing to a different portion of the data than content traversals. |
||
Exclude node IDs |
|
The subtrees of exclude nodes will be ignored by change processing, unless specific start node IDs are configured. This option appears if "Use separate Exclude node IDs for change processing" is enabled. |
||
Use separate Type IDs for change processing |
|
Whether to use separate Type IDs for change processing. The default is false, meaning the Type IDs configured under OpenText Content Server Content Traversal Settings are used for change processing, too. This option allows to apply change processing to a different set of node types than content traversals. |
||
Type IDs |
|
IDs of node (sub)types to process during change processing. This option appears if "Use separate Type IDs for change processing" is enabled. |
||
Maximum number of retries for changed items |
|
The maximum number of retries in case of failures to process a change. If the connector cannot fetch an item which has been changed (e.g. due to a temporary network outage), then it retries fetching it during subsequent change processing iterations. This option specifies the number of iterations which retry to fetch an item. |
OpenText Content Server Debugging Settings
Optional configuration related to debugging.
Name | Property Key | Description |
---|---|---|
JSON dump base path |
|
The directory to dump the raw JSON received from the REST API to. If the directory does not exist, it will be created. If the value is unset (this is the default), no JSON will be dumped. |
JSON dump filter |
|
Specifies which REST API responses are dumped into the JSON dump base path. You can choose between two options:
|
Microsoft Search Configuration
Connector Product Settings
Configuration Options related to specifying the product which is going to connect to the Microsoft Search.
Name | Property Key | Description |
---|---|---|
Connection ID |
|
Connection ID of the connector product which is registered with Microsoft Search. |
Microsoft Services Authentication Settings
Configuration Options related to authentication for the Microsoft Search.
Name | Property Key | Description |
---|---|---|
OAuth2.0 client ID |
|
OAuth2.0 client ID for the Microsoft Search Authentication. |
OAuth2.0 client secret |
|
OAuth2.0 client secret for the Microsoft Search Authentication. |
Tenant ID |
|
Tenant ID of OAuth2.0 Token URI for the Microsoft Search Authentication. |
Microsoft Search Connection Settings
Configuration Options related to establish a connection and sending requests to Microsoft Search.
Name | Property Key | Description |
---|---|---|
API endpoint |
|
Microsoft Search API endpoint including version specifier. |
Requests per Second |
|
Maximum number of requests per second. |
Connect Timeout |
|
Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default if applicable). |
Socket Timeout |
|
Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default if applicable). |
Use Poxy |
|
If enabled, the connection to Microsoft Graph API will be established through a HTTP/HTTPS proxy. |
Proxy Endpoint |
|
Target proxy URL including protocol, host and port. |
Proxy Authentication |
|
If enabled, the connector uses the specified credentials to authenticate towards proxy. |
Proxy Username |
|
Proxy authentication username. |
Proxy Password |
|
Proxy authentication password. The value will be stored encrypted by the connector. |
Microsoft Search Principal Mapping Settings
Configuration Options related to mapping source system principals to Microsoft Search AzureAD users.
Name | Property Key | Description |
---|---|---|
Principal ID Attributes |
|
AzureAD attributes to match principal ids against. Maps a principal id to all AzureAD user objects where one of the specified attributes values matches the principal id. |
General Configuration
Database Configuration
Name | Property Key | Description |
---|---|---|
URL |
|
JDBC URL for the target database. Out of the box, the connector will use H2 file database. For productive usage, use PostgreSQL specifying the URL in format: |
Username |
|
Database Username to read and write to database. |
Password |
|
Database Password for the specified user |
Traversal Configuration
Name | Property Key | Description |
---|---|---|
Traversal History Length |
|
Max. number of traversals to store in the history. Once the limit is exceeded, the connector will automatically remove oldest entries in the history. (default: 100) |
Number of Traversal Workers |
|
Number of workers to execute the traversal in parallel. Increasing this value might improve the performance, but will footprint higher memory consumption. It is recommended to keep the default value. (default: 10) |
Traversal Job Poll Interval |
|
Interval between the workers to be triggered to fetch and process the next tasks. (default: 10ms) |
Completion Timeout |
|
If the search engine indexes the items asynchronously, there might be some processing still in-flight during the completion process of a traversal. This value specifies the timeout value until all asynchronous callbacks are expected to return before completing the traversal. (default: 10m) |
Principal Aliaser Configuration
Principal Aliasing is applied on user information as part of Content ACL processing during Content Synchronization and Principal processing during Principal Synchronization. It’s purpose is to map external source system user to the corresponding user in search engines domain. You can configure a list of aliasers in the connector which will be applied in sequence and in order on user ACEs and user principals. The Connector supports following custom aliasing mechanism.
Custom Aliaser Disabled
If the Custom Aliaser checkbox is not selected, the connector will process user information on ACE and user principals unchanged to Search Engine. If all relevant users in the source system can be found with the same identifier in the search engine, this setup is sufficient to reflect the same secure search experience in the search engine as defined by the policy in the source system. The connector uses this option as default to process user information.
Custom Aliaser Enabled
If custom aliasing is enable then there are four types of aliaser avaialble:
Simple XML Table Aliaser
Static mapping table which can be uploaded as XML file. The connector uses the uploaded file as lookup table to map a user in the source system to a user in the search engine. Users missing a record in the file will be dropped from the ACE and during Principal Synchronization. This option is only recommended for environment with a manageable amount of users as for each user the corresponding mapping entry needs to be specified in the file.
Name | Description |
---|---|
XML Mapping File |
Browse and upload or drag and drop. |
Sample XML mapping file:
<?xml version="1.0" encoding="UTF-8"?> <storeddata> <entry keyValue="user1">user1@raytion.com</entry> <entry keyValue="user2">user2@raytion.com</entry> <entry keyValue="user3">user3@raytion.com</entry> </storeddata>
Regex Replacer Aliaser
Regex Replacer Aliaser computes aliases based on a regular expression. Principals that match the regular expression are replaced by the Substitution String.
Name | Property Key | Description |
---|---|---|
Pattern |
|
The regular expression to match, this is the part that will be replaced. If braces (…) are used in the pattern then the matched value can be retrieved using $1 |
Substitute String |
|
String to replace the matching part of the find string. Matched value is accessed by employing $1 |
Regex Extractor Aliaser
Regex Extractor Aliaser computes aliases based on a regular expression. Principals that match the regular expression are inserted into the Insert-Into String.
Name | PropertyKey | Description |
---|---|---|
Pattern |
|
The regular expression to match, this is the part that will be inserted into the new value. If braces (…) are used in the pattern then the matched value can be retrieved using $$ |
Insert-Into String |
|
String to replace the matching part of the pattern. Matched value is accessed by employing $$ |
LDAP Aliaser
Ldap Aliaser searches for an LDAP entry with the requested name in the input value and returns the specified output attribute.
Name | Property Key | Description |
---|---|---|
Host |
|
Fully Qualified Domain Name of an LDAP server |
Port |
|
Port to use for LDAP connection, defaults are 389/636 or (recommended) 3268/3269 for simple/SSL |
AccountDN |
|
AccountDN for bind to LDAP |
Password |
|
Password part of credentials |
Input Field |
|
The Active Directory attribute name for this equality filter |
Search Root DN |
|
Distinguished Name of the subtree which is searched. The smaller the subtree the better the performance but the higher the chance of encountering principals which are not part of this subtree |
Output Field |
|
Attribute that should be returned in result entries |