Connector Configuration

Microsoft Yammer Basic Configuration

Mandatory configurations to crawl content from Microsoft Yammer.

Yammer Connection Settings

Setting Description

Setting	Description
Access Token	The App bearer token for a Yammer Network Admin account that was created at App Registration.
Domain	The Yammer Network name or domain. You can find this as part of the URL after you open Yammer, e.g. `https://www.yammer.com/domain.com/#/home`.

Access Token

The App bearer token for a Yammer Network Admin account that was created at App Registration.

Domain

The Yammer Network name or domain. You can find this as part of the URL after you open Yammer, e.g. https://www.yammer.com/domain.com/#/home.

Microsoft Yammer Advanced Configuration

Optional configurations to filter Microsoft Yammer content and to make performance adjustments.

Yammer Performance Settings

Setting	Description
Requests per Second	The maximum number of requests against the Yammer API that start within one second. It defaults to 10. If you increase this value, it can improve synchronization performance unless the API limits of Yammer are exceeded. In this case, the access to Yammer could be temporarily blocked.

Setting

Description

Requests per Second

The maximum number of requests against the Yammer API that start within one second. It defaults to 10. If you increase this value, it can improve synchronization performance unless the API limits of Yammer are exceeded. In this case, the access to Yammer could be temporarily blocked.

Yammer Filter Settings

Setting	Description
Maximum Size	Upper file size and unit for binary content. For files above this limit only metadata is indexed. Example: 300KB, 5MB, 1GB.

Setting

Description

Maximum Size

Upper file size and unit for binary content. For files above this limit only metadata is indexed. Example: 300KB, 5MB, 1GB.

Yammer Content Paging Settings

This software processes Yammer content in day batches.

Setting	Description
Start Date	The date of the earliest content to be synchronized. The default is September 8^th, 2008, the release date of Yammer. If you started using Yammer much later than that, you can adjust the date in oder to prevent a short idle time and wasted API calls at the beginning of the synchronization.
Number of Days per Query	Yammer content is fetched in batches covering entire days. Increasing the number of days to fetch per request slightly reduces the number of API calls at the expense of the memory load of the connector. Default: 30 days.

Setting

Description

Start Date

The date of the earliest content to be synchronized. The default is September 8^th, 2008, the release date of Yammer. If you started using Yammer much later than that, you can adjust the date in oder to prevent a short idle time and wasted API calls at the beginning of the synchronization.

Number of Days per Query

Yammer content is fetched in batches covering entire days. Increasing the number of days to fetch per request slightly reduces the number of API calls at the expense of the memory load of the connector. Default: 30 days.

Apache Solr Configuration

Instance Configuration

Configuration options related to specifying the target Solr Instance and Collection including authentication/authorization settings.

Setting Description

Setting	Description
Deployment	Deployment of the target Solr instance. Use `Collection Server` to feed against a standalone collection server. If your target instance is a Cloud Deployment, select the option `Zookeeper`.
Collection Server URL	For Standalone Collection Server, the URL to the collection server including the data path, e.g. `http://localhost:8983/solr`.
Zookeeper Instances	For Solr Cloud target, list of zookeeper instances including host and port.
Zookeeper Chroot	Znode Chroot of the cluster.
Collection ID	ID of the target collection.
Use Authentication	Enable this option to use Basic Authentication to authenticate against your Solr instance.
Username	Basic Authentication Username, if authentication is enabled.
Password	Basic Authentication Password, if authentication is enabled.
Use Proxy	If enabled, the connection to the Solr instance will be established through 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.

Deployment

Deployment of the target Solr instance. Use Collection Server to feed against a standalone collection server. If your target instance is a Cloud Deployment, select the option Zookeeper.

Collection Server URL

For Standalone Collection Server, the URL to the collection server including the data path, e.g. http://localhost:8983/solr.

Zookeeper Instances

For Solr Cloud target, list of zookeeper instances including host and port.

Zookeeper Chroot

Znode Chroot of the cluster.

Collection ID

ID of the target collection.

Use Authentication

Enable this option to use Basic Authentication to authenticate against your Solr instance.

Username

Basic Authentication Username, if authentication is enabled.

Password

Basic Authentication Password, if authentication is enabled.

Use Proxy

If enabled, the connection to the Solr instance will be established through 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.

Advanced HTTP Configuration (Optional)

Configuration options for fine-tuning the Http connection parameters.

Setting	Description
Socket Timeout	Timeout value for receiving data from server.
Connection Timeout	Timeout value for establishing a connection to server.
Connection Request Timeout	Timeout value for requesting a connection from connection manager.
Max. Number of Connections	Max. number of connections maintained by the connection manager.
Max. Number Requests per Second	Max. number of requests send to the server per second.

Setting

Description

Socket Timeout

Timeout value for receiving data from server.

Connection Timeout

Timeout value for establishing a connection to server.

Connection Request Timeout

Timeout value for requesting a connection from connection manager.

Max. Number of Connections

Max. number of connections maintained by the connection manager.

Max. Number Requests per Second

Max. number of requests send to the server per second.

Cultural/Language Suffix Configuration (Optional)

Specify the fields which should be appended with the cultural suffix retrieved from the language information attached to an item.

Setting	Description
Standard Fields	Select any arbitrary fields to append the cultural suffix from a list of standardized fields provided by the connector.
Include Additional Fields	Enable this option to include also additional fields not listed in the standard field list, e.g. fields generated by the pipeline.
Additional Fields	List of field names to apply the suffix to.
Fallback Language	Fallback language code in ISO 639 format to apply for items with missing language information.

Setting

Description

Standard Fields

Select any arbitrary fields to append the cultural suffix from a list of standardized fields provided by the connector.

Include Additional Fields

Enable this option to include also additional fields not listed in the standard field list, e.g. fields generated by the pipeline.

Additional Fields

List of field names to apply the suffix to.

Fallback Language

Fallback language code in ISO 639 format to apply for items with missing language information.

Metadata Mapping Configuration (Optional)

Defines Solr Field Names for standardized metadata provided by the connector.

Setting	Description
Mapping Entries	Mapping entries which will be applied to determine the field name in the Solr schema. Metadata with missing entry in this list will be processed with its default field name.

Setting

Description

Mapping Entries

Mapping entries which will be applied to determine the field name in the Solr schema. Metadata with missing entry in this list will be processed with its default field name.

Client-Side Commit Configuration (Optional)

Defines the client-side commit behavior.

Setting	Description
Enable client-side hard-commit	If enabled the connector triggers a hard-commit periodically.
Commit Period	Frequency of hard-commit triggered by the connector.

Setting

Description

Enable client-side hard-commit

If enabled the connector triggers a hard-commit periodically.

Commit Period

Frequency of hard-commit triggered by the connector.

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:

Static Mapping Aliaser

Static Mapping entries which will be applied to all user processed by the connector as part of the document ACL and principal information. If this type of aliaser is configured any user token without a mapping entry will be dropped from being synchronized to the search engine.

Setting Description

Setting	Description
Mappings	Mapping Entry with `Source User ID` with the user token from source system and `Target User ID` with the user token which should be processed to the search engine in place of the source user ID.

Mappings

Mapping Entry with Source User ID with the user token from source system and Target User ID with the user token which should be processed to the search engine in place of the source user ID.

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