Configuration

This section explains each of the properties in the configuration blade.

General

PropertyDescription

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.

Settings

PropertyDescription

Transpose Type

The transpose options are:

  • Rows: Convert data received by row per asset parameter to a row per asset with columns for each parameter.

  • Columns: Convert data received with columns for each assets' parameters to a row per asset i.e. split a column into a name column and value column.

Static Columns

The columns or attributes of the input payload to include unchanged in the output payload.

Rows

This section applies to the Rows transpose type only.

PropertyDescription

Use Group By

Tick to partition the input payload by certain attribute(s) if there could be duplicates in the Row Name to Transpose. Unticked by default.

Group By

The columns or attributes from the input payload on which the data is grouped (applies when Use Group By is ticked).

Field to transpose

The column or attribute from the input payload used for the new transposed columns' values.

Row Name to Transpose

The column or attribute from the input payload used for the new transposed columns' names.

Column Prefix

Optional text added to the beginning of the new attributes in the format {Prefix}_{Column Returned}.

Columns Returned

The expected values in the Row Names to Transpose property. The Agent will try to match these to the incoming data and a new attribute is added for each distinct value to the output payload.

Columns

The Columns Grid applies to the Columns transpose type only. Click '+' to add a new column.

Details for how the Columns Grid is used can be found here. Columns or attributes from the input payload in neither Static Columns nor Columns Grid are excluded from the output payload.

PropertyDescription

Column

The column or attribute of the input payload to transpose. Both the name and value are split into two attributes.

Column Name

The column or attribute name for the output attribute name. The same name can be used for multiple columns - collapsing the source column names into one.

Value Name

The column or attribute name for the output attribute value. The same name can be used for multiple columns - collapsing the source column values into one.

Before configuring the Transformation, please ensure that its input endpoint is connected to a parent Agent which will be sending data to it.

Endpoints

NameDescription

Input

This endpoint is used to receive data from the parent Agent.

Output

Events received from the parent Agent are either split (Columns type) or combined (Rows type) and made available to this endpoint. The output payload is a combination of the static column(s) and transposed columns.

Error

If errors are encountered during the execution of this Agent they will be published on this endpoint.

Last updated