Connector Quick Start

Start Connector

Unpack the distribution and run the start script located in the installation bin directory.

LINUX

./connector

WINDOWS

./connector.bat

Login to Connector

Once the Connector has started, navigate to the Admin UI and login with the default username and password, admin/admin:

Configure Connector

Follow the description and instruction in the Basic Configuration Menu to configure the mandatory settings.

SQL Database Configuration

Configure the connection to the database by stating the JDBC driver, the connection URI, username and password.
Connection Setup

Choose the Query Type

  • Single Stage Querying - this is the simplest form, use this option for simple queries that are expected to return small result sets without error.

  • Two Stage Batched Querying - Use this option for complex queries that may encounter errors in the result set, this option is able to recover and continue while at the same time keeping the query rate to the database at a minimum.

  • Two Stage Single Row Querying - Use this option for complex queries that may encounter errors in the result set, this option is able to recover and continue. This option has a higher query rate to the database, but in most scenarios it will be the fastest most robust option.

If you are unsure which option is best for your scenario then use Two Stage Single Row Querying.

Content Query Setup Query Type
Configure the Content Query, IDs Query and ID Column depending on your Query Type. Make sure to use the appropriate placeholder for the Two Stage …​ Query Types. RAYTION_ID_VARIABLE and RAYTION_IDS_VARIABLE respectively. See here for more information regarding the syntax of each query type.
Content Query Setup Queries

Google Cloud Search Configuration

Google Cloud Search Service Account

Configure the mail address of a technical user to check the existence of principals before feeding them. This is not the mail address from the service account described in the following.
Configure your Service Account which is used by the connector for authenticating and authorizing the requests send to Google Cloud Search API. A new service account can be created as part of step Google Cloud Search Quick Start - Create Service Account. The connector requires the created service account JSON file, which can be uploaded directly in the Admin UI of the connector.
gcs account settings service account

Google Cloud Search Identity Source

Configure the ID of the identity source created as part of step Google Cloud Search Quick Start - Create Identity Source.
gcs identitysource settings

Google Cloud Search Data Source

Configure the ID of the datasource created as part of step Google Cloud Search Quick Start - Create Data Source.
  • If you followed the step Google Cloud Search Quick Start - Create Data Source Schema, this is the default value assigned as object type to a document to specify the object type from a schema. It is applied when no meta date objectType is present at a document. The value has to be set to the object name of the schema set for your Data Source. The value can be retrieved from schema.objectDefinitions.name inside your schema Json file or payload.*

gcs datasource settings

Upload License

  • Contact Raytion and obtain a license for your connector

  • Login to the Admin UI

  • Select License in the menu:

uploadlicense 1
  • Upload the license file by browsing for the file or simply dragging a dropping the license onto the license page

  • The Status of the license will be displayed as valid, and the expiration and item quota will also be displayed:

uploadlicense 2

Synchronizing Data

Once the connector is configured and the license uploaded, you can start synchronizing data using the traversal feature in the dashboard.

Content Traversal

  • Ramp Up will process all items to Amazon Kendra.

  • Incremental will process only changed items since last traversal run.

dashboard content without change processing

Schedule Traversal

Scheduled traversals can also be configured through the menu.

From this button a Schedule can be configured.
schedule button
From upper right corner you can choose the traversal type and then click on NEW SCHEDULED TRAVERSAL.
schedule type
Configure the frequency that the Traversal will be executed and click Save.
schedule frequency