AX1550

GetPlanFilePath function

Returns the file path of a particular plan file, given a file group name and a plan code.

Syntax

GetPlanFilePath("FileGroupName", PlanCode)

Parameter Description

FileGroupName

The name of the file group. A file group alias name can also be used.

PlanCode

The plan code for which to return the file path.

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.

Remarks

GetPlanFilePath is a non-volatile function.

Examples

=GetPlanFilePath("Budget 2022", 3000)

This example returns the file path of the plan file for department 3000, for file group Budget 2022. For example: \Axiom\SystemFolderName_FileGroups\Budget 2017\SystemFolderName_Plans\3000.

You might use this function to provide a file path to another Axiom function, for example:

=GetFormDocumentLinkTag("Open plan file for Dept 3000", GetPlanFilePath("Budget 2022", 3000), , TRUE)