Comment on page

Configuration

This section explains each of the properties in the configuration blade.
General
Property
Description
Collection
This associates the Agent to a specific collection (defaults to that of the current Data Stream).
Polling Interval (seconds)
A timespan to specify how often should the Agent check for new data/changes or update its cache.
Refer to Collections and Stream Hosts to understand more about Collections.
IoT Hub Details
Property
Description
Use Variables?
Tick to select saved variables; or enter the text manually.
Event Hub Name
The name of the Event Hub to which you will connect.
Event Hub EndPoint
The URI of the Event Hub Namespace, in the format "sb://{namespaceName}.servicebus.windows.net". 
The URL can be found on the Namespace's Azure settings page, but needs to have "sb://" prepended to it.
Shared Access Key Name
The name of the Shared Access Key to use.
Shared Access Key Value
The value of the Shared Access Key to use.
Consumer Group
The Consumer Group to read from. If empty, defaults to "$Default".
Output Properties
Property
Description
Specify JSON path for payload
Tick to allow complex JSON objects to be read from the message by specifying a dot-notation path for each property; or simple paths only (default).
Use File Definition?
Tick to pre-fill the Output Properties grid with property names from a CSV file; or manually add rows (default).
CSV File Definition
The CSV File to read headers from to pre-fill the Output Properties Grid. Applies if Use File Definition? is ticked.
Grid
This grid defines the shape of the records that will be received. If Use File Definition? is ticked, this table will be pre-filled by the CSV File Definition and only the Data Type property is editable.
Property
Description
Property
The name of the property.
JSON Path
The JSON path to the property value to be extracted. Applies if Specify JSON path for payload is ticked.
​
Eg. Given a payload of:
{"store":{"book":{"category": "reference","author": "Nigel Rees"}}}
​
The JSON Path to the "author" attribute would be "store.book.author".
Data Type
The type of the property.
Endpoints
Name
Description
Output
Events received from the Azure Event Hub will be made available on this endpoint. Events will always be in the format specified by the Output Properties Grid, with nulls for properties that were not found.
Error
If errors are encountered during the execution of this Agent they will be published on this endpoint.

Property	Description
Collection	This associates the Agent to a specific collection (defaults to that of the current Data Stream).
Polling Interval (seconds)	A timespan to specify how often should the Agent check for new data/changes or update its cache.

Property	Description
Use Variables?	Tick to select saved variables; or enter the text manually.
Event Hub Name	The name of the Event Hub to which you will connect.
Event Hub EndPoint	The URI of the Event Hub Namespace, in the format "sb://{namespaceName}.servicebus.windows.net". The URL can be found on the Namespace's Azure settings page, but needs to have "sb://" prepended to it.
Shared Access Key Name	The name of the Shared Access Key to use.
Shared Access Key Value	The value of the Shared Access Key to use.
Consumer Group	The Consumer Group to read from. If empty, defaults to "$Default".

Property	Description
Specify JSON path for payload	Tick to allow complex JSON objects to be read from the message by specifying a dot-notation path for each property; or simple paths only (default).
Use File Definition?	Tick to pre-fill the Output Properties grid with property names from a CSV file; or manually add rows (default).
CSV File Definition	The CSV File to read headers from to pre-fill the Output Properties Grid. Applies if Use File Definition? is ticked.

Property	Description
Property	The name of the property.
JSON Path	The JSON path to the property value to be extracted. Applies if Specify JSON path for payload is ticked. Eg. Given a payload of: {"store":{"book":{"category": "reference","author": "Nigel Rees"}}} The JSON Path to the "author" attribute would be "store.book.author".
Data Type	The type of the property.

Name	Description
Output	Events received from the Azure Event Hub will be made available on this endpoint. Events will always be in the format specified by the Output Properties Grid, with nulls for properties that were not found.
Error	If errors are encountered during the execution of this Agent they will be published on this endpoint.

Last modified 1yr ago