The Elasticsearch Connector can be configured using the Aspire Admin UI. It requires the following entities to be created:

• Credential
• Connection
• Connector
• Seed

Create Credential 

1. On the Aspire Admin UI go to the credentials page
2. All existing credentials will be listed. Click on the new button
3. Enter the new credential description.
4. Select Elasticsearch from the Type list.
5. General:
   1. No Authentication: Select this if authentication is not required.
   2. Use Basic Authentication: Select this to enable basic user authentication.
      1. Username: The name of Elasticsearch user to use.

      2. Password: The password of Elasticsearch user to use.

   3. AWS Signature V4: Select this to enable AWS Signature V4 authentication.
      1. Region: The Region of the ES service to use i.e: us-east-1.
      2. Use Default AWS Credentials: Check this to use default AWS credentials.
      3. Access Key: The Access key of the ES service to use. Only required if "Use Default AWS Credentials" is unchecked.
      4. Secret Key: The Secret key of the ES service to use. Only required if "Use Default AWS Credentials" is unckeckedunchecked.

Create Connection 

1. On the Aspire Admin UI go to the connections page page Image Added
2. All existing connections will be listed. Click on the new button button Image Added
3. Enter the new connection description. 
4. Select Elasticsearch from the Type list.
5. General:
   1. Hostname: The Elasticsearch server hostname.
   2. Port: The Elasticsearch server port number.
   3. Protocol: The Elasticsearch server URL protocol.
   4. Should Fetch Documents: Check to fetch the documents content.
   5. Use MGET for fetching: Check to user MGET for fetching the documents. If not individual GET requests will be executed for each document.
   6. Wait for discovery before fetching: Check to make the fetch process wait for discovery process to be done.
   7. Include Fields: The specified fields will be included in the fetch process of the document.
      1. Include Field: Enter the name of the field to include in the fetch process.
   8. Exclude Fields: The specified fields will be excluded in the fetch process of the document.
      1. Exclude Field: Enter the name of the field to exclude in the fetch process.
6. Network:
   1. Number of slices: The number of slices to use for the queries.
   2. Page size: The number of documents to get per request.
   3. Scroll timeout: The time to keep each scroll request active.
   4. Connection timeout: The timeout to use for the connections to elastic.
   5. Number of Slice Retries: The number of retries for each slice processing.
   6. Slice Retry Wait Time: The time in milliseconds to wait between each slice retry.
   7. Number of Request Retries: The number of retries for each Elasticsearch request.
   8. Requests Retry Wait Time: The time in milliseconds to wait between each Elasticsearch request retry.
   9. Use Connection Throttling: Check to enable connection throttling.
      1. Throttle Rate in Millis: The throttle rate in milliseconds.
      2. Connections Rate: The number of connection to allow in the the specified throttle rate.

Create Connector Instance

For the creation of the Connector object using the Admin UI check this page.

Create Seed 

1. On the Aspire Admin UI go to the seeds page 
2. All existing seed will be listed. Click on the new button 
3. Enter the new seed description.
4. Select Elasticsearch from the Type list.