Connector Configuration

Microsoft Teams Configuration

Please note that certain settings affect the performance of content or principal traversals, see Performance section of the FAQ for details.

Mandatory Settings (BASIC)

In order for the connector to connect to Microsoft Teams, some actions are required on the source system as well as on the connector side. The following sections assume that the Microsoft Teams related preparations described in Microsoft Teams Setup have been done.

Authentication Settings

To establish a successful connection to Microsoft Teams, an Azure application with certificate authentication has to be configured.

Name Key Description

Name	Key	Description
Directory (Tenant) ID	`raytion.connector.agent.microsoft.teams. authentication.tenantId`	The ID of the Microsoft tenant. It can be found in the 'Overview' tab of the corresponding Azure application registration in the Azure Portal.
Application (Client) ID	`raytion.connector.agent.microsoft.teams. authentication.applicationId`	The ID of the application registered in the Azure Portal. It can be found in the 'Overview' tab of the corresponding Azure application registration in the Azure Portal.
Certificate File	`raytion.connector.agent.microsoft.teams. authentication.certificate`	Upload for a certificate file (extension: pfx). See Certificate File Generation for a guide on how to generate a certificate.
Certificate Password	`raytion.connector.agent.microsoft.teams. authentication.certificatePassword`	The password of the certificate file. See Certificate File Generation for a guide on how to generate a certificate.

Directory (Tenant) ID

raytion.connector.agent.microsoft.teams. authentication.tenantId

The ID of the Microsoft tenant. It can be found in the 'Overview' tab of the corresponding Azure application registration in the Azure Portal.

Application (Client) ID

raytion.connector.agent.microsoft.teams. authentication.applicationId

The ID of the application registered in the Azure Portal. It can be found in the 'Overview' tab of the corresponding Azure application registration in the Azure Portal.

Certificate File

raytion.connector.agent.microsoft.teams. authentication.certificate

Upload for a certificate file (extension: pfx). See Certificate File Generation for a guide on how to generate a certificate.

Certificate Password

raytion.connector.agent.microsoft.teams. authentication.certificatePassword

The password of the certificate file. See Certificate File Generation for a guide on how to generate a certificate.

Proxy Settings

If the connector is connected to the Internet via a proxy server, the configuration is controlled via the following settings.

Name Key Description

Name	Key	Description
Use Proxy	`raytion.connector.agent.microsoft.teams. proxy.useProxy`	If enabled, the connection to the Microsoft Teams instance will be established through HTTP/HTTPS proxy.
Proxy URL	`raytion.connector.agent.microsoft.teams. proxy.uri`	Target proxy URL including protocol, host and port.
Use authentication	`raytion.connector.agent.microsoft.teams. proxy.authentication`	If enabled, the connector uses the specified credentials to authenticate towards proxy.
Username	`raytion.connector.agent.microsoft.teams. proxy.username`	Proxy authentication username.
Password	`raytion.connector.agent.microsoft.teams. proxy.password`	Proxy authentication password. The value will be stored encrypted by the connector.

Use Proxy

raytion.connector.agent.microsoft.teams. proxy.useProxy

If enabled, the connection to the Microsoft Teams instance will be established through HTTP/HTTPS proxy.

Proxy URL

raytion.connector.agent.microsoft.teams. proxy.uri

Target proxy URL including protocol, host and port.

Use authentication

raytion.connector.agent.microsoft.teams. proxy.authentication

If enabled, the connector uses the specified credentials to authenticate towards proxy.

Username

raytion.connector.agent.microsoft.teams. proxy.username

Proxy authentication username.

Password

raytion.connector.agent.microsoft.teams. proxy.password

Proxy authentication password. The value will be stored encrypted by the connector.

Optional Settings (ADVANCED)

The following sections describe optional configuration adjustments for the Microsoft Teams connector.

Teams Discovery Settings

Microsoft Teams' top level content structure are teams. Each team may consist of channels with messages as well as channel private and team assigned files. In order to define which teams to traverse, the connector provides two strategies. Either a list of team IDs is provided or a request against the Microsoft API will be done, fetching all team enabled Azure groups present in the given tenant. The result of the automatic site discovery can be narrowed down via filtering.

