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 (default to that of the current Data Stream).
Refer to Collections and Stream Hosts to understand more about Collections.
Connection Settings
The Agent uses Application Authentication to authenticate with the Telit IoT Portal.
Property
Description
Url
The url of the Telit Iot Portal the deviceWise api is connecting to.
App Id
The unique value generated by the Telit device, is associated with the Thing Key.
App Token
The token supplied by the Telit Management Portal, used to authenticate the session to IoT Portal.
Thing Key
The unique key that associates the Telit application or client to a particular Thing.
Target
Property
Description
Publish Type
The Thing service to which provided values are published: Properties or  Alarms.
Before configuring the Action Agent, please ensure that its input endpoint is connected to a parent Agent which will be sending data to it.
Input Mapping
See Property.Publish Api and Alarm.Publish Api for more information.
Name
Text
ThingKey (String)
The column or attribute of the input payload that contains the Thing key.
PropertyKey (String)
The column or attribute of the input payload that contains the key to the property that you wish to publish to (applies to Properties Return Type only)..
Value (Double)
The column or attribute of the input payload that contains the value to publish (applies to Properties Return Type only). 
AlarmKey (String)
The column or attribute of the input payload that contains the key for the alarm that you wish to publish to (applies to Alarms Return Type only).
State (Int)
The column or attribute of the input payload that contains the state to publish (applies to Alarms Return Type only).
Message (String)
The column or attribute of the input payload that contains the message to publish (applies to Alarms Return Type only).
Latitude (Double)
The column or attribute of the input payload that contains the Latitude coordinate of the alarm state event (applies to Alarms Return Type only).
Longitude (Double)
The column or attribute of the input payload that contains the Longitude coordinate of the alarm state event (applies to Alarms Return Type only).
Republish (Boolean)
The column or attribute of the input payload that contains the republish boolean (applies to Alarms Return Type only). 
If the alarm being published is newer than all other existing alarms, and republish is false, the publish will be suppressed and will not add an additional record.
Timestamp (DateTime)
The column or attribute of the input payload that contains the timestamp in which the value was recorded.
CorrId (String)
The column or attribute of the input payload that contains the correlation Id that can be used when querying related data objects.
Aggregate (Boolean)
The column or attribute of the input payload that contains the boolean aggregation (applies to Properties Return Type only). 
If 'true', then aggregate data (hourly and daily) will be generated for the values published in this API call, if 'false' only the history will be saved.
Refer to Setup Input Mappings for step-by-step instructions. 
Endpoints
Name
Description
Input
This endpoint is used to receive data from the parent Agent.
Output
Events received from the parent Agent are made available to this endpoint, with Telit success, error codes, and error messages appended to the original event.
Error
Errors encountered during the execution of this Agent will be published on this endpoint.

Property	Description
Collection	This associates the Agent to a specific Collection (default to that of the current Data Stream).

Property	Description
Url	The url of the Telit Iot Portal the deviceWise api is connecting to.
App Id	The unique value generated by the Telit device, is associated with the Thing Key.
App Token	The token supplied by the Telit Management Portal, used to authenticate the session to IoT Portal.
Thing Key	The unique key that associates the Telit application or client to a particular Thing.

Property	Description
Publish Type	The Thing service to which provided values are published: Properties or Alarms.

Name	Text
ThingKey (String)	The column or attribute of the input payload that contains the Thing key.
PropertyKey (String)	The column or attribute of the input payload that contains the key to the property that you wish to publish to (applies to Properties Return Type only)..
Value (Double)	The column or attribute of the input payload that contains the value to publish (applies to Properties Return Type only).
AlarmKey (String)	The column or attribute of the input payload that contains the key for the alarm that you wish to publish to (applies to Alarms Return Type only).
State (Int)	The column or attribute of the input payload that contains the state to publish (applies to Alarms Return Type only).
Message (String)	The column or attribute of the input payload that contains the message to publish (applies to Alarms Return Type only).
Latitude (Double)	The column or attribute of the input payload that contains the Latitude coordinate of the alarm state event (applies to Alarms Return Type only).
Longitude (Double)	The column or attribute of the input payload that contains the Longitude coordinate of the alarm state event (applies to Alarms Return Type only).
Republish (Boolean)	The column or attribute of the input payload that contains the republish boolean (applies to Alarms Return Type only). If the alarm being published is newer than all other existing alarms, and republish is false, the publish will be suppressed and will not add an additional record.
Timestamp (DateTime)	The column or attribute of the input payload that contains the timestamp in which the value was recorded.
CorrId (String)	The column or attribute of the input payload that contains the correlation Id that can be used when querying related data objects.
Aggregate (Boolean)	The column or attribute of the input payload that contains the boolean aggregation (applies to Properties Return Type only). If 'true', then aggregate data (hourly and daily) will be generated for the values published in this API call, if 'false' only the history will be saved.

Name	Description
Input	This endpoint is used to receive data from the parent Agent.
Output	Events received from the parent Agent are made available to this endpoint, with Telit success, error codes, and error messages appended to the original event.
Error	Errors encountered during the execution of this Agent will be published on this endpoint.

Action Agent - Previous

Example

Next - Action Agent

Release Notes

Last modified 1yr ago