Connector Configuration

In some scenarios, it can be useful to provide a system property or an environment variable within a configuration value. For example, you might want to distribute multiple connector instances over different containers and have certain configured parameters adapted according to specific system properties or environment variables, respectively. You can do this by providing a placeholder of the form ${my.system.property} within the value of some configuration option. The connector will resolve this property when reading the configuration, i.e., the placeholder will be replaced by the value of the corresponding system property / environment variable.

However, for security reasons this replacement is disabled by default. A malicious user could misuse this feature to obtain sensitive information about the connector environment such as the host’s operating system, the user under which the connector is running etc. You can mitigate this issue e.g. by restricting the access to the connector UI.

If you want to enable the resolution of system properties and environment variables, set the system property resolvePlaceholdersInPropertyValues to true. This can be done, for example, in the connector’s start script under the bin directory as follows.
In connector.bat (Windows):
set CONNECTOR_OPTS="-DresolvePlaceholdersInPropertyValues=true"
In connector (Linux/Unix):
CONNECTOR_OPTS='"-DresolvePlaceholdersInPropertyValues=true"'

SQL Database Configuration

Connection Settings

To establish a connection to a database, the following properties are mandatory:

Name Property Description

Jdbc Driver Name

raytion.connector.agent.sql.connections.connections.jdbcDriverDisplayName

Name of the JDBC Driver for the database.

Jdbc Custom Driver Class

raytion.connector.agent.sql.connections.connections.customJdbcDriverClass

Name of the JDBC Driver Class if none of the preconfigured drivers is used.

Jdbc Connection Uri

raytion.connector.agent.sql.connections.connections.connectionUri

URI for database connection.

Jdbc Connection Username

raytion.connector.agent.sql.connections.connections.username

Username for the database connection.

Jdbc Connection Password

raytion.connector.agent.sql.connections.connections.password

Password for database connection.

Content Query Settings

To then crawl content from this connection, the following content query properties are mandatory:

Name

Property

Description

Query Type

raytion.connector.agent.sql.connections.connections.contentQueries.type

Decides a how to query data from the database.

* Single Stage Querying - This is the simplest form, use this option for simple queries that are expected to return small result sets without error. * Two Stage Batched Querying - Use this option for complex queries that may encounter errors in the result set, this option is able to recover and continue while at the same time keeping the query rate to the database at a minimum. * Two Stage Single Row Querying - Use this option for complex queries that may encounter errors in the result set, this option is able to recover and continue. This option has a higher query rate to the database, but in most scenarios it will be the fastest most robust option.

If you are unsure which option is best for your scenario then use ‘Two Stage Single Row Querying’.

ID Column

raytion.connector.agent.sql.connections.connections.contentQueries.idColumn

Name of the column whose values are used as IDs.

Depending on your Query Type the following properties are also mandatory:

Single Stage Querying

Name

Property

Description

SQL Query

raytion.connector.agent.sql.connections.connections.contentQueries.query

The SQL query which returns the data to be indexed.

Two Stage Batched Querying

Name

Property

Description

SQL Content ID Query

raytion.connector.agent.sql.connections.connections.contentQueries.idsQueryBatched

The SQL query which returns the IDs of all the rows to be indexed. e.g. SELECT id FROM customer

SQL Content Query by IDs

raytion.connector.agent.sql.connections.connections.contentQueries.queryByIdsBatched

SQL which queries rows based on IDs. " Use the Placeholder RAYTION_IDS_VARIABLE in an 'IN (…​)'-clause. e.g. SELECT id, name, address, contact FROM customer WHERE id IN (RAYTION_IDS_VARIABLE)

Query Batch Size

raytion.connector.agent.sql.connections.connections.contentQueries.queryBatchSize

The number of rows to be fetched by a single query.

ID Column

raytion.connector.agent.sql.connections.connections.contentQueries.idColumn

The column that will provide the IDs in the first query, these IDs will then be substituted into the RAYTION_IDS_VARIABLE placeholder in the second query.

Two Stage Single Row Querying

Name

Property

Description

SQL Content ID Query

raytion.connector.agent.sql.connections.connections.contentQueries.idsQuerySingleRow

