Documentation Index

Fetch the complete documentation index at: https://docs.sightmachine.com/llms.txt

Use this file to discover all available pages before exploring further.

Enact Data Receiver

Prev Next

Overview

The enact data receiver connects to the Enact API for InfinityQS reads quality data available.

Example

{
  "data_receiver": [
    {
      "data_receiver_name": "my_enact_receiver",
      "protocol": "enact",
      "asset_tag": "process",
      "default_stream_type": "Enact_Quality_v8",

      "connections": [
        {
           "refresh_token": "...",
           "client_id": "...",
           "client_secret": "...",
           "subscription_key": "..."
        }
      ],

      "streams": []
    }
  ]
}

Acquiring a refresh key is a crucial step in setting up the Enact REST API Receiver; annoyingly the provider is currently using a browser-redirect heavy workflow. In practice, that means you almost certainly want to use postman to fetch a refresh token: https://www.postman.com/downloads/

You can use the ‘get new authorization token’ button in the ‘Authorization’ header to get a new refresh token. This process needs to be done every 30 days when the existing refresh token expires.

Supported Properties

Configuration:

Required and optional properties that can be configured for an Enact receiver:

  • data_receiver_name: Unique name of the data receiver. This name will be used to track the progress state of the data stream.

  • protocol: Protocol to be used. Should be set to enact.

  • asset_tag: Column to use as the asset tag when not specified in the streams section.

  • default_stream_type: Stream type to used when not specified in the streams section.

  • connections: How to connect to the REST API. A connection has the following configurable settings:

  • streams: List of data streams; this receiver ignores this field and fetches all data regardless of configuration, however for technical reasons the field must be present and be a list. An empty list is likely the best thing to put here, otherwise the schema below must be respected: