Skip to main content

​
Key Capabilities

  • Consolidates batch groups into a single unified message
  • XPath-based merging for XML content with configurable output headers
  • Flexible header handling (accumulate, keep same, or none)

​
Overview

The Batch Merge connector accepts a Batch Group that arrives in the Send folder (the Transactions tab of the connector settings pane) and merges the Batch Messages in the Batch Group into a single Message. The output Message passes down the flow through the Transactions tab, and it can be processed by other connectors as needed.
The Batch Merge connector can only accept Batch Groups as inputs. If the connector receives an individual message as an input, it throws an error message.

​
Connector Configuration

This section contains all of the configurable connector properties.

​
Settings Tab

​
Configuration

Settings that determine how the connector can be accessed.
SettingDescription
Connector IdThe static, unique identifier for the connector.
Connector TypeDisplays the connector name and a description of what it does.
Connector DescriptionAn optional field to provide a free-form description of the connector and its role in the flow.
XPathWhich repeated XML element to use when merging Batch Messages. See XPath Usage Example for more details.
Output HeadersDefines how headers should be transferred from input Batch Messages into the output Message. The options are:
None: Headers are not kept or merged
Accumulate: Headers from all batch messages are accumulated, which allows for duplicates or variations
KeepSame: Only headers that are the same across all batch messages are retained
Local File SchemeA scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see Macros.

​
Advanced Tab

​
Logging

​
Other Settings

SettingDescription
Processing DelayThe amount of time (in seconds) by which the processing of files placed in the Transactions tab is delayed. This is a legacy setting. Best practice is to use a File connector to manage local file systems instead of this setting.

​
Miscellaneous

​
Automation Tab

​
Automation Settings

SettingDescription
SendWhen checked, the connector automatically merges Batch Groups as soon as they arrive in the Send folder (the Transactions tab). If you uncheck this, you must manually instruct the connector to merge Batch Groups.

​
Performance

​
Alerts Tab

​
SLAs Tab

​
XPath Usage Example

The example below shows a simple XML tree of a Batch Message: 
<Orders>
    <Shipping>
        <Item>Paper</Item>
        <Quantity>100</Quantity>
        <Recurring>Yes</Recurring>
    </Shipping>
    <Shipping>
        <Item>Eraser Bulk</Item>
        <Quantity>20</Quantity>
        <Recurring>No</Recurring>
    </Shipping>
</Orders>
The example below shows a similar, separate Batch Message in the same Batch Group: 
<Orders>
    <Shipping>
        <Item>Pencil, Box 100</Item>
        <Quantity>10</Quantity>
        <Recurring>Yes</Recurring>
    </Shipping>
</Orders>
If you set the value for XPath to /Orders/Shipping, the output message would merge like this: 
<Orders>
    <Shipping>
        <Item>Paper</Item>
        <Quantity>100</Quantity>
        <Recurring>Yes</Recurring>
    </Shipping>
    <Shipping>
        <Item>Eraser Bulk</Item>
        <Quantity>20</Quantity>
        <Recurring>No</Recurring>
    </Shipping>
    <Shipping>
        <Item>Pencil, Box 100</Item>
        <Quantity>10</Quantity>
        <Recurring>Yes</Recurring>
    </Shipping>
</Orders>

​
Macros

​
Examples