Control Sheet settings

Specifies whether Save Type 1 is enabled for the sheet (On/Off). Save Type 1 is a flexible save type typically used for templates/plan files and reports.

For more information, see Using Save Type 1.

Specifies whether unmatched data in the table is zeroed before saving, based on a zero tag.

In most cases, this should be set to On. However, the default setting is Off because the destination table must contain a manually created column to hold the zero tags. The name of this column depends on whether you are using the default save behavior (SaveTagDocID) or whether you are using a custom zero tag and column (SaveTagCustom, or a different custom name). The default behavior is used unless you set Disable DocID During Zero to On.

Once you have confirmed that the destination table contains the required column, you can enable this setting. All of the remaining Save Type 1 settings in this section only apply when this setting is On.

NOTE: If the Save Type 1 process is for an Axiom form (or for any file that is intended to be used as read-only with save data), then use caution before enabling the zero on save option. The data saved by an Axiom form is not persisted in the file, therefore the data saved by one user may be totally different than the data saved by another user, depending on the configuration of the Axiom form. If zero on save is enabled in this circumstance, the second user would zero the data saved by the first user.

For more information, see:

• How Save Type 1 works
• Using zero tags with Save Type 1

Specifies whether the default SaveTagDocID column is used when zeroing data on save. This setting only applies if Zero data on save enabled is set to On.

• If Off (the default), then the document ID is saved to the SaveTagDocID column when data is saved. This column must exist in the target table, or else an error will occur when saving.
• If On, then the default behavior is disabled. In this case, you must specify a ZeroTagValue for the save process, and you must either specify a CustomZeroTag Column, or use the default custom column of SaveTagCustom.

This setting does not have to be set to On in order to use a custom zero tag and column. If this setting is Off and a custom zero tag and column are defined, then both columns will be used.

NOTE: This setting can also be defined within the Save2DB tag for a particular save process. If it is defined there, then the Control Sheet setting is ignored.

For more information, see Using zero tags with Save Type 1.

Defines a custom zero tag for the zero process performed during a save-to-database.

If you use this option, then you must also define a CustomZeroTagColumn (or use the default custom column of SaveTagCustom).

NOTE: This setting can also be defined within the Save2DB tag for a particular save process. If it is defined there, then the Control Sheet setting is ignored.

For more information, see Using zero tags with Save Type 1.

Specifies whether Save Type 3 is enabled for the sheet (On/Off). Save Type 3 is a structured save type used for driver files. It can also be used in other Axiom files.

If Save Type 3 is enabled for a sheet, no other save types can be enabled for that sheet.

For more information, see Using Save Type 3.

Determines whether workbook protection is enabled or not.

• If enabled, workbook protection is applied when the file is opened, and users cannot add / remove sheets or hide / unhide sheets.
• If not enabled, workbook protection is not applied.

NOTE: Workbook protection is always applied to plan files, regardless of whether this setting is enabled or not.

For more information, see Configuring workbook protection for Axiom files.

Determines whether workbook protection is applied when a snapshot copy is taken. By default, this option uses a formula to inherit the setting for the “live file” option above.

For more information, see Applying protection to snapshot copies.

Determines whether the file is read-only, regardless of the user's security permissions to the file. By default, this is set to Off, meaning the user's security permissions determine the access level for the file.

This setting is evaluated after the file has been opened and all initial processing and calculations have occurred, including any Axiom queries set to refresh on open. If On, then the file is immediately converted to read-only and the user's lock on the file is released. The file tab is updated to reflect the read-only status. (If the file is already open read-only, then no additional action occurs.)

You might use this setting if you want to determine whether the file is editable based on something other than the user's security settings. For example, perhaps the file should not be editable at certain periods of the year; in this case you could use a formula to dynamically determine whether the file should be editable or not. This would be easier than manually changing security permissions at certain times of the year.

NOTES:  

