Prompt

Use the Prompt tab of the Substitution Parameter form to define what the user will be prompted for:

Prompt String

Enter a string which is used to prompt the user to enter a value when the query is run.

Data Type

Select the type of value the user is required to enter as a parameter. A number of data types are available:

  • String - A sequence of text characters.

  • Numeric - A sequence of numbers.

  • Date - A date value in a configurable format.

  • Time - A time value in a configurable format.

  • Date and Time - Both a Date and Time value in the configured format.

  • List of Values (Comma Separated) - Values from a list you can configure, separated by commas. For example, this could be a list of Sites.

  • File Open Path - A prompt to open a file.

  • File Save Path - A prompt to save a file.

  • Folder Open Path - A prompt to open a folder.

  • True/False - A binary value prompt for True or False.

If you are prompting the user for a date, you have the option of including a time portion, so the format may be either Date, Time or DateTime (i.e. date and time). If a date or time is selected, you can select a format from the drop-down format lists .

If you are prompting the user for a list of values, you can specify whether those values are enclosed in quotes.

The File Open Path and File Save Path options allow you to select a file type for the Open/ Save operation from the File-type Filter drop down.

Format Example

Enter an example of the format that is required to be entered by the user. When you select a date format, an example is automatically shown which matches the date/time format you have selected.