Scheduler task: Web Report Processing

The web report to process for the task. Click the Browse button to open the Axiom Explorer dialog, and then select a report to process. You can select any template-based web report that you have access to within the Reports Library.

Only one report can be selected for each File Processing task. If you want to process multiple reports, you can add multiple File Processing tasks to the Scheduler job.

TIP: Once the file is selected, only the file name displays in the task. If you want to know the folder location of the selected file, hover your cursor over the field. The folder location is listed in the tooltip.

The maximum number of subordinate jobs to run in parallel. The default number is 4.

This is the total number of sub-jobs that can be run at the same time for this task. Ultimately the number of sub-jobs that are run in parallel depends on the number of Scheduler threads that have been configured for use at your organization, and the number of Scheduler threads that are currently available (threads that are not processing other higher-priority jobs).

Select one of the following to determine the output format of each pass:

• Export to Excel (default): The contents of the report are exported to a spreadsheet (XLSX) file. The output uses the same behavior as when you export to spreadsheet while viewing the web report. See Exporting grid data in a web report to Excel.
• Export to PDF: The report is saved as a PDF file. The output uses the same behavior as when you save to PDF while viewing the web report. See Exporting a PDF copy of a web report.

Select one of the following to determine the delivery method for the output:

• Save Files (default): The output files are saved to the specified output folder.
• Email Files: The output files are emailed to the specified recipients. The output files are not saved anywhere on the file system.
• Save and Email Files: The output files are both saved and emailed.

Select one of the following to determine whether the output is saved as a single file or multiple files:

• Multiple Output files (default): The results of each pass are saved as individual output files. For example, if the multipass settings result in 10 passes, then 10 output files are created (one file for each pass).

• Single Output File: The results of each pass are collected into a single output file. For example, if the multipass settings result in 10 passes, then the results of all 10 passes are placed in a single output file.

  If the output type is Excel, then each pass is a separate sheet in the Excel file. If the output type is PDF, then the PDF for each pass is combined into one large PDF file.

Specify how the output file (or files) should be named. You can do the following:

• You can use processing variables and/or Scheduler job variables to generate dynamic file names.

• You can type a "hard-coded" file name.

If the task will generate multiple output files, then the file name (or the output folder path) must use a processing variable so that the output of each pass is unique. If the task will generate a single output file, then variables are not required.

To use a processing variable, you can type the variable or you can click the pencil icon to open a text editor. From the Insert Variable list, select the variable that you want to use.

For example, you could set the file name to Income Statement [Current_Value]. If the report is being processed by region to multiple output files, this will generate file names such as Income Statement West, Income Statement East, and so on (where "East" and "West" are region names).

NOTE: Processing variables and Scheduler variables use different syntax. Processing variables are enclosed in square brackets. Scheduler job variables are enclosed in curly brackets.

Specifies whether column headers are included in the file output. By default this is set to On, which means column header text is included in the first row of the spreadsheet. Column grouping headers and multi-row headers are not included.

If this option is set to Off, then column headers are omitted from the file output and the data starts in the first row of the spreadsheet.

Select the orientation for the PDF, either Portrait or Landscape. Portrait is the default orientation.

Select one of the following:

• Local File System (default): The output location is outside of Axiom, to a location on your local network share. The specific path is detailed in the Output Folder setting. Access to output files is not controlled by Axiom.
• Axiom Repository: The output location is the Axiom file system, within the Reports Library. The specific path is detailed in the Output Folder setting. Access to output files is controlled by security access to the designated folder within Axiom.

Specify the folder location for the file output. You can type a folder path, or you can click the folder icon to browse to the folder location. The browse dialog will display either your local file system or the Axiom file system, depending on what you selected for Output To.

The output folder can be made dynamic as follows:

• If File Generation is set to Multiple Output Files, then processing variables can be used in the output folder path. For example, you can include [Current_Value] in the output folder path, and this will be replaced with the current multipass value. Processing variables are not valid in the output folder path if the task is configured to generate a single output file.

• Scheduler job variables can be used in the output folder path.

NOTE: Processing variables and Scheduler variables use different syntax. Processing variables are enclosed in square brackets. Scheduler job variables are enclosed in curly brackets.

Local file system

The output folder location must be entered as a UNC path, and must be accessible by the Scheduler service user account (for on-premise systems) or the Axiom Cloud Integration Service (for cloud systems). For more information, see Troubleshooting file access.

The ability to save files to the specified location and access them after saving is controlled by local network security.

Axiom repository

The specified location in the Axiom file system must be within the Reports Library, and the location must use the full path (meaning: \Axiom\Reports Library\...). The ability to save files to the specified location and to create new folders (if necessary) depends on the Axiom security permissions for the user processing the file. Users can only create new folders if they have read/write permissions to the parent folder, and they can only create new files if they have read/write permissions to the target folder.

Once the files are created within the Axiom file system, access to those files is dependent on the user's permissions to the output folder. Typically you should create the output folder in advance (or if you want to create output folders on-the-fly, create a parent folder to hold the output folders), and then set permissions for that folder as appropriate in Axiom security, so that the appropriate users will be able to access the files after they are created.

