Controlling when an Axiom query is refreshed

If enabled, the query will be refreshed when a user manually refreshes the sheet. For example, the user could click the Refresh button in the ribbon, or click a task pane item that is configured to perform a refresh, or press F9.

This option is enabled by default. If you disable this option, then the query will not refresh when a user manually refreshes the sheet. For example, you might disable this option if you have a query that you only want to run when the file is opened, and not during any subsequent manual refreshes.

NOTE: In plan files only, users cannot manually refresh Axiom queries unless they have the Run AQs in Plan Files permission. If you have a query that needs to be run in plan files, but you do not want to give users this permission, then you can enable Refresh on file open for the query.

If enabled, the query will be refreshed when the file is processed by a feature that includes performing a refresh, such as Process Plan Files, File Processing, or Process Document List. Some of these features, such as Process Plan Files, allow you to disable refreshing particular queries as part of that particular processing job. For other features, the query will always be refreshed if this option is enabled.

This option is enabled by default. If you disable this option, then the query will not be available to processing features that include performing a refresh.

If enabled, the query will be refreshed when the file is processed by the Scheduler task Process Template List. This option only applies to file group template files; it has no effect in any other file type.

When the query is processed by Process Template List, the Last refresh time of the query is updated in the template. This feature is intended to enable use of time-stamped Axiom queries in virtual plan files, by time-stamping the query in the template.

If enabled, the query will be refreshed automatically whenever the file is opened, whether by a user or by a system process (with one exception: Process Plan Files—see notes below). This setting is disabled by default.

When this setting is enabled, you can use the Open Without Refresh option if you need to open the file without running the Axiom query. This option is available to administrators from the right-click menu in Open Plan Files, Browse Reports Library, or Axiom Explorer.

NOTES:  

• If the file uses refresh forms (refresh variables or Axiom form as refresh form), the refresh form will only display on file open if you explicitly configure it to do so using the Refresh Forms Run Behavior setting on the Control Sheet.
• In plan files, queries configured to refresh on open are always run when the file is opened by a user, regardless of whether the user has the Run AQs in Plan Files security permission. This can be used if you have a query that needs to be run to enable functionality in the plan file (such as for a drop-down list), but you do not otherwise want users to be able to refresh Axiom queries.
• This setting is ignored by Process Plan Files. However, the query can still be selected for processing if it is also enabled to Refresh during document processing.
• For other system processes that include refreshing Axiom queries, such as File Processing and Process Document List, the query will be processed initially when the file is opened, and then also during processing (assuming Refresh during document processing is enabled). If you do not want the query to be processed twice in this situation, you can disable Refresh during document processing.

This option only applies when the file is processed using the multipass option of File Processing. If enabled, the query will be run once before multipass processing begins. If you do not want the query to also be run during each individual pass, then you should disable Refresh during document processing.

This option is disabled by default. You might enable this option if you have a query that needs to be run to bring an initial set of data into the file, but you don't want to set the query to refresh on open because the query is quite large and causes an unnecessary delay when opening the file for editing.