Device event report
The Device Event Report Task Template is designed to allow you to run a Device Event Report on a recurring or data-driven task schedule. The report can be run against an Entity Type or an Event Type, External System or all External Systems, one or more Event Categories, and one or more Event Codes. Reports can be presented in a detailed format or a summary view format, and the events can be grouped by device type or by event. Finally, you have a choice of output formats and you can specify the output directory for the report.
Use the following procedure to configure a task template:
-
Go to System Operations > Task Management > Task Templates.
-
Use the dropdown menu to select the Task Type and Task Template. (Click Add to create a new task template. For more information, see Adding task templates.)
-
Configure the Task specific parameters. These parameters are defined after step 5 of this procedure.
-
Configure the Common task template parameters. For more information, see Task template parameters.
-
Click Save.
Task Specific Parameters
Entity Type
Defines the entity that IEE builds the export file or report around. Entity type supports all main configuration entities. The valid values are as follows.
-
service point
-
account
-
meter
-
data routing program
-
monitoring data program
In a task template, select the entity type from the dropdown menu and click Search to find the specific ID. Click the appropriate row in the search results and click OK to add the ID to the task template.
Entities can be reported by ID, Group, and Schedule. Possible Entity Type values are as follows:
-
Account
-
Customer
-
Meter
-
Service Point
-
Service Point Channel
Service Point ID
The ID field below the Entity Type field changes based on the Entity Type selected. Click the Search button to open the entity Using the search utility and find a specific ID of the selected Entity Type.
Select Time Span
Defines the Time Span.
-
Select the Time Period from the dropdown menu and select the appropriate date and time criteria.
-
(Optional) Click the
Reading Groups button to view and select dates available for a particular meter reading group.
A reading group identifies a group of physical readings that IEE imported, collected, or edited at the same time and processed as a set. In IEE versions 7.0 SP2 and later, a reading group can also identify a group of readings that were exported at the same time. Reading group selection allows you to select time periods that correspond to existing data chunks without having to enter them manually.
You will see the Reading Groups button in many sections of IEE, including interactive graphing, reports, and exports.
To select reading groups
A reading group identifies a group of readings that are imported, collected, edited, or exported at the same time and processed as a set. Reading groups can include interval readings, register readings, or both.
You can select reading groups based on import (for pre-billing data) and export (for post-billing data). When you have selected a reading group and click OK, the reading group values populate the screen you are working in.
Other types of reading groups, such as archive reading groups, may exist in IEE, but they are not available in this dialog.
To select reading groups:
-
In the window or dialog you are working in, click the Reading Groups button or link.
-
Enter a Service Point ID or click Search to search for a service point.
-
Enter a service point Channel Number.
-
Optional: From the Show dropdown menu, select a filter:
-
All. Determines whether to show all reading groups.
-
Import. Determines whether to show only import reading groups. Import reading groups are created when data is imported into IEE, created by the estimation process, or created through the editing process.
-
Export. Determines whether to show only export reading groups. Export reading groups are created by IEE export tasks, including the AMI Billing Export.
-
Click Find Groups. All groups that contain this service point and match the Show filter appear in a table:
-
Received/Exported. Defines the date and time IEE received the data for imports or exported the data for exports. If you have not filtered the list to show only imports or exports, refer to the Creation Method column. An asterisk indicates that the external system that received the exported data has confirmed that it has received and used the data. Show Version Confirmation Controls must be enabled in System Administration > System Settings > System Behavior Settings for this asterisk to appear.
-
Creation Method. Describes the method that created the reading group, such as manual validation or an XML import or export.
-
Start Date. Defines the date and time of the earliest read in the group.
-
End Date. Defines the date and time of the latest read in the group.
-
Calculated. Describes the date and time the billing determinants were calculated. Applies to export groups only.
-
Significance. Describes the reason the readings were exported, such as Billing or Load Research. Applies to export groups only.
-
Click a row to select it, and then select the data version to use:
-
Current Version. Defines the current reading values in the database.
-
Received/Exported. Defines the reading values at the time IEE imported or exported it.
-
Calculated Data. Defines the reading values at the time IEE calculated the billing determinants.
-
Click OK.
-
(Optional) Click the
Schedule Dates button to select a time of use schedule.
The Schedule Dates button allows you to select a time period corresponding to a specific entity. This option is generally used for running a report task that matches the date and time range of a particular data export (usually for billing purposes). When you click the Schedule Dates button, the Schedule Dates dialog displays.
To configure the schedule parameters:
-
Use the Schedule dropdown menu to select a schedule.
-
Select the Task Template to apply.
-
Select the Entity Type.
You can use the Search Utility to locate the entity type ID.
-
The start date and end date selected on the main screen are then populated in this dialog.
Time Zone
Defines the time zone IEE uses for the service point. Select the time zone if it is different from the default shown.
Time Span Selection
Defines the time that the Time Span for the report is based: The valid values are as follows.
Event Type
Defines the type of event you will run the report against. The valid values are as follows.
-
Event. Informational events that may not require specific action.
-
Alarm. Events that require immediate attention.
-
Both. Displays information about both Event and Alarm events.
Report Type
You can create a detailed Event Report or a summary report. The valid values are as follows.
Detail. Select this option to display detailed information in an interactive grid format, or to the screen, printer or disk. With a detailed report, you can group the report by Device Type or Event and view the report either using Crystal Reports or in the IEE grid layout.
Summary Graph. Select this option to display a summary count of the events that were reported by Device Event only; therefore, the Group By selection is not available for this type of report.
The Summary report displays a bar graph that represents the number of events for each event type along with a table view to include each event description, event code, total number of event occurrences, and last occurrence time of selected time span type.
The summary graph can be run on a schedule. The detail drill-down meter event occurrences are not included in the graph; however, from the graph view screen, you can save or print the graph and summary data. IEE also provides detailed data selection during the save and print processes, so you can save and print the detailed data that is associated with the Summary graph. When saving or printing detail data this way, the occurrences of the event are limited to a maximum number of event occurrences based on the workgroup setting
Max. Events to Retrieve for Device Event Report.
Defines the maximum number of events that IEE can retrieve for the Device Events Report. If the number of events that meet the filter criteria exceeds this limit, the latest events are retrieved. You can retrieve older data by changing the date values for the Start and End date of the report.
The Summary view of the Device Event Report is not limited by this setting unless you are saving or printing the Summary report, then the limit is enforced. However, if this setting is set above 1000, the performance of the drill-down option to view detailed data is affected. For best performance, do not set this setting above 1000.
To access this setting:
-
Go to System Administration > System Admin > Security Setup > Workgroup.
-
From the Workgroups tab, select the workgroup in the lower pane to display additional tabs.
-
From the Properties tab, navigate to the Reports section.
Group By
Determines grouping of events for a Detailed report. When creating a Detailed report, you can group events by:
Grouping is disabled for Summary Graph reports.
Device Type
Defines the type of device to run the Event report against. Select one or more of the following checkboxes:
-
Meter
-
Recording Device
-
Collector
-
Repeater
-
Transformer
Event Filter
Determines which event filters you want to use when running the report. Select one or more filters to control the events that are displayed in the report. Check Select/Deselect All to select all filters or clear all filters.
For more information about event filters, see Adding event filters.
Enable External System
Defines any external IEE system to which the IEE Event Report is associated. Check the Enable External System checkbox to enable the External System dropdown menu. From the dropdown menu, select from the external systems configured in the External System code table.
The external system selected for this report must match the External System configured on the meter.
External Systems are configured in the System Administration Code Tables.
Output
Send Data To
Defines where to send the report. You can output the report as a file on the computer or network, to a disk, or send the report directly to a printer.
Printer
Determines which printer you are sending the report to. If you have selected Printer in the Send Data To field, this field is enabled for you to select the specific printer. The printer must first be configured under Windows Printers and Devices before it is displayed in this list.
Export File Type
Determines the output format for the export file. Use the dropdown list to select the output format for the report if you are sending this export to disk.
Export Directory
Defines the path where to save the report. If you have selected Disk in the Send Data To field, this field is enabled for you to select the specific path. Click the Select button to navigate to the directory of your choice.
Export File Name
Determines the filename for the report. If you have selected Disk in the Send Data To field, this field is enabled for you to specify the filename for the report.
Click Run Report if you are running this report from the Device Events workbench.