Home >

AX2233

File processing variables

File processing variables can be used in file processing settings, to return information such as the current pass value. These variables are valid when entered into one of the following areas:

• File Processing pane
• File Processing Control Sheet

File processing variables are typically used to generate dynamic values when during multipass processing. For example, if you are using multipass processing to create a snapshot copy of a file, and all of the sheets are being combined into one output file, you can use file processing variables to dynamically generate unique sheet names for each pass.

The following rules apply to file processing variables:

• File processing variables only return values when they are used in file processing settings. They can be entered into the setting field directly, or referenced via a cell reference.

  When used anyplace else, file processing variables do not return a value. If you want to return the current value or current pass number for use within a report sheet (for example, to create a dynamic report title), then you can use the GetCurrentValue function instead.

• File processing variables only return values during file processing. When viewing the variables within the file processing settings, they will always display just the variable name.
• File processing variables use the following syntax: [VariableName]. The variables must be placed in brackets in order to be recognized during file processing.

Variable	Description
[Current_PassNumber]	Returns the number of the current pass. When multipass processing, the first pass returns 1. Subsequent passes are incremented by 1. If the multipass settings result in 10 passes, then this variable will return 1-10, with the sort order determining which item is the first pass. When non-multipass processing, the variable always returns 1.
[Current_SheetName]	Returns the name of the current sheet being processed. This variable is for use in generating sheet names for snapshot copies. For example, you could use [Current_Value]_[Current_SheetName] when using multipass processing and combining all results into a single file. If the multipass processing was by VP, the sheets would have names such as Jones_IncomeStmt, Smith_IncomeStmt (where the sheet being processed is named IncomeStmt). If you are doing standard (non-multipass) processing, or if you are multipass processing to separate files, then you can use just [Current_SheetName] to replicate the original sheet name in the snapshot copies. This variable is only valid within the Sheet Name setting for file processing. It cannot be used in other settings.
[Current_Value]	Returns the item being processed in the current pass. For example, if the multipass process is by VP, this variable would return "Jones" when VP Jones is being processed, "Smith" when VP Smith is being processed, etc. This variable returns nothing (blank) during standard (non-multipass) processing, unless a default current value is defined for the column that defines the multipass list of elements. Default current values can be defined on the File Processing Control Sheet.

File processing variables are not case sensitive.

If you want to use a file processing variable within a formula, the formula must be constructed so that the file processing variable is returned as text within the file processing setting. For example: