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.
Service
Property
Description
OData Version
Your OData service version. V3 and V4 are supported. 
Authentication Type
The authentication methods supported:
User Credentials
App Credentials
Url
The URL of the token endpoint provided by the application to make API requests.
Use Connection Variables
Tick to select saved variables; or enter the text manually for the authentication properties.
Authorization URL
The endpoint address (URL) of the OData service authorizing the client e.g. https://login.windows.net/example.com.au (applies to App Credentials Authentication Type only).
Client ID
The unique identifier to request authorized access to client data (applies to App Credentials Authentication Type only).
Secret ID
The client secret obtained from the OData service (applies to App Credentials Authentication Type only).
User Name
The user name used to authenticate the connection (applies to User Credentials Authentication Type only).
Password
The password used to authenticate the connection (applies to User Credentials Authentication Type only).
Action
The request method performed by the OData service: POST or GET.
Entity
The entity against which the action is performed.
Input Mapping
The properties grid is populated once an entity is selected.
Property
Description
Parameter
The parameter specified in the uploaded metadata configuration of the selected entity.
Value
The column or attribute of the input payload used as the parameter value.
Type
The data type of the value.
Results
Property
Description
Result Properties
The columns which the Agent will return. If no columns are specified, all columns from the OData service are returned.
Results Returned As
The result properties are either appended to the incoming payload (Append to Current), or a new payload is created that consists only of the expressions (New).
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 the attributes dependent upon the Results property configuration.
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
OData Version	Your OData service version. V3 and V4 are supported.
Authentication Type	The authentication methods supported: User Credentials App Credentials
Url	The URL of the token endpoint provided by the application to make API requests.
Use Connection Variables	Tick to select saved variables; or enter the text manually for the authentication properties.
Authorization URL	The endpoint address (URL) of the OData service authorizing the client e.g. https://login.windows.net/example.com.au (applies to App Credentials Authentication Type only).
Client ID	The unique identifier to request authorized access to client data (applies to App Credentials Authentication Type only).
Secret ID	The client secret obtained from the OData service (applies to App Credentials Authentication Type only).
User Name	The user name used to authenticate the connection (applies to User Credentials Authentication Type only).
Password	The password used to authenticate the connection (applies to User Credentials Authentication Type only).
Action	The request method performed by the OData service: POST or GET.
Entity	The entity against which the action is performed.

Property	Description
Parameter	The parameter specified in the uploaded metadata configuration of the selected entity.
Value	The column or attribute of the input payload used as the parameter value.
Type	The data type of the value.

Property	Description
Result Properties	The columns which the Agent will return. If no columns are specified, all columns from the OData service are returned.
Results Returned As	The result properties are either appended to the incoming payload (Append to Current), or a new payload is created that consists only of the expressions (New).

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 the attributes dependent upon the Results property configuration.
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