• This setting should not be used to facilitate read-only, save-to-database reports. Instead, users should be explicitly granted read-only access to the file with Allow Save Data (in Security). If a user has read/write access with Allow Save Data, then the user can only save data from the file when it is opened as read/write. If the file is artificially downgraded to read-only, the read/write user cannot save data. The exception to this rule is when the file is restricted to read-only access because it is owned by an installed product package.

• This setting also applies to administrators. If this setting is enabled but an administrator needs to open the file with read/write permissions, use the Open Without Refresh feature. For more information, see Opening an Axiom file without refreshing data.

Determines whether users are prompted to save the file if the file is open read-only and changes are made to it.

• If Off (default), then users are prompted to save the file if changes are made to it. In this case the user must save the file as another name and/or in a different location in order to save the changes.

• If On, then users are not prompted to save the file if changes are made to it. This is intended for configurations where end users need to open the file and refresh the data coming into it, but they never need to save the file. The file is simply a vehicle to display data. In this case eliminating the unnecessary save prompt can improve the user experience.

This setting applies whenever the file is opened read-only. If the file is opened read/write, users are always prompted to save the file if changes are made.

These settings determine whether alerts are processed when a save-to-database is performed or when the document is saved. By default both settings are disabled (Off). You can choose to enable one or the other of these options, but not both. If both settings are enabled then only the save-to-database alert processing will occur.

To enable alert processing for either the save-to-database process or the document save, select one of the following options:

• Process: When alerts are processed, the normal alert processing results dialog is shown. This is typically only used when the alert author is testing the alert setup for the file.
• ProcessSilently: Alerts are processed silently in the background; the user performing the save will not be aware of the alert processing (unless, of course, the user receives an alert as a result of the processing). This is the intended setting for production-ready files.

If no alerts are defined in the document, then the alert processing is ignored and no error message is displayed.

For more information, see Processing alerts.

Specifies whether Axiom query batches are processed across sheets or per sheet. By default this setting is Off, which means that any batched Axiom queries are processed per sheet.

If set to On, then batched Axiom queries are processed across sheets. This means that queries from different sheets can be processed concurrently in the same batch.

For more information, see Batch processing for Axiom queries.

Specifies whether parallel processing for save-to-database is enabled. By default this setting is On, which means that save blocks in a file are processed concurrently instead of sequentially. This behavior automatically handles potential dependencies and waits for processes to complete as needed.

If set to Off, then save blocks are processed sequentially, one by one. This may impact performance in files with many save blocks, or with multiple save blocks that process many records.

For more information, see How Save Type 1 works.

Specifies a task pane to open automatically when this file is opened. The task pane cannot be closed, and will remain linked to this file (meaning it will show or hide depending on whether this file is the active file). When this file is closed, the task pane is automatically closed.

Specify the full path and file name to one of the following:

• A custom task pane file in the Task Panes Library (AXL file)
• A form-enabled file, where the form has been designed for use as a task pane

For example:

To easily obtain the full path for a file, navigate to that file in the Explorer task pane, then right-click and select Copy document path to clipboard. You can then paste the value into the cell.

Alternatively, you can use document shortcut syntax to specify the task pane file. When using a document shortcut, you can add a parameter to specify an alternate tab name for the task pane. If specified, this tab name will be used instead of the file name. For example:

To create the document shortcut syntax, take the normal file path and then add the text document:// to the front of it. To use the optional tab name parameter, append the text ?AxiomTabName=Name to the end of the shortcut.

The next time you open the document after saving, the entry will be automatically converted into a system-managed document shortcut (you can tell the difference by the presence of a _tid parameter on the end of the shortcut). If you need to change the entry to point to a different document, or to change the tab name, simply enter the path or document shortcut as you would have originally, and it will be converted again when you save the file.

For more information, see Associating a task pane with a particular file.

Specifies a sheet to set as the active sheet when the file is opened. Enter the name of any visible sheet in the file. This setting can be used so that the file always opens to the specified sheet, regardless of which sheet was active when the file was last saved. For more information, see Setting the active sheet and active cell.

Determines whether the Quick Filter feature is available for the report. By default this is set to Off, which means that Quick Filter is available.

