Header enricher

Header enricher

The Header Enricher is a service which can enrich the headers of a ConnectMessage or its individual Message Parts. This means you can change certain properties or create them.

In the table below, you will find an explanation of these properties. All attributes with a ‘*’ are mandatory.

Attribute

Description

Name*

By default, we fill this out with the technical ‘tag’, followed by a serial number. Changing the name is optional.

Enabled

Check this box if you want this service to be enabled.

MessagePart

Name of the MessagePart in a ConnectMessage where the content of the file is being stored.

Overwrite

Allow overwriting of existing headers.

Header

Here, you can change or create properties.

By pushing   , you can create one or more extra header property lines. The header properties are explained in the table below. You can also remove a header property by pressing the  button next to the header property you want to remove.

Description

Description of the specific service. This is for documentation purposes.

Header Selections

The functions are different based on the selection of the Header Function.

Add

 

In the table below, you will find an explanation about the properties of a Header. All attributes with a ‘*’ are mandatory.

Attribute

Description

Header name

Name of header to add. Use this field to define the header's name. When using Add, Move, XPath or Copy a new header with this name will be created.

Header function

Function to execute on header. You can choose between adding a header (add), deleting a header (delete), moving a header (move), copying a header (copy), performing an (xpath), (json) or (regex) query on the message or running a (script) to modify the header data. By default this is set to add.

Header value

Value of header to add. Use this field to define the header's value or use an XPath/JSON expression when Header function is set to (xpath) or (json).

Header value type

Type of the value of the Header. You can choose between String, Integer, Long, Boolean and Double. By default this is set to String.

Overwrite existing value

Specify whether the existing property has to be overwritten by choosing ‘true’ or ‘false’. By default the property will not be overwritten.

MessagePart-Out

Messagepart of the destination header. By default this is set to the ConnectMessage headers.

Delete

Attribute

Description

Header name

Name of header to Delete. Use this field to define the header's name. When using Delete the header with this name will be deleted.

Header function

Function to execute on header. You can choose between adding a header (add), deleting a header (delete), moving a header (move), copying a header (copy), performing an (xpath), (json) or (regex) query on the message or running a (script) to modify the header data. By default this is set to add.

MessagePart-Out

Messagepart of the destination header. By default this is set to the ConnectMessage headers.

Move

Attribute

Description

Header name

Name of header to move. Use this field to define the header's name. When using Move, a new header with this name will be created.

Header function

Function to execute on header. You can choose between adding a header (add), deleting a header (delete), moving a header (move), copying a header (copy), performing an (xpath), (json) or (regex) query on the message or running a (script) to modify the header data. By default this is set to add.

When using move, you have to define the source header name from where the value will be moved to header name.

Header value type

Type of the value of the Header. You can choose between String, Integer, Long, Boolean and Double. By default this is set to String.

Source Header Name

Name of the source header for move operations.

Overwrite existing value

Specify whether the existing property has to be overwritten by choosing ‘true’ or ‘false’. On default the property will not be overwritten.

MessagePart-In

Messagepart of the source header. By default this is set to the ConnectMessage headers.

MessagePart-Out

Messagepart of the destination header. By default this is set to the ConnectMessage headers.

Copy

Attribute

Description

Header name

Name of header to copy. Use this field to define the header's name. When using Copy a new header with this name will be created.

Header function

Function to execute on header. You can choose between adding a header (add), deleting a header (delete), moving a header (move), copying a header (copy), performing an (xpath), (json) or (regex) query on the message or running a (script) to modify the header data. By default this is set to add.

When using copy, you have to define the source header name from where the value will be copied to header name.

Header value type

Type of the value of the Header. You can choose between String, Integer, Long, Boolean and Double. By default this is set to String.

Source Header Name

Name of the source header for copy operations.

Overwrite existing value

Specify whether the existing property has to be overwritten by choosing ‘true’ or ‘false’. On default the property will not be overwritten.

MessagePart-In

Messagepart of the source header. By default this is set to the ConnectMessage headers.

MessagePart-Out

Messagepart of the destination header. By default this is set to the ConnectMessage headers.

XPath

Attribute

Description

Header name

Name of header to use XPATH on. Use this field to define the header's name. When using XPath a new header with this name will be created.

Header function

Function to execute on header. You can choose between adding a header (add), deleting a header (delete), moving a header (move), copying a header (copy), performing an (xpath), (json) or (regex) query on the message or running a (script) to modify the header data. By default this is set to add.

When using XPath you have to use the header value to define the XPath expression.

Header value

Type of the value of the Header. You can choose between String, Integer, Long, Boolean and Double. By default this is set to String.

Overwrite existing value.

Specify whether the existing property has to be overwritten by choosing ‘true’ or ‘false’. On default the property will not be overwritten.

MessagePart-In*

Messagepart containing the XML payload to perform XPath expression on. Required when using xpath.

MessagePart-Out

Messagepart of the destination header. By default this is set to the ConnectMessage headers.

JSON

Attribute

Description

Header name

Name of header to use JSON on. Use this field to define the header's name. When using JSON a new header with this name will be created.

Header function

Function to execute on header. You can choose between adding a header (add), deleting a header (delete), moving a header (move), copying a header (copy), performing an (xpath), (json) or (regex) query on the message or running a (script) to modify the header data. By default this is set to add.

When using JSON you have to use the header value to define the JSONPath expression.

Header value

Type of the value of the Header. You can choose between String, Integer, Long, Boolean and Double. By default this is set to String.

Overwrite existing value.

Specify whether the existing property has to be overwritten by choosing ‘true’ or ‘false’. On default the property will not be overwritten.

MessagePart-In*

Messagepart containing the JSON payload to perform JSONPath expression on. Required when using json.

MessagePart-Out

Messagepart of the destination header. By default this is set to the ConnectMessage headers.

Regex

Attribute

Description

Header name

Name of header to use Regex on. Use this field to define the header's name. When using Regex a new header with this name will be created.

Header function

Function to execute on header. You can choose between adding a header (add), deleting a header (delete), moving a header (move), copying a header (copy), performing an (xpath), (json) or (regex) query on the message or running a (script) to modify the header data. By default this is set to add.

When using Regex you have to use the header value to define the Regular expression.

Header value

Type of the value of the Header. You can choose between String, Integer, Long, Boolean and Double. By default this is set to String.

Overwrite existing value.

Specify whether the existing property has to be overwritten by choosing ‘true’ or ‘false’. On default the property will not be overwritten.

MessagePart-In*

Messagepart containing the Text payload to perform Regex expression on. Required when using regex.

MessagePart-Out

Messagepart of the destination header. By default this is set to the ConnectMessage headers.

Script

Attribute

Description

Header name

Name of header to modify/add. Use this field to define the header's name.

Header function

Function to execute on header. You can choose between adding a header (add), deleting a header (delete), moving a header (move), copying a header (copy), performing an (xpath), (json) or (regex) query on the message or running a (script) to modify the header data. By default this is set to add.

When using move or copy, you have to define the source header name from where the value will be copied or moved to header name. When using XPath you have to use the header value to define the XPath expression.

Header value type

Type of the value of the Header. You can choose between String, Integer, Long, Boolean and Double. By default this is set to java.lang.String.

Overwrite existing value

Specify whether the existing property has to be overwritten by choosing ‘true’ or ‘false’. On default the property will not be overwritten.

MessagePart-In

Messagepart of the source header. By default this is set to the ConnectMessage headers.

MessagePart-Out

Messagepart of the destination header. By default this is set to the ConnectMessage headers.

Reference to script

The reference to the script or bean you want to use to set the header value.