Skip to content

IoT Consumer Configurations#

🔒 IoTConsumer.Edit

Overview#

Creating an adequate IoT Consumer configuration will enable the user to receive and parse the appropriate events in a straightforward and seamless fashion. The use of IoT Data Platform Keywords helps in such configurations and these keywords can be used when configuring IoT Consumers. Either due to security reasons (e.g. database connection strings) or for simplicity sake (e.g. Kafka topic names) we advise to use these whenever possible. These keywords are automatically replaced by the system upon starting an IoT Consumer.

System Keywords#

Hard-coded keywords with specific logic on how to fetch for the actual value to use. See below for details.

Topic#

Represents the topic name which the system will infer for an IoT Event Definition (topic is a concept related with the kafka broker technology). It follows the standard systemname_eventtype_eventname_raw

Example: production_equipment_sensordata_raw

{
    "ReadSettings": {
        "Topic": "$(Topic)"
    },
}

TopicList#

Represents a list of topics, split by comma.

Example: production_equipment_sensordata_raw, production_equipment_facilitydata_raw

{
    "ReadSettings": {
        "Topic": "$(TopicList)"
    },
}

EventDefinition#

Represents the name of the IoT Event Definition

Example: "SensorData"

{
    "WriteSettings": {
        "TableName": "$(EventDefinition)"
    },
}

EventDefinitionList#

Represents a list of IoT Event Definitions, split by comma

Example: "SensorData,FacilityData"

{
    "ReadSettings": {
        "InputEvents": "$(EventDefinitionList)"
    },
}

OnlineDBConnectionString#

Connection string for the MES Online database in JDBC format using a readonly account.

Example: MSINSTANCE\ONLINE;databaseName=AdventureWorks;user=MyUserName;password=*****;applicationName=IoTConsumerName;

{
    "ReadSettings": {
        "MetadataConnectionString": "$(OnlineDBConnectionString)",
    },
}

OnlineDBConnectionStringDotNet#

Connection string for the MES Online database in DotNet format using a readonly account.

Example: Data Source=MSINSTANCE\ONLINE;Initial Catalog= AdventureWorks;User ID= MyUserName;Password=*****;MultipleActiveResultSets=True

{
    "ReadSettings": {
        "MetadataConnectionString": "$(OnlineDBConnectionStringDotNet)",
    },
}

ControlTopic#

Represents a special internal topic name which the system uses to submit requests for a listener application (e.g. MessageBus Sink). By default, it should follow the standard _systemname_dp.control

{
    "ControlTopic": "$(ControlTopic)"
}

MessageBusTopic#

Represents a special internal topic name which the system uses to submit messages to be sent by MessageBus (e.g. Live Data use case). By default, It should follow the standard _systemname_dp.messagebus

{
    "MessageBusTopic": "$(MessageBusTopic)"
}

Configurable Keywords#

All values set in the MES Configuration section beneath the /Cmf/System/Configuration/IoTDataPlatform/ branch are recursively fetched and added into a Key/Value dictionary. With this mechanism, users can define customized keywords in the config and use them as Keywords in the IoT Consumer definition.

Moreover, by default, the system already provides many entries such the following depicted below, these can also be used as Keywords:

iot_consumer_configurations

To reference configurable keywords in the IoT Consumer configuration, just use the following template: $(keywordName).

Sample usage:

{
    "ReadSettings": {
        "BootstrapServers": "$(KafkaBootstrapServers)",
        "SystemName": "$(SystemName)"
    },
    "WriteSettings": {
        "SparkURL" : "$(SparkEndpoint)"
    }
}