Name Key Description

Name	Key	Description
Auto Team Discovery Enabled	`raytion.connector.agent. microsoft.teams.team-discovery.autoTeamDiscovery`	Defines if auto team discovery will be used. To manually state the teams to be traversed, unset this flag.
Team ID File	`raytion.connector.agent. microsoft.teams.team-discovery.teams`	Upload for a file which contains team IDs delimited by line. Only the teams found in this file will be considered in the traversals. Needs to be configured if auto team discovery is disabled.

Auto Team Discovery Enabled

raytion.connector.agent. microsoft.teams.team-discovery.autoTeamDiscovery

Defines if auto team discovery will be used. To manually state the teams to be traversed, unset this flag.

Team ID File

raytion.connector.agent. microsoft.teams.team-discovery.teams

Upload for a file which contains team IDs delimited by line. Only the teams found in this file will be considered in the traversals. Needs to be configured if auto team discovery is disabled.

Instead of a Team ID file, a CSV file exported from the Teams Admin Center can be used. For information about the export of a filtered list of Teams using the Teams Admin Center, see F.A.Q. section.

Teams Indexing Scope

Decide for indexing public and/or private teams. One option must be checked for the connector to extract any data out of Teams.

Name Key Description

Name	Key	Description
Include public teams	`raytion.connector.agent. microsoft.teams.team-visibility.includePublicTeams`	If checked, teams marked as public are processed.
Include private teams	`raytion.connector.agent. microsoft.teams.team-visibility.includePrivateTeams`	If checked, teams marked as private are processed.

Include public teams

raytion.connector.agent. microsoft.teams.team-visibility.includePublicTeams

If checked, teams marked as public are processed.

Include private teams

raytion.connector.agent. microsoft.teams.team-visibility.includePrivateTeams

If checked, teams marked as private are processed.

Channel Indexing Scope

Decide for indexing public, private and/or shared channels. One option must be checked for the connector to extract any data out of Teams.

Name Key Description

Name	Key	Description
Include public channels	`raytion.connector.agent. microsoft.teams.channel-visibility.includePublicChannels`	If checked, channels with membership type public or standard are processed.
Include private channels	`raytion.connector.agent. microsoft.teams.channel-visibility.includePrivateChannels`	If checked, channels with membership type private are processed.
Include shared channels	`raytion.connector.agent. microsoft.teams.channel-visibility.includeSharedChannels`	If checked, channels with membership type shared are processed.

Include public channels

raytion.connector.agent. microsoft.teams.channel-visibility.includePublicChannels

If checked, channels with membership type public or standard are processed.

Include private channels

raytion.connector.agent. microsoft.teams.channel-visibility.includePrivateChannels

If checked, channels with membership type private are processed.

Include shared channels

raytion.connector.agent. microsoft.teams.channel-visibility.includeSharedChannels

If checked, channels with membership type shared are processed.

Content Filter Settings

Configuration options to filter items by their content.

Each content filter operates using an Inclusion List or an Exclusion List based on text comparisons. Various comparator types (String Matcher Type) can be chosen, including:

EXACT - The filtered text must match exactly with the search text.
PREFIX - The filtered text must begin with the search text.
SUFFIX - The filtered text must end with the search text.
SUBSTRING - The filtered text must contain the search text at any position.
REGEX - The search text defines a regular expression that the filtered text must satisfy.

If the inclusion list contains any values, only the elements for which the text comparison with any of the list entries is successful will be indexed. All other elements will not be indexed.

If the exclusion list contains values, all entries for which the text comparison with any of the list values is successful will not be indexed.

Each filter can only contain either an inclusion or an exclusion list of values.

Name Key Description

Name	Key	Description
Enable Team Title Filter	`raytion.connector.agent. microsoft.teams.content-filter.teamFiltering`	Enable or disable a text type filter for team titles.
Enable Channel Title Filter	`raytion.connector.agent. microsoft.teams.content-filter.channelFiltering`	Enable or disable a text type filter for channel titles.
Enable Message Content Filter	`raytion.connector.agent. microsoft.teams.content-filter.messageFiltering`	Enable or disable a text type filter based on message contents.

