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_ FileGroups
\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_ CalcMethodLibraries
\\Drivers	Contains the driver files for a file group.	SystemFolderName_ Drivers
\\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_ Plans
\\Process Definitions	Contains the process definitions for a file group	SystemFolderName_ Process
\\Templates	Contains the plan file templates for a file group.	SystemFolderName_ Templates
\\Utilities	Contains the utilities for a file group.	SystemFolderName_ Utilities
\\Workflow	Contains the workflow definitions for a file group.	SystemFolderName_ Workflow
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_ ReportsLibrary 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_ AxiomTables 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_ DiagramsLibrary 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_ FilterLibrary 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_ ShortcutListLibrary 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_ RibbonListLibrary 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_ ProcessDefinitionLibrary 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_ JobsLibraryFolder 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_ ImportsLibrary 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_ ExportsLibrary Any user-defined subfolders can be referenced by the name as it appears in Axiom Explorer.
Axiom System	Contains system files for Axiom Software. Only administrators can see and access this area.	SystemFolderName_ AxiomSystem
\Axiom Intelligence Models	Contains supporting files for Axiom Intelligence reporting. This folder is only present if your system has licensed this feature.	SystemFolderName_ AxiomIntelligenceModels
\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.	SystemFolderName_ DocumentTemplates
\\Calc Method Library	Contains the default file for calc method libraries.	SystemFolderName_ CalcMethodLibraryTemplate
\\Control Sheet	Contains the default Control Sheets.	SystemFolderName_ ControlSheetTemplate
\\\Alert	Contains the default Alert Control Sheet.	SystemFolderName_ AlertControlSheet
\\\Batch	Contains the default Batch Control Sheet.	SystemFolderName_ BatchControlSheet
\\\Default	Contains the default Control Sheet. This is the base Control Sheet that defines a spreadsheet file as an Axiom file.	SystemFolderName_ DefaultControlSheet
\\\Drilling	Contains the default Drilling Control Sheet.	SystemFolderName_ DrillingControlSheet
\\\File Collect	Contains the default File Collect Control Sheet.	SystemFolderName_ FileCollectControlSheet
\\\File Processing	Contains the default File Processing Control Sheet.	SystemFolderName_ FileProcessingControlSheet
\\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_ DriversTemplate
\\Empty Workbooks	Contains blank workbooks used by Axiom Software processes that create spreadsheet files.	SystemFolderName_ EmptyWorkbooks
\\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_ FormsTemplate
\\File Group Templates	Contains the default file for plan file templates.	SystemFolderName_ TemplatesTemplate
\\Report Designer	Contains templates for use in the Web Client Report Designer.	SystemFolderName_ WebReportTemplate
\\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_ ReportsTemplate
\\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_ SupportUtilities
\\Utilities	Contains the default file for file group utilities. This folder can contain multiple files. Administrators can save additional utility templates to this folder, and users will be able to select which template to use when they create a new utility.	SystemFolderName_ UtilitiesTemplate
\Forms Runtime	Contains files to support display of Axiom forms.	SystemFolderName_ FormsRuntime
\GEO Feature Files	Contains example GeoJSON files that can be used with Map View components in Axiom forms.	SystemFolderName_ GeoJsonData
\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_ PostPackageProcessing
\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_ SchedulerWorkingFolder
\Startup	Contains files that are launched at system startup. Separate folders are maintained for the Excel Client and the Windows Client.	SystemFolderName_ Startup
\\Excel Startup	Any files placed in this folder are opened when the Excel Client is started.	SystemFolderName_ ExcelStartup
\\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_ Hidden
\\\Excel Client	Any files placed in this folder are opened and hidden when the Excel Client is started.	SystemFolderName_ ExcelHidden
\\\Windows Client	Any files placed in this folder are opened and hidden when the Windows Client is started.	SystemFolderName_ SpreadsheetGearHidden
\\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_ Home
\\\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_ WebClient
\\\Excel Client	If a file is placed here, this file will be used as the default Home Page file for the Excel Client.	SystemFolderName_ ExcelClient
\\\Windows Client	If a file is placed here, this file will be used as the default Home Page file for the Windows Client.	SystemFolderName_ SpreadsheetGearHome
\\Windows Startup	Any files placed in this folder are opened when the Windows Client is started.	SystemFolderName_ SpreadsheetGearStartup
\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_ UserFoldersRoot The folder name of each subfolder is the user ID of the relevant user.

Updating document templates

The following document templates are always updated when a database is upgraded: control sheets, sample task panes and ribbon tabs, and support utilities. All other document templates are not updated by a database upgrade, however, they may be updated by a product installation.

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, see the Installation Guide.

Using system folder names

When using folder paths in Axiom features such as the GetDocument function, you can use the folder path as you see it in your system, or you can use the underlying system folder name as defined in the software code. You should use the system folder name if your system is deployed in an environment where users are working in different system languages.

For example, imagine that some of your users work in English, while others work in French. In English systems, the path to a particular folder looks like the following:

\Axiom\Reports Library\Budget Reports\Acct Subtotals.xlsm

If this folder path is used in a GetDocument function, it will not work in French systems because the French system does not have a folder named "Reports Library." Instead, users in French systems see a French language version of this folder name.

To work around this issue, you can use the system folder name instead of the localized folder name. For example, the following path would work in both English and French systems:

\Axiom\SystemFolderName_ReportsLibrary\Budget Reports\Acct Subtotals.xlsm

Only system-controlled folders such as "Reports Library" are localized and require the system folder name syntax. The parent folder "Axiom" is the same in all system languages. Any subfolders and file names created by the client—such as the "Budget Reports" subfolder in the example above—are always displayed as they were defined, regardless of the system language.