Page History

The IBM Cloud Injector module provides the ability to push Tag data to an IBM's Watson IoT Platform.  The settings configuration for this module are located under the Configure tab of the Ignition Gateway web UI.                                                                      

Image Removed

Once in the configuration section there are four tabs: General, IBM Cloud MQTT, Sets, and Tag Agents.  Each of these tabs is described in detail in the following sections.

...

The Sets tab contains a list of IBM Cloud Sets.  Each set represents a grouping of IBM Cloud MQTT endpoints.  When a set is referenced by a Tag Agent the Agent will push Tag data to all IBM Cloud MQTT endpoints contained within that Set. The Sets are disjoint, meaning that a single IBM Cloud MQTT endpoint cannot be in more than one set.  Out of the box the IBM Cloud Injector module will have one "Default" set defined.

Image AddedImage Removed

Additional Sets can be configured for situations where multiple Tag Agents will need to push to different IBM Cloud MQTT endpoints. The configuration options for Sets are listed below.

...

• Name
  • This is the friendly name of the set used to easily identify it.
• Description
  
  • This is a friendly description of the set.
• Push Policy
  • This defines which endpoints to push to. If PUSH_TO_ALL is selected, every endpoint that is part of this set will receive all messages. If PUSH_TO_ANY is selected, only one of the endpoints that is part of this set will receive any given message. PUSH_TO_ANY is useful when adding endpoint configurations to increase the throughput of the Injector.

Clicking on the 'Create new IBM Cloud Set...' link will bring up the following form to add a new Set.

Image RemovedImage Added

Tag Agents

Tag Agents are the workers within IBM Cloud Injector that monitor tag events, convert them to a JSON representation, and push them to one or more IBM Cloud MQTT endpoints. Out of the box the IBM Cloud Injector module will have one "default" Tag Agent defined.

...

• Tag Provider Name
  
  • The name of the Tag provider containing the tags.
• Tag Path
  • An optional folder path under the Tag provider where the root folder of the Tags can be found.
• Tag Pacing Period
  • The buffer period, in milliseconds, that Tag events will be aggregated into a single payload before pushing.
• Convert UDTs
  • Whether to convert UDT members to normal Tags before publishing.  If enabled the Tags representing the UDT member will retain their member path prefixed by the UDT Instance name.
  • Publish UDT Definitions
    • This can only be set if 'Convert UDTs' is false 
    • Whether or not to publish UDT definitions in the NBIRTH messages
• Set
  • The Set of IBM Cloud MQTT endpoints that the Tag Agent will push to.
• Auto-discover Tags
  • Whether newly added tags should be dynamically scanned and their values pushed.  This field is disabled by default.  It should remain disabled while manually editing tags and/or their configurations. It should only typically be enabled in systems where tags are created in real time.

...

Clicking on the 'Create new Tag Agent Settings..' link will bring up the following form to add a new Tag Agent.

Image RemovedImage Added