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
Configure a content query for this connection by setting the SQL query and the ID column.
Content Query Setup

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 Content Information

Once, the connector is configured and license uploaded, you can start synchronize content information using the traversal feature in the dashboard.

Content Traversal

In order to synchronize items from source system, the Connector provides different types of execution:

  • Ramp-Up: All items from source system are processed to the search engine. This includes also previously synchronized unchanged items. Note, that Ramp-Up will not delete deprecated items.

  • Incremental: All items are from source system are compared against the state in the connector from previous synchronization runs. Only changed items (this includes newly added, modified and moved items) will be processed to Amazon Kendra. This type can be used to reduce the load on the search engine. Incremental Runs will also synchronize delete information by deleting all removed items from the search engine index.

content dashboard

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