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:

http://your-host:16390

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

Amazon Kendra Configuration

Configure the ID and region of the index created at step Amazon Kendra Quick Start - Create Index. Specify the Role ARN assigned to the Index. All the parameters can be retrieved from the Index settings in AWS console.
Index Settings
Configure the ID of the data source created at step Amazon Kendra Quick Start - Create Data Source.
Data Source ID
Configure the Access Keys for the technical account which should write to the index. The specified account requires the Managed Policy AmazonKendraFullAccess
AWS Account Credentials

The Access Keys can be also configured via system properties. The keys can be identified from one of following locations:

  • Java System Properties aws.accessKeyId and aws.secretAccessKey

  • Environment Variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY

  • Web Identity Token credentials from System or Environment Variables

  • Credentials Profile File at location ~/.aws/credentials

  • Credentials delivered through the Amazon EC2 container

  • Instance profile credentials delivered through the Amazon EC2 metadata service

AWS Account System Credentials

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