Connector Configuration
|
In some scenarios, it can be useful to provide a system property or an environment
variable within a configuration value. For example, you might want to distribute multiple
connector instances over different containers and have certain configured parameters
adapted according to specific system properties or environment variables, respectively. You
can do this by providing a placeholder of the form However, for security reasons this replacement is disabled by default. A malicious user could misuse this feature to obtain sensitive information about the connector environment such as the host’s operating system, the user under which the connector is running etc. You can mitigate this issue e.g. by restricting the access to the connector UI. If you want to enable the resolution of system properties and environment variables,
set the system property |
Jira Cloud Configuration
Required Configuration Properties
Jira Cloud Connection Settings
Configuration Options related to establish connection to the target Jira instance.
| Name | Description |
|---|---|
Jira Cloud URL |
URL for targeting Jira Cloud. |
Client ID |
ID of the Atlassian App. |
Client Secret |
Secret of the Atlassian App. |
Refresh Token |
Initial Refresh Token. |
Overwrite Existing Token |
Overwrite existing Refresh Token in the repository. |
Optional Configuration Properties
Jira Cloud Comment Filter Settings
Configuration Options on how to treat issue comments
| Name | Description |
|---|---|
Embed comments |
Unprotected comments are embedded in the content and metadata of their issue |
Discard protected comments |
If true, comments that have an additional access restriction will be discarded. Otherwise they will be fed as separate documents. |
Jira Cloud Project Filter Settings
Configuration Options for applying include/exclude -list filter on Jira Projects.
| Name | Description |
|---|---|
Project Include List |
List for including projects based on project keys. Only projects in this list are processed by the connector if the list is not empty. |
Project Exclude List |
List for excluding projects based on project keys. All projects configured in this list will not be processed by the connector. |
Jira Cloud Principal Settings
Configuration Options for the principal properties, required to synchronize.
| Name | Description |
|---|---|
Jira User Identifier |
Strategy to identify a user. This user property is used to identify a user contained in the ACL. |
Jira Cloud Type Filter Settings
Configuration Options for applying type filter on Jira.
| Name | Key |
|---|---|
Filter Projects |
Flag to enable or disable the processing of projects. If true, projects are not processed as items. |
Filter Issues |
Flag to enable or disable the processing of issues. If true issues are not processed by the connector. |
Filter Comments |
Flag to enable or disable the processing of comments. If true comments are not processed by the connector. |
Filter Attachments |
Flag to enable or disable the processing of attachments. If true attachments are not processed by the connector. |
Google Cloud Search Configuration
Account Settings
Configuration Options to specify the service account settings.
| Name | Property Key | Description |
|---|---|---|
Account E-Mail Address for Lookup |
|
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. |
Datasource Settings
Configuration Options related to the target Google Cloud Search Datasource. The connector will send any search items to the configured datasource.
| Name | Property Key | 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. |
Default Object Type |
|
If a document has no meta date objectType set, the value from here is used. The object type specifies which schema object definition, registered for the specified datasource, is used. |
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 | Property Key | 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 | Property Key | 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 | Property Key | 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 Google Cloud Search 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 | Property Key | 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. |
Request Workers |
|
Maximum number of workers requesting the callback for asynchronous requests. |
Rate Limit Settings
Configuration Options related to rate limiting to reduce network traffic.
| Name | Property Key | Description |
|---|---|---|
Max Queries Per Second (Content) |
|
Maximum number of queries per second to the Google Cloud Search Content Service. |
Max Queries Per Second (Security) |
|
Maximum number of queries per second to the Google Cloud Search Security Service. |
Retry Settings
Configuration Options related to the retry mechanism of requests against Google Cloud Search.
| Name | Property Key | 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
Configuration Options related to feeding (indexing) items and principals.
| Name | Property Key | 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. |
General Configuration
Database Configuration
| Name | Property Key | Description |
|---|---|---|
Configuration Type |
|
Supported are PostgreSQL, MS SQL Server, and JDBC URL configuration. |
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. |
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. |
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 |
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. |
Security Configuration
Request Restriction Settings
| Name | Property Key | Description |
|---|---|---|
Accepted Host Names |
|
A list of domains (+ port) that are allowed as host names in the headers of HTTP requests
to the connector. This means that you can access the connector only via a URL that
employs one of the configured domains. Each entry must have the format
If no domains are configured (the default), then you can use any domain via which the connector host is reachable. |
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 |