Tags

Add Tags

Within the Event Hubs Connector, tags contained within the connector topic refer to an individual Event Hub that share the settings defined for the connector topic.

To add tags, and therefore an Event Hub, to a connector topic, select a connector topic in the navigation tree and press the “Add” toolbar button.

../_images/eventhubs-add-client-tags.png

In the dialog, enter one or more Event Hub names in separate lines.

../_images/eventhubs-add-client-tags-dlg.png

Click the “Add” button in the dialog to add the defined Event Hub names as tags to the connector topic.

Alternatively, you can use the tag browser to connect to an Event Hub and query available messages. The tag browser will subscribe to the given Event Hub and wait for messages to arrive. If Event Hub messages contain JSON payloads then you may optionally want to check the “Decode JSON” option. This will inspect JSON payloads and make values within JSON objects available as individual tags.

Select one or more tags to drag onto the topic panel to add these tags (Event Hub message or properties) to the connector topic.

../_images/eventhubs-drag-tags.png

Expand the “JSON” header at the bottom of the tag browser panel to view the JSON payload associated with a tag browser tag.

Note

The tag browser can only display Event Hubs that are active (new messages are being sent). If messages are sent infrequently then it may take a little while for the tag browser to populate the tree view. Note also that the load of the Event Hubs service may increase if many Event Hub messages are being captured.

Tag Settings

Select a tag in the content panel to modify its settings.

../_images/eventhubs-tag-settings.png
  • Name
    Choose a name for the tag. By default, this will be the same as the Event Hub name.
  • Event Hub Name
    The Event Hub Name is the “address” of the tag within the Event Hubs service.
  • JSON path
    If the Event Hub message value contains a JSON object then you may optionally enter a path to a value within the JSON object to retrieve individual values. The JSON path maybe, for example, the name of a property within the JSON object. Tags with empty JSON paths refer to the entire message or JSON object.

Remove Tags

To remove tags from a topic, select tags within the topic’s content panel, then press the toolbar’s “Remove” button to remove selected tags.

../_images/eventhubs-remove-client-tags.png

Warning

Note that the tags are also removed from any task using the tags.