Creating A Prompted Variable

  1. Do one of the following in Workbench to open the Prompted User Variable Properties dialog box:
  2. Enter in Variable Name a meaningful name for the variable.
  3. Select a Data Type from the drop-down list. The options are: Date, DateTime, Number, String, and Time.
  4. Enter in Default Value/Formula either a value or a formula to use if the user does not enter anything when prompted, or if the value is not supplied via a command line argument.
  5. Optionally, enter in Help Text information about the variable.
  6. Enter in Prompt Text the text that should appear to prompt users to enter a value. This text can be up to 256 characters.
  7. Define Prompt Text that displays whenever a user is prompted to enter a value or formula.
  8. Click OK. A message indicates if any required information is missing or if any invalid values were provided.
  9. Click OK. If any required information is missing or if any invalid values were provided, a message appears. Otherwise, the new variable appears under User Variables in the Variables dialog box.

Note: If quotation marks enclose a prompted variable, the quotation marks are stripped from the variable. To pass a quoted variable, use escape characters (\") before each quotation mark. For example, to pass "Hello world" into a formula, use the following: "\"Hello world\""

See also

Creating a SQL Query

Formula Editor

Using System Variables

Managing User Variables