Connector Configuration

Frontify Configuration

Configuration options related to defining the domain to traverse.

Frontify Instance Settings

The details of the Frontify domain to traverse.

Name	Description
Frontify Instance URL	URL of your company domain.
Token	Token for addressing your domain.
Username	Account to access the Guidelines.
Password	Password for the account to access the Guidelines.
Browser	Browser engine used by Selenium to render Guideline pages.
Driver Path	Absolute path to the Selenium driver for the selected browser. If left empty, Selenium tries to self-initialize.
Text extraction from guideline web pages	If TEXT is selected, all non-visible elements will be removed.

Name

Description

Frontify Instance URL

URL of your company domain.

Token

Token for addressing your domain.

Username

Account to access the Guidelines.

Password

Password for the account to access the Guidelines.

Browser

Browser engine used by Selenium to render Guideline pages.

Driver Path

Absolute path to the Selenium driver for the selected browser. If left empty, Selenium tries to self-initialize.

Text extraction from guideline web pages

If TEXT is selected, all non-visible elements will be removed.

Frontify Guideline Content Language Settings

Options related to crawling Guidelines in multiple languages by their language code additionally to the default language.

Name	Description
Guideline Language Filter	List of all languages code (ISO 639-1) that shall be processed by connector additionally to the default language, e.g. "fr" for French. Frontify must support the translation.

Name

Description

Guideline Language Filter

List of all languages code (ISO 639-1) that shall be processed by connector additionally to the default language, e.g. "fr" for French. Frontify must support the translation.

Frontify Guideline Connection Settings

Options related to the connection crawling guidelines via Selenium.

Name	Description
Rendering time	Time given to the browser to complete loading and rendering a page.
Rendering timeout	If Selenium takes longer to render the page, it will be marked as failed.
Number of rendering instances	Number of parallel Selenium/browser instances to render pages.
Folder for screenshots	The connector will put a screenshot of the crawled guideline page into this folder to allow verification of rendering times. If empty, no screenshots will be taken.

Name

Description

Rendering time

Time given to the browser to complete loading and rendering a page.

Rendering timeout

If Selenium takes longer to render the page, it will be marked as failed.

Number of rendering instances

Number of parallel Selenium/browser instances to render pages.

Folder for screenshots

The connector will put a screenshot of the crawled guideline page into this folder to allow verification of rendering times. If empty, no screenshots will be taken.

Frontify Asset Settings

Options related to crawling Assets from Libraries and Workspace Projects.

Name	Description
Enable Asset traversal	Flag for indexing Assets from Libraries and Workspace Projects.
Include Asset Type	List of Asset types which should be included in crawling. If no include filters are defined, all Asset types are included.
Exclude Asset Type	List of Asset types which should be excluded from crawling.
Fetch Assets from Library	Flag for indexing Assets from Libraries. When enabled, the connector will process Assets, Comments, and Attachments sourced from a Library
Fetch Assets from Workspace Project	Flag for indexing Assets from Workspace Projects. When enabled, the connector will process Assets and Comments sourced from a Workspace Project.

Name

Description

Enable Asset traversal

Flag for indexing Assets from Libraries and Workspace Projects.

Include Asset Type

List of Asset types which should be included in crawling. If no include filters are defined, all Asset types are included.

Exclude Asset Type

List of Asset types which should be excluded from crawling.

Fetch Assets from Library

Flag for indexing Assets from Libraries. When enabled, the connector will process Assets, Comments, and Attachments sourced from a Library

Fetch Assets from Workspace Project

Flag for indexing Assets from Workspace Projects. When enabled, the connector will process Assets and Comments sourced from a Workspace Project.

Frontify Guideline Filter Settings

Options related to filtering Guidelines by their ID.

Name	Description
Include Guideline ID	List of Guidelines Ids (hubs) will be processed by connector. If no include filters are defined, all Guidelines are included.
Exclude Guideline ID	List of Guidelines Ids (hubs) will not be processed by connector. If no exclude filters are defined, all Guidelines are included.

Name

Description

Include Guideline ID

List of Guidelines Ids (hubs) will be processed by connector. If no include filters are defined, all Guidelines are included.

Exclude Guideline ID

List of Guidelines Ids (hubs) will not be processed by connector. If no exclude filters are defined, all Guidelines are included.

Frontify Pagination Settings

Options related to the number of items returned for a single request.

Name	Description
Library Page Size	Number of Libraries requested with a single call.
Workspace Page Size	Number of Workspaces requested with a single call.
Asset Page Size	Number of Assets requested with a single call.
Asset Comment Page Size	Number of Asset Comments requested with a single call.

Name

Description

Library Page Size

Number of Libraries requested with a single call.

Workspace Page Size

Number of Workspaces requested with a single call.

Asset Page Size

Number of Assets requested with a single call.

Asset Comment Page Size

Number of Asset Comments requested with a single call.

Frontify Content Filter Settings

Filter Options related to content of items.

Name	Description
Max Content Size	Defines the maximum content size of all files. Files that exceed this size will only have their metadata indexed.

Name

Description

Max Content Size

Defines the maximum content size of all files. Files that exceed this size will only have their metadata indexed.

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

