Connector Configuration

Confluence Configuration

Confluence Instance Settings

Configuration Options related to establish connection to the target Confluence instance.

Name	Description
URI	URI of the confluence instance to connect to.
Username	Username to connect to Confluence. This user must be able to login to Confluence and registered with the Raytion Confluence Plugin.
Password	Password for the user to connect to Confluence. Encryption is recommended.

Name

Description

URI

URI of the confluence instance to connect to.

Username

Username to connect to Confluence. This user must be able to login to Confluence and registered with the Raytion Confluence Plugin.

Password

Password for the user to connect to Confluence. Encryption is recommended.

Confluence Connection Settings

Configuration Options related to fine tune connection with the Confluence instance.

Name	Description
Socket Timeout	An inactive connection will be treated as terminated after this duration.
Connection TTL	Unused connections of the pool will be discarded after this duration.
Requests per second	Maximum amount of requests which are started towards the Confluence instance.
Connection Pool Size	Maximum number of parallel requests to Confluence.
Batch Size	Number of items that are requested in one request.

Name

Description

Socket Timeout

An inactive connection will be treated as terminated after this duration.

Connection TTL

Unused connections of the pool will be discarded after this duration.

Requests per second

Maximum amount of requests which are started towards the Confluence instance.

Connection Pool Size

Maximum number of parallel requests to Confluence.

Batch Size

Number of items that are requested in one request.

Confluence Space Filter Settings

Configuration Options determining which Confluence Spaces should be search targets

Name	Description
Included Spaces (Keys)	If this list is empty, all spaces will be synchronized. Otherwise only those spaces whose key is part of this list.
Excluded Spaces (Keys)	Spaces whose key is in this list will not be synchronized. Even if the key is also in the include list.

Name

Description

Included Spaces (Keys)

If this list is empty, all spaces will be synchronized. Otherwise only those spaces whose key is part of this list.

Excluded Spaces (Keys)

Spaces whose key is in this list will not be synchronized. Even if the key is also in the include list.

Confluence Acl Cache Settings

Configuration Options determining how much and long to cache ACL data of Spaces and Pages.

Name

Description

Cache Time To Live

Maximum age of ACL cache entries. Larger improves performance and requires more memory.

Maximum Cache Weight

Maximum cache size. Spaces and Pages weigh more the more ACL entries they have. Larger improves performance and requires more memory.

Confluence Type Filter Settings

Configuration Options related to which types of search targets should be generated

Name	Description
User Profiles	User Profile pages will become search targets, if this value is enabled.
Labels	Labels will become search targets, if this value is enabled.
Page Contributors	In addition to the creator and the last modifier of a page or blogpost, all other modifiers are queried, too. This is an expensive operation.
Comment Handling	NONE: Comments will not be indexed. ATTACH_TO_PARENT: Comments will be part of page or blog post. MERGE_ALL_COMMENTS: Comments will be one separately indexed document.
Drafts of Pages and Blog Posts	Pages and Blog Posts in draft status will be indexed.
Deleted Pages and Blog Posts	Pages and Blog Posts in deleted status will be indexed.
Maximum Attachment Size	Attachments with a larger size will not have their content indexed.
Ignore content file extensions	Attachments with a file extension from this list will not have their content indexed but only their metadata. Entries will automatically be converted to lowercase with US locale.

Name

Description

User Profiles

User Profile pages will become search targets, if this value is enabled.

Labels

Labels will become search targets, if this value is enabled.

Page Contributors

In addition to the creator and the last modifier of a page or blogpost, all other modifiers are queried, too. This is an expensive operation.

Comment Handling

NONE: Comments will not be indexed. ATTACH_TO_PARENT: Comments will be part of page or blog post. MERGE_ALL_COMMENTS: Comments will be one separately indexed document.

Drafts of Pages and Blog Posts

Pages and Blog Posts in draft status will be indexed.

Deleted Pages and Blog Posts

Pages and Blog Posts in deleted status will be indexed.

Maximum Attachment Size

Attachments with a larger size will not have their content indexed.

Ignore content file extensions

Attachments with a file extension from this list will not have their content indexed but only their metadata. Entries will automatically be converted to lowercase with US locale.

Microsoft Search Configuration

Connector Product Settings

Configuration Options related to specifying the product which is going to connect to the Microsoft Search.

Name	Description
Connection ID	Connection ID of the connector product which is registered with Microsoft Search.
Product Name	Name of the connector product.
Product Description	Description of the connector product.

Name

Description

Connection ID

Connection ID of the connector product which is registered with Microsoft Search.

Product Name

Name of the connector product.

Product Description

Description of the connector product.

Microsoft Services Authentication Settings

Configuration Options related to authentication for the Microsoft Search.

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

Name

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

Name

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.

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

Setting

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

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