AX2243

File processing using Scheduler

Using the File Processing Scheduler task, you can schedule a report for processing. The report must already be configured for file processing in order to process it using Scheduler.

Once you have a Scheduler job set up, you can run it on demand, or you can schedule it for future execution. For example, you may have a set of reports that you want to run every week, every month, or every quarter.

Requirements and limitations

Note the following requirements when running file processing using Scheduler:

  • 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 file processing type is Print, the Scheduler server(s) must be configured to access the specified printer. This may require the assistance of your IT department.

Creating the Scheduler job

In order to create a Scheduler job, you must be an administrator or have the Scheduled Jobs User security permission. Non-admin users must also have read/write access to at least one folder in the Scheduler Jobs Library.

Scheduler jobs can only be created in the Desktop Client General term for using either the Excel Client or the Windows Client, both of which are installed to the user's desktop.. Although you can view the status of existing jobs in the Web Client, you cannot create new jobs in that environment.

To create a File Processing job in Scheduler:

  1. On the Axiom tab, in the Administration group, click Manage > Scheduler.

    Scheduler on default Axiom ribbon tab

    In systems with installed products, this feature may be located on the Admin tab. In the System Management group, click Scheduler.

    Scheduler on Admin tab (example product ribbon)

  2. In the Scheduler dialog, click New.

    A new job is opened in the dialog, with a tab name of New Job.

  3. Click Add > File Processing to add the task to the new job.

    The task is added to the job, and you can now configure the task properties.

  4. In the Task Details section, click Browse to select the File to Process.

    You can select any file that you have access to in the Reports Library, or in the Utilities folder of a file group. The file must already be enabled for file processing in order to be processed using Scheduler. If you select a file that is not enabled for file processing, the task will display a configuration error.

  5. If you want to process the file using multipass processing, make sure that Process File Multipass is selected. It is selected by default for most file processing files. However, if you do not want to perform multipass processing, then you should clear this option.

  6. If needed, you can override certain file processing settings defined in the file (including batch variables), so that the override value is used when the file is processed by Scheduler. In order to override a setting, select the Override check box for that setting and then enter the override value into the field.

    In the following example, the file type of the output file has been overridden and changed to PDF output for the Scheduler execution.

    When overriding values, Scheduler job variables can be used in fields that accept typed input. The following example shows a Scheduler job variable being used to set the value of a batch variable.

  7. Complete any other job or task properties as needed. For example, you may want to configure the following:

    • Scheduling Rules: You can create a scheduling rule to execute the job according to a predefined schedule. For more information, see Defining scheduling rules for a job.
    • Notification: You can edit the notification settings to send emails to designated recipients when the job executes successfully and/or when it errors. For more information, see Setting up notifications for jobs.

    For the remaining properties, in most cases the default settings are sufficient. To learn more about these settings, see Job properties and Task Control properties.

  8. Click Save. You can define a name for the job and save it to the desired location in the Scheduler Jobs Library.

Once the job is saved, you can run it as needed by clicking Run Once. If the job has a defined scheduling rule, then it will be automatically placed on the schedule for future execution according to that rule.