If the report is not designed to be used with Quick Filter, then you can set this to On. The Quick Filter functionality will not be available when the report is active. For more information, see Setup considerations for using Quick Filter in a report.

Specifies one or more sheets in the file as a master sheet, so that end users can add new sheets on-the-fly by copying the designated master sheets. Separate multiple sheet names with commas.

This feature applies to all Axiom spreadsheet files except driver files. For more information, see Setting up master sheets.

Specifies whether the spreadsheet row and column headings are shown on each sheet in the workbook. This property can be set as follows:

• <Blank>: Row and column headings are visible if the file is opened read/write, and hidden if the file is opened read-only. This is the default setting.
• On: Row and column headings are visible when the file is opened.
• Off: Row and column headings are hidden when the file is opened.

This property only determines the starting point of the headings in the workbook. Users can toggle the headings on and off by using the Headings option on the Axiom ribbon tab.

For more information, see Configuring default display options for a sheet.

Specifies one or more data lookup queries to run when the file is opened, by listing the names of the DataLookup data sources. Separate multiple data source names with commas. Data sources will be executed in the order they are listed.

The list of data source names can be qualified with sheet names (such as Sheet1!Data) or unqualified (just Data). If qualified, then Axiom Software will only scan the listed sheets for the data sources. If unqualified, then Axiom Software must scan all sheets for the data sources, which can impact performance. All items in the list must be either qualified or unqualified. Mixing qualified and unqualified names will result in an error when the data sources are executed.

To run unnamed DataLookup data sources on open, use the keyword [unnamed] (either with a sheet name, or without to scan all sheets). The keyword can be used by itself or as part of the comma-separated list of names.

For more information, see Data lookups.

Specifies whether the message stream is enabled for the file, so that users can view comments and add comments about the file.

• If set to On, the Message Stream task pane will be available when the file is opened in the Desktop ClientGeneral term for using either the Excel Client or the Windows Client, both of which are installed to the user's desktop., and the Message Stream panel will be available when the file is opened in the Web Client (for form-enabled files).

• If set to Off, the message stream will not be available for the file. Users cannot view or add comments.

If comments already exist when the message stream is disabled, they will be retained in the database. If the message stream is re-enabled, the comments will be available again.

For more information on how users view and make comments, see Commenting on documents using the Message Stream task pane.

This setting is enabled by default for all new files created in version 2016.1 or later. For existing files created prior to version 2016.1, the setting is not present and treated as disabled. When you upgrade the Control Sheet of these older files, the setting will be migrated as blank and treated as disabled. You must explicitly turn the setting On after upgrading the Control Sheet, if you want the message stream to be available for these older files.

Specifies whether data lookup queries are cleared when the file is saved. By default, this is set to Off, which means that any results that are present in the file when it is saved will be retained.

This feature is intended for data security. If data lookups are not configured to automatically run when the file is opened, then the data queried and saved by one user will still be present when another user opens the file. This may result in users seeing data outside of their data filter, because the data will not update until the data lookups are executed.

If this option is set to On, then the result column for all DataLookup data sources will be cleared when the file is saved. This means that users will not see this data until the data lookups are executed.

This setting is primarily intended for reports.

Specifies whether the Control Sheet is hidden for all users when the file is opened. By default, this is set to Off, which means the user's security permissions determine whether the Control Sheet is hidden by default. If the user is an administrator or has the Sheet Assistant permission, then the Control Sheet is visible by default, otherwise it is hidden.

If set to On, the Control Sheet is hidden by default for all users.

For more information, see Viewing the Control Sheet.

Defines a data context name, for use by Axiom forms to control data saves. If a name is defined, then only one user at a time can "lock" the data context and save data from the form. For more information, see Enabling save locks for Axiom forms.

This option has no effect on spreadsheet Axiom files; it only applies to form-enabled files and only when the file is opened as a form.

Defines an optional description for the data context, if a data context is defined. The description is displayed on the Save Lock dialog within the Axiom form.

