AX2347

Axiom functions

Axiom functions can be used to bring Axiom Software data or information into specific cells. Some Axiom functions can be used to perform an action.

Axiom functions are Microsoft Excel user-defined functions (UDFs).

NOTE: Whenever possible, Axiom queries or data lookups should be used instead of Axiom functions, for performance reasons. An Axiom function should only be used when it is the only way to return the desired information.

The following list details all Axiom functions available for use in Axiom Software, in alphabetical order. The navigation menu to the right organizes the functions into functional groups.

Function	Description
GetCalcMethod	Inserts a calc method at the current location, using the row's InsertCM tag if defined.
GetColumnInfo	Returns information about a table column, given the column name.
GetColumnLetter	Returns a column letter based on a specified context.
GetCurrentSheetView	Returns the names of the currently applied views for a specified sheet.
GetCurrentValue	Returns information about the current filter context applied to the file, for either multipass processing or for a temporary sheet filter.
GetData	Returns data from a table. Can be used to return summed data from data tables, or specific data records from reference tables and document reference tables.
GetDataElement	Launches the Choose Value dialog and places the user's selected value in a designated cell.
GetDocument	Opens a specified file when the cell containing the function is double-clicked.
GetDocumentHyperlink	Returns a hyperlink to a file in the Axiom Software file system, that can be used to launch the system and open the file.
GetDocumentInfo	Returns information about the current document, such as the file name, the folder name, or the document ID.
GetFeatureInfo	Returns information about features installed by a package.
GetFileGroupID	Returns the ID of the current file group or a specified file group.
GetFileGroupProperty	Returns information about the current file group or a specified file group.
GetFileGroupVariable	Returns the value of a variable defined for the current file group or a specified file group.
GetFileGroupVariableEnablement	Returns whether a picklist variable is enabled for a specified value in the picklist enablement column.
GetFileGroupVariableProperty	Returns information about a file group variable, especially picklist variable properties.
GetFormDocumentLinkTag	Returns a content tag that will render as a hyperlink to an Axiom form in the Axiom file system, when used within a form.
GetFormDocumentURL	Returns a URL to a form-enabled document in the Axiom file system, to open an Axiom form from within another form.
GetFormResourceLinkTag	Returns a content tag that will render as a hyperlink to a non-Axiom file in the Axiom file system, when used within an Axiom form.
GetFormResourceURL	Returns a URL to a non-Axiom file in the Axiom file system, to open the file in its native application from within an Axiom form.
GetFormState	Returns the current form state value for a specified form state key. Also can be used to set the default value if no value currently exists.
GetPeriod	Returns the current period for the system or for a table.
GetPlanFileAttachment	Opens a specified plan file attachment or a dialog to allow the user to select an attachment to open.
GetPlanFileDocumentID	Returns the document ID for a particular plan file within a file group.
GetPlanFilePath	Returns the file path for a particular plan file within a file group.
GetProcessInfo	Returns information about a process, such as the due date for a step or a step owner.
GetRowNumber	Returns a row number based on a specified context.
GetSecurityInfo	Returns information about a user's security settings, such as the file group filter, the table type filter, or individual security permissions.
GetSharedVariable	Returns the current value for a specified shared variable. Also can be used to set the initial value for the variable if no value currently exists.
GetSystemInfo	Returns information about the current Axiom Software system, such as the system name or the product version.
GetSystemURL	Returns a URL to a system page in Axiom Software. Currently this is only used for internal development.
GetTableInfo	Returns information about a table, given the table name.
GetURLEncodedString	Returns an encoded string that is valid for use in a URL, given a string with spaces or other special characters.
GetUserInfo	Returns information about a user, such as the user ID, the user name, and the user email.
GetWebReportDocumentURL	Returns a URL to a web report in the Axiom file system, to open the web report from another web report or an Axiom form.
GetWorkflowInfo	Returns information about a workflow, such as a plan file's current stage number, a stage name, or a stage owner. Only applies if you are using the legacy workflow feature.
IsRunningMultipass	Returns True if multipass processing is currently occurring; returns False if not.
ManagePlanFileAttachments	Opens a dialog to allow the user to add, edit, or delete a plan file attachment for a specified plan file.
RunEvent	Runs Scheduler jobs that contain a specified event.
SetSharedVariable	Sets and returns the value for a specified shared variable, so that the value can be referenced by other forms within the shared form context (using GetSharedVariable).
ShowFilterWizardDialog	Opens the Filter Wizard dialog to allow the user to create a filter. The filter is then placed in a designated cell.
ShowFormDialog	Opens a designated form-enabled file as a dialog.