The SQL query which returns the IDs of all the rows to be indexed. e.g. SELECT id FROM customer

SQL Content Query by ID

raytion.connector.agent.sql.connections.connections.contentQueries.queryByIdSingleRow

SQL which queries a single row given an ID. Use the Placeholder RAYTION_ID_VARIABLE in an EQUALS-clause. e.g. SELECT id, name, address, contact FROM customer WHERE id = RAYTION_ID_VARIABLE

ID Column

raytion.connector.agent.sql.connections.connections.contentQueries.idColumn

The column that will provide the IDs in the first query, these IDs will then be substituted into the RAYTION_ID_VARIABLE placeholder in the second query.

Connection Pooling Settings (Optional)

Configuration options for pooling settings of a connection. These settings are only considered when the flag Set Optional Connection Pooling Parameters is activated.

Name Property Description

Set Optional Connection Pooling Parameters

raytion.connector.agent.sql.connections.connections.setOptionalParameters

Flag to enable optional parameters for the connection pooling.

Pool Connection Timeout

raytion.connector.agent.sql.connections.connections.connectionTimeout

Maximum time that a client will wait for a connection from the pool.

Idle Timeout

raytion.connector.agent.sql.connections.connections.idleTimeout

Maximum time that a connection is allowed to sit idle in the pool.

Pool Connection Keep Alive Time

raytion.connector.agent.sql.connections.connections.keepAliveTime

The interval in which pool connections will be tested for aliveness, thus keeping them alive by the act of checking. Deactivated if set to 0.

Maximum Pool Connection Lifetime

raytion.connector.agent.sql.connections.connections.maxLifetime

The maximum lifetime of a connection in the pool.

Minimum Idle Pool Connections

raytion.connector.agent.sql.connections.connections.minIdle

The minimum number of idle connections in the pool to maintain.

Maximum Pool Connections

raytion.connector.agent.sql.connections.connections.maxPoolSize

The maximum number of connections in the pool.

SQL Select Rate

raytion.connector.agent.sql.connections.connections.maxSelectsPerSecond

Maximum rate at which SQL will be executed against the database. A value of '-1' is equivalent to no limit.

Content Query Column Settings (Optional)

Configuration Options for optional columns of a Content Query. Only available with Query Type Single Stage Querying.

Group Column

Name Property Description

Set Group Column

raytion.connector.agent.sql.connections.connections.contentQueries.setGroupColumn

Flag to enable a group column for the query. A group column groups the results of a query that have the same value in this given column. The results of a group are aggregated into one item by concatenating the values of a column into a comma separated list of these values. If the values of a column are binary data, then only the first value is taken.

Group Column

raytion.connector.agent.sql.connections.connections.contentQueries.groupColumn

Name of the column which is used for a GROUP_BY query. This column must not be the same as Content Column or ID Column.

Column to Metadata Field Mapping

To define which column of the query should be considered for the value of a metadata field, mappings from a column name to a metadata field can be configured:

Name Property Description

Column Name

raytion.connector.agent.sql.connections.connections.contentQueries.columnMappings.columnName

The column of the query whose values should be mapped to the metadata field.

Metadata Field

raytion.connector.agent.sql.connections.connections.contentQueries.columnMappings.metadataField

The metadata field to which the value of the column should be mapped.

Here mappings for the following metadata fields can be defined whereas only one mapping per field is allowed:

Metadata Field Remark

Content

Title

Item Type

Mime Type

File Extension

Preview URL

It is expected that the column’s values are strings in proper URL format.

Click URL

It is expected that the column’s values are strings in proper URL format.

Keywords

It is expected that the column’s values are a comma separated list of strings.

Languages

It is expected that the column’s values are a comma separated list of strings.

Author

Contributors

It is expected that the column’s values are a comma separated list of strings.

Created Date

It is expected that the column’s values are timestamps with time zones.

Last-Modified Date

It is expected that the column’s values are timestamps with time zones.

Breadcrumbs

It is expected that the column’s values are a comma separated list of strings in proper URL format.

Amazon Kendra Configuration

Instance Configuration

Configuration options related to specifying the target Kendra Index and Data Source including authentication/authorization settings.

Setting Description

