On this page
AX2458
Axiom Software file system
The Axiom Software file system is a virtual folder directory that is provided to logically organize the documents in the Axiom Software database, and make it easier to locate and manage these documents.
Axiom folders
The following table details each folder in the file system (using the folder display names in Axiom Explorer), with a brief description of its contents and how it is used. The system folder name is an internal name that should be used when referencing Axiom file paths in non-English systems (such when listing file paths in the GetDocument function).
Folders are listed in the order they are displayed in Axiom Explorer. Subfolders are indicated with "\" in front of the folder name.
Folder Name | Description | System Folder Name |
---|---|---|
File Groups |
Contains all of the files in your file groups. This folder contains a sub-folder for each file group. |
SystemFolderName_ |
\FileGroupName |
Contains the files for a specific, user-defined file group. Each file group defined in the system has its own folder. |
N/A |
\\Calc Method Libraries |
Contains the calc method libraries for the file group. |
SystemFolderName_ |
\\Drivers |
Contains the driver files for a file group. |
SystemFolderName_ |
\\Plan File Attachments |
Contains the supporting file attachments for plan files in a file group. | SystemFolderName_ PlanFileAttachments |
\\Plan Files |
Contains the individual plan files for a file group. |
SystemFolderName_ |
\\Process Definitions |
Contains the process definitions for a file group |
SystemFolderName_ |
\\Templates |
Contains the plan file templates for a file group. |
SystemFolderName_ |
\\Utilities |
Contains the utilities for a file group. |
SystemFolderName_ Utilities |
\\Workflow |
Contains the workflow definitions for a file group. |
SystemFolderName_ |
Libraries |
Contains the file libraries for Axiom Software. This is not a literal folder; it displays for organizational purposes in Axiom Explorer. |
N/A |
Reports Library |
Contains the reports created in your system. You can create multiple sub-folders as needed to organize your reports, and control access to these files and folders in Security. |
SystemFolderName_ Any user-defined subfolders can be referenced by the name as it appears in Axiom Explorer. |
Table Library |
Contains the user-defined tables created in your system. You can create multiple sub-folders as needed to organize your tables. |
SystemFolderName_ Tables cannot be opened using GetDocument. |
Data Diagrams Library |
Contains the data diagrams created in your system. You can create multiple sub-folders as needed to organize your diagrams, and control access to these files and folders in Security. |
SystemFolderName_ Any user-defined subfolders can be referenced by the name as it appears in Axiom Explorer. |
Filter Library |
Contains the filter criteria statements created in your system. You can create multiple sub-folders as needed to organize your diagrams, and control access to these files and folders in Security. |
SystemFolderName_ Any user-defined subfolders can be referenced by the name as it appears in Axiom Explorer. |
Task Panes Library |
Contains the task panes created in your system. You can create multiple sub-folders as needed to organize your task panes, and control access to these files and folders in Security. |
SystemFolderName_ Any user-defined subfolders can be referenced by the name as it appears in Axiom Explorer. |
Ribbon Tabs Library |
Contains the ribbon tabs created in your system. You can create multiple sub-folders as needed to organize your ribbon tabs, and control access to these files and folders in Security. |
SystemFolderName_ Any user-defined subfolders can be referenced by the name as it appears in Axiom Explorer. |
Process Definition Library | Contains process definitions created in your system. You can create multiple sub-folders as needed to organize your definitions, and control access to these files and folders in Security. |
SystemFolderName_ Any user-defined subfolders can be referenced by the name as it appears in Axiom Explorer. |
Scheduler Jobs Library |
Contains the scheduler jobs created in your system. You can create multiple sub-folders as needed to organize your jobs, and control access to these files and folders in Security. |
SystemFolderName_ Any user-defined subfolders can be referenced by the name as it appears in Axiom Explorer. |
Imports Library |
Contains the imports created in your system. You can create multiple sub-folders as needed to organize your imports, and control access to these files and folders in Security. |
SystemFolderName_ Any user-defined subfolders can be referenced by the name as it appears in Axiom Explorer. |
Exports Library |
Contains the exports created in your system. You can create multiple sub-folders as needed to organize your exports, and control access to these files and folders in Security. |
SystemFolderName_ Any user-defined subfolders can be referenced by the name as it appears in Axiom Explorer. |
Axiom System |
Contains system files for Axiom Software. |
SystemFolderName_ |
\Diagnostics |
Can be used to hold supporting files for custom diagnostics tests. | SystemFolderName_ Diagnostics |
\Document Templates |
Contains default files used throughout the system. When a new file is created in Axiom Software, the appropriate document template is used to create the new file. The Control Sheet templates are updated by default when upgrading a system database. Most other templates can be optionally updated at any time by using the Software Manager. See Updating document templates. |
SystemFolderName_ |
\\Calc Method Library |
Contains the default file for calc method libraries. |
SystemFolderName_ |
\\Control Sheet |
Contains the default Control Sheets. |
SystemFolderName_ |
\\\Alert |
Contains the default Alert Control Sheet. This sheet can be added to a file to enable alerts. |
SystemFolderName_ |
\\\Batch |
Contains the default Batch Control Sheet. This sheet can be added to a file to enable Batch processing. |
SystemFolderName_ |
\\\Default |
Contains the default Control Sheet. This is the base Control Sheet that defines a spreadsheet file as an Axiom file. |
SystemFolderName_ |
\\\Drilling |
Contains the default Drilling Control Sheet. This sheet can be added to a file to enable drilling. |
SystemFolderName_ |
\\\File Collect |
Contains the default File Collect Control Sheet. This sheet can be added to a file to enable File Collect processing. |
SystemFolderName_ |
\\\File Processing |
Contains the default File Processing Control Sheet. This sheet can be added to a file to enable file processing. |
SystemFolderName_ |
\\Drivers |
Contains the default file for driver files. This folder can contain multiple files. Administrators can save additional driver templates to this folder, and users will be able to select which template to use when they create a new driver. |
SystemFolderName_ |
\\Empty Workbooks |
Contains blank workbooks used by Axiom Software processes that create spreadsheet files. |
SystemFolderName_ |
\\Forms |
Administrators can optionally save form-enabled report templates to this folder. If one file exists in this folder, it is used as the default form template. If multiple files exist in this folder, users will be able to select which template to use when they create a new form-enabled report. |
SystemFolderName_ |
\\File Group Templates |
Contains the default file for plan file templates. |
SystemFolderName_ |
\\Report Builder |
Contains templates for use in the Web Client Report Builder |
SystemFolderName_ |
\\Reports |
Contains the default file for report files. This folder can contain multiple files. Administrators can save additional report templates to this folder, and users will be able to select which template to use when they create a new report. |
SystemFolderName_ |
\\Sample Ribbon Tabs |
Contains the built-in ribbon tabs delivered with Axiom Software. If you want to use one of these ribbon tabs, copy it over to your Ribbon Tabs Library and then modify it as needed. The ribbon tabs in this folder are system controlled and may be overwritten on future upgrades. |
SystemFolderName_ RibbonListSamples |
\\Sample Task Panes |
Contains the built-in task panes delivered with Axiom Software. If you want to use one of these task panes, copy it over to your Task Panes Library and then modify it as needed. The task panes in this folder are system controlled and may be overwritten on future upgrades. |
SystemFolderName_ SampleLists |
\\Support Utilities |
Contains templates for support utilities, such as a Save Type 4 report to change the system configuration settings. |
SystemFolderName_ |
\\Utilities |
Contains the default file for file group utilities. |
SystemFolderName_ |
\Forms Runtime |
Contains files to support display of Axiom forms. |
SystemFolderName_ |
\GEO Feature Files |
Contains example GeoJSON files that can be used with Map View components in Axiom forms. |
SystemFolderName_ |
\Package Manager |
Contains supporting files relating to licensed product packages. |
SystemFolderName_ PackageManager |
\\Post Package Processing |
Contains any files to be used after installing a product package. Only applies to installations with licensed product packages. |
SystemFolderName_ |
\Process History |
Contains historical process definitions to support viewing process history. These files are system-managed. They are automatically created when a process instance is aborted or completed, and they are automatically deleted when the corresponding process history instance is deleted. | SystemFolderName_ ProcessHistory |
\Scheduler Working Folder |
Contains system files used by Scheduler, such as system event handlers and system-managed jobs. |
SystemFolderName_ |
\Startup |
Contains files that are launched at system startup. Separate folders are maintained for the Excel Client and the Windows Client. |
|
\\Excel Startup |
Any files placed in this folder are opened when the Excel Client is started. |
SystemFolderName_ |
\\Hidden |
Any files placed in this folder are opened and hidden at system startup. Separate sub-folders are maintained for the Excel Client and the Windows Client. The Hidden folder is primarily used to support custom solutions. Please contact Axiom Software support if you have any questions about files in this folder. |
SystemFolderName_ |
\\\Excel Client |
Any files placed in this folder are opened and hidden when the Excel Client is started. |
SystemFolderName_ |
\\\Windows Client |
Any files placed in this folder are opened and hidden when the Windows Client is started. |
SystemFolderName_ |
\\Home |
Contains the default Home file. This file can be customized for a system. You can also create separate versions for the various Axiom Clients by copying the Home file (or a different report file) into the sub-folders. |
SystemFolderName_ |
\\\Web Client |
If a form-enabled file is placed here, this file will be used as the default Home Page file for the Web Client. |
SystemFolderName_ |
\\\Excel Client |
If a file is placed here, this file will be used as the default Home Page file for the Excel Client. |
SystemFolderName_ |
\\\Windows Client |
If a file is placed here, this file will be used as the default Home Page file for the Windows Client. |
SystemFolderName_ |
\\Windows Startup |
Any files placed in this folder are opened when the Windows Client is started. |
SystemFolderName_ |
\User Folders |
Contains the Favorites and My Documents for each user in the system. This folder only displays when using the Axiom Explorer dialog; it does not display in the Explorer task pane. |
SystemFolderName_ The folder name of each subfolder is the user ID of the relevant user. |
Axiom file types
The file type for Axiom spreadsheet files (reports/utilities, plan files/templates, drivers) is either XLSX or XLSM, depending on the file type of the corresponding default template. Prior to version 4.4, the default templates were in XLSM format. New systems created in version 4.4 or later use the XLSX format. If desired, you can update the default templates in existing systems using the Software Manager.
The change to the XLSX format was to discourage casual use of VBA within Axiom files. Because the Windows Client does not support VBA, customers should make a conscious decision before using any VBA. If an XLSM file does contain VBA, that VBA is only usable within the Excel Client. (Note that opening and saving an XLSM file within the Windows Client will retain any VBA, the VBA just cannot be run within the Windows Client.)
If you have an Axiom file in XLSX format, and you want to save it in XLSM format for the purposes of VBA development, you must do the following:
- Use Save As (Local File) to save the file outside of the Axiom Software file system. Select XLSM as the file format.
- If the file is a report file, you can use Save As (Repository) to save the XLSM file back to the Reports Library. The only way to save a local file to other areas of the Axiom Software file system is to use the Import File feature in Axiom Explorer.
Except for control sheet templates, document templates are not automatically updated when your system is upgraded. This is so that any changes made to the document templates in your system will be preserved when you upgrade.
If you want to update a document template to the latest version provided by Axiom Software, you can use the Software Manager to do so. Using the Reload System Documents utility, you can specify which templates you want to update. The latest templates in the selected template categories will be placed in your Axiom Software database, overwriting the current templates.
The Software Manager is the tool used to install and configure your Axiom Software database and server components. For more information on using the Software Manager, see the Installation Guide.
Get more information and training resources: www.kaufmanhall.com |
Was this topic helpful? axiom_file_system.htm |
