Configuration Reference¶

The main sections of a configuration file are:

SM Cloud Credentials
Receivers
Transforms
Transmits

The configuration also allows the use of environment variables.

SM Cloud Credentials¶

This section specifies how to connect to the Sight Machine cloud. These settings are used for both uploading data and accessing the FTX platform via MA as well as other features that require cloud connectivity.

In order to do this, the following environment variables must be configured.

FTX_CLOUD_URL - The full url of your service environment (e.g: https://customer.sightmachine.io)
FTX_CLOUD_KEY - Your API key
FTX_CLOUD_KEY_ID - Your API key ID

sight_machine_cloud (Deprecated)¶

sight_machine_cloud is now deprecated and it is recommended to configure this using the environment variables instead.

{
    "sight_machine_cloud": {
        "base_url": "<URL of your service environment>",
        "api_key_id": "<Your API key ID>",
        "api_key": "<Your API key>"
    }
}

Required fields:

base_url: URL of your Service Environment (e.g. https://my-environment.sightmachine.io)
api_key_id: Edge API key ID used to connect to the Sight Machine platform
api_key: Edge API key used to connect to the Sight Machine platform

To get an api_key and api_key_id for the Sight Machine platform, please refer to the Getting an API key section of the Quickstart guide.

Receivers¶

The data_receiver section contains settings for connecting to a data source, reading the input stream, and if necessary, parsing the received data. Settings for a data receiver will vary depending on the protocol of the data receiver.

FactoryTX has a few built-in data receivers available:

For information about available parsers and their configurations, please refer to the Parsers Configurations section.

To create your own custom receiver, please refer to the Creating a custom receiver guide in Tutorials.

Transforms¶

The transforms section contains settings for transforming the records received from the data receivers before passing them to data transmits for upload. Transforms are a receiver-independent way to manipulate and clean data.

FactoryTX has a few built-in transforms ready to be used:

To indicate that no transforms are needed, set transforms to an empty list ([]).

To create your own custom transform, please refer to the Creating a custom transform guide in Tutorials.

Transmits¶

The data_transmit section contains settings for transmitting the records to the Sight Machine cloud for storage and consumption.

Currently, FactoryTX has two options for transmitting data: