AX1494

GetFileGroupProperty data lookup

You can use GetFileGroupProperty rows in a DataLookup data source to return information about a file group, such as the file group name or the current plan code.

The GetFileGroupProperty data lookup supports similar query parameters as the GetFileGroupProperty function, and can be used as a substitute for this function to improve file performance. The data lookup is intended to be used in cases where the queried value is not expected to change during the current file session, and therefore the value only needs to be queried once (or only after specific events).

To create a GetFileGroupProperty data lookup, add a [GetFileGroupProperty] row to a DataLookup data source and add the appropriate parameter columns. For more information on creating the DataLookup data source, see Creating DataLookup data sources.

GetFileGroupProperty parameters

[GetFileGroupProperty] rows use the following parameter columns. Within the DataLookup control row, these parameter names must be placed in square brackets—for example, [CodeName]. The parameters can be placed in any order.

NOTE: If the entry for any parameter depends on a value returned by another data lookup row, then that row must be in a different data source and executed before this row is executed. For more information, see Dependent data lookups.

Parameter Description

CodeName

Use one of the following codes to specify the information you want to return about the file group:

  • Description: Returns the file group description.
  • DriversPath: Returns the path to the Drivers folder for the file group.
  • FileGroupID: Returns the database ID of the file group.
  • FileGroupName: Returns the file group name.
  • FileGroupDisplayName: Returns the display name of the file group.
  • FileGroupTabPrefix: Returns the tab prefix of the file group.
  • ProcessDefinitionID: Returns the ID of the process definition associated with the file group. Only applies if a process definition is specified as the Plan File Process for the file group. Returns blank otherwise.
  • PlanFile: Returns the plan code for the current plan file. This keyword can only be used within a file group. When used in a file that is not a plan file (such as a template), the file name is returned.
  • ScenarioName: Returns the scenario name when the file group is a scenario (returns blank otherwise).
  • UtilitiesPath: Returns the path to the Utilities folder for the file group.
  • TemplateName: Returns the name of the template used to create the current plan file. Only applies to plan files.

FileGroup

Optional. The ID or name of the file group.

  • If you are using the data lookup within a file that belongs to a file group (template, driver, etc.), then you can omit this parameter and the current file group is assumed.
  • If you are using the data lookup outside of a file group (such as in a report file), then you must specify either the file group ID or the file group name (the true name, not the display name if it is different). File group aliases can be used for the file group name.

Result

The Result column is where the return value for the row is placed when the data lookup is executed. You can reference this cell to use the return value in other areas of the file.

This column must be present in order for the data lookup to be valid.

IsError

Optional. Indicates whether the return value for the data lookup was an error.

  • If TRUE, the return value is an error. This may be an Axiom #ERR code, a specific error message, or a custom error message defined in the data lookup (such as the GetData invalid query message).
  • If FALSE, the query executed successfully.

The IsError column can be helpful if you need to set up formulas with error trapping. Instead of using the ISERROR Excel function, you can use a construction such as:

=IF(Info!$M$10=True, "", Info!$L$10)

Where the IsError column is in M10 and the Result column is in L10. If the data lookup returns an error, this function returns blank instead of displaying the error.

Example

The following screenshot of a DataLookup data source shows several GetFileGroupProperty examples:

For more examples of GetFileGroupProperty use, see GetFileGroupProperty function. The same examples work for both approaches. To use a function example in a DataLookup data source, you would place the applicable function parameters in the corresponding parameter columns.

See also