Batch Create Connector
Batch Create Connector
In CData Arc, data travels through flows as Messages that consist of a body and metadata headers. For example, if one connector passes a file to another, the file is transmitted as a Message that contains the file in the body and metadata about the file and associated connectors as headers. Messages can be grouped together in Batch Groups, which allow multiple messages to travel together as a single unit. Some uses for Batch Groups include moving data between systems and processing multiple purchase orders at once. When a Message is part of a Batch Group, it is referred to as a Batch Message.
The Batch Create connector produces Batch Groups based on Messages that arrive in the Send folder (the Input tab of the connector settings pane). When a Batch Group is created, it is passed down the flow through the Output tab, where it can be processed by other connectors as needed.
Note: The Batch Create connector can only accept individual messages as inputs. If the connector receives an existing Batch Group as an input, it throws an error message.
This section contains all of the configurable connector properties.
Settings that determine how the connector can be accessed.
- Connector Id The static, unique identifier for the connector.
- Connector Type Displays the connector name and a description of what it does.
- Connector Description An optional field to provide a free-form description of the connector and its role in the flow.
Settings that specify Batch Grouping options.
- Correlation Id Header The connector looks for headers that match the header name you enter, then groups messages according to the values they have assigned to that header. See Correlation Id Header Example for details.
- Max Batch Size The maximum number of messages to include in a Batch Group. Any messages in excess of this number wait until the next sending interval. For example, if this is set to 5, and seven messages arrive in the send folder, the connector creates one Batch Group of five messages and adds the final two to the next scheduled Batch Group.
- Min Batch Size The minimum number of messages that must be present to create a Batch Group. For example, if this is set to five, and three messages arrive in the Send folder, the connector does not create a Batch Group from those messages (even if the specified sending interval passes) until at least two more messages arrive.
- Save to Sent Folder Check this to copy files processed by the connector to the Sent folder for the connector.
- Sent Folder Scheme Instructs the connector to group messages in the Sent folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all messages for the week in that folder. The blank setting tells the connector to save all messages directly in the Sent folder. For connectors that process many messages, using subfolders helps keep messsages organized and improves performance.
- Log Level The verbosity of logs generated by the connector. When you request support, set this to Debug.
- Log Subfolder Scheme Instructs the connector to group files in the Logs folder according to the selected interval. For example, the Weekly option instructs the connector to create a new subfolder each week and store all logs for the week in that folder. The blank setting tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.
- Log Messages Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Input or Output tabs.
Miscellaneous settings are for specific use cases.
- Other Settings Enables you to configure hidden connector settings in a semicolon-separated list (for example,
setting1=value1;setting2=value2). Normal connector use cases and functionality should not require the use of these settings.
Settings related to the creation and sending of Batch Groups.
- Enable automation If selected, the connector automatically creates Batch Groups following the settings below. If cleared, the connector does not create Batch Groups until you manually trigger it.
- Send If selected, the connector automatically creates Batch Groups from messages as soon as they arrive in the Send folder (Input tab) as long as other set criteria are met.
- Scheduled Send If selected, the connector uses a scheduled interval to create Batch Groups from messages that arrive in the Send folder.
- Send Interval The interval at which to create Batch Groups. Only available if Scheduled Send is enabled.
- Minutes Past the Hour The minutes offset for an hourly schedule. Only applicable when the interval setting above is set to Hourly. For example, if this value is set to 5, the automation service downloads at 1:05, 2:05, 3:05, etc.
- Time The time of day that the attempt should occur. Only applicable when the interval setting above is set to Daily, Weekly, or Monthly.
- Day The day on which the attempt should occur. Only applicable when the interval setting above is set to Weekly or Monthly.
- Minutes The number of minutes to wait before attempting the download. Only applicable when the interval setting above is set to Minute.
- Cron Expression A five-position string representing a cron expression that determines when the attempt should occur. Only applicable when the interval setting above is set to Advanced.
Settings related to the allocation of resources to the connector.
- Max Workers The maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the Settings > Automation page.
- Max Files The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the Settings > Automation page.
Correlation Id Header Example
When you enter a header name in the Correlation Id Header field, the connector looks for headers that match the name you enter, then groups messages according to the values they have assigned to that header. For example, the following table displays six incoming messages:
If you enter Batch-Correlation-Id in the Correlation Id Header field, the connector creates three Batch Groups of these messages:
- The first batch group contains the messages with MessageId 1 and 2, since they both have the value
001for the Batch-Correlation-Id header.
- The second batch group contains messages with MessageId 3 and 4, since they both have the value
002for the header.
- The third batch group contains messages 5 and 6, since neither of them has the Batch-Correlation-Id header.