Links

Example

The following examples can be found on this page:

Basic Output Example

This example demonstrates how to use the Action Agent to send stream data to the Boon Amber platform and print its raw JSON response.

Step 1: Add the Agent

Drag the Boon Amber Action Agent onto the canvas and rename it. Link the input endpoint to the stream data, the output endpoint to the printer, and save the Data Stream.

Step 2: Configure General

Select the Agent and click Configure. In this case, keep the default Collection.

Step 3: Configure Service Details

Fill in the Base URL and select a Metadata File. In this case, select the base URL, and upload the Metadata File.
Refer to Metadata File Configuration to understand how to configure the file for upload.
Enter the authentication details. In this case, keep the default authentication type (Boon Amber) and select a username and password.

Step 4: Configure Operations

Select the operation and result entity (defined in the uploaded Metadata File). In this case, set the operation to 'Post Stream' and the result entity to 'Raw JSON'.

Step 5: Configure Input Mapping

The input mapping is populated when you select an operation. Map one of the parent Agent's output attributes to each parameter, which is fetched from the metadata file.
In this case, select SensorId and Data.

Step 6: Results

Apply the changes, save the Data Stream, and publish it.
Let's look at the Live Data View. Observe that the response string from the Boon Amber is printed as well as its input payload.

Files

File
Link
Security Key
Data Stream
Boon Amber Action Agent Example.xuc
C0mp|ex123
Metadata
Boon Amber Metadata.json
See the Import, Export, and Clone - XMPro article for steps to import a Data Stream.

Advanced Output Example

This example demonstrates how to use the Action Agent to write stream data to the Boon Amber platform and return the deserialized data from its response. It makes use of the JSON Deserializer and Calculated Field Agents to properly format the output.

Step 1: Add the Agent

Drag the Boon Amber Action Agent onto the canvas and rename it. Link the input endpoint to the stream data, the output endpoint to the deserializer, and save the Data Stream.

Step 2: Configure General

Select the Agent and click Configure. In this case, keep the default Collection.

Step 3: Configure Service Details

Fill in the Base URL and select a Metadata File. In this case, select the base URL, and upload the Metadata File.
Refer to Metadata File Configuration to understand how to configure the file for upload.
Enter the authentication details. In this case, keep the default authentication type (Boon Amber) and select a username and password.

Step 4: Configure Operations

Select the operation and result entity (defined in the uploaded Metadata File). In this case, set the operation to 'Post Stream' and the result entity to 'Raw JSON'.

Step 5: Configure Input Mapping

The input mapping is populated when you select an operation. Map one of the parent Agent's output attributes to each parameter, which is fetched from the metadata file. In this case, select SensorId and Data.

Step 6: Results

Apply the changes, save the Data Stream, and publish it.
Let's look at the Live Data View. Observe that the values from the Boon Amber response string are deserialized and printed as well as its input payload.

Files

File
Link
Security Key
Data Stream
Boon Amber Action Agent Advanced Example.xuc
C0mp|ex123
Metadata
Boon Amber Metadata.json
See the Import, Export, and Clone - XMPro article for steps to import a Data Stream.