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 open the Data Routes window.

2. On the Data Routes window, click Create Data Route.

   The Create Data Route window is opened.

3. In the Name and Asset section, enter a Name.

4. Select an asset from the Asset list. The data that you collect is associated with the asset that you select.

5. In the Device Type list, select from the following options:

   • Appliance (Core device).
   • Gateway
   • Device Group

6. If you selected either the Gateway or Device Group device type, then select one of the following additional options:

   • For a Gateway device type, select a device from the Device list.
   • For a Device Group device type, select a group from the Device Group list.

7. Enter a Trace ID. The default value for the Trace ID is the asset name.

8. In the Data Profile section, select a Data Type.

   Consider the restrictions in the following table when selecting a data type:

   Data type	Restriction
   HIOTA	Modbus only works with the HIOTA data type because it is built into the message format. REST ingress only works with the HIOTA or USER DEFINED data types because the endpoint either takes a HIOTA message as is or the data type is defined in the REST header. The HIOTA data type is not supported for small message optimization. (Batch selector in the Date Source section of the window.)
   INFLUX	The INFLUX data type works with InfluxDB and MinIO databases and Kafka and AMQP protocols. The InfluxDB line protocol should not be written to CouchDB 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 InfluxDB data destination. REST ingress only works with the HIOTA or USER DEFINED data types because the endpoint either takes a HIOTA message as is or the data type is defined in the REST header. The USER DEFINED data type is not supported for small message optimization. (Batch selector in the Date Source section of the window.)

9. Select one of the following Data Size options.

   • small (0B to 25KB)
   • medium (25KB to 1MB)
   • large (1MB to 25MB)
   CautionAfter the data size is submitted, the selection cannot be edited. When the Data Size is set too large, the dispatch method is automatically set to REST. The Data Size selection can affect the default values of the following data route configuration properties:

   • Quality of Service (MQTT and AMQP)
   • Timeout (InfluxDB)
   • 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

10. In the Data Source section, enter a Name for the data source.

11. Select a protocol from the Protocol list.

    The following protocols are supported data sources for IIoT Core Services with the Appliance device type:

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

    The following protocols are supported data sources for IIoT Gateway with the Devices and Device groups device type:

    Protocol	Description
    MQTT	Use the MQTT protocol as a data source for the gateway. MQTT 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.

12. In the Protocol field, in the Data Source section, if you select an option other than a default setting, complete the required fields to configure the protocol.

13. Click More Options to update additional options.

    TipFor AMQP and MQTT, you can toggle the Batch selector to enable or disable small message optimization for the AMQP and MQTT protocols.

    • Off: Toggle off to disable batch processing for small messages. You can add additional data destinations.
    • On: Tpggle on to enable batch processing for small messages. You can 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.

14. In the Data Destinations section, enter a Name for the data destination.

15. In the Destination Type list, select either protocol or database.

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

16. Select one of the following, additional options for the destination type that you selected:

    • For a protocol destination type, select a protocol from the Protocol list.
    • For a database device type, select a database from the Database Type list.
    See Data destinations for a description of values.

17. In the Protocol field, in the Destination section, if you select an option other than a default setting, complete the required fields to configure the protocol.

18. Click More Options to update additional options.

19. If you specified Postgres as the database type, use one of the following options to update the Data Schema table:

    • Click Add, enter information for the Data Schema column, and then click Apply.
    • Click Import to import a database schema.
    NoteYou can also select the check box to Add hiota fields.

20. Click More Options to update additional options.

21. 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.

22. Choose one of the following save options:

    • Click Save And Deploy to deploy the route.
    • Click Save to save the route as a draft.
    • Click Cancel to cancel creating the data 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 must 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 the 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.