Specifies the visibility settings for the sheet. Available options are:

• Visible – The sheet is visible to all users.
• Hidden – The sheet is hidden by default.

Sheet visibility settings are applied when the file is opened. For more information, see Configuring sheet visibility for Axiom files.

Determines whether sheet protection is enabled or not.

• If enabled, sheet protection is applied when the file is opened, and users are restricted to making edits in unprotected cells.
• If not enabled, sheet protection is not applied (however, any existing protection is not removed).

For more information, see Configuring worksheet protection for Axiom files.

Determines whether worksheet protection is applied when a snapshot copy is taken. By default, this option uses a formula to inherit the setting for the “live file” option above.

For more information, see Applying protection to snapshot copies.

Defines the freeze panes settings for the sheet, using the following syntax:

For example, A1:H13 would freeze rows 1 through 12 and columns A through G.

Freeze panes settings are applied when the file is first opened, and then reapplied after applying a view. For more information, see Configuring default display options for a sheet.

Specifies the active cell on the sheet when the file is first opened. The sheet will be scrolled so that the specified cell is at the upper-left of the sheet, within the boundary of the freeze panes.

NOTE: If an Initial Dynamic View is specified for the sheet, and that view has an active cell defined, that cell will be the active cell instead of the cell specified here.

Specifies whether special Axiom double-click actions are enabled for the sheet:

• If enabled, then when you double-click a cell in the sheet, the appropriate Axiom double-click action will be performed (for example, drilling the data or opening a calc method form). If multiple double-click actions could apply to the cell, the highest-priority action is performed.

• If disabled (default), then no special Axiom double-click actions will apply to the sheet.

For more information, see Double-click behavior.

Specifies whether drilling is enabled for the sheet:

• If On (default), then the Drill button on the ribbon is active when this sheet is active. Double-click drilling, if enabled, is also available for the sheet.

• If Off, then the Drill button on the ribbon is disabled when this sheet is active, regardless of whether drillable content exists on the sheet. Double-click drilling is also prevented.

For more information, see Disabling drilling for a sheet.

Displays the name of the master sheet that was used to create this sheet. This field is system-managed; Axiom Software places the appropriate sheet name here when the sheet is inserted into the file using the Add New Sheet command.

For more information, see Setting up master sheets.

Specifies whether gridlines are visible in the sheet by default:

• <Blank>: Gridlines are left as is when the file is opened. The visibility of gridlines is controlled by Excel functionality.
• On: Gridlines are visible when the file is opened.
• Off: Gridlines are hidden when the file is opened.

For more information, see Configuring default display options for a sheet.

Specifies a default sheet view for the sheet. Only a single sheet view name can be specified.

This sheet view is applied when the sheet is first made active after the file is opened.

For more information, see Defining sheet views for a sheet and Setting the default views for a sheet.

Specifies one or more default column views for the sheet. Multiple column view names can be specified, separated by commas.

The column views are applied when the sheet is first made active after the file is opened.

For more information, see Defining column views in a sheet and Setting the default views for a sheet.

Specifies one or more default row views for the sheet. Multiple row view names can be specified, separated by commas.

The row views are applied when the sheet is first made active after the file is opened.

For more information, see Defining row views in a sheet and Setting the default views for a sheet.

Displays the name of the currently active sheet view (if applicable).

This field is system-managed, and is used to re-apply the sheet view after certain activities performed in the sheet (such as running an Axiom query). If you input any text in this cell, it will be overwritten the next time a view is applied.

Displays the names of the currently active column views (if applicable). Multiple column view names are separated by commas.

This field is system-managed, and is used to re-apply the column views after certain activities performed in the sheet (such as running an Axiom query). If you input any text in this cell, it will be overwritten the next time a column view is applied.

Determines whether Axiom functions are refreshed when the file is opened. The default setting is On. This setting applies to all sheets in the file.

Axiom functions such as GetData are non-volatile, and therefore do not refresh automatically—they refresh only on demand, or in response to a change in a dependent cell. If this option is set to Off, then the functions will not be refreshed until the user explicitly refreshes the file.

