Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Type (Determines the data type and entry method.)
  • Name (The label for the parameter and the token used in the SQL statement to resolve the value when executing.
  • Description (Helpful description shown to guide user.)
  • Default (Default value for parameter. Can be Custom Default for DateTime types only.)
  • Min/Max (In ApplicableIf applicable, include the minimum and maximum range the value can be.)

...

TypeDescription
DateTime

A value representing a custom date and time modifier to start as a default. Uses the default attribute of the parameter node.

See Supported Custom Defaults below.

DateA value representing a Date. The UI will display a Date Picker control.
BooleanA value representing a choice of True or False. The UI will display a toggle or checkbox control.
IntegerA value representing a generic number such as a number of days or hours. The UI will display a number entry control.
DeviceA value representing a device object number. The UI will display a listing of protocol devices to choose from.
ObjectA value representing an object number. The UI will display a listing of objects to choose from.
MeterA value representing a meter object number. The UI will display a listing of meters to choose from.
ArchiveA value representing a an archive object number. The UI will display a listing of archives to choose from.
PublisherA value representing a publisher object number. The UI will display a listing of publishers to choose from.
FilterA value representing a an archive filter object number. The UI will display a listing of archive filters to choose from.

...

TypeDescription
Current

The current date and time as of executing the SQL.

TopHourThe current top of hour as of executing the SQL. Example: Current Time=12.30PM, TopHour=12.00PM
StartDayThe current date as of executing the SQL.
EndDayThe current date plus 1 day as of executing the SQL.
YesterdayThe current date minus 1 day as of executing the SQL.
PriorHourThe last top hour minus 1 hour from current date and time as of executing the SQL. Example: Current Time=12.30PM, PriorHour=11.00AM
NextHourThe next top of hour plus 1 hour from current date and time as of executing the SQL. Example: Current Time=12.30PM, NextHour=1.00PM
StartMonthThe current date's month starting day as date of the first day of the current month as of executing the SQL.

Examples

...