Versions Compared

Old Version 14

changes.mady.by.user Michael Standal

Saved on

compared with

New Version 15

changes.mady.by.user Emma Fullilove (Deactivated)

Saved on

Key

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

...

Info
titleOne or More Parameters Example

<parameters>
<parameter type="Boolean" name="OnlyEnabled" description="Enabled Devices Only" default="true" />

<parameter type="Integer" name="Missing" description="Missing Record Count" default="0" min="-1" max="100"/>

<parameter type="Boolean" name="IncludeStation" description="Include Station Meters" default="false" />

<parameter type="Device" name="DeviceName" description="Device" default="0" />

</parameters>

Supported Parameter Types

TypeDescription

DateTime

Date

A value representing a datetime. Modifiers can be used to set a default. Uses the default attribute of the parameter node.

See Supported Custom Defaults below.

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 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 an archive filter object number. The UI will display a listing of archive filters to choose from.

Supported Custom Defaults

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 date of the first day of the current month as of executing the SQL.

Examples


Info
titleArchive Hourly Summary (Stored Procedure Method)

<?xml version="1.0" encoding="utf-8" ?>
<report>
<name>Archive Hourly Summary Report</name>
<description>Returns the Archive Hourly Summary. Use the Missing Record Count parameter to control the minimum number of records a device must be missing to be included in the report.</description>
<sql>
<!-- EXECUTE asi_spHourlyArchiveStatus '@onlyEnabled', '@iMissing', @includeStation -->
</sql>
<parameters>
<parameter type="Boolean" name="onlyEnabled" description="Enabled Devices Only" default="true" />
<parameter type="Integer" name="iMissing" description="Missing Record Count" default="0" min="-1" max="100"/>
<parameter type="Boolean" name="includeStation" description="Include Station Meters" default="false" />
</parameters>
</report>

Note: Stored Procedure Parameters are preceded by the "@" character. The matches the name of the corresponding parameter.

...