Configuration

This section explains each of the properties in the configuration blade. 
General
Property
Description
Collection
This associates this Agent to a specific Collection and defaults to that of the current Data Stream.
Visit Collections and Stream Hosts to understand more about Collections.
Service Details
Property
Description
Use Variables
Tick to use variables for Base Url, Username, and Password. 
Base Url
The base URL of the Boon Amber Rest API server. 
e.g. https://amber.boonlogic.com/v1​
Metadata File
The metadata configuration file that includes the operations available, their operations, and the output schema of the operations.
Refer to Metadata File Configuration for more information.
Authentication Type
The Authentication method supported for the Boon Amber platform which uses a Bearer Token retrieved from the provided credentials. The Token is automatically refreshed based on its expiration.
Username
The Username required to authenticate with the Boon Amber Rest API.
Password
The Password required to authenticate with the Boon Amber Rest API.
Operation
Property
Description
Operation
The operation to be performed. The list is populated from the uploaded metadata configuration file.
Result Entity
The expected result entity from the operation that will be performed (applies when responseSchema is specified in the metadata JSON file). The list of entities is populated from the uploaded metadata configuration file.
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
The grid is populated when an operation is selected.
Property
Description
Parameter
The parameter specified in the uploaded metadata JSON file.
Value
The column or attribute from the input payload that is used as the parameter value sent to the Boon Amber Rest API.
Endpoints
Property
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 operation result entity attributes appended.
Error
If errors are encountered during the execution of this Agent, they will be published on this endpoint.

Property	Description
Collection	This associates this Agent to a specific Collection and defaults to that of the current Data Stream.

Property	Description
Use Variables	Tick to use variables for Base Url, Username, and Password.
Base Url	The base URL of the Boon Amber Rest API server. e.g. https://amber.boonlogic.com/v1
Metadata File	The metadata configuration file that includes the operations available, their operations, and the output schema of the operations. Refer to Metadata File Configuration for more information.
Authentication Type	The Authentication method supported for the Boon Amber platform which uses a Bearer Token retrieved from the provided credentials. The Token is automatically refreshed based on its expiration.
Username	The Username required to authenticate with the Boon Amber Rest API.
Password	The Password required to authenticate with the Boon Amber Rest API.

Property	Description
Operation	The operation to be performed. The list is populated from the uploaded metadata configuration file.
Result Entity	The expected result entity from the operation that will be performed (applies when responseSchema is specified in the metadata JSON file). The list of entities is populated from the uploaded metadata configuration file.

Property	Description
Parameter	The parameter specified in the uploaded metadata JSON file.
Value	The column or attribute from the input payload that is used as the parameter value sent to the Boon Amber Rest API.

Property	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 operation result entity attributes appended.
Error	If errors are encountered during the execution of this Agent, they will be published on this endpoint.

Last modified 6mo ago