Manage data routes

Gateways can receive data using the MQTT or Modbus protocol. IIoT Core can receive data through AMQP or REST.

Parent Topic

• Data route configuration values

  The following tables describe the protocol and database options supported in IIoT Core Services.

Parent Topic

• Data route configuration values

  The following tables describe the protocol and database options supported in IIoT Core Services.

Before you begin

Procedure

1. In the IIoT Core Services UI, select the Data Route tab to enter the data route inventory.

2. Click the Create Data Route button.

   The Create Data Route page opens.

3. In the Name field, enter a name for the data route.

4. In the Asset field, select an asset. The data you collect is associated with this asset.

5. Under Device Type, select from the following:

   • Appliance (core).
   • Gateway: If the device type is a gateway, use the Device list to select a device in the inventory.
   • Device Group: If the device type is a device group, use the Device Group list to select a device group in the inventory.

6. If you selected Gateway or Device Group in the Device Type field, you will be asked to select the device or device group in the corresponding Device or Device Group field.

7. Enter a Trace ID. The Trace ID uses the asset name as default.

8. Choose a data profile.

   1. Select the Data Type, taking the following restrictions into consideration.

      Data type	Restriction
      HIOTA	Modbus only works with the HIOTA data type because it is built into the message format.
      INFLUX	This works with Influx, Kafka, AMQP, and MinIO. The Influx line protocol should not be written to Couch or Postgres.
      JSON	N/A
      PARQUET	Parquet only works with REST as a data source and MinIO as a data destination.
      USER DEFINED	The USER DEFINED data type cannot be saved to an Influx data destination. Not supported for small message optimization. (Batch selector in the data source step)
      HIOTA or USER DEFINED	REST ingress only works with these data types. This is because the endpoint either takes a HIOTA message as is or the data type is defined in the REST header. Not supported for small message optimization. (Batch selector in the data source step)

   2. Select the Data Size.
      • small (0B to 25KB)
      • medium (25KB to 1MB)
      • large (1MB to 25MB)
   When the Data Size is set to large, the dispatch method is automatically set to REST. Your Data Size selection can affect the default values of the following data route configuration properties:
   • Quality of Service (MQTT and AMQP)
   • Timeout (Influx)
   • Timeout (Minio)
   • Idle Timeout (Minio)
   • TLS Timeout (Minio)
   • Expect Continue Timeout (Minio)
   • Keep Alive (Minio)
   • Max Idle Connections (Minio)
   • Store and Forward Number of Retries
   • Store and Forward Notification Interval

   Once submitted, the data size cannot be edited.

9. Choose a Data Source.

   1. Specify a name for the data source.

   2. Select a protocol, either using default settings or a custom setting.

      Supported data sources for IIoT Core Services:

      Protocol	Description
      AMQP	Use the AMQP protocol as a data source for IIoT Core Services. NoteAMQP supports batching of small messages.
      REST	Use REST as a data source.
      Kafka	Use the Kafka protocol as a data source.

      Supported data sources for IIoT Gateway:

      Protocol	Description
      MQTT	Use the MQTT protocol as a data source for the gateway. NoteMQTT supports batching of small messages.
      Modbus	Use the Modbus protocol as a data source for the gateway.

      For more information about data sources, see Data sources.
   (Optional) For AMQP and MQTT, you can enable small message optimization by turning on the Batch selector:
   • Off: No batch processing for small messages. You can add additional data destinations.
   • On: You can now set the Batch Count and Batch Timer fields by specifying the message size, how many messages should be batched together, and a timeout parameter. The ability to add additional data destinations is not available. The Batch Count needs to be equal to or smaller than QoS.

10. Choose Data Destinations.

    1. Specify a name for the data destination.

    2. Select a destination type of either protocol or database.

    3. Enter values for the protocol or database type. See Data destinations for a description of values.

    4. When Postgres is the data destination, add and describe each column, or you can import a database schema.

    NoteIf you enabled batch processing of small messages, only the Influx database is supported as a destination.

11. (Optional) Click Add Another Data Destination to add another destination for the route.

    NoteYou cannot add additional data destinations if you enabled batch processing for an AMQP or a MQTT data source.

12. Click Save to save as a draft or Save And Deploy to deploy the route.

Results

Parent Topic

• Creating a data route

  You can establish a data route from the data source to a data destination that connects through a supported protocol.

Procedure

1. Create a data route using REST as data source.

   For more information, see Create a data route using the IIoT Core Services UI.For the data route, you need to know the following information when you send the binary file:
   • Trace ID
   • Content Type
   NoteREST only works with USER DEFINED or HIOTA data types.

2. Send your binary file to https://<host>:30983/api/v1/ingress-rest.

Results

Parent Topic

• Creating a data route

  You can establish a data route from the data source to a data destination that connects through a supported protocol.