Connector Configuration

Happeo Configuration

Happeo Instance Settings

Configuration Options for the setup of the connection to the target Happeo instance.

Name	Description
API Key	API Key for targeting Happeo instance.
Use Proxy	Flag to connect to Happeo via a proxy.
Use Proxy Authentication	Flag to connect to proxy with authentication.
Proxy URL	URL for targeting Proxy.
Proxy Username	Username of the authenticating user against proxy.
Proxy Password	Password of the authenticating user against proxy.

Name

Description

API Key

API Key for targeting Happeo instance.

Use Proxy

Flag to connect to Happeo via a proxy.

Use Proxy Authentication

Flag to connect to proxy with authentication.

Proxy URL

URL for targeting Proxy.

Proxy Username

Username of the authenticating user against proxy.

Proxy Password

Password of the authenticating user against proxy.

Happeo Domain Settings

Configuration Options related to the domains of the target Happeo instance.

Name	Description
API Domain	The Happeo API Domain, it is used for crawling the data.
Source Domain	The Happeo Source Domain, it is used for constructing the Item Click URLs.

Name

Description

API Domain

The Happeo API Domain, it is used for crawling the data.

Source Domain

The Happeo Source Domain, it is used for constructing the Item Click URLs.

Happeo Connection Settings

Configuration options for fine-tuning the Http connection parameters.

Name	Description
Max. Connections	Maximum number of open connections.
Max. Requests per Second	Maximum number of requests per second.
Request Timeout in Milliseconds	Timeout of requests to Happeo.
Socket Timeout in Milliseconds	Timeout of the socket connected to Happeo.

Name

Description

Max. Connections

Maximum number of open connections.

Max. Requests per Second

Maximum number of requests per second.

Request Timeout in Milliseconds

Timeout of requests to Happeo.

Socket Timeout in Milliseconds

Timeout of the socket connected to Happeo.

Google Cloud Search Configuration

Account Settings

Configuration Options to specify the service account settings.

Name	Description
API Customer ID	ID of the Customer to access the Google Admin API.
Account E-Mail Address	The E-Mail Address of the user to impersonate. It is used in the principal sync to check if users exist before feeding them to Google Cloud Search. This is not the service account.
Service Account JSON File	The JSON File containing the service account details

Name

Description

API Customer ID

ID of the Customer to access the Google Admin API.

Account E-Mail Address

The E-Mail Address of the user to impersonate. It is used in the principal sync to check if users exist before feeding them to Google Cloud Search. This is not the service account.

Service Account JSON File

The JSON File containing the service account details

Datasource Settings

Configuration Options related to the target Google Cloud Search Datasource. The connector will send any search items to the configured datasource.

Name	Description
Datasource ID	The ID of the Google Cloud Search Datasource to index the items to. The IDs can be inspected at admin.google.com.
Datasource Schema Object Type	The Object Type defined in the schema definition registered for the specified datasource.

Name

Description

Datasource ID

The ID of the Google Cloud Search Datasource to index the items to. The IDs can be inspected at admin.google.com.

Datasource Schema Object Type

The Object Type defined in the schema definition registered for the specified datasource.

Identity Source Settings

Configuration Options related to the target Google Cloud Search Identity Source. The connector will feed the principals to the configured Identity Source.

Name	Description
Identity Source ID	The ID of the Google Cloud Search Identity Source to synchronize the external source system principals. The IDs can be inspected at admin.google.com.

Name

Description

Identity Source ID

The ID of the Google Cloud Search Identity Source to synchronize the external source system principals. The IDs can be inspected at admin.google.com.

Encoding Settings

Configuration Options to specify encoding settings for indexing items.

Name	Description
Group Encoding Scheme	When groups were indexed into the Identity Source using GCDS, their IDs are encoded with Base16 or Base64. When the connector is handling groups it also has to encode group IDs in the correct scheme for the connector to work correctly.

Name

Description

Group Encoding Scheme

When groups were indexed into the Identity Source using GCDS, their IDs are encoded with Base16 or Base64. When the connector is handling groups it also has to encode group IDs in the correct scheme for the connector to work correctly.

HTTP Settings

Configuration Options related to the HTTP connections to Google Cloud Search.

Name	Description
Max Connections (Content)	Maximum number of connections to the Google Cloud Search Content Service.
Max Connections (Security)	Maximum number of connections to the Google Cloud Search Security Service.
Connect Timeout	Timeout to establish a connection.
Read Timeout	Timeout to read data from an established connection.
Use Proxy	Flag to connect to Happeo via a proxy.
Use Proxy Authentication	Flag to connect to proxy with authentication.
Proxy URL	URL for targeting Proxy.
Proxy Username	Username of the authenticating user against proxy.
Proxy Password	Password of the authenticating user against proxy.

Name

Description

Max Connections (Content)

Maximum number of connections to the Google Cloud Search Content Service.

Max Connections (Security)

Maximum number of connections to the Google Cloud Search Security Service.

Connect Timeout

Timeout to establish a connection.

Read Timeout

Timeout to read data from an established connection.

Use Proxy

Flag to connect to Happeo via a proxy.

Use Proxy Authentication

Flag to connect to proxy with authentication.

Proxy URL

URL for targeting Proxy.

Proxy Username

Username of the authenticating user against proxy.

Proxy Password

Password of the authenticating user against proxy.

Request Settings

Configuration Options related to sending synchronous/asynchronous requests to Google Cloud Search.

Name	Description
Request Mode	Mode of item requests against Google Cloud Search (Synchronous or Asynchronous)
Request Timeout	Timeout of synchronous requests against Google Cloud Search.
Request Period	Time Period in which asynchronous requests against Google Cloud Search should be checked for a response.

Name

Description

Request Mode

Mode of item requests against Google Cloud Search (Synchronous or Asynchronous)

Request Timeout

Timeout of synchronous requests against Google Cloud Search.

Request Period

Time Period in which asynchronous requests against Google Cloud Search should be checked for a response.

Retry Settings

Configuration Options related to the retry mechanism of requests against Google Cloud Search.

Name	Description
Max Retries	Maximum number of retries for a request.
Initial Waiting Time	Initial Waiting Time for the response of a request.
Delay Factor	Factor multiplied to the delay after each failed retry.

Name

Description

Max Retries

Maximum number of retries for a request.

Initial Waiting Time

Initial Waiting Time for the response of a request.

Delay Factor

Factor multiplied to the delay after each failed retry.

Feeding Settings

Name	Description
Feed only existing GCS Users	Flag to indicate if only users who exist in Google Cloud Search should be fed. If a user does not exist and this flag is active then the membership of the user to a group is just not fed. The ACE of an item containing the user is dropped if the user does not exist and this flag is active.

Name

Description

Feed only existing GCS Users

Flag to indicate if only users who exist in Google Cloud Search should be fed. If a user does not exist and this flag is active then the membership of the user to a group is just not fed. The ACE of an item containing the user is dropped if the user does not exist and this flag is active.

Cache Settings

Name	Description
Maximum Cache Size	Max. Number of entries in the Cache which stores mappings of principal IDs to GCS resource names.

Name

Description

Maximum Cache Size

Max. Number of entries in the Cache which stores mappings of principal IDs to GCS resource names.

General Configuration

Database Configuration

Name Property Key Description

Name	Property Key	Description
URL	`spring.datasource.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	`spring.datasource.username`	Database Username to read and write to database.
Password	`spring.datasource.password`	Database Password for the specified user

URL

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

spring.datasource.username

Database Username to read and write to database.

Password

spring.datasource.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)
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)

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)

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)

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