Documentation

Squirro Insight Engine - Indexing Configuration

The following describes how to configure our connectors to index data into a Squirro instance.

Technical Prerequisites

Before being able to index documents into your Squirro instance, you need to make sure to have configured indexing pipelines.

Project Name, Id and Pipeline Ids

The Squirro dialogs provide the information needed to configure the connector’s connection to Squirro.

For example the URL in the configuration dialog
https://<projectname>.squirro.cloud/app/#settings/<projectid>/pipeline_workflows
offers

  1. Base URL to your Squirro instance, i.e., https://<projectname>.squirro.cloud

  2. The project name, <projectname>

  3. Project id, <projectid>

To obtain a pipeline id, please talk to your Squirro representative.

API Key

You can obtain your API key as follows.

  1. Open your Squirro instance

  2. Click on your user name icon

  3. Click on my account

  4. Open API access

  5. Generate or copy the User Token

Connector Configuration

  1. Squirro base URL: this is the FQDN, with port and protocol which points to the Squirro installation, for example https://instance.squirro.cloud

  2. Project Id: this is the project id as described above.

  3. Project name: is the project name as described above.

  4. Document pipeline Id: This is the id of the document index pipeline, which the connector should use. Please note that only one pipeline is supported for indexing all documents from a source.

  5. Principal index pipeline Id: This is the id of the principal index pipeline, which the connector should use to send user-group relationships.

  6. API token to your instance. Please add the API token, which you obtained following the steps above.

  7. Public keys for SSL certificates: this configuration is needed, if you run the environment with self-signed certificates, or certificates which are not known to the Java key store.
    We use a straight-forward approach to validate SSL certificates. In order to render a certificate valid, add the modulus of the public key into this text field. You can access this modulus by viewing the certificate within the browser.

  1. Response timeout: determines the timeout when waiting for Squirro responses in milliseconds.

  2. Connection timeout: determines the timeout when waiting for connections to Squirro in milliseconds.

  3. Socket timeout: determines the timeout when waiting for connections to Squirro in milliseconds.

When finished with setting these fields, click on validate and save. If you observe any issues, then the validator will let you know or you can find more insights in the log files.

Please note that maintaining the index schema from this dialog is not supported.