Extract Field Action

Extract a field from the message body.

The extract field action expects an application/json content type.

The field parameter allows you to specify which field of the json the user wants to extract. By default the message body will be overriden with the extracted field.

The optional parameter headerOutput allows the user to specify wheter the extracted field should be stored in a message header named 'CamelKameletsExtractFieldName', leaving the message body untouched.

The optional parameter headerOutputName allows the user to specify a custom header name instead of the default 'CamelKameletsExtractFieldName'. This parameter must be used in conjunction with headerOutput. If no headerOutputName parameter will be provided, the default 'CamelKameletsExtractFieldName' will be used.

The optional parameter strictHeaderCheck allows to user to enable a strict header name check. If enabled the action will check if the header output name (custom or default) has been used already in the exchange. If so, the extracted field will be stored in the message body, if not, the extracted field will be stored in the selected header (custom or default).

The headerOutput/headerOutputName/strictHeaderCheck parameters are particulary useful in case you would like to reuse an extracted field as parameter for another header, for example.

Metadata

Property	Value
Type	action
Group	Actions
Namespace	Transformation
Support Level	Stable
Provider	Apache Software Foundation

Properties

Name	Type	Required	Default	Description
`field`	string	✓		The name of the field to extract
`headerOutput`	boolean		`false`	If enable the action will store the extracted field in an header named CamelKameletsExtractFieldName
`headerOutputName`	string		`none`	A custom name for the header containing the extracted field
`strictHeaderCheck`	boolean		`false`	If enabled the action will check if the header output name (custom or default) has been used already in the exchange. If so, the extracted field will be stored in the message body, if not, the extracted field will be stored in the selected header (custom or default).
`trimField`	boolean		`false`	If enabled we return the Raw extracted field

Dependencies

camel:kamelet
camel:core
camel:jackson