Enable Team Title Filter

raytion.connector.agent. microsoft.teams.content-filter.teamFiltering

Enable or disable a text type filter for team titles.

Enable Channel Title Filter

raytion.connector.agent. microsoft.teams.content-filter.channelFiltering

Enable or disable a text type filter for channel titles.

Enable Message Content Filter

raytion.connector.agent. microsoft.teams.content-filter.messageFiltering

Enable or disable a text type filter based on message contents.

Item Type Filter Settings

The content structure in Microsoft Teams is hierarchical: Teams contain Channels, Channels contain Messages. Messages, in turn, contain message attachments and replies, which represent messages themselves. Built upon this hierarchical system, the Item Type Filter allows for excluding elements from a certain hierarchy level downwards.

Name Key Description

Name	Key	Description
First Excluded Item Type	`raytion.connector.agent. microsoft.teams.item-type-filter.firstExcludedItemType`	If selected `No Filter` - all Teams items (teams, channels, messages) will be indexed. If selected `Channels` - Only the teams will be indexed. If selected `Messages` - Only teams and channels will be indexed. Default: `No Filter`
Exclude Files	`raytion.connector.agent. microsoft.teams.item-type-filter.excludeFiles`	If checked, all files (team and channel files as well as message attachments) are excluded from indexing. Default: `false`

First Excluded Item Type

raytion.connector.agent. microsoft.teams.item-type-filter.firstExcludedItemType

If selected No Filter - all Teams items (teams, channels, messages) will be indexed.
If selected Channels - Only the teams will be indexed.
If selected Messages - Only teams and channels will be indexed.
Default: No Filter

Exclude Files

raytion.connector.agent. microsoft.teams.item-type-filter.excludeFiles

If checked, all files (team and channel files as well as message attachments) are excluded from indexing.
Default: false

File Extension Filter Settings

Configuration options to filter files based on their extension. The filter is applied on document library and list item attached files.

Name Key Description

Name	Key	Description
Enable File Extension Filtering	`raytion.connector.agent. microsoft.teams.extension-filter.extensionFiltering`	Enable or disable the file extension filter.
File Extension - Includes	`raytion.connector.agent. microsoft.teams.extension-filter.includeList`	The include list entries are matched against file names. Only if the file name ends with an extension mentioned in this list, the corresponding file will be traversed.
File Extension - Excludes	`raytion.connector.agent. microsoft.teams.extension-filter.includeList`	The exclude list entries are matched against file names. If the file name ends with an extension mentioned in this list, the corresponding file will not be traversed.

Enable File Extension Filtering

raytion.connector.agent. microsoft.teams.extension-filter.extensionFiltering

Enable or disable the file extension filter.

File Extension - Includes

raytion.connector.agent. microsoft.teams.extension-filter.includeList

The include list entries are matched against file names. Only if the file name ends with an extension mentioned in this list, the corresponding file will be traversed.

File Extension - Excludes

raytion.connector.agent. microsoft.teams.extension-filter.includeList

The exclude list entries are matched against file names. If the file name ends with an extension mentioned in this list, the corresponding file will not be traversed.

Include and exclude lists can’t be used at the same time.

General Filter Settings

The following general filter settings can be configured to restrict the traversals.

Name Key Description

Name	Key	Description
Max File Size	`raytion.connector.agent. microsoft.teams.filter.maxFileSize`	Maximal allowed size for content of documents. If the size is exceeding this value, the content of the document is discarded and ignored.
Ignore ACL	`raytion.connector.agent. microsoft.teams.filter.ignoreAcls`	If this flag is set, the documents will be public. For public search scenarios this makes sense, because fewer requests will be executed. Furthermore, fewer permissions are required for the content traversal.

Max File Size

raytion.connector.agent. microsoft.teams.filter.maxFileSize

Maximal allowed size for content of documents. If the size is exceeding this value, the content of the document is discarded and ignored.

Ignore ACL

