Database Splitter

The Database Splitter is used to split database files into multiple data files that are passed to subsequent tasks in the process.

Input

Database data (see Database emulation).

Processing

The file is separated into multiple chunks according to the rules set in the task's properties.

Output

Multiple data files, sent one after the other to the rest of the tasks in the process. Metadata, job infos and user variables are not modified by this task.

Task properties

General Tab

  • Split group: Use this group to indicate how you want the file to be split.
  • Field value change: Select if you want the file to be split based on changes in the values of a selected database field (the value in the ClientID field changes, for example).
  • Field value condition: Select if you want the file to be split based on a condition set for the values of a selected database field (the value in the Order field equals 1, for example).
  • Field count: Select if you want the file to be split whenever a given number of pages or data pages has been reached.
    The following options are only displayed when the Field value change or the Field value condition option has been selected at the top of the dialog box.
  • Field: Enter the name of the field upon which to base the splitter condition. Note that you can use the popup menu's Get Data command to select the field and populate this box automatically.

    • The following options are only displayed when the Field value condition option has been selected at the top of the dialog box.

  • Operator: Select the condition to fulfill for the condition to be true and thus for the splitting process to take place.
  • Value: Enter the condition value. Note that you can use the popup menu's Get Data command to select the value and populate this box automatically
  • Match case: Select to force the splitter to match the character casing when resolving the Field value change or Field value condition. If this option is selected, a change from “DAY” to “Day” will be considered as a valid field value change, and “DAY” and “Day” will not be considered as equal values.
  • Where to split group: Options from this group are used to define a number of pages or records before or after which the file is to be split.
  • Pages or records: Enter the number of pages or records before or after which the file is to be split. Enter 0 if you want the file to be split right before or after the page or record that matches the set condition.
  • Before or after: Options from this list box are used to define exactly how the file is to be split. Select Records before if you want the file to be split a given number of records before the field that matches the set condition. Select Records after if you want the file to be split a given number of records after the field that matches the set condition. Select Pages before if you want the file to be split a given number of pages before the field that matches the set condition. Select Pages after if you want the file to be split a given number of pages after the field that matches the set condition.
  • Split when condition is found group: Use this group if you want the condition to be met a multiple number of times before splitting the file. Leave the default value of 1 in the Times box if you want to split the file every time the condition is met, but enter a value of 2, for example, if you want to split the file every second time the condition is met.
  • Time(s): Enter the number of times the condition must be met before the file is to be split.
    The following options are only displayed when the Field count option has been selected at the top of the dialog box.
  • Maximum records per file: Enter the maximum number of records to include in each file. Enter 0 for no limit.
  • Maximum pages per file: Enter the maximum number of pages to include in each file. Enter 0 for no limit.

On Error Tab

For a description of the options on the On Error tab see Using the On Error tab.

Miscellaneous Tab

The Miscellaneous tab is common to all tasks.

It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button and are displayed in The Task Comments Pane.

Check the option Use as step description to display the text next to the icon of the plugin in the Process area.

The tab also provides an option to highlight the task in The Process area with the default color, set in the Preferences (see Colors), or the color selected or defined under Highlight color on this tab.
To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon.