AX2248

Batch Control Sheet

The Batch Control Sheet defines settings for the batch action of file processing. Each row in the control sheet lists a file to be processed as part of the batch. If desired, you can list the same file multiple times, using different configuration settings.

NOTE: All files listed for batch processing must already be set up to use file processing. If a file is not set up to use file processing, an error will occur during processing.

Batch Control Sheets can only be added to a file that is enabled for file processing and where Batch has been specified as the processing type. When you initially select the processing type, you will be prompted to add a Batch Control Sheet to the file. You can subsequently add more control sheets to the file by using the Add batch sheet action in the File Processing pane.

When the batch processing is performed, only the control sheets listed in the file processing Sheets to Process will be processed.

To validate entries in the Batch Control Sheet, use the Validate batch configuration action in the File Processing pane.

The Batch Control Sheet is only visible to administrators and to users with the Allow File Processing permission to the file. Otherwise, it is hidden by default.

The following settings are defined for each file in the batch:

Item	Description
File Path	The folder location and file name of the file to be processed, including the file extension. The Reports Library is assumed as the file location and can be omitted from the file path (however, full paths can be used as well). However, if you want to process a non-report file, you must specify the full repository path. Only files in the Axiom Budgeting and Performance Reporting file system can be processed. For example: If the report is located in a subfolder of the Reports Library, specify the subfolder name and the file name. Do not place a slash before the folder name. MonthlyReports\IncomeStatement.xlsx If the report is located in the root of the Reports Library, specify only the file name. IncomeStatement.xlsx If you want to process a non-report file, specify the full repository path. \Axiom\File Groups\Budget 2021\Drivers\US_Drivers.xlsx. To look up a report file path, right-click and select Select Report. In the Select Report to Process dialog, navigate to the desired report and then click OK. The file path and report name is inserted into the cell.
Enabled	Specifies whether the file will be processed as part of the batch (On/Off). If blank, Off is assumed. You can use this setting to temporarily exclude files from a batch process, or to conditionally include files based on some other selection in the file (if the cell is set up to use an IF formula to return either On or Off).
Process Multipass	Optional. Specifies whether the file is processed using multipass processing. If On, then the file is processed using multipass processing. The file must have valid multipass settings defined, and/or you can define multipass settings within the Batch Control Sheet. If the processing type of the target file is Save Data in Batches, then only multipass processing is supported and this setting must be On. If Off or blank, then the file is processed using normal non-multipass processing. Any multipass settings in the file or in the Batch Control Sheet are ignored. If the processing type of the target file is Batch, then multipass processing does not apply and this setting must be Off.
Multipass Source Column	Optional. Specifies the source column for the multipass processing. For example: `DEPT.DEPT` to process the file once for each department. This setting only applies if Process Multipass is set to On. This setting must use Table.Column format to specify the column. If left blank, then the multipass process will use the source column settings defined in the report. IMPORTANT: This override is equivalent to specifying a source column in the multipass "basic" view, meaning that advanced settings such as the source table and the "group by" are automatically configured based on the source column. If the file to be processed uses advanced multipass settings (including additional source columns), then using the override may not return results as expected. For example, if the source report uses a data table as the source table, and you specify a batch override of DEPT.VP, then the source table will be changed to DEPT. If this does not meet your needs, you may be able to use batch variables instead to override specific multipass settings.
Multipass Data Filter	Optional. Specifies a filter for the multipass processing, to limit the items to be processed. This setting only applies if Process Multipass is set to On. For example, you could specify `DEPT > 5000` to only process departments greater than 5000, or `DEPT.Region='North'` to only process departments in the North region. If left blank, then the multipass process will use the source filter settings defined in the report.
Batch Variables	Optional. Specifies values for one or more batch variables, to be applied to the file during processing. Batch variables use the following syntax: VariableName=VariableValue The variable name must be defined in the source file, and the file must be set up to use the value in some way. When the batch is processed, the variable value defined in the Batch Control Sheet will be placed into the corresponding Variable Value cell within the source file, and then the file will be processed. You can list multiple variable name/value pairs, separated by semicolons. For example: VariableName1=Value1;VariableName2=Value2