raytion.connector.agent. microsoft.teams.filter.ignoreAcls

If this flag is set, the documents will be public. For public search scenarios this makes sense, because fewer requests will be executed. Furthermore, fewer permissions are required for the content traversal.

Metadata Settings

Configuration options to customize the metadata provided by the connector.

In Microsoft Teams, files from team and channel drives are stored within document libraries on SharePoint Online sites. As a result, items indexed by the Teams connector include both Teams-specific elements and SharePoint Online elements associated with teams.

Name Key Description

Name	Key	Description
Enable Manual Item Type Definition	`raytion.connector.agent. microsoft.teams.metadata.manualItemTypeDefinition`	Enables manual definition of item types.
Team Group Item Type	`raytion.connector.agent. microsoft.teams.metadata.groupItemType`	Override the item type for team objects. Default: `Teams.Group`
Team Channel Item Type	`raytion.connector.agent. microsoft.teams.metadata.channelItemType`	Override the item type for channel objects. Default: `Teams.Channel`
Team Channel Message Item Type	`raytion.connector.agent. microsoft.teams.metadata.messageItemType`	Override the item type for channel messages. Default: `Teams.Message`
List Item Type	`raytion.connector.agent. microsoft.teams.metadata.listItemType`	Override the item type for document libraries (drives). Default: `SP.List`
Document Library File Item Type	`raytion.connector.agent. microsoft.teams.metadata.documentLibraryFileItemType`	Override the item type for drive file items. Default: `SP.Item`
Document Library Folder Item Type	`raytion.connector.agent. microsoft.teams.metadata.documentLibraryFolderItemType`	Override the item type for drive folder items. Default: `SP.Item`

Enable Manual Item Type Definition

raytion.connector.agent. microsoft.teams.metadata.manualItemTypeDefinition

Enables manual definition of item types.

Team Group Item Type

raytion.connector.agent. microsoft.teams.metadata.groupItemType

Override the item type for team objects.
Default: Teams.Group

Team Channel Item Type

raytion.connector.agent. microsoft.teams.metadata.channelItemType

Override the item type for channel objects.
Default: Teams.Channel

Team Channel Message Item Type

raytion.connector.agent. microsoft.teams.metadata.messageItemType

Override the item type for channel messages.
Default: Teams.Message

List Item Type

raytion.connector.agent. microsoft.teams.metadata.listItemType

Override the item type for document libraries (drives).
Default: SP.List

Document Library File Item Type

raytion.connector.agent. microsoft.teams.metadata.documentLibraryFileItemType

Override the item type for drive file items.
Default: SP.Item

Document Library Folder Item Type

raytion.connector.agent. microsoft.teams.metadata.documentLibraryFolderItemType

Override the item type for drive folder items.
Default: SP.Item

Principal Synchronization Settings

In various scenarios, varying strategies for principal resolution may be of interest. The connector offers support for three distinct modes:

Full Microsoft Teams and all Azure AD groups and users:
1. Fetches and resolves all Teams related SharePoint Online site collection groups.
2. Fetches and resolves all Azure AD users and groups.
Full Microsoft Teams and referred Azure AD groups and users
1. Fetches and resolves all Teams related SharePoint Online site collection groups.
2. Resolves only Azure AD groups which were found as members of site collection groups or team enabled Azure groups.
Only Microsoft Teams groups
1. Fetches and resolves all SharePoint Online site collection specific groups.
2. Azure user and groups will not be fetched nor resolved.

Resolution of SharePoint Online as well as Azure AD principals is required for secure search. This is the case, because Microsoft added Azure AD support on top of an already existing permission structure in SharePoint Online.

Name Key Description

Name	Key	Description
Principal Crawl Algorithm	`raytion.connector.agent. microsoft.teams.principal-sync.crawlMethod`	Defines how and in which scope the principal synchronization should be done. Possible values are listed above this table. We recommend `Full Microsoft Teams and referred Azure AD groups and users` as it fetches and resolves only the minimal set of principals which is required for secure search.

Principal Crawl Algorithm

raytion.connector.agent. microsoft.teams.principal-sync.crawlMethod