Index ID

ID of the target index.

Region ID

ID of the region where the index is deployed. One of us-east-1(N. Virginia), us-east-2(Ohio), us-west-2(Oregon), eu-west-1(Ireland), ca-central-1(Canada), ap-southeast-1(Singapore) or ap-southeast-2(Sydney) is available.

Amazon Resource Name

ARN of the IAM Service Role assigned to the index.

Data Source ID

ID of the Custom Data Source Connector added to target index. All documents and groups processed by the connector will be attached to this data source.

Use System Credentials

If set to true, the AWS Access and Secret Key will be automatically discovered from following locations:

- Java System Properties aws.accessKeyId and aws.secretAccessKey

- Environment Variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY

- Web Identity Token credentials from System or Environment Variables

- Credentials Profile File at location ~/.aws/credentials

- Credentials delivered through the Amazon EC2 container

- Instance profile credentials delivered through the Amazon EC2 metadata service

Access Key

If Use System Credentials is set to false, access keys need to be specified explicitly in the configuration. The specified account requires the Managed Policy AmazonKendraFullAccess.

Secret Access Key

Secret Key of the specified AWS account. The value will be stored encrypted by the connector.

HTTP Connection Configuration (Optional)

Configuration options for fine-tuning the Http connection parameters.

Setting Description

Connection Acquire Timeout

Timeout value for acquiring an already established connection from connection manager.

Connection Timeout

Timeout value for establishing a connection to host.

Connection Idle Timeout

Timeout value after an idle connection should be closed.

Connection Time to Live

Timeout value after the connection should be closed regardless of its current state.

Max. Number of Connections

Max. number of allowed connections maintained by the connection manager.

Max. Number of acquired connections

Max. number of requests allowed to wait for a connection.

Batch Configuration (Optional)

Documents are processed in a batch to Kendra. This configuration section includes all batch related properties including the callback behavior.

Setting Description

Max. Size

Max. batch size. All batch put requests will be restricted to this value . The max. allowed value is 10.

Ignore Processing State

If enabled, the connector submits all documents asynchronously without polling the processing state from Kendra. Documents failed during processing are not recognized by the connector. Unless you would like to monitor the connector using Amazon CloudWatch only, it is recommended to disable this option.

Flush Timeout

Periodic delay between flushing the batch. Within this period, it is guaranteed that the batch is flushed. If the current batch size exceeds the configured max. batch size, only the max. number of items will be flushed in a single cycle.

Callback Timeout

The Batch API used to index or delete items is asynchronous. The connector is polling the state of the submitted requests to track the state of the items. This property defines the timeout until the connector is expecting the requests to be completed in the asynchronous processing in the search engine.

Empty Content Processing Configuration (Optional)

Items with unsupported mime types (supported are: application/pdf, text/html, application/xhtml+xml, application/msword, application/mspowerpoint and text/plain) or empty content are rejected by Kendra. To make those items available in the search, the connector allows you to configure a token which will be appended to the content of those items.

Setting Description

Empty Content Token

Token appended to items with empty content or unsupported mime types. Must be not blank.

General Configuration

Database Configuration

Name Property Key Description

Configuration Type

raytion.connector.db.config.type

Supported are PostgreSQL, MS SQL Server, and JDBC URL configuration.

PostgreSQL

Name Property Key Description

Host

raytion.connector.db.config.postgres.host

Domain name or IP address of the database server.

Port

raytion.connector.db.config.postgres.port

Specifies the port number PostgreSQL is listening on, default is 5432.

Database Name

raytion.connector.db.config.postgres.name

Name of the database.

Username

raytion.connector.db.config.postgres.username

Username to authenticate with. The regarding user has to have read and write permissions to the database.

Password

raytion.connector.db.config.postgres.password

Password of the configured database user.

Add Custom Parameter

raytion.connector.db.config.postgres.addParameters

Enables the configuration of additional parameters.

MS SQL Server

Name Property Key Description

Host

raytion.connector.db.config.mssql.host

Domain name or IP address of the database server. Instance to connect to on server can be specified by '‹server_name>|<instance_name>'.

Port

raytion.connector.db.config.mssql.port