This option only applies when the file output is being saved to your local file system, and only for Axiom Cloud systems that are using remote data connections.

Select the name of the remote data connection to use for the file processing operation. The designated remote data connection will be used to access the local file system and save output file(s) to the designated location.

A remote data connection is required to save files locally from an Axiom Cloud system. For more information, see Managing remote data connections.

Optional. Specify a table column that holds the desired email recipients for each pass. This option only applies if File Generation is set to Multiple Output Files, so that each pass will be sent a separate email.

You can type the name of a table column, or click the column button to select a column from the multipass table or a lookup table. (You must select a multipass column first before you can use the column button to select a column.) For example, if the multipass column is Dept.VP, the recipient column might be Dept.VP.Email.

The specified column can contain any of the following: email addresses, user login names, and/or role names. The column can contain multiple values separated by a semicolon. The recipients listed in the column will be used as the To address for the email (in addition to any recipients listed directly in the To field). If the column contains a user login name, that user's email address as defined in security will be used. If the column contains a role name, the email will be sent to all users in the role.

To verify that the recipient column will resolve as you expect for each pass, you can click the Preview Multipass List button in the Multipass Data Settings section. The specified recipient column displays in this preview so that you can see the recipient column values associated with the multipass column values.

NOTE: The recipient column must have a one-to-one relationship with the values in the specified multipass column.

Specify the To recipient(s) for the email. This is required if a recipient column is not specified. If a recipient column is specified, the recipients listed here will be added to the recipients listed in the column for each pass.

You can type one or more email addresses, user login names, and/or role names. Separate multiple recipients with semicolons. If a user login name is listed, that user's email address as defined in security will be used. If a role name is listed, the email will be sent to all users in the role.

NOTE: If File Generation is set to Multiple Output Files, the recipients in the To field will receive a separate email for each pass. The only way to dynamically send the emails to different recipients per pass is to use the Recipient Column option.

Optional. Specify the CC recipient(s) for the email. This field follows the same rules as the To field.

Optional. Specify the BCC recipient(s) for the email. This field follows the same rules as the To field.

Select one of the following to specify the From address for the email:

• Current User: The email will be sent from the user who executes the Scheduler job.
• System User: The email will be sent from the designated From user for Scheduler. This is the same value returned by the {Scheduler.FromEmailAddress} job variable.

Enter the subject line for the email. Processing variables can be used in the subject line when File Generation is set to Multiple Output Files.

To use a processing variable, you can type the variable or you can click the pencil icon to open a text editor. From the Insert Variable list, select the variable that you want to use.

For example, you could set the subject line to Monthly report for [Current_Value] in order to include the current pass value in the subject line.

Specify the column to use for multipass processing. You can type a Table.Column name, or click the column icon to select the column from a dialog. You can select any column on a data or reference table, though typically processing is performed by a dimension such as Dept.Dept, or a grouping such as Dept.Region.

The report will be processed once for each unique value in the specified column (except for any values excluded by the Source Filter). A filter is applied to the data query in the report so that the data is limited to the current pass value. For example, if you are processing by Dept.Dept, then the report will be processed once for each department, and the report data will be limited to only the data for that department.

Keep in mind the difference between processing by a data table column such as GL2022.Dept, versus a dimension table column such as Dept.Dept. When processing by GL2022.Dept, the report will be processed by each department with data in the GL2022 table. When processing by Dept.Dept, the report will be processed by each department in the Dept table.

To verify the list of values for processing, click the Preview Multipass List button to view the list of items. The first 100 values are shown, in the order they will be processed. If the task configuration includes a Recipient Column (in the email settings) or a Sort By column, these columns are also shown in the preview.

Optional. Define a header to display in the report output file. This option only applies if the processing type is Export to PDF.

The current pass header should use processing variables to display information about the current pass. To use a processing variable, you can type the variable or you can click the pencil icon to open a text editor. From the Insert Variable list, select the variable that you want to use.

For example, you can define a header such as:

By default, if the current pass header is left blank, then the PDF output will not include a header to indicate the current pass information. However, it is possible that the template used to create the report may have been designed with a dynamic header that will display this information.

Optional. Specify one or more sort columns for the list of multipass values. You can type a Table.Column name, or click the column icon to select the column from a dialog. You can also optionally specify Asc or Desc after the column name (ascending order is used if not specified). For example: Dept.Dept Desc. Separate multiple values with semicolons.

By default, the values are sorted by the multipass column in ascending order. The Sort By field only needs to be used if you want the values to be sorted in descending order instead, or if you want the values sorted by a different column in the same table.

The processing order is only relevant when File Generation is set to Single Output File, since it determines the order of each individual pass within the single file. When outputting to Multiple Output Files, the order is still used during processing but it has no useful impact on the outcome.

This variable returns the current multipass processing value. For example, if you are processing by Dept.Dept, and the current pass is for department 20000, the variable will be replaced by the value "20000" for this pass.

This variable is typically used in settings such the file name, sheet name (when generating Excel output), and folder path.

This variable returns the current pass number. For example, if the current pass is number 20 of 35 passes, the variable will be replaced by the value "20" for this pass.