AX2336

Overview of save types

Any managed Axiom file can be configured to save data to the database. Save settings are configured on a per sheet basis, on the Control Sheet.

Axiom Software supports several "save types" that can be used for different purposes:

Save Type 1: This is the most flexible save type, and is the one most likely to be used in templates/plan files and report files. To set up Save Type 1, you use tags within the sheet to establish a save-to-database control row and control column, and to determine what data is saved or deleted. The destination database table and columns must already exist in the database.
Save Type 3: This is a structured save type, used to create document reference tables for drivers or other data. Unlike Save Type 1, Save Type 3 creates the table in the database (if it does not already exist). The table is based on the sheet structure, and all edits are managed within the sheet. When a save is performed, the table is edited to match the current structure in the spreadsheet. If a row or column is deleted in the sheet, the corresponding row or column is removed from the table.
Save Type 4: This save type provides an alternate method for performing certain system administration tasks. For example, instead of creating or editing column aliases within the table editor, you can modify them from within a spreadsheet interface using Save Type 4. This save type is set up in a similar manner as Save Type 1, with a save-to-database control row and control column, but using different tags.

Axiom Software supports another save type, Save Type 2, which is the method used by the Open Table in Spreadsheet feature to view and edit data and reference tables within a spreadsheet interface. Save Type 2 is a highly structured save type that is only used for this system-managed editing, and cannot be used by other files in Axiom Software. For more information, see Viewing and editing tables using Open Table in Spreadsheet.

Security settings and saving data to the database

If a file is configured to save data to the database, a user's security settings impact whether that user can perform the data save:

For report files, driver files, and file group utilities, the option Allow Save Data must be enabled for the folder or for the specific file, on the Files tab of Security.
For plan files, the option Allow Save Data must be enabled in the plan file permission set for the file group, on the File Groups tab of Security. If process management (or workflow) is being used, then users without this option enabled may be automatically granted this permission for plan files where they are the current step owner.

Assuming the user has rights to perform the save within the file, the user must also have write rights to the target table, as defined on the Tables tab of Security.

Administrators do not need to be explicitly granted any permissions; they automatically have the necessary permissions to save data.

Comparison of save types

The following table summarizes the defining characteristics of each save type:

Save Type	Location of Database Codes	Target Table and Columns	Behavior to Delete and/or Zero Data
1	Anywhere; depends on placement of tags in the sheet. Typically used in templates/plan files and reports.	Target table and columns must already exist in the database. Can save to data tables or reference tables.	If Zero on Save enabled is On, data from the prior save is zeroed before performing the new save (based on the document ID or a custom save tag). Rows of data can be deleted by flagging the row for deletion instead of save.
3	Column A, and rows 1-3. Typically used in driver files.	The table and columns are created based on the sheet structure. Creates a document reference table.	The table and columns are re-created to match the spreadsheet data. If a row or column is deleted or zeroed in the spreadsheet, it is deleted or zeroed in the table.
4	Anywhere; depends on placement of tags in the sheet. Typically used in reports.	Modifies certain table structure settings and system settings.	Depends on the operation being performed. Zeroing does not apply to this process, but in some cases records can be deleted or restored to default values.

Save Type

Location of Database Codes

Target Table and Columns

Behavior to Delete and/or Zero Data

Anywhere; depends on placement of tags in the sheet.

Typically used in templates/plan files and reports.

Target table and columns must already exist in the database. Can save to data tables or reference tables.

If Zero on Save enabled is On, data from the prior save is zeroed before performing the new save (based on the document ID or a custom save tag).

Rows of data can be deleted by flagging the row for deletion instead of save.

Column A, and rows 1-3.

Typically used in driver files.

The table and columns are created based on the sheet structure. Creates a document reference table.

The table and columns are re-created to match the spreadsheet data. If a row or column is deleted or zeroed in the spreadsheet, it is deleted or zeroed in the table.

Anywhere; depends on placement of tags in the sheet.

Typically used in reports.

Modifies certain table structure settings and system settings.

Depends on the operation being performed. Zeroing does not apply to this process, but in some cases records can be deleted or restored to default values.

Note that blank rows and columns are permitted when using any save type. Blank rows and columns are skipped during the save process.

Save-to-database processing order

Each sheet in a file can have at least one enabled save type. If Save Type 3 is enabled for a sheet, then no other save types can be enabled for that sheet. Save Type 1 and Save Type 4 can both be enabled on the same sheet.

Sheets are processed in the order they are listed on the Control Sheet, from left to right. If both Save Type 1 and Save Type 4 are enabled for the same sheet, then Save Type 1 is processed before Save Type 4.

If Save Type 1 or Save Type 4 are enabled for a sheet, then that sheet can contain multiple save-to-database processes (Save2DB or SaveStructure2DB). Generally speaking, these tags are processed in the order they are found in the sheet, moving from left to right and top to bottom. It is also possible to specify an order for Save Type 1 tags in a sheet.