Flow / Unit types / Text / JQ
JQ
Description
This unit is a Processor unit type.
This unit queries a properly formatted JSON using the JQ JSON processor.
An event comes in through the in port. The data field content is queried using the JQ expression configured in the properties.
Successful input events are enriched with a new field containing the query result, and the event is output through the out port.
If an error occurs, the input event is enriched with new fields describing the problem, and the event is sent through the error port.
Configuration
After dragging this unit into the Flow canvas, double-click it to access its configuration options. The following table describes the configuration options of this unit:
| Tab | Field | Description |
|---|---|---|
General | Name | Enter a name for the unit. It must start with a letter, and cannot contain spaces. Only letters, numbers, and underscores are allowed. |
| Expression | A JQ valid expression that will determine the behavior of the unit. | |
| Result type | The type of the expected result. JSON stands for JSON String. Java stands for generic java types (Map, List, String, ...). | |
| In field | Enter the name of the input event field containing JSON data. | |
| Out field | Enter a name for the output event field containing the result. |
Input ports
| Port | Description |
|---|---|
| in | Input events. Events must contain a field to be parsed. |
Output ports
| Port | Description |
|---|---|
| out | Outputs successful Input events, enriched with an extra field containing the parse result. |
| error | Outputs input events enriched with standard error fields. |