Connector for Altair IoT Studio

The Altair IoT Studio connector allows reading/writing data from Altair IoT Studio. This dedicated connector is recommended over the standard Web Data connector since it can automatically iterate over all the available data from service using iteration over cursor in the response. The UI also allows minimal settings required to connect to the Altair IoT Studio OpenAPI endpoints.

NOTE: 

To use this connector, you need to set the connector.iot_studio.url property in Panopticon.properties. This is the full API URL to the server running Altair IoT Studio.

For example:

connector.iot_studio.url=https\://api.swx.altairone.com

 

  1. Select one from the following Operations:
    • Get the status of all the things from a category
    • Get properties values of a specific thing
    • Get historical values of the all the properties of a specific thing

      NOTE:  For this operation, you should limit the query string in URL to avoid too much data. The default value for limit is 50 inside IoT Sudio API.

    • Manage data through HTTP
    • Run a custom query
    The corresponding properties of the selected Operation are discussed below:
    Property Description

     Category Name

     The name of the category that will group your things in a logical way.

    Scope 

    The request parameter while retrieving OAuth token. 

    URL 

     Path for the following options:

    • Get the status of all the things from a category (i.e., /spaces/{space-id}/categories/{category-name}/things?limit={limit})

    • Get properties values of a specific thing (i.e., /spaces/{space-id}/things/{thing-id}/properties)

    • Get historical Values of the all the properties of a specific thing (i.e., /spaces/{space-id}/things/{thing-id}/properties-history?limit={limit})

    Record Path 

    When loading JSON data, the Record Path can be suggested automatically by pressing the Fetch button. The default is data. However, for the Run a Custom Query operation, the default is result. 

    Array Handling 

    Determines how the data table will be created to accommodate the array of values. 

    Thing ID

    The ID of the thing or asset. 

    HTTP Method 

    The appropriate HTTP method for the request with the following options:

    • GET - To retrieve data.

    • POST – To add new data.

    • PUT – To replace existing data.

    • DELETE – To remove existing data.

    Request Headers 

    Custom Request Headers which enable connection to the API of AnythingDB. 

    Request Body 

    The request body to be supplied to the HTTP call. 

    Path

    Path for the Run a custom query operation: /spaces/{space-id}/query/cursor

     

  2. Under the Connection section, enter Space ID, Client ID, and Client Secret to connect to Altair IoT Studio.
  3. Select the Timeout which is the length of time to wait for the server response (10 to 300). Default is 10.
  4. Click    to the fetch the schema based on the connection details. Consequently, the list of columns with the data type found from inspecting the first ‘n’ rows of the input data source is populated and the Save button is enabled. 
  5. You can also opt to load or save a copy of the column definition.
  6. Click   to add columns and specify their properties:
    Property Description

    Name

    The column name of the source schema.

    JsonPath

    The JsonPath of the source schema.

    Type

    The data type of the column. Can be a Text, Numeric, or Time

    Date Format

    The format when the data type is Time.

    Enabled

    Determines whether the message field should be processed.

    To delete a column, check its  or all the column entries, check the topmost , then click .

  7. Click to test the connection. When successful, displays.

  8. You can control the total number of rows and cursor iteration using the Row Limit section for the operations.

 

(c) 2013-2024 Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support