Connector Configuration

File System Configuration

Configuration Options related to defining the paths to traverse.

File System Sources

The details of which paths to traverse and which files and folders to process.

Name Property Key Description

Name	Property Key	Description
Start Folders	`raytion.connector.agent.filesystem.config .sources[*].startFolders`	A list of folders to traverse.
Traverse Symbolic Links	`raytion.connector.agent.filesystem.config .sources[*].traverseSymbolicLinks`	Enable traversal of symbolic links.
Enable Filters	`raytion.connector.agent.filesystem.config .sources[*].enableFilters`	Enable filter options for the folders.

Start Folders

raytion.connector.agent.filesystem.config .sources[*].startFolders

A list of folders to traverse.

Traverse Symbolic Links

raytion.connector.agent.filesystem.config .sources[*].traverseSymbolicLinks

Enable traversal of symbolic links.

Enable Filters

raytion.connector.agent.filesystem.config .sources[*].enableFilters

Enable filter options for the folders.

Filter Configurations

Configure one or more filters for the defined start folders.

Folder Filter Settings

Name Property Key Description

Name	Property Key	Description
Regular Expression	`raytion.connector.agent.filesystem.config .sources[].filters[] .folderTraversalFilter.regExpressions`	The regular expression the path will be matched against.

Regular Expression

raytion.connector.agent.filesystem.config .sources[*].filters[*] .folderTraversalFilter.regExpressions

The regular expression the path will be matched against.

File Filter Settings

Name Property Key Description

Name	Property Key	Description
Action	`raytion.connector.agent.filesystem.config .sources[].filters[] .pathIndexFilter.action`	When the Filter Rule matches, this action is performed.
Regular Expression	`raytion.connector.agent.filesystem.config .sources[].filters[] .pathIndexFilter.regExpressions`	The regular expression the path will be matched against

Action

raytion.connector.agent.filesystem.config .sources[*].filters[*] .pathIndexFilter.action

When the Filter Rule matches, this action is performed.

Regular Expression

raytion.connector.agent.filesystem.config .sources[*].filters[*] .pathIndexFilter.regExpressions

The regular expression the path will be matched against

File Size Filter Settings

Name Property Key Description

Name	Property Key	Description
Action	`raytion.connector.agent.filesystem.config .sources[].filters[] .fileSizeIndexFilter.action`	When the Filter Rule matches, this action is performed.
Rule	`raytion.connector.agent.filesystem.config .sources[].filters[] .fileSizeIndexFilter.rule`	The applied rule.
File Size	`raytion.connector.agent.filesystem.config .sources[].filters[] .fileSizeIndexFilter.fileSize`	The applied File Size.

Action

raytion.connector.agent.filesystem.config .sources[*].filters[*] .fileSizeIndexFilter.action

When the Filter Rule matches, this action is performed.

Rule

raytion.connector.agent.filesystem.config .sources[*].filters[*] .fileSizeIndexFilter.rule

The applied rule.

File Size

raytion.connector.agent.filesystem.config .sources[*].filters[*] .fileSizeIndexFilter.fileSize

The applied File Size.

Path Depth Filter Settings

Name Property Key Description

Name	Property Key	Description
Maximum Path Depth	`raytion.connector.agent.filesystem.config .sources[].filters[] .pathDepthTraversalFilter.abovePathDepth`	Maximum path depth allowed.

Maximum Path Depth

raytion.connector.agent.filesystem.config .sources[*].filters[*] .pathDepthTraversalFilter.abovePathDepth

Maximum path depth allowed.

Date Index Filter Settings

Name Property Key Description

Name	Property Key	Description
Date Field	`raytion.connector.agent.filesystem.config .sources[].filters[] .dateIndexFilter.dateField`	Date field of the Item/Folder.
Mode	`raytion.connector.agent.filesystem.config .sources[].filters[] .dateIndexFilter.mode`	Choose if the filter will be applied on a period or on a specific date.
Unit	`raytion.connector.agent.filesystem.config .sources[].filters[] .dateIndexFilter.unit`	To calculate the relative date take the current date and go back N time.
Quantity	`raytion.connector.agent.filesystem.config .sources[].filters[] .dateIndexFilter.quantity`	The amount of units which shall be used to calculate the cut-off date.
Format	`raytion.connector.agent.filesystem.config .sources[].filters[] .dateIndexFilter.format`	A date format string.E.g.’yyyy-MM-dd’for year-month-day.
Date	`raytion.connector.agent.filesystem.config .sources[].filters[] .dateIndexFilter.date`	A fixed date of the specified format.

Date Field

raytion.connector.agent.filesystem.config .sources[*].filters[*] .dateIndexFilter.dateField

Date field of the Item/Folder.

Mode

raytion.connector.agent.filesystem.config .sources[*].filters[*] .dateIndexFilter.mode

Choose if the filter will be applied on a period or on a specific date.

Unit

raytion.connector.agent.filesystem.config .sources[*].filters[*] .dateIndexFilter.unit

To calculate the relative date take the current date and go back N time.

Quantity

raytion.connector.agent.filesystem.config .sources[*].filters[*] .dateIndexFilter.quantity

The amount of units which shall be used to calculate the cut-off date.

Format

raytion.connector.agent.filesystem.config .sources[*].filters[*] .dateIndexFilter.format

