When executing a model in batch mode, generally one or more files or layers are processed with one or more batch parameter sets resulting in two or more output files or layers. Batch parameter sets are defined on a module's control panel and include all parameters that can be configured for one batch pass.
Each configurable module has a Batch Parameter Sets table, which is used to configure a module for batch mode. The Batch Parameter Sets table has the following properties:
- Each row of the table is a batch parameter set.
- The parameters displayed in the table can be edited from the tabs only; parameters cannot be edited from the table.
- The table can be hidden.
- The content of the active row in a table displays on the tabs.
- The values of only the active row can be applied by clicking the Run button (single execution mode) on the Modeler tool bar.
- Configuring the parameters on the tabs before displaying the Batch Parameter Sets table displays the parameter values in the Batch Parameter Sets table.
To facilitate populating the Batch Parameter Sets table, you can
- Select multiple rows or the whole table and then edit all parameters from the tabs so that all selected Batch Parameter Sets are identical.
- Click anywhere in a table row to display its contents on the tabs.
- For some modules, one or more of the following functions are available from the table by right-clicking a column heading:
- Auto-increment: increments a numeric or a text value that you have to enter. This option updates parameters for all cells in a selected column.
- Set Automatically: takes the parameter value from the input file or generates the parameter value from the system. This option updates parameter values for a selected cell or cells.
- Add Files: enables you to add multiple input or output files simultaneously. Selected files are appended to the table.
- From Input Module: loads the input files as output files. This function acts on all cells in a column and overwrites existing cell content.
- Change Directory: saves all selected output files simultaneously to the same directory.
- Add Prefix/Suffix: differentiates output files from other files by attaching a prefix, a suffix, a time stamp, or all three to the output file name. This option applies to all selected cells.
For examples of configuring modules for batch processing, see Common modules.