AX1454

String, Integer, and Decimal refresh variables

String, Integer, or Decimal refresh variables prompt users to make a "free input" of the designated type. For example, if the variable is an Integer variable, then the user can enter any whole number. However, the user cannot enter any decimal numbers or any text.

Variable behavior

The variable displays as a text box where the user can type in their desired value for the variable. In the Web Client only, Integer and Decimal variables also have up and down arrows at the side of the text box to increase or decrease the current input.

Desktop Client: Example free-input refresh variables

Web Client: Example free-input refresh variables

Invalid entries—for example, attempting to enter a decimal value into an Integer variable—are treated as follows:

  • In the Desktop Client, the user can enter any value into the text boxes. However, if the value is invalid, then a validation message displays at the bottom of the dialog. The OK button is disabled until the user enters a valid value.

  • In the Web Client, invalid values are prevented at the point of entry, so no validation messages display.

NOTE: In the Web Client, decimal values for refresh variables are limited to hundredths (two places to the right of the decimal point).

Variable properties

This section explains how to complete a variable row in the RefreshVariables data source when defining a String, Integer, or Decimal variable. Some data source columns do not apply in this case and are not discussed here. If any inapplicable columns are present in the data source, they should be left blank on rows that define free-input variable types. If you are using the Data Source Assistant to complete the variable properties, then only the applicable columns will be shown in the task pane.

For more information on the RefreshVariables data source in general, see Defining refresh variables.

General variable properties

All refresh variables use a common set of general properties such as the variable name, display name, and whether the variable is enabled or required. Any special considerations for String, Integer, or Decimal variables are noted.

Column Tag Description

[Name]

 (missing or bad snippet)

[DisplayName]

 (missing or bad snippet)

Because free-input variables do not restrict what users can enter for the variable (other than the data type), the display name should clearly define the purpose of the variable.

[VariableType]

Specifies the variable type. Enter one of the following:

  • String: The user can enter any string value.
  • Integer: The user can enter any whole number.
  • Decimal: The user can enter any numeric value, including decimals.

[IsEnabled]

 (missing or bad snippet)

[SelectedValue]

The user's entered value for the variable will be placed in this cell. When setting up the file to use the variable value, point your formulas to this cell.

(missing or bad snippet)

[IsRequired]

 (missing or bad snippet)

[DependsOn]

 (missing or bad snippet)

[ClearSelectedValueonSave]

 (missing or bad snippet)

[ClearSelectedValueonOpen]

 (missing or bad snippet)

[DefaultValueonOpen]

 (missing or bad snippet)

[GroupName]

 (missing or bad snippet)

[CollapseOnOpen]

 (missing or bad snippet)

Variable-specific properties

(missing or bad snippet)