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.

ServiceNow AI Search Configuration

Instance Configuration

Configuration options related to specifying the ServiceNow AI Search instance.

Setting Description

Setting	Description
ServiceNow Instance Hostname	Host Name of your ServiceNow Platform e.g. `venX.service-now.com`.
AI Search External Content User	Username of the technical user with at least the role `ais_external_content`.
AI Search External Content User Password	Password for the specified technical user.
User Proxy	If enabled, the connection to ServiceNow will be established through an HTTP/HTTPS proxy.
Proxy Endpoint	Target proxy URL including protocol, host and port.

ServiceNow Instance Hostname

Host Name of your ServiceNow Platform e.g. venX.service-now.com.

AI Search External Content User

Username of the technical user with at least the role ais_external_content.

AI Search External Content User Password

Password for the specified technical user.

User Proxy

If enabled, the connection to ServiceNow will be established through an HTTP/HTTPS proxy.

Proxy Endpoint

Target proxy URL including protocol, host and port.

Connection Configuration (Optional)

Configuration options for fine-tuning the Http connection parameters.

Setting Description

Setting	Description
Requests per second	The Number of requests sent per second. The default is set to `1` as defined in default rate limit rule. Make sure to increase the value, only if you modified the default rate limiting for AI Search External Content API.
Connection Timeout	Timeout value for establishing a connection to host. Modify the value only if you modified system property `glide.http.timeout` in your ServiceNow instance.
Max. Number of Connections	Max. number of allowed connections maintained by the connection manager. Modify the value only if you modified system property `glide.ais.ext.parallel_count` in your ServiceNow instance.

Requests per second

The Number of requests sent per second. The default is set to 1 as defined in default rate limit rule. Make sure to increase the value, only if you modified the default rate limiting for AI Search External Content API.

Connection Timeout

Timeout value for establishing a connection to host. Modify the value only if you modified system property glide.http.timeout in your ServiceNow instance.

Max. Number of Connections

Max. number of allowed connections maintained by the connection manager. Modify the value only if you modified system property glide.ais.ext.parallel_count in your ServiceNow instance.

Payload Configuration (Optional)

Configuration options for fine-tuning AI Search payload constraints.

Setting Description

Setting	Description
Max. Content Batch Payload Size	Max. batch payload size for ingestDocuments-operation. Modify the value only if you modified system property `glide.ais.ext.max_memory_size` in your ServiceNow instance.

Max. Content Batch Payload Size

Max. batch payload size for ingestDocuments-operation. Modify the value only if you modified system property glide.ais.ext.max_memory_size in your ServiceNow instance.

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