Defines how and in which scope the principal synchronization should be done. Possible values are listed above this table.

We recommend Full Microsoft Teams and referred Azure AD groups and users as it fetches and resolves only the minimal set of principals which is required for secure search.

Connection Settings

In order to adjust the connector on HTTP client level, the following parameters can be adjusted:

Name Key Description

Name	Key	Description
Socket Timeout	`raytion.connector.agent. microsoft.teams.connection.socketTimeout`	Duration after which inactive connections will be terminated. Default: `30s`
Connection Timeout	`raytion.connector.agent. microsoft.teams.connection.connectionTimeout`	Maximal duration a client should wait for an initial response from a server. Default: `30s`
Retry Count	`raytion.connector.agent. microsoft.teams.connection.retryCount`	Maximal number of times a request should be retried on failure. Default: `3`
Retry Delay	`raytion.connector.agent. microsoft.teams.connection.retryDelay`	Fix delay between request retries. Default: `1s`
Max Total Connections	`raytion.connector.agent. microsoft.teams.connection.maxTotalConnections`	Maximum number of allowed connections overall. Default: `20`
Max Connections Per Route	`raytion.connector.agent. microsoft.teams.connection.maxConnectionsPerRoute`	Number of concurrent connections per route. Default: `10`
Connection Time To Live (TTL)	`raytion.connector.agent. microsoft.teams.connection.connectionTimeToLive`	Duration after which unused connections will be discarded. Default: `30s`
Requests Per Second	`raytion.connector.agent. microsoft.teams.connection.desiredRps`	Maximum number of requests which are active in parallel. Default: `15.0`
Rate Limit Requests Per Second	`raytion.connector.agent. microsoft.teams.connection.rateLimitRps`	Maximum number of requests which are active in parallel while the API rate is near its limit. Default: `0.33`
User Agent HTTP Header	`raytion.connector.agent. microsoft.teams.connection.userAgent`	HTTP header which is sent with every request. It identifies the agent responsible for the request. Default: `ISV\|Raytion\|TeamsConnector/9.0`

Socket Timeout

raytion.connector.agent. microsoft.teams.connection.socketTimeout

Duration after which inactive connections will be terminated.
Default: 30s

Connection Timeout

raytion.connector.agent. microsoft.teams.connection.connectionTimeout

Maximal duration a client should wait for an initial response from a server.
Default: 30s

Retry Count

raytion.connector.agent. microsoft.teams.connection.retryCount

Maximal number of times a request should be retried on failure.
Default: 3

Retry Delay

raytion.connector.agent. microsoft.teams.connection.retryDelay

Fix delay between request retries.
Default: 1s

Max Total Connections

raytion.connector.agent. microsoft.teams.connection.maxTotalConnections

Maximum number of allowed connections overall.
Default: 20

Max Connections Per Route

raytion.connector.agent. microsoft.teams.connection.maxConnectionsPerRoute

Number of concurrent connections per route.
Default: 10

Connection Time To Live (TTL)

raytion.connector.agent. microsoft.teams.connection.connectionTimeToLive

Duration after which unused connections will be discarded.
Default: 30s

Requests Per Second

raytion.connector.agent. microsoft.teams.connection.desiredRps

Maximum number of requests which are active in parallel.
Default: 15.0

Rate Limit Requests Per Second

raytion.connector.agent. microsoft.teams.connection.rateLimitRps

Maximum number of requests which are active in parallel while the API rate is near its limit.
Default: 0.33

User Agent HTTP Header

raytion.connector.agent. microsoft.teams.connection.userAgent

HTTP header which is sent with every request. It identifies the agent responsible for the request.
Default: ISV|Raytion|TeamsConnector/9.0

Cache Settings

Configuration options determining values for the connector’s caches.

Name Key Description

Name	Key	Description
Enable Cache Stat Logging	`raytion.connector.agent. microsoft.teams.cache.statLoggingEnabled`	When enabled, internal cache stats (cache hit / miss rate) are logged in a given interval.
Stat Logging Interval	`raytion.connector.agent. microsoft.teams.cache.statLoggingInterval`	The interval in which the cache stats should be logged.

Enable Cache Stat Logging

raytion.connector.agent. microsoft.teams.cache.statLoggingEnabled

When enabled, internal cache stats (cache hit / miss rate) are logged in a given interval.

Stat Logging Interval

raytion.connector.agent. microsoft.teams.cache.statLoggingInterval

The interval in which the cache stats should be logged.

CSM Configuration

Required Configuration Properties

CSM Connection Settings

Configuration options for the connection to the target CSM instance.

Name	Description
CSM endpoint	URL of the CSM instance to connect to.

Name

Description

CSM endpoint

URL of the CSM instance to connect to.

CSM Authentication Settings

Configuration Options for the authentication against the target CSM instance.

Name	Description
Username	Username of the technical user.
Password	Password of the technical user.

Name

Description

Username

Username of the technical user.

Password

Password of the technical user.

Optional Configuration Properties

CSM Connection Settings

Configuration options for fine-tuning the Http connection parameters.

Name	Description
Concurrent Connections	Maximum number of concurrent open connections.
Requests Rate	Maximum number of requests per second.
Connect Timeout in Milliseconds	Timeout of the connect request.
Socket Timeout in Milliseconds	Timeout of the socket connected to CSM.
Request Timeout in Milliseconds	Timeout of a request to CSM.

Name

Description

Concurrent Connections

Maximum number of concurrent open connections.

Requests Rate

Maximum number of requests per second.

Connect Timeout in Milliseconds

Timeout of the connect request.

Socket Timeout in Milliseconds

Timeout of the socket connected to CSM.

Request Timeout in Milliseconds

Timeout of a request to CSM.

CSM Ingestion Settings

Configuration options to specify how principals are ingested in the CSM.

Name	Description
Domain	Namespace under which to ingest principals.

Name

Description

Domain

Namespace under which to ingest principals.

Apache Solr Configuration

Instance Configuration

Configuration options related to specifying the target Solr Instance and Collection including authentication/authorization settings.

Setting Description

Setting	Description
Deployment	Deployment of the target Solr instance. Use `Collection Server` to feed against a standalone collection server. If your target instance is a Cloud Deployment, select the option `Zookeeper`.
Collection Server URL	For Standalone Collection Server, the URL to the collection server including the data path, e.g. `http://localhost:8983/solr`.
Zookeeper Instances	For Solr Cloud target, list of zookeeper instances including host and port.
Zookeeper Chroot	Znode Chroot of the cluster.
Collection ID	ID of the target collection.
Use Authentication	Enable this option to use Basic Authentication to authenticate against your Solr instance.
Username	Basic Authentication Username, if authentication is enabled.
Password	Basic Authentication Password, if authentication is enabled.
Use Proxy	If enabled, the connection to the Solr instance will be established through 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.

Deployment

Deployment of the target Solr instance. Use Collection Server to feed against a standalone collection server. If your target instance is a Cloud Deployment, select the option Zookeeper.

Collection Server URL

For Standalone Collection Server, the URL to the collection server including the data path, e.g. http://localhost:8983/solr.

Zookeeper Instances

For Solr Cloud target, list of zookeeper instances including host and port.

Zookeeper Chroot

Znode Chroot of the cluster.

Collection ID

ID of the target collection.

Use Authentication

Enable this option to use Basic Authentication to authenticate against your Solr instance.

Username

Basic Authentication Username, if authentication is enabled.

Password

Basic Authentication Password, if authentication is enabled.

Use Proxy

If enabled, the connection to the Solr instance will be established through 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.

ACL Settings

Configuration options influencing the document ACL creation.

Setting	Description
Domain Prefix	Prefix applied to access control entries of document ACLs. In case a domain considering CSM (Query type: 'sharepoint') is used with the connector, this prefix needs to match the CSM domain concatenated with the CSM domain separator (':'). Otherwise, leave the prefix blank.

Setting

Description

Domain Prefix

Prefix applied to access control entries of document ACLs. In case a domain considering CSM (Query type: 'sharepoint') is used with the connector, this prefix needs to match the CSM domain concatenated with the CSM domain separator (':'). Otherwise, leave the prefix blank.