For templates/plan files, this option should always be On to ensure that driver references are updated when users open plan files. Note that the Process Plan Files utility refreshes all functions regardless of this setting.

This option does not affect Axiom queries. If you want an Axiom query to refresh when the file is opened, you must enable Refresh data on file open for the query. However if an Axiom query is set to refresh on open, this process will also refresh the Axiom functions.

Determines whether Axiom function results are converted to zero when the file is saved. The default setting is Off. This setting applies to all sheets in the file.

This feature is intended for data security. If the file is not configured to refresh data when the file is opened, then the data queried and saved by one user will still be visible when another user opens the file. This may result in users seeing data outside of their data filter, because the functions will not update until the user explicitly refreshes the file.

If this option is set to On, then users will see zeros in Axiom functions when they first open the file, and they must refresh the file to see data. This setting is primarily intended for reports.

NOTE: If this option and Convert Axiom Query results to zero on save are both enabled, and the file has Axiom queries that are configured to Refresh after save data, then the functions will save as zero but then immediately calculate after the save when the queries are refreshed.

Specifies when refresh forms are presented to the user, if the file is configured to display a refresh dialog (using either refresh variables or an Axiom form). This setting applies to all sheets in the file. Available options are:

• Off: The refresh dialog is disabled and does not display when the file is refreshed.

• OnManualRefreshOnly (default): The refresh dialog only displays when the file is manually refreshed (by clicking Refresh).

• OnOpenOnly: The refresh dialog only displays when the file is refreshed on open. This occurs if an Axiom query is set to Refresh data on file open, or if the workbook is set to Refresh all Axiom functions on open.

• OnManualRefreshAndOpen: The refresh dialog displays when the file is refreshed on open, and when the file is manually refreshed.

The refresh dialog is always disabled when the file is refreshed by an automated process, such as Process Plan Files, File Processing, or by any Scheduler task that opens and refreshes the file.

For more information, see Setting up refresh dialogs for Axiom files.

Specifies whether Axiom query data is zeroed when the file is saved. The default setting is Off. This setting is configured on a per sheet basis and applies to all Axiom queries on the sheet.

This feature is intended for data security within reports. If an Axiom query is not set to refresh on open, then the data queried and saved by one user will still be visible when another user opens the file. This may result in users seeing data outside of their data filter, because the query will not update until the user explicitly refreshes the file.

If this option is set to On, then when the file is saved, all Axiom queries in the sheet are zeroed as follows (depending on the refresh behavior for the query):

• If the query is set to rebuild, then all rows in the query are deleted, and the data ranges are collapsed.
• If the query is set to update and/or insert, and zero on update is not enabled, then no action occurs. The rows in the data ranges are left as is.
• If the query is set to update and/or insert, and zero on update is enabled, then the existing rows are left in the data range, but the data values are zeroed. For more information on which columns are zeroed, see the discussion on zero behavior in Specifying how data is refreshed in an Axiom query.

Specifies whether all AQ data range filtersFilters applied to Axiom query tags, to limit the data brought into that data range. Filters are placed within the tags, delimited by a semi-colon -- for example, [AQ1;dept.region='west']. are sent to the server for parsing as part of the query to the database, or just the first data range filter. This helps determine the data to be returned by the query.

• By default this is set to Off, which means that only the first data range filter is sent to the server. In the majority of cases, this is sufficient to ensure that the data returned by the data query will be compatible with all data range filters in the report.

• If On, then all data range filters for the query are sent to the server. This may be necessary in cases where the data range filters specify very different sets of data. Enabling this option will increase the complexity of the data query statement and therefore may slow report performance. It is not recommended to enable this option unless it is necessary for the data query. Contact Axiom Software Support if you need assistance determining whether this option should be enabled.

Specifies whether the filter is for a specific table or a table type. Select By Table or By Table Type.

If the filter type is By Table, specifies the table to be filtered.

If the filter type is By Table Type, specifies the table type to be filtered.