AX2365

GetPlanFileDocumentID function

Returns the document ID for a particular plan file, given a file group name and a plan code.

NOTE: Whenever possible, you should use the function GetPlanFilePath instead of GetPlanFileDocumentID, for improved performance. Most settings that use a document ID can use a path instead.

Syntax

GetPlanFileDocumentID("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 document ID.

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

  • The first parameter of this function also accepts a file group code. However, use of file group code is being phased out. If you have existing functions that use the file group code, these functions should eventually be migrated to use the file group name.

  • GetPlanFileDocumentID is a non-volatile function.

Examples

=GetPlanFileDocumentID("Budget 2022",3000)

This example returns the document ID for the plan file for department 3000, for file group Budget 2022. For example: 93.

See also