Connector Configuration
Google Drive Configuration
Google Drive Breadcrumb Cache Settings
Configuration Options related to the setup of the Breadcrumb Cache.
Name | Description |
---|---|
Max. Size |
Maximum amount of items in the Breadcrumb Cache. |
Max. time to live |
Maximum time of items in the Breadcrumb Cache. |
Google Drive Clients Cache Settings
Configuration Options related to the setup of the Drive Clients Cache.
Name | Description |
---|---|
Max. Size |
Maximum amount of items in the Drive Clients Cache. |
Google Drive Filter Settings
Configuration options determining which Google Drives to crawl.
Name | Description |
---|---|
Included Google Drives |
Only the Drives defined here will be crawled. If no include filters are defined, all drives which are not explicitly excluded are crawled. |
Excluded Google Drives |
Drives in this list will not be crawled. |
Google Drive Feed Document Settings
Configuration Options related to the feeding of documents.
Name | Description |
---|---|
Exclude Trashed |
Flag to indicate if items which are trashed should be excluded from the index. |
Exclude Recursive Trashed |
Flag to indicate if items which are trashed recursively should be excluded from the index. |
Include Comments |
Flag to indicate if comments should be included in the document’s metadata. |
Download Content |
Flag to indicate if content should be downloaded. |
Max. Content Size |
Maximum Size of downloadable content in bytes. |
Google Drive Feed Permission Settings
Configuration Options related to feeding of permissions.
Name | Description |
---|---|
Include public permissions |
Flag to indicate if public permissions should be included. |
Include public by link permissions |
Flag to indicate if public by link permissions should be included. |
Google Drive HTTP Settings
Configuration Options related to the HTTP connection to Google Drive.
Name | Description |
---|---|
Max. requests per second |
Maximum amount of requests per second to Google Drive. |
Socket Timeout |
Timeout of the socket connected to Google Drive. |
Retry Interval |
Retry interval for the rate limit against Google Drive. |
Parallel request limit |
Maximum number of parallel HTTP requests. |
Google Drive Instance Settings
Configuration required to establish a connection to Google Drive.
Name | Description |
---|---|
Google Workspace Domain |
Domain of the Google Workspace. |
Admin Directory User |
E-mail address of a user who is allowed to access the Google domain’s user directory. Used only to enumerate users and groups of the domain, not to sync his or her My Drive or Shared drives. |
Encrypted Service Account File |
Flag to indicate whether the Service Account File is encrypted. |
Service Account JSON File |
The JSON File containing the service account details |
Use Proxy |
Enable this option to connect to Google Drive through a proxy. |
Proxy URL |
URL for targeting Proxy. |
Use Proxy Authentication |
If the requests to the proxy needs to be authenticated, you can specify the credentials here. |
Proxy Username |
Username of the authenticating user against the proxy. |
Proxy Password |
Password of the authenticating user against the proxy. |
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. |
OAuth2.0 client secret |
|
OAuth2.0 client secret for the Microsoft Search Authentication. |
Tenant ID |
|
Tenant ID of OAuth2.0 Token URI for the Microsoft Search Authentication. |
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 |
---|---|---|
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 |
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) |
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.
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 |