AX1711
Scheduler task: Process Template List
This task processes a user-defined list of file group templates. During processing, any Axiom queries with Refresh during template processing enabled are executed and time-stamped, and then the template files are saved.
The primary purpose of this task is to enable use of time-stamped Axiom queries with virtual plan files. Because virtual plan files are re-created from template each time they are accessed, Axiom queries cannot be time-stamped within the plan files. Virtual plan files can use the time stamp from the template, but under normal circumstances, Axiom queries are not time-stamped when they are run in templates. However, when Axiom queries are run during template processing, the Last refresh time for the query is updated, which means that the queries can be configured to only run if the primary table has changed.
To use this task to enable time-stamped Axiom queries for virtual plan files, do the following:
- In the template, enable Refresh only if primary table changed since last refresh and Refresh during template processing for the Axiom queries that you want to be time-stamped.
- In Scheduler, create a job with a Process Template List task and add the template to the task. Define a scheduling rule for the job as appropriate. For example, you might want the template to be processed nightly.
When the template is processed, the designated Axiom queries will be run if the primary table has changed, and the time stamps are updated. When a virtual plan file that uses this template is opened, the queries will not be run again if the primary table has not changed.
This task should only be used to process Axiom queries that meet the requirements of time-stamped queries.
Templates to process
Specify the templates to be processed when the task is run. Templates are processed sequentially in the order listed. If you have multiple templates to process (in the same or different file groups), you can run them all in the same task.
|
|
To add a template, click the Add button. In the Axiom Explorer dialog, select the file or files that you want to add, and then click Open. |
|
|
To remove a template, select the file in the list and then click the Remove button. Only one file can be selected at a time. |
|
|
To change the order of templates, select the file in the list and then click the arrow buttons to move the file up or down. |
Normal template behavior rules apply during processing. For example, save-to-database and action codes are not run in templates. The only exception to normal template behavior during this task is that any executed Axiom queries will be time stamped.
Selecting a template using a file group alias
You may want to specify the template to process using a file group alias, so that the task does not have to be manually updated after rolling over to a new file group for a new year of planning. When you are selecting a template in the Axiom Explorer dialog, you can expand the file group alias node to see all of the files in the current target of the alias.
For example, in the following screenshot, the file group alias Current Budget is expanded. Because the alias currently points to the file group Budget 2018, the folders and files under the alias are from Budget 2018. When you select a file or folder, you can see the real file path in the top of Axiom Explorer.
Selecting a template to process using a file group alias
When you select a template underneath an alias, the file path is written using alias syntax, so that the Scheduler task will look for the template within the current target of the alias. This path is visible in the tooltip that displays when you hover your cursor over a selected template.
File path using file group alias syntax
When the file group alias is updated to point to a new file group, the Scheduler task will use the file in the new file group automatically. If the file does not exist in the new file group, the task will fail with an error.
