AX2558

Scheduler task: Collect Worksheets

This task collects sheets from multiple source workbooks and combines them into a single target workbook. You can then save the target workbook to a specified file location, and/or email the workbook.

NOTE: This task is primarily intended for backward-compatibility only. The main method of performing a file collect operation is to use the file processing feature with the File Processing Scheduler task. For more information on setting up a file collect report using file processing, see File collect.

Typically, this task would be used at the end of a job with multiple File Processing tasks, to take the results of those tasks and collect them into a single workbook.

Item Description
Save or Email Workbook

Specifies the delivery option for the target workbook. Select one of the following:

  • Save Workbook: The target workbook is saved to the specified output folder.
  • Email Workbook: The target workbook is emailed to the specified recipients. The file is not saved anywhere on the file system.
  • Save and Email Workbook: The target workbook is both saved and emailed.

Target Workbook

Complete the following settings to define the target workbook:

Item Description
Output Folder

The folder location where the target workbook will be saved (if you are saving the workbook). Click the folder icon to select a folder location, or type a folder location.

NOTE: The Output Folder location must be accessible by the Scheduler service user account. If you specify a network folder location using the Browse button, the location is automatically entered as a UNC path. If you specify a C: drive location, that location will be evaluated as the C: drive of the Scheduler server. For more information, see Troubleshooting file access.

If the specified folder does not already exist, Axiom Software attempts to create it.

Job variables can be used in this setting.
Output File Name The name of the target workbook. Job variables can be used in this setting.
File Type

The file type of the target workbook. Select XLS, XLSX, or XLSM.

NOTE: PDF displays as an option, but it is not supported in this context.

Email Settings

This section only applies if you are emailing the target workbook. The "From" address is always the Scheduler default From address (as defined in the system configuration settings).

Item Description
To

Enter the email addresses to receive the target workbook via email. Separate multiple addresses with a semicolon.
Subject Line The subject line for the email.
Body Text The body text for the email.

Source Workbooks

In this section, you specify one or more source workbooks from which to collect worksheets. Workbooks are identified by folder location. Within a folder location, you can specify one or more workbooks by name, or by using wildcards, or by using *.* to collect all workbooks at the location.

All sheets in each source workbook will be collected. Ideally, you will be collecting from workbooks that only contain relevant sheets (for example, no blank "Sheet2," etc.), and where the sheets have unique names. If multiple workbooks have sheets with the same name, the sheets will be incremented by number in the target workbook.

  

To add a workbook, click the Add button. In the Edit Workbooks Source dialog, complete the settings as described below, then click OK to add the workbook to the list.
 

To remove a workbook, select the workbook in the list and then click the Remove button. Only one workbook can be selected at a time.
 

To change the order of workbooks, select the workbook in the list and then click the arrow buttons to move the workbook up or down. Source workbooks are processed in the order they are listed in the grid.

Item Description
Folder Path

The folder location of the source workbook(s). Click the folder icon to select a folder location.

NOTE: The Folder Path location must be accessible by the Scheduler service user account. If you specify a network folder location using the Browse button, the location is automatically entered as a UNC path. If you specify a C: drive location, that will be evaluated as the C: drive of the Scheduler server.

Job variables can be used in this setting.
Workbooks

The workbooks from which you want to collect worksheets, within the specified folder path.

  • Specify *.* if you want to collect all files in the folder path.
  • Specify individual file names to collect from specific files. Separate multiple file names with semicolons.

You can use wildcards (* or ?) to specify groups of files that share naming conventions. For example: North*.xls to collect all XLS files where the file name starts with "North".

Only files with the following file types are valid to be collected: XLS, XLSX, XLSM. If you are using wildcards, the matches must be valid file types, or else the task will fail with an error.

Job variables can be used in this setting.

Once you have saved a source workbook location, you can edit it by double-clicking the row.