AX2342

Using Save Type 4

Save Type 4 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.

You can use Save Type 4 in any managed Axiom file, but it is most typically used in reports. Save Type 4 is configured on a per sheet basis. Each sheet can have multiple save processes.

To set up Save Type 4 for a sheet:

  1. On the Control Sheet, configure the following settings:

    • If the sheet is not already set up on the Control Sheet, enter the sheet name into one of the definition columns.
    • In the Save to Database Setup section, set Save Type 4 Enabled to On.

    NOTE: The save-to-database settings are protected on the Control Sheet. You must unprotect the sheet using Advanced > Protect > Worksheet before you can configure a save-to-database process.

  2. In the sheet, define the save-to-database control row and control column by placing the tag [SaveStructure2DB;TableName;CustomSaveTag=Name] in any cell within the first 500 rows of the sheet. The CustomSaveTag parameter is optional and can be omitted if you want to use the default save tags.

    The following table names are valid for SaveStructure2DB:

    Table Name Save Type 4 Behavior More Information

    Axiom.Aliases

    Create, edit, or delete column aliases

    Managing column aliases using Save Type 4

    Axiom.CalculatedFields

    		 Create, edit, or delete calculated fields

    Managing calculated fields using Save Type 4

    Axiom.Calculations

    Create, edit, or delete calculation types

    Managing calculation types using Save Type 4

    Axiom.Columns

    Create, edit, or delete table columns

    Managing columns using Save Type 4

    Axiom.ColumnSequences

    Create, edit, or delete column sequences

    Managing column sequences using Save Type 4

    Axiom.ColumnSequenceItems

    		 Create, edit, or delete column sequence items

    Managing column sequence items using Save Type 4

    Axiom.FileGroupAliases

    		 Create, edit, or delete file group aliases

    Managing file group aliases using Save Type 4

    Axiom.FileGroupVariables

    Create, edit, or delete file group variables

    Managing file group variables using Save Type 4

    Axiom.Notifications

    Update notification status (read / not read)

    Updating alert notification status using Save Type 4

    Axiom.Principals

    		 Create or edit users in security

    Managing users in Axiom Security using Save Type 4

    Axiom.ProcessActions

    Manage active tasks for a process

    Managing process tasks using Save Type 4

    Axiom.ProcessInstances

    Change the process initiator for a plan file

    Changing the process initiator using Save Type 4

    Axiom.Roles

    Create or edit roles in security

    Managing roles in Axiom Security using Save Type 4

    Axiom.SystemConfiguration

    Edit system configuration settings

    Editing system configuration settings using Save Type 4

    Axiom.Tables

    Create or edit tables

    Managing tables using Save Type 4

    The row containing the tag becomes the control row, and the column containing the tag becomes the control column.

  3. In the save-to-database control row, for each column to be saved, enter the target column name from the specified table.

  4. In the save-to-database control column, enter a row tag for each row that you want updated.

    The specific row tags depend on the table that you are saving to. All Save Type 4 processes support [Save] at a minimum; other tags may also be supported. See the individual topics on updating each table for more information.

    If no row tag is placed in this column, then the row will be ignored during the save-to-database process.

  5. If desired, set up a [SaveError] column to perform custom save validation on rows to be updated. For more information, see Using custom save validation.

If you want to use a Save Type 4 process to edit or update existing values, you can use an Axiom query to bring in the current set of values from the table, then modify the values in the sheet before saving back to the database. For more information, see Using an Axiom query to return system information.

How Save Type 4 blocks are processed

When a save-to-database is executed for a file, the Save Type 1 and Save Type 4 blocks are handled as part of the same process. Axiom Software locates all save blocks that are either Save Type 1 and Save Type 4 and triggers them for processing in order. For more information on how these save processes are ordered and executed, see Order of save block processing.

See also