Name	Property Key	Description
Connection ID	`raytion.connector.backend.microsoft-search.product.connectionId`	Connection ID of the connector product which is registered with Microsoft Search.

Connection ID

raytion.connector.backend.microsoft-search.product.connectionId

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

Name	Property Key	Description
OAuth2.0 client ID	`raytion.connector.backend.microsoft-search.authentication.clientId`	OAuth2.0 client ID for the Microsoft Search Authentication.
Tenant ID	`raytion.connector.backend.microsoft-search.authentication.tenantId`	Tenant ID of OAuth2.0 Token URI for the Microsoft Search Authentication.
Authentication Method	`raytion.connector.backend.microsoft-search.authentication.authMethod`	How to authenticate against Microsoft search. Available is authentication via client secret, java keystore, or certificate file.
OAuth2.0 client secret	`raytion.connector.backend.microsoft-search.authentication.clientSecret`	OAuth2.0 client secret for the Microsoft Search Authentication.
Certificate Keystore Alias	`raytion.connector.backend.microsoft-search.authentication.certificateKeystore.certificateKeystoreAlias`	The alias under which the certificate is stored in the keystore.
Certificate Keystore Password	`raytion.connector.backend.microsoft-search.authentication.certificateKeystore.certificateKeystorePassword`	The password to access the keystore.
Client Certificate Password	`raytion.connector.backend.microsoft-search.authentication.clientCertificate.clientCertificatePassword`	The password to access the certificate.

OAuth2.0 client ID

raytion.connector.backend.microsoft-search.authentication.clientId

OAuth2.0 client ID for the Microsoft Search Authentication.

Tenant ID

raytion.connector.backend.microsoft-search.authentication.tenantId

Tenant ID of OAuth2.0 Token URI for the Microsoft Search Authentication.

Authentication Method

raytion.connector.backend.microsoft-search.authentication.authMethod

How to authenticate against Microsoft search. Available is authentication via client secret, java keystore, or certificate file.

OAuth2.0 client secret

raytion.connector.backend.microsoft-search.authentication.clientSecret

OAuth2.0 client secret for the Microsoft Search Authentication.

Certificate Keystore Alias

raytion.connector.backend.microsoft-search.authentication.certificateKeystore.certificateKeystoreAlias

The alias under which the certificate is stored in the keystore.

Certificate Keystore Password

raytion.connector.backend.microsoft-search.authentication.certificateKeystore.certificateKeystorePassword

The password to access the keystore.

Client Certificate Password

raytion.connector.backend.microsoft-search.authentication.clientCertificate.clientCertificatePassword

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

Name	Property Key	Description
API endpoint	`raytion.connector.backend.microsoft-search.connection.endpoint`	Microsoft Search API endpoint including version specifier.
Requests per Second	`raytion.connector.backend.microsoft-search.connection.requestsPerSecond`	Maximum number of requests per second.
Connect Timeout	`raytion.connector.backend.microsoft-search.connection.connectTimeout`	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	`raytion.connector.backend.microsoft-search.connection.socketTimeout`	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	`raytion.connector.backend.microsoft-search.connection.useProxy`	If enabled, the connection to Microsoft Graph API will be established through a HTTP/HTTPS proxy.
Proxy Endpoint	`raytion.connector.backend.microsoft-search.connection.proxy.uri`	Target proxy URL including protocol, host and port.
Proxy Authentication	`raytion.connector.backend.microsoft-search.connection.proxy.authentication`	If enabled, the connector uses the specified credentials to authenticate towards proxy.
Proxy Username	`raytion.connector.backend.microsoft-search.connection.proxy.username`	Proxy authentication username.
Proxy Password	`raytion.connector.backend.microsoft-search.connection.proxy.password`	Proxy authentication password. The value will be stored encrypted by the connector.

API endpoint

raytion.connector.backend.microsoft-search.connection.endpoint

Microsoft Search API endpoint including version specifier.

Requests per Second

raytion.connector.backend.microsoft-search.connection.requestsPerSecond

Maximum number of requests per second.

Connect Timeout

raytion.connector.backend.microsoft-search.connection.connectTimeout

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

raytion.connector.backend.microsoft-search.connection.socketTimeout

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

raytion.connector.backend.microsoft-search.connection.useProxy

If enabled, the connection to Microsoft Graph API will be established through a HTTP/HTTPS proxy.

Proxy Endpoint

raytion.connector.backend.microsoft-search.connection.proxy.uri

Target proxy URL including protocol, host and port.

Proxy Authentication

raytion.connector.backend.microsoft-search.connection.proxy.authentication

If enabled, the connector uses the specified credentials to authenticate towards proxy.

Proxy Username

raytion.connector.backend.microsoft-search.connection.proxy.username

Proxy authentication username.

Proxy Password

raytion.connector.backend.microsoft-search.connection.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

Name	Property Key	Description
Principal ID Attributes	`raytion.connector.backend.microsoft-search.principal-mapping.principalIdProperties`	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.

Principal ID Attributes

raytion.connector.backend.microsoft-search.principal-mapping.principalIdProperties

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

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