Specifies the port number MS SQL Server is listening on, default is 1433.

Database Name

raytion.connector.db.config.mssql.name

Name of the database.

Username

raytion.connector.db.config.mssql.username

Username to authenticate with. The regarding user has to have read and write permissions to the database.

Password

raytion.connector.db.config.mssql.password

Password of the configured database user.

Add Custom Parameter

raytion.connector.db.config.mssql.addParameters

Enables the configuration of additional parameters.

JDBC URL

Name Property Key Description

URL

raytion.connector.db.config.jdbc.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: jdbc:postgresql:<host>:<port>/<database>

Username

raytion.connector.db.config.jdbc.username

Database Username to read and write to database.

Password

raytion.connector.db.config.jdbc.password

Database Password for the specified user

Traversal Configuration

Name Property Key Description

Traversal History Length

raytion.connector.agent.traversal
.store.historyLength

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)

Include Checksum

raytion.connector.agent.traversal
.pipeline.includePipelineChecksum

If enabled, any changes made to the pipeline e.g. configuration, the subsequent incremental run triggers a refeed of all items.

Change Processing Interval

raytion.connector.agent.traversal
.changeprocessing.interval

Interval between change processing traversals.

Resume on Start

raytion.connector.agent.traversal
.resume.resumeTraversalOnRestart

If enabled, any traversals in paused state are automatically resumed after the connector restart. Otherwise, the traversal remains in paused state.

Number of Traversal Workers

raytion.connector.agent.traversal
.workers.worker

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

raytion.connector.agent.traversal
.workers.jobPollInterval

Interval between the workers to be triggered to fetch and process the next tasks. (default: 10ms)

Completion Timeout

raytion.connector.agent.traversal
.workers.completionTimeout

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)

Executor Size

raytion.connector.agent.traversal
.execution.executorSize

The executor size restricts the max. number of concurrent running traversals.

Queue Size

raytion.connector.agent.traversal
.execution.queueSize

The queue size restricts the max. number of queued traversals. If the value is exceeded, the connector rejects further traversal requests until the queue size is below the configured size.

Traversal Jobs

Name Property Key Description

Job Timeout Check Frequency

raytion.connector.job-broker.heartbeatPeriod

Configures how often the connector checks for timed out jobs.

Job Timeout

raytion.connector.job-broker.heartbeatTimeout

The duration for which a job can stay idle before it is timed out.

Job Cache Size

raytion.connector.job-broker.jobPollCacheSize

Max. cache size of Jobs waiting for processing in memory. When cache is empty, next batch is fetched.

Security Configuration

Request Restriction Settings

Name Property Key Description

Accepted Host Names

raytion.connector.security
.requests.acceptedDomains

A list of domains (+ port) that are allowed as host names in the headers of HTTP requests to the connector. This means that you can access the connector only via a URL that employs one of the configured domains. Each entry must have the format domain:port. Examples:

  • localhost:16390

  • connector.company.com:16390

If no domains are configured (the default), then you can use any domain via which the connector host is reachable.

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

raytion.connector.aliaser.aliasers[*]
.replacer.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

raytion.connector.aliaser.aliasers[*]
.replacer.substituteString

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

raytion.connector.aliaser.aliasers[*]
.extractor.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

raytion.connector.aliaser.aliasers[*]
.extractor.insertIntoString

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

raytion.connector.aliaser.aliasers[*]
.ldap.host

Fully Qualified Domain Name of an LDAP server

Port

raytion.connector.aliaser.aliasers[*]
.ldap.port

Port to use for LDAP connection, defaults are 389/636 or (recommended) 3268/3269 for simple/SSL

AccountDN

raytion.connector.aliaser.aliasers[*]
.ldap.bindAccountDN

AccountDN for bind to LDAP

Password

raytion.connector.aliaser.aliasers[*]
.ldap.password

Password part of credentials

Input Field

raytion.connector.aliaser.aliasers[*]
.ldap.inputField

The Active Directory attribute name for this equality filter

Search Root DN

raytion.connector.aliaser.aliasers[*]
.ldap.baseDN

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

raytion.connector.aliaser.aliasers[*]
.ldap.outputField

Attribute that should be returned in result entries