Skip to content

Create IoT Consumer#

🔒 IoTConsumer.Create

🔒 IoTConsumer.CreateTemplate

🔒 IoTConsumer.CreateFromTemplate

Overview#

This operation is used to create a IoT Consumer. A template can also be created using a similar procedure and there is also the possibility of using a template to create the new object as well. This selection can be done in the main entity menu.

Setup#

No specific setup is required other than to meet the preconditions of the transaction.

Preconditions#

  • The IoT Consumer does not currently exist in the system.
  • The IoT Data Platform module is properly licensed in the system.

Sequence of Steps#

Step 1: General Data#

  1. Provide a name for the IoT Consumer.
  2. Optionally, provide a description of the IoT Consumer.
  3. Select the IoT Consumer Definition to use.
  4. Select the number of Instances of the IoT Consumer, the maximum number of worker instances that can be allocated by the system for high-availability and scalability purposes.

  5. Select the Start Date.

    Warning

    If defined in the past, the system will attempt to "replay" the messages from that date onwards; if defined in the future, the system will pick-up messages from after that date.

  6. Select the Event Filter Type out of the following options:

    • All - all events are selected.
    • List (Default) - the user will have to pick the events to be ingested.
    • Pattern - a pattern must be specified to select events.

    • Type - the user must specify an IoT Consumer Type.

      Note

      Some IoT Consumer Definitions may not support every Event Filter Type.

  7. Depending on the Event Filter Type, the configuration of the IoT Consumer will be slightly different. If Type is selected, the user must select a Type defined from lookup table IoTEventTypeType; if Pattern is selected, the user must enter a well formed PatternFilter.

    create_iot_consumer_step_one

Step 2: Events#

  1. If the Event Filter Type selected is List, the user must select the events to be used from a list of available events in the system:

    create_iot_consumer_step_two

Step 3: Configuration#

  1. Set the specific parameters to a particular IoT Consumer Definition.
  2. Select Create to complete the operation.