AX1771
GetPlanItemValue function
Returns values from the plan code table, for the current plan code. It is intended to be used in plan files, to provide a lightweight method of returning related values.
When a plan file is opened, all values from the plan code table for that plan code are automatically loaded into document memory and can be retrieved using GetPlanItemValue. Using GetPlanItemValue instead of GetData eliminates the need to make round-trip server calls to the database to display this information in plan files.
NOTE: You can use a data lookup to return the same information as a GetPlanItemValue function. Whenever possible, it is recommended to use data lookups over Axiom functions for faster performance.
Syntax
GetPlanItemValue("ColumnName")
| Parameter | Description |
|---|---|
|
ColumnName |
The name of any column in the plan code table for the file group. Use only the column name, not full Table.Column syntax. For example, if you want to return a description from the Description column, use GetPlanItemValue returns the value in this column, for the current plan code. |
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
-
GetPlanItemValue only returns values when used in a plan file. When setting up the function in the file group template, it will return an expected error.
-
The related values from the plan code table are loaded into document memory when the plan file is opened. If any of these values change while the plan file is still open in the current session, GetPlanItemValue will not reflect these changes. If a particular value may change often and you need to reflect this change in the current session, you should use GetData instead.
-
GetPlanItemValue is a non-volatile function.
Examples
=GetPlanItemValue("Description")
This example returns the value stored in the Description column of the plan code table, for the current plan code. For example, if the current plan file is for Dept 25000, and the value in the Description column of the plan code table is "Finance", then this function returns "Finance".