Language Settings

Settings that define which metadata fields require a language specific processing. These fields will be suffixed with the language code, belonging to the document (example: 'content_en'). The language specific processing can be defined in the Apache Solr schema for fields with a dedicated language suffix.

Setting Description

Setting	Description
Standard Fields	Select any arbitrary fields to append the language suffix. The list consists of standardized fields provided by the connector. The fields are: `Content`, `Source`, `Title`, `Item Type`, `Keywords`, `Author`, and `Contributors`.
Include Additional Fields	Enable this option to include also additional fields not listed in the standard field list, e.g. fields generated by the pipeline.
Additional Fields	List of field names to apply the suffix to.
Fallback Language	Fallback language code in ISO 639 format to apply for items with missing language information.

Standard Fields

Select any arbitrary fields to append the language suffix. The list consists of standardized fields provided by the connector. The fields are: Content, Source, Title, Item Type, Keywords, Author, and Contributors.

Include Additional Fields

Enable this option to include also additional fields not listed in the standard field list, e.g. fields generated by the pipeline.

Additional Fields

List of field names to apply the suffix to.

Fallback Language

Fallback language code in ISO 639 format to apply for items with missing language information.

Adjustments to these configuration options, may require appropriate changes to the Apache Solr schema and a full content synchronization to index the altered metadata fields.

Advanced ACL Settings (Optional)

Advanced options for handling document ACL.

Setting	Description
Everyone ACE	Identifier of the access control entry which marks a document as public.
Nobody ACE	Identifier of the access control entry which indicate that a document is not accessible by anyone.

Setting

Description

Everyone ACE

Identifier of the access control entry which marks a document as public.

Nobody ACE

Identifier of the access control entry which indicate that a document is not accessible by anyone.

Metadata Field Settings (Optional)

Define the names of Apache Solr specific fields.

Setting	Description
Allow Document ACL Field	Metadata field name for the allow access control list.
Deny Document ACL Field	Metadata field name for the deny access control list.
Content Field	Metadata field name for the document’s content.

Setting

Description

Allow Document ACL Field

Metadata field name for the allow access control list.

Deny Document ACL Field

Metadata field name for the deny access control list.

Content Field

Metadata field name for the document’s content.

Advanced HTTP Settings (Optional)

Configuration options for fine-tuning the Http connection parameters.

Setting	Description
Socket Timeout	Timeout value for receiving data from server.
Connection Timeout	Timeout value for establishing a connection to server.
Connection Request Timeout	Timeout value for requesting a connection from connection manager.
Max. Number of Connections	Max. number of connections maintained by the connection manager.
Max. Number Requests per Second	Max. number of requests send to the server per second.
Max. Number of Retries	The maximum amount of times failed request shall be retried. Infinite retries are not supported. The delay between retries follows the pattern: [1s, 5s, 30s, 30s, …].

Setting

Description

Socket Timeout

Timeout value for receiving data from server.

Connection Timeout

Timeout value for establishing a connection to server.

Connection Request Timeout

Timeout value for requesting a connection from connection manager.

Max. Number of Connections

Max. number of connections maintained by the connection manager.

Max. Number Requests per Second

Max. number of requests send to the server per second.

Max. Number of Retries

The maximum amount of times failed request shall be retried. Infinite retries are not supported. The delay between retries follows the pattern: [1s, 5s, 30s, 30s, …].

General Configuration

Database Configuration

Name Property Key Description

Name	Property Key	Description
Configuration Type	`raytion.connector.db.config.type`	Supported are PostgreSQL, MS SQL Server, and JDBC URL configuration.

Configuration Type

raytion.connector.db.config.type

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

PostgreSQL

Name Property Key Description

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.

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

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.

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

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

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

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

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.

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

Name	Property Key	Description
Accepted Host Domains	`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:16630` `connector.company.com:16630` If no domains are configured (the default), then you can use any domain via which the connector host is reachable.

Accepted Host Domains

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:16630
connector.company.com:16630

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.

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

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

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

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

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

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

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