Versions Compared

Key

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

ACM ships with pre-made reports covering many different data topics. Custom reports can be created that are specific to your organizational needs. This page will show how to create a new custom report and where to locate it for users to access.

...

  1. Create a new file with the .XML extension. Assign a unique name.
  2. Paste in the sample File Format shown on this page.
  3. Enter a Name and Description for the report. Assign a unique name. This is the display name that will appear in report listings. The description is supporting text to explain what the report provides.
  4. Enter the SQL for the report:
    1. SQL Query method. 

      Info

      Example: <!-- SELECT * FROM TblObjects ORDER BY ObjectId -->


    2. Stored Procedure method.

      Info

      Example: <!–EXECUTE dbo.asi_spProcedureName '@Parameter' -->


  5. Create one or more parameters as needed. If no parameters are needed, leave the parameters node empty. See Parameters section for details and examples.
  6. Save the file to the File Location shown below. The Report Service will include the new report the next time the listing is loaded or refreshed. There is no need to restart the Report Service.

...

<?xml version="1.0" encoding="utf-8" ?>
<report>
<name> NameName</name>
<description>Description</description>
<sql>
    <!-- SQL -->
</sql>
<parameters>
<parameter type="Type" name="Name" description="Description" default="DefaultValue" />
</parameters>
</report>

...

A value representing a generic number such as a number of days or hours. The UI will display a number entry
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.Value 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 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 archive filter object number. The UI will display a listing of archive filters to choose from.

...