> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arc.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Split Connector
> Split a single XML file into multiple XML files using XPath-based rules, with support for batch grouping and wildcard element matching.
export const SlasTab = ({siteName = "CData Arc"}) => <>
Settings related to configuring Service Level Agreements (SLAs).
SLAs enable you to configure the volume you expect connectors in your flow to send or receive, and to set the time frame in which you expect that volume to be met. {siteName} sends emails to warn the user when an SLA is not met, and marks the SLA as At Risk, which means that if the SLA is not met soon, it will be marked as Violated. This gives the user an opportunity to step in and determine the reasons the SLA is not being met, and to take appropriate actions. If the SLA is still not met at the end of the at-risk time period, the SLA is marked as violated, and the user is notified again.
To define an SLA, toggle Expected Volume on, then click the Settings tab.
- If your connector has separate send and receive actions, use the radio buttons to specify which direction the SLA pertains to.
- In the Expect at least portion of the window:
- Set the minimum number of transactions you expect to be processed (the volume)
- Use the Every fields to specify the time frame
- Indicate when the SLA should go into effect. If you choose Starting on, complete the date and time fields.
- Check the boxes for the days of the week that you want the SLA to be in effect. Use the dropdown to choose Everyday if necessary.
- In the Set status to 'At Risk' portion of the window, specify when the SLA should be marked as at risk.
- By default, notifications are not sent until an SLA is in violation. To change that, check Send an 'At Risk' notification.
The following example shows an SLA configured for a connector that expects to receive 1000 files every day Monday-Friday. An at-risk notification is sent 1 hour before the end of the time period if the 1000 files have not been received.
You can turn off SLA alerts if necessary. This can be useful during maintenance windows. Click Settings on the navbar, then navigate to Alerts > General Alerts. Click the tablet and pencil icon to edit, and uncheck the SLA Alerts setting.
;
export const AlertsTab = ({siteNameShort = "Arc"}) => <>
Settings related to configuring alerts.
Before you can execute Service Level Agreements (SLAs), you need to set up email alerts for notifications. By default, {siteNameShort} uses the global settings on the Alerts tab. To use other settings for this connector, toggle Override global setting on.
By default, error alerts are enabled, which means that emails are sent whenever there is an error. To turn them off, uncheck the Enable checkbox.
Enter a Subject (mandatory). Check Allow {siteNameShort}Script in Subject to use {siteNameShort}Script in the Subject field. When you select this, the {siteNameShort}Script Editor button appears (
).
Optionally, enter a comma-separated list of Recipient emails.
;
export const MiscConnector = () => <>
Miscellaneous settings are for specific use cases.
| Setting |
Description |
| 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. |
;
export const Logging = () => <>
Settings that govern the creation and storage of logs.
| Setting |
Description |
| 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. The Weekly option (which is the default) instructs the connector to create a new subfolder each week and store all logs for the week in that folder. Leaving this setting blank 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 Transactions tab. |
;
export const MacrosExamples = ({extraMacros = []}) => <>
Some macros, such as %Ext% and %ShortDate%, do not require an argument, but others do. All
macros that take an argument use the following syntax: %Macro:argument%
Here are some examples of the macros that take an argument:
- %Header:headername%: Where
headername is the name of a header on a message.
- %Header:mycustomheader% resolves to the value of the
mycustomheader header set on the input message.
- %Header:ponum% resolves to the value of the
ponum header set on the input message.
- %RegexFilename:pattern%: Where
pattern is a regex pattern. For example, %RegexFilename:^([\w][A-Za-z]+)% matches and resolves to the first word in the filename and is case insensitive (test_file.xml resolves to test).
- %Vault:vaultitem%: Where
vaultitem is the name of an item in the vault. For example, %Vault:companyname% resolves to the value of the companyname item stored in the vault.
- %DateFormat:format%: Where
format is an accepted date format (see Sample Date Formats for details). For example, %DateFormat:yyyy-MM-dd-HH-mm-ss-fff% resolves to the date and timestamp on the file.
{extraMacros.filter(item => item.example).map(item => - {item.example}
)}
You can also create more sophisticated macros, as shown in the following examples:
- Combining multiple macros in one filename:
%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%
- Including text outside of the macro:
MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%
- Including text within the macro:
%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%
;
export const MacrosTable = ({siteName = "CData Arc", extraMacros = []}) => <>
Using macros in file naming strategies can enhance organizational efficiency and contextual
understanding of data. By incorporating macros into filenames, you can dynamically include
relevant information such as identifiers, timestamps, and header information, providing
valuable context to each file.
{siteName} supports these macros, which all use the following syntax: %Macro%.
| Macro | Description |
|---|
| ConnectorID | Evaluates to the ConnectorID of the connector. |
| ConnectorName | Evaluates to the name of the connector. Enables you to include the connection name in file names or paths: for example, to tag backup files by which database connection produced them. |
| Ext | Evaluates to the file extension of the file currently being processed by the connector. |
| Filename | Evaluates to the filename (extension included) of the file currently being processed by the connector. |
| FilenameNoExt | Evaluates to the filename (without the extension) of the file currently being processed by the connector. |
| MessageId | Evaluates to the MessageId of the message being output by the connector. |
| RegexFilename:pattern | Applies a RegEx pattern to the filename of the file currently being processed by the connector. |
| Header:headername | Evaluates to the value of a targeted header (headername) on the current message being processed by the connector. |
| LongDate | Evaluates to the current datetime of the system in long-handed format (for example, Wednesday, January 24, 2024). |
| ShortDate | Evaluates to the current datetime of the system in a yyyy-MM-dd format (for example, 2024-01-24). |
| DateFormat:format | Evaluates to the current datetime of the system in the specified format (format). See Sample Date Formats for the available datetime formats. |
| Vault:vaultitem | Evaluates to the value of the specified vault item. |
{extraMacros.map(item =>
| {item.name} |
{item.description} |
)}
;
export const Performance = () => <>
Settings related to the allocation of resources to the connector.
| Setting |
Description |
| 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 Performance Settings portion of the Advanced Settings 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 Performance Settings portion of the Advanced Settings page. |
;
export const siteNameShort = "Arc";
export const siteName = "CData Arc";
export const extraMacros = [{
name: "Counter",
description: "Used as a unique identifier for each output file from the split XML. The first output file uses `1` for this value, and each subsequent output file increments the value."
}];
The Split connector splits a single XML file into multiple XML files.
## Key Capabilities
* XPath-based XML file splitting for batch record separation into individual files
* Configurable batch grouping with wildcard XPath support for dynamic element matching
* Max records per file control for output file size management
## Overview
The Split connector is configured with an XPath upon which input XML files should be split into multiple output XML files. This is useful when an XML file contains a batch of data such as multiple orders, multiple line items, or multiple customer records. The Split connector splits this batched XML data into a separate XML file for each order, item, or record. See the [Split Examples](#split-examples) for more information.
## Connector Configuration
This section contains all of the configurable connector properties.
### Settings Tab
#### Configuration
*Settings related to the core operation of the connector.*
| Setting | Description |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **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. |
| **XPath** | The path in the XML structure to the element upon which the split should occur. Each unique occurrence of the specified XPath results in a unique output XML file. |
#### Advanced Settings
*Settings not included in the previous categories.*
| Setting | Description |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Batch Size** | Controls how many messages are put into a batch group. The default is 1, which means a batch group is not created. If you set it to a value less than 1, all messages are contained in a single batch group. If you set it to a value greater than 1, each batch group contains the number of messages indicated here. See the [Split Examples](#split-examples) for more information. |
| **Max Records** | The maximum number of records to include in a single output message. Use -1 to indicate that all output records should be put in a single file, and use 0 to indicate that the connector can decide based on the configured **Output File Format**. By default, XML outputs one record per file, and flat file formats include all records in one file. |
| **Local File Scheme** | A 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](#macros). |
### Advanced Tab
#### Logging
#### Other Settings
| Setting | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Processing Delay** | The 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](../flows/designing-a-flow#interacting-with-the-local-file-system) to manage local file systems instead of this setting. |
#### Miscellaneous
### Automation Tab
#### Automation
*Settings related to the automatic processing of files by the connector.*
| Setting | Description |
| -------- | ----------------------------------------------------------------------- |
| **Send** | Whether messages arriving at the connector are automatically processed. |
#### Performance
### Alerts Tab
### SLAs Tab
## Split Examples
Below is an example XML input file that contains multiple *TransactionSet* elements (in other words it contains a batch of transactions):
```xml theme={null}
1
value1
value2
value3
value4
```
The Split connector can split this input file into four separate output files, one for each *TransactionSet* element. To accomplish this, set the **XPath** field to the XPath to the *TransactionSet* element:
`/Items/Interchange/TransactionSet`
An output file for each *TransactionSet* would result. One example is shown below.
Output 1:
```xml theme={null}
1
value1
```
If you set **Batch Size** to 2, the connector outputs two batch groups, each with two messages. One example batch group is shown below.
Batch 1
Batch Message 1:
```xml theme={null}
1
value1
```
Batch Message 2:
```xml theme={null}
1
value2
```
## XPath Wildcards
The **XPath** can include a wildcard character (\*) to split on all elements at a given XPath. For example, the input XML might contain multiple groups of data that need to be split into separate files, but the groups of data have different element names:
```xml theme={null}
value1
value2
value3
```
Split these groups by setting the **XPath** to the following value:
`/Items/*`
The following three output files would result:
Output 1:
```xml theme={null}
value1
```
Output 2:
```xml theme={null}
value2
```
Output 3:
```xml theme={null}
value3
```
## Macros
### Examples