A date format string.E.g.’yyyy-MM-dd’for year-month-day.

Date

raytion.connector.agent.filesystem.config .sources[*].filters[*] .dateIndexFilter.date

A fixed date of the specified format.

File System Global Filter Settings

Filter Options related to all configured Start Folders.

Name Property Key Description

Name	Property Key	Description
Index Folders	`raytion.connector.agent.filesystem.global .filter.enableFolderIndexing`	If Setting is enabled then the information of folders will be indexed too.
Max Content Size	`raytion.connector.agent.filesystem.global .filter.maxContentSize`	The Maximum Content Size of all files. Files that exceed this size will only have their metadata indexed. A Greater-Than-Filter defined in a Source will override this global content filter.

Index Folders

raytion.connector.agent.filesystem.global .filter.enableFolderIndexing

If Setting is enabled then the information of folders will be indexed too.

Max Content Size

raytion.connector.agent.filesystem.global .filter.maxContentSize

The Maximum Content Size of all files. Files that exceed this size will only have their metadata indexed. A Greater-Than-Filter defined in a Source will override this global content filter.

Microsoft SharePoint Configuration

Submission Repository Settings

Connector needs caching Submissions before sending them for indexing to SharePoint.

Setting	Description
Repository Filename	Full Path of the Repository filename. Filename must end with (.db).
Username	Username to authenticate with. The regarding user has to have read and write permissions to the database.
Password	Password of the configured database user.

Setting

Description

Repository Filename

Full Path of the Repository filename. Filename must end with (.db).

Username

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

Password

Password of the configured database user.

Submission Repository Limit Settings (Optional)

Settings for limiting the Submission number the Repository can have, so that the used disc space is limited.

Setting	Description
Max. Unprocessed Submissions	Maximum unprocessed Submissions inside the repository. If Submissions exceed this number then insertions are blocked until other Submissions are removed from repository.
Max. Insertion Waiting Time	Maximum insertion waiting time in case the Repository reaches the maximum size limit. After this duration the Submission will be rejected and marked as failed from the Connector.
Repository Size Retrieval Interval	Duration interval in which the connector retrieves the current number of unprocessed Submissions in the Repository.

Setting

Description

Max. Unprocessed Submissions

Maximum unprocessed Submissions inside the repository. If Submissions exceed this number then insertions are blocked until other Submissions are removed from repository.

Max. Insertion Waiting Time

Maximum insertion waiting time in case the Repository reaches the maximum size limit. After this duration the Submission will be rejected and marked as failed from the Connector.

Repository Size Retrieval Interval

Duration interval in which the connector retrieves the current number of unprocessed Submissions in the Repository.

Submission Crawl Settings (Optional)

Settings for fetching Submissions to SharePoint.

Setting	Description
Callback Timeout	The connector is polling the state of the submitted requests to track the state of the Submissions. This property defines the timeout until the connector is expecting the requests to be processed in the SharePoint.
Crawl Trigger Size	The size of cached Submissions to trigger a BCS Crawl.
Crawl Interval	Duration interval for checking if a crawl has to be triggered.
Status Polling Interval	The connector is polling the state of the submitted requests to track the state of the Submissions. This property defines the interval in which the connector is polling the Submission status.
Inserting Idle Duration	Time duration that no other Submission is inserted to cache. After this time, a Crawl will be triggered even if the Trigger Size was not exceeded.

Setting

Description

Callback Timeout

The connector is polling the state of the submitted requests to track the state of the Submissions. This property defines the timeout until the connector is expecting the requests to be processed in the SharePoint.

Crawl Trigger Size

The size of cached Submissions to trigger a BCS Crawl.

Crawl Interval

Duration interval for checking if a crawl has to be triggered.

Status Polling Interval

The connector is polling the state of the submitted requests to track the state of the Submissions. This property defines the interval in which the connector is polling the Submission status.

Inserting Idle Duration

Time duration that no other Submission is inserted to cache. After this time, a Crawl will be triggered even if the Trigger Size was not exceeded.

CrawlTrigger Service Settings

CrawlTrigger Service settings for fetching Submissions to SharePoint.

Setting	Description
Endpoint	Endpoint of the CrawlTrigger Service.
Content Source Name	Name of the content source configured in SharePoint.
Domain	User Domain for the Authentication process.
Username	Username to authenticate to CrawlTrigger Service.
Password	Password to authenticate to CrawlTrigger Service.
Connection Timeout	Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. 0 is infinite.
Receive Timeout	Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. 0 is infinite.

Setting

Description

Endpoint

Endpoint of the CrawlTrigger Service.

Content Source Name

Name of the content source configured in SharePoint.

Domain

User Domain for the Authentication process.

Username

Username to authenticate to CrawlTrigger Service.

Password

Password to authenticate to CrawlTrigger Service.

Connection Timeout

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. 0 is infinite.

Receive Timeout

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. 0 is infinite.

General Configuration

Database Configuration

Setting Description

Setting	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: `jdbc:postgresql:<host>:<port>/<database>`
Username	Database Username to read and write to database.
Password	Database Password for the specified user

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

Database Username to read and write to database.

Password

Database Password for the specified user

Traversal Configuration

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

Setting

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.

Setting	Description
XML Mapping File	Browse and upload or drag and drop.

Setting

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.

Setting	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

Setting

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.

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

Setting

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.

Setting	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

Setting

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