AX1779

GetFileSystemInfo function

Returns information about a specified document in the Axiom file system.

GetDocumentInfo and GetFileSystemInfo serve similar purposes. GetDocumentInfo returns information about the current document, whereas GetFileSystemInfo returns information about any document in the Axiom file system.

Syntax

GetFileSystemInfo("Code", "Path")

Parameter Description

Parameter	Description
Code	A code that specifies the piece of information that you want the function to return. See the Code table below for the supported list of values.
Path	The full path to the document for which you want to return information, such as: `\Axiom\Reports Library\Forms\Dashboard.xlsx`. If the document is part of a file group, the function GetFileGroupProperty can be used to return the path to the Utilities, Templates, or Drivers folder for a specified file group.

Code

A code that specifies the piece of information that you want the function to return. See the Code table below for the supported list of values.

Path

The full path to the document for which you want to return information, such as: \Axiom\Reports Library\Forms\Dashboard.xlsx.

If the document is part of a file group, the function GetFileGroupProperty can be used to return the path to the Utilities, Templates, or Drivers folder for a specified file group.

All non-numeric entries must be placed in double quotation marks, unless you are using cell references to reference the text held in another cell.

The following values are supported for the Code parameter:

Code	Description
Description	Returns the description of the file, if defined.
DocumentID	Returns the ID of the file (a numeric value assigned by Axiom).
DocumentType	Returns the document type for the file (such as Report or Template).
FolderID	Returns the ID of the folder where the file is located (a numeric value assigned by Axiom).
LockedByUser	Returns the login name of the user who currently has the file lock (if applicable).
RecordCreatedBy	Returns the login name of the user who created the file.
RecordCreatedDTM	Returns the date and time the file was created.
RecordModifiedBy	Returns the login name of the user who last modified the file.
RecordModifiedDTM	Returns the date and time the file was last modified.

Remarks

If your system is deployed in an environment where users work in different system languages, then you should use system folder names in any file paths. For more information, see Using system folder names.
GetFilesystemInfo is a non-volatile function.

Examples

=GetFileSystemInfo("DocumentID", "\Axiom\Task Panes Library\CapitalNavigation.axl")

This example returns the database ID of the designated file. For example: 219.

=GetFileSystemInfo("DocumentID", GetFileGroupProperty("DriversPath", "Current Budget")&"\GeneralDrivers.xlsx")

This example uses GetFileGroupProperty to return the path to the Drivers folder for the specified file group, and then returns the database ID of the designated driver file. In this case Current Budget is a file group alias name, so the function updates dynamically as the target of the alias changes.

=GetFileSystemInfo("RecordModifiedDTM", "\Axiom\Reports Library\Forms\Dashboard.xlsx")

This example returns the last modified date of the specified file.