Connector Configuration
Microsoft Viva Engage Basic Configuration
Mandatory configurations to crawl content from Microsoft Viva Engage.
Connection Settings
| Setting | Key | Description |
|---|---|---|
Access Token |
|
The App bearer token for a Microsoft Viva Engage Network Admin account that was created at App Registration. |
Domain |
|
The Microsoft Viva Engage Network name or domain. You can find this as part of the URL after you open Viva Engage, e.g. |
Microsoft Viva Engage Advanced Configuration
Optional configurations to filter Microsoft Viva Engage content and to make performance adjustments.
Performance Settings
| Setting | Key | Description |
|---|---|---|
Requests per Second |
|
The maximum number of requests against the Viva Engage 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 Viva Engage are exceeded. In this case, the access to Viva Engage could be temporarily blocked. |
Socket Timeout |
|
Duration after which inactive connections will be terminated. |
Connection Timeout |
|
Maximal duration a client should wait for an initial response from a server. |
Retry Count |
|
Maximal number of times a request should be retried on failure. |
Retry Delay |
|
Fix delay between request retries. |
Max Total Connections |
|
Maximum number of available connections. |
Max Connections Per Route |
|
Number of concurrent connections per route. |
Connection Time To Live (TTL) |
|
Duration after which unused connections will be discarded. |
Filter Settings
| Setting | Key | Description |
|---|---|---|
Maximum Size |
|
Upper file size and unit for binary content. For files above this limit only metadata is indexed. Example: 300KB, 5MB, 1GB. |
Restrict content from public communities to their members |
|
Content which is located in public communities will just be visible to its members. |
Content Paging Settings
This software processes Microsoft Viva Engage content in day batches.
| Setting | Key | Description |
|---|---|---|
Start Date |
|
The date of the earliest content to be synchronized. The default is September 8th, 2008, the release date of Viva Engage. If you started using Viva Engage 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 |
|
Microsoft Viva Engage 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. |
Microsoft Search Configuration
Connector Product Settings
Configuration Options related to specifying the product which is going to connect to the Microsoft Search.
| Name | Property Key | Description |
|---|---|---|
Connection ID |
|
Connection ID of the connector product which is registered with Microsoft Search. |
Microsoft Services Authentication Settings
Configuration Options related to authentication for the Microsoft Search.
| Name | Property Key | Description |
|---|---|---|
OAuth2.0 client ID |
|
OAuth2.0 client ID for the Microsoft Search Authentication. |
Tenant ID |
|
Tenant ID of OAuth2.0 Token URI for the Microsoft Search Authentication. |
Authentication Method |
|
How to authenticate against Microsoft search. Available is authentication via client secret, java keystore, or certificate file. |
OAuth2.0 client secret |
|
OAuth2.0 client secret for the Microsoft Search Authentication. |
Certificate Keystore Alias |
|
The alias under which the certificate is stored in the keystore. |
Certificate Keystore Password |
|
The password to access the keystore. |
Client Certificate Password |
|
The password to access the certificate. |
Microsoft Search Connection Settings
Configuration Options related to establish a connection and sending requests to Microsoft Search.
| Name | Property Key | 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.
| Name | Property Key | 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
| Name | Property Key | Description |
|---|---|---|
Configuration Type |
|
Supported are PostgreSQL, MS SQL Server, H2 and JDBC URL configuration. |
JDBC URL
| Name | Property Key | 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: |
Username |
|
Database Username to read and write to database. |
Password |
|
Database Password for the specified user |
PostgreSQL
| Name | Property Key | Description |
|---|---|---|
Host |
|
Domain name or IP address of the database server. |
Port |
|
Specifies the port number PostgreSQL is listening on, default is 5432. |
Database Name |
|
Name of the database. |
Username |
|
Username to authenticate with. The regarding user has to have read and write permissions to the database. |
Password |
|
Password of the configured database user. |
Add Custom Parameter |
|
Enables the configuration of additional parameters. |
H2
| Name | Property Key | Description |
|---|---|---|
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 |
|
Username to authenticate with. The regarding user has to have read and write permissions to the database. |
Password |
|
Password of the configured database user. |
Add Custom Parameter |
|
Enables the configuration of additional parameters. |
MS SQL Server
| Name | Property Key | Description |
|---|---|---|
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 |
|
Specifies the port number MS SQL Server is listening on, default is 1433. |
Database Name |
|
Name of the database. |
Username |
|
Username to authenticate with. The regarding user has to have read and write permissions to the database. |
Password |
|
Password of the configured database user. |
Add Custom Parameter |
|
Enables the configuration of additional parameters. |
Oracle
| Name | Property Key | Description |
|---|---|---|
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 |
|
Specifies the port number Oracle is listening on, default is 1521. |
Username |
|
Username to authenticate with. The regarding user has to have read and write permissions to the database. |
Password |
|
Password of the configured database user. |
Connection Type |
|
Specifies whether to connect to the database via the instance’s unique SID or a service name. |
Service |
|
A name of a given service / a TNS alias of the Oracle database instance. |
Traversal Configuration
| Name | Property Key | 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) |
Include Checksum |
|
If enabled, any changes made to the pipeline e.g. configuration, the subsequent incremental run triggers a refeed of all items. |
Change Processing Interval |
|
Interval between change processing traversals. |
Resume on Start |
|
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 |
|
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) |
Executor Size |
|
The executor size restricts the max. number of concurrent running traversals. |
Queue Size |
|
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 |
|
Configures how often the connector checks for timed out jobs. |
Job Timeout |
|
The duration for which a job can stay idle before it is timed out. |
Job Cache Size |
|
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 |
|
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.
| Name | PropertyKey | 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.
| Name | Property Key | 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 |