Connector Setup and Configuration

Connectors are the software components that communicate with the datasources that supply data to Seeq applications.

See the Supported Connectors section for a list of currently supported datasources. If you don't see your datasource listed here, please contact support@seeq.com to find out if it is supported.

Configuration Basics

Prior to Seeq version R54, all connector configuration is performed via editing of JSON files in the data folder's configuration/link folder.

Starting with Seeq Server version R54, connector configuration JSON files do not need to be updated manually on the machine running the agent and can instead be managed through the administration page. In the datasources tab, select the datasource of interest and click “Manage” for the associated connection card.

Each Connector type has its own JSON file and may specify multiple Connections.

Below is a simple example configuration demonstrating the basic configuration fields. Each configuration will contain additional fields specific to the connector.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "Version": "Seeq.Link.Connector.Example.ExampleConnectorConfigV1", "Connections": [ { "Name": "Example Connection", "Id": "90d3898f-a42c-4045-b994-3f0b10b91389", "Enabled": true, "Indexing": { "Frequency": "1w", "OnStartupAndConfigChange": true, "Next": "2020-08-26T03:37:16.780163-07[UTC]" }, "Transforms": null, "MaxConcurrentRequests": null, "MaxResultsPerRequest": null } ] }
  1. Version: The configuration version. This field is auto-populated in the default configuration file for each connector.

  2. Id: Every datasource in Seeq requires a unique identifier called a Datasource ID. This identifier is specified in the connection's JSON configuration as the Id field.

    1. It is important to keep the Id constant for a connected datasource. If you change the Id field, you will get duplicate items indexed in Seeq. You can recover from this by archiving the unwanted duplicates.

    2. Conversely, if you create a new connection to a new and separate datasource, you must supply a unique Id. You can use an online tool like Online GUID Generator.

  3. Name: Each datasource in Seeq also has a Datasource Name specified as the Name field in the connection's JSON configuration.

    1. You can change the Name field (without changing the Id field) to change how the datasource is presented to the user in, say, the drop-down of Datasource filters in the Data tab.

    2. Note that any changes to the Name field will be applied the next time the connector performs an indexing operation.

  4. Enabled: This flag determines whether a connection will appear in Seeq. If it is set to false, the connection will be ignored.

  5. Indexing: Specifies the indexing schedule for the connection. Starting with Seeq Server version R54, scheduling has to be configured in datasource administration page (Administration > Datasources , select your datasource and press Manage), the values set in the Indexing section of the JSON being ignored. 

    1. When you connect to a datasource, the connector will perform an indexing operation that inspects all of the signals, assets, and conditions that are available in the datasource and makes entries in Seeq Server's index database so that users can search for those items and bring them up in Seeq Workbench visualizations. This indexing operation can take time depending upon the speed of the datasource and in proportion to the number of items in the datasource.

    2. The indexing operation consumes CPU/memory/disk resources and it is a best practice to configure an indexing schedule that reflects your unique business and user needs. If possible, schedule indexing during "off hours" so that hardware resources do not compete with user activity. See Scheduling Connector Indexing Activities for more information.

  6. Transforms:. See Connector Property Transforms.

  7. MaxResultsPerRequest: See General Troubleshooting of Connectors#ThrottlingRequestActivity.

  8. MaxConcurrentRequests: See General Troubleshooting of Connectors#ThrottlingRequestActivity.

Adding Multiple Connections

  1. Copy an existing connection block within the Connections list field, being sure to add a comma , after the previous block’s closing brace } if necessary.

  2. Replace the Id field in the new connection block with a new unique ID (see Id above).

  3. Adjust any relevant fields within the connection (this will vary depending on the connector).

  4. Save the JSON configuration file.

 Be sure to generate a new ID field as described above; a connection with a duplicate ID will fail to index.

Starting with Seeq Server version R54, connector configuration JSON files do not need to be updated manually on the machine running the agent and can instead be managed through the administration page. In the datasources tab click [+Connection] to add a new connection.

Further Reading