Connector Configuration

Configuration for Drupal Connector

Please note that certain settings can affect the performance of content traversals. Refer to Performance section of the FAQ for details.

Basic Settings

Instance Setup

Use these settings to specify how the connector accesses your Drupal instance. The configured Technical Account must have privileges to read the desired node types and comments.

Drupal Instance Authentication Configuration
Drupal Instance Authentication Configuration

Name

Key

Description

Drupal Base URL

raytion.connector.agent.drupal.instance.baseUrl

Base URL of your Drupal instance (e.g., http://drupal.ddev.site/).

Use Authentication

raytion.connector.agent.drupal.instance.useAuthentication

Enable or disable Basic Authentication.

Username

raytion.connector.agent.drupal.instance.username

Technical Account username (with privileges).

Password

raytion.connector.agent.drupal.instance.password

Technical Account password (can be stored encrypted).

JSON:API Path Prefix

raytion.connector.agent.drupal.instance.pathPrefix

Path prefix for JSON:API endpoints (default: jsonapi).

Query Parameter for API

raytion.connector.agent.drupal.instance.queryParameter

Optional Drupal query parameter (e.g., jsonapi_include=0).

Use Proxy

raytion.connector.agent.drupal.instance.useProxy

Set to true to route connections via a proxy.

Proxy Base URL

raytion.connector.agent.drupal.instance.proxy.baseUrl

URL of the proxy server (e.g., http://proxy.intranet:8080).

Proxy Username

raytion.connector.agent.drupal.instance.proxy.username

Username for proxy authentication (if enabled).

Proxy Password

raytion.connector.agent.drupal.instance.proxy.password

Password for proxy authentication (can be stored encrypted).

Use Proxy Authentication

raytion.connector.agent.drupal.instance.proxy.useProxyAuthentication

Enable or disable authentication for the proxy (if useProxy is true).

Comments

Enable or disable the traversal of Drupal comments, including embedded comments within nodes.

Drupal Comment Settings

Name

Key

Description

Enable Comments

raytion.connector.agent.drupal.comment.enableComments

Set to true or false to include or exclude comments.

Enable Embedded

raytion.connector.agent.drupal.comment.enableEmbeddedComments

Set to true to traverse nested comments within content.

Included Comment Types

raytion.connector.agent.drupal.comment.includedTypes[x]

Array of specific comment types to include (e.g., [0]=included).

Excluded Comment Types

raytion.connector.agent.drupal.comment.excludedTypes[x]

Array of comment types to exclude (e.g., [0]=excluded).

Node Type

Only nodes are traversed, but the connector will not auto-discover node types. You must explicitly define which node types (e.g., page, article) are to be included.

Drupal Node Type Settings

Name

Key

Description

Content Types File

raytion.connector.agent.drupal.discovery.contentTypesFile

Upload a file listing the Drupal content types to traverse (one per line). Example: page, article.

Advanced Settings

Only Published Content

Limit the connector to traverse only published content if desired.

Name

Key

Description

Include Only Published Content

raytion.connector.agent.drupal.content.includeOnlyPublishedContent

Set to true to include only published items.

Language

Configure language options for nodes in a multi-language Drupal setup.

Drupal Language Settings

Name

Key

Description

Default Language

raytion.connector.agent.drupal.language.defaultLanguage

Primary content language (e.g., en).

Additional Languages

raytion.connector.agent.drupal.language.additionalLanguages[x]

Specify additional languages as an array, e.g., [0]=de.

Enable Other Languages

raytion.connector.agent.drupal.language.enableOtherLanguages

Set to true to process any other detected languages beyond the default/additional ones.

Language Filter Name

raytion.connector.agent.drupal.language.languageFilterName

Query parameter or field name for filtering by language (e.g., langcode).

Pagination

Configure pagination for nodes, comments, attachments, roles, types, and users to optimize performance.

Drupal Pagination Settings

Name

Key

Description

Node Page Size

raytion.connector.agent.drupal.page.size.node

Number of nodes fetched per page (default: 50).

Comment Page Size

raytion.connector.agent.drupal.page.size.comment

Number of comments fetched per page (default: 50).

Attachment Page Size

raytion.connector.agent.drupal.page.size.attachment

Number of attachments fetched per page (default: 50).

Role Page Size

raytion.connector.agent.drupal.page.size.role

Number of roles fetched per page (default: 50).

Type Page Size

raytion.connector.agent.drupal.page.size.type

Number of content types fetched per page (default: 50).

User Page Size

raytion.connector.agent.drupal.page.size.user

Number of users fetched per page (default: 50).

Connection

Configure the HTTP client for timeouts, retries, and connection limits.

Drupal Connection Settings

Name

Key

Description

Max Connections

raytion.connector.agent.drupal.connection.maxConnections

Maximum number of open HTTP connections.

Max Requests Per Second

raytion.connector.agent.drupal.connection.maxRequestsPerSecond

Limit on the number of requests sent per second (e.g., 50).

Request Timeout

raytion.connector.agent.drupal.connection.requestTimeout

Time (in ms) to wait for a request to complete (e.g., 60000ms).

Socket Timeout

raytion.connector.agent.drupal.connection.socketTimeout

Inactivity timeout for a socket (e.g., 60000ms).

ServiceNow AI Search Configuration

Instance Configuration

Configuration options related to specifying the ServiceNow AI Search instance.

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.

Connection Configuration (Optional)

Configuration options for fine-tuning the Http connection parameters.

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.

Payload Configuration (Optional)

Configuration options for fine-tuning AI Search payload constraints. Each batch must fulfill both the size constraint and the count constraint.

Setting Description

Max. Content Batch Payload Size

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

Max. Principal Batch Payload Size

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

Max. Content Batch Item Count

Max. number of items per batch for ingesting documents.

Max. Principal Batch Item Count

Max. number of users per batch for mapping users.

General Configuration

Database Configuration

Name Property Key Description

Configuration Type

raytion.connector.db.config.type

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

JDBC URL

Name Property Key Description

URL

raytion.connector.db.config.jdbc.url

JDBC URL for the target database. Out of the box, the connector will use H2 file database. For productive usage, use PostgreSQL specifying the URL in format: jdbc:postgresql:<host>:<port>/<database>

Username

raytion.connector.db.config.jdbc.username

Database Username to read and write to database.

Password

raytion.connector.db.config.jdbc.password

Database Password for the specified user

PostgreSQL

Name Property Key Description

Host

raytion.connector.db.config.postgres.host

Domain name or IP address of the database server.

Port

raytion.connector.db.config.postgres.port

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

Database Name

raytion.connector.db.config.postgres.name

Name of the database.

Username

raytion.connector.db.config.postgres.username

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

Password

raytion.connector.db.config.postgres.password

Password of the configured database user.

Add Custom Parameter

raytion.connector.db.config.postgres.addParameters

Enables the configuration of additional parameters.

H2

Name Property Key Description

Filename

raytion.connector.db.config.h2.filename

Name for file-based H2 database. Name must be at least three characters long and must not contain a semicolon. May include absolute or relative path to the database file.

Username

raytion.connector.db.config.h2.username

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

Password

raytion.connector.db.config.h2.password

Password of the configured database user.

Add Custom Parameter

raytion.connector.db.config.h2.addParameters

Enables the configuration of additional parameters.

MS SQL Server

Name Property Key Description

Host

raytion.connector.db.config.mssql.host

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

Port

raytion.connector.db.config.mssql.port

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

Database Name

raytion.connector.db.config.mssql.name

Name of the database.

Username

raytion.connector.db.config.mssql.username

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

Password

raytion.connector.db.config.mssql.password

Password of the configured database user.

Add Custom Parameter

raytion.connector.db.config.mssql.addParameters

Enables the configuration of additional parameters.

Oracle

Name Property Key Description

Host

raytion.connector.db.config.oracle.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.oracle.port

Specifies the port number Oracle is listening on, default is 1521.

Username

raytion.connector.db.config.oracle.username

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

Password

raytion.connector.db.config.oracle.password

Password of the configured database user.

Connection Type

raytion.connector.db.config.oracle.identificationType

Specifies whether to connect to the database via the instance’s unique SID or a service name.

Service

raytion.connector.db.config.oracle.service

A name of a given service / a TNS alias of the Oracle database instance.

Traversal Configuration

Name Property Key Description

Traversal History Length

raytion.connector.agent.traversal
.store.historyLength

Max. number of traversals to store in the history. Once the limit is exceeded, the connector will automatically remove oldest entries in the history. (default: 100)

Include Checksum

raytion.connector.agent.traversal
.pipeline.includePipelineChecksum

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

Change Processing Interval

raytion.connector.agent.traversal
.changeprocessing.interval

Interval between change processing traversals.

Resume on Start

raytion.connector.agent.traversal
.resume.resumeTraversalOnRestart

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

Number of Traversal Workers

raytion.connector.agent.traversal
.workers.worker

Number of workers to execute the traversal in parallel. Increasing this value might improve the performance, but will footprint higher memory consumption. It is recommended to keep the default value. (default: 10)

Traversal Job Poll Interval

raytion.connector.agent.traversal
.workers.jobPollInterval

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

Completion Timeout

raytion.connector.agent.traversal
.workers.completionTimeout

If the search engine indexes the items asynchronously, there might be some processing still in-flight during the completion process of a traversal. This value specifies the timeout value until all asynchronous callbacks are expected to return before completing the traversal. (default: 10m)

Executor Size

raytion.connector.agent.traversal
.execution.executorSize

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

Queue Size

raytion.connector.agent.traversal
.execution.queueSize

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

Traversal Jobs

Name Property Key Description

Job Timeout Check Frequency

raytion.connector.job-broker.heartbeatPeriod

Configures how often the connector checks for timed out jobs.

Job Timeout

raytion.connector.job-broker.heartbeatTimeout

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

Job Cache Size

raytion.connector.job-broker.jobPollCacheSize

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

Principal Aliaser Configuration

Principal Aliasing is applied on user information as part of Content ACL processing during Content Synchronization and Principal processing during Principal Synchronization. It’s purpose is to map external source system user to the corresponding user in search engines domain. You can configure a list of aliasers in the connector which will be applied in sequence and in order on user ACEs and user principals. The Connector supports following custom aliasing mechanism.

Custom Aliaser Disabled

If the Custom Aliaser checkbox is not selected, the connector will process user information on ACE and user principals unchanged to Search Engine. If all relevant users in the source system can be found with the same identifier in the search engine, this setup is sufficient to reflect the same secure search experience in the search engine as defined by the policy in the source system. The connector uses this option as default to process user information.

Custom Aliaser Enabled

If custom aliasing is enable then there are four types of aliaser avaialble:

Simple XML Table Aliaser

Static mapping table which can be uploaded as XML file. The connector uses the uploaded file as lookup table to map a user in the source system to a user in the search engine. Users missing a record in the file will be dropped from the ACE and during Principal Synchronization. This option is only recommended for environment with a manageable amount of users as for each user the corresponding mapping entry needs to be specified in the file.

Name Description

XML Mapping File

Browse and upload or drag and drop.

Sample XML mapping file:

<?xml version="1.0" encoding="UTF-8"?>
<storeddata>
    <entry keyValue="user1">user1@raytion.com</entry>
    <entry keyValue="user2">user2@raytion.com</entry>
    <entry keyValue="user3">user3@raytion.com</entry>
</storeddata>
Regex Replacer Aliaser

Regex Replacer Aliaser computes aliases based on a regular expression. Principals that match the regular expression are replaced by the Substitution String.

Name Property Key Description

Pattern

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

The regular expression to match, this is the part that will be replaced. If braces (…​) are used in the pattern then the matched value can be retrieved using $1

Substitute String

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

String to replace the matching part of the find string. Matched value is accessed by employing $1

Regex Extractor Aliaser

Regex Extractor Aliaser computes aliases based on a regular expression. Principals that match the regular expression are inserted into the Insert-Into String.

Name PropertyKey Description

Pattern

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

The regular expression to match, this is the part that will be inserted into the new value. If braces (…​) are used in the pattern then the matched value can be retrieved using $$

Insert-Into String

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

String to replace the matching part of the pattern. Matched value is accessed by employing $$

LDAP Aliaser

Ldap Aliaser searches for an LDAP entry with the requested name in the input value and returns the specified output attribute.

Name Property Key Description

Host

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

Fully Qualified Domain Name of an LDAP server

Port

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

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

AccountDN

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

AccountDN for bind to LDAP

Password

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

Password part of credentials

Input Field

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

The Active Directory attribute name for this equality filter

Search Root DN

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

Distinguished Name of the subtree which is searched. The smaller the subtree the better the performance but the higher the chance of encountering principals which are not part of this subtree

Output Field

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

Attribute that should be returned in result entries