AX2251

Setting up a batch

Using batch processing, you can perform file processing on multiple files in batch. To set up batch processing, you must enable the file for file processing, and then complete one or more special Batch Control Sheets.

Enabling batch processing within a file

It is recommended to use a dedicated report file to hold the batch settings. Using a report file allows the file to be scheduled using Scheduler's File Processing task.

  1. Open or create a report to contain the batch settings. The report must first be enabled for file processing before you can configure the batch settings:

    • On the Axiom tab, in the File Output group, click File Processing > Enable File Processing in this workbook.

    The File Processing pane opens, and a sheet named Control_FileProcessing is added to the file.

  2. In the File Processing pane, for Processing Type, select Batch.

  3. A message box is displayed, asking if you want to add a batch sheet to the file. Click Yes.

    A Batch Control Sheet, named Batch, is added to the file. This sheet will hold the configuration settings for the batch processing.

Only one setting displays in the File Processing pane: Sheets to Process. By default, the Batch sheet is listed here. This means that when the file is processed, it will process all of the enabled files listed on the Batch Control Sheet.

If desired, you can add multiple Batch Control Sheets to the file, and process them in the same operation. In the File Processing pane:

  • To add more Batch Control Sheets to the file: In the Actions section, click Add batch sheet. If you are using multiple Batch Control Sheets, it is recommended to rename the sheets to something that indicates the purpose of each sheet.
  • To process multiple Batch Control Sheets: Click the Select worksheets icon to the right of the Sheets to Process box, and then select the desired sheets. Only Batch Control Sheets are eligible for processing.

No other file processing settings apply to batch processing. All information relating to the batch process is defined on the Batch Control Sheet.

Setting up the batch file list

Each row in the Batch Control Sheet represents a file that you want to process as part of the batch. For each file, you specify:

  • The folder path and name of the file. The Reports Library is assumed as the location unless a full repository path is specified.
  • Whether the report is enabled or not within the batch.
  • Whether the report is to be processed using multipass processing. If multipass processing applies, you can use the settings defined in the report or specify optional override settings.
  • If batch variables are defined in the report, you can specify values for the batch variables, to be used when the report is processed.

For more information on the batch settings, see Batch Control Sheet.

The files in the batch can run any file processing action. For example, the batch could contain several reports to be processed using snapshot, and then the last report in the batch could be a report that is set up for file collect.

Example Batch Control Sheet

Once you have set up the list of batch files, you can validate it using the Validate batch configuration action in the File Processing pane. The validation process checks for issues such as:

  • Invalid file paths or names
  • Invalid source column or data filter entries
  • Invalid batch variable entries

The validation process reports the first error that it finds in the list. Once you have corrected that error, run the validation again to ensure that no additional errors exist.

The validation process only checks rows where a file is listed and enabled for processing.