Banked reads report (BankedReadAdapter)

When an automated meter is first set at a Service point (Customer location), it may begin recording and broadcasting readings data to its collection network prior to the configuration information for the meter being added to IEE configuration data. In this situation, IEE banks incoming readings data and tries the import again on the next calendar day.

IEE also banks readings for meters that are configured in the database, but for which IEE does not recognize an incoming channel. This can occur when a meter program update has added a channel to the meter or when a meter has been reprogrammed to a different interval length and the change has not yet been communicated to IEE. The device itself will exist in IEE, but the channels will not match the IEE configuration.

The Banked Reads report provides a file export that provides a list of the channels which have been banked, and for how long they have been waiting to be processed.

The Banked Reads report is available as an export task template. IEE exports results to a .csv file for use in spreadsheets and other systems. This topic explains how to configure the Banked Reads Adapter task template and schedule the report. If MSMQ was configured during IEE installation and configuration, IEE notifies the queue of the success or failure of each Banked Reads report export.

Use the following procedure to configure a task template:

1. Go to System Operations > Task Management > Task Templates.

2. 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.)

3. Configure the Task specific parameters. These parameters are defined after step 5 of this procedure.

4. Configure the Common task template parameters. For more information, see Task template parameters.

5. Click Save.

Task specific parameters:

Report Directory

Defines the file path to the directory where IEE will place the exported file. You can type directly into the field or click Search to browse to a directory. This field supports standard IEE macros, such as ($ExportDirectory), defined during system configuration.

Report File Name

Defines the name to use for the exported file. Include the extension, such as .csv. IEE includes the export date and time in the filename so as not to overwrite previously exported files.

Minimum Banked Age

Defines how long banked data remains banked before appearing in the banked readings report export. For example, an entry of "1" in this field on the task template will include only readings received prior to the calendar day on which the report is run. An Entry of "7" in this field will include in the report, only those channels which were received more than a week ago, and have not yet been successfully processed into the system. Conversely, enter a 0 (zero) to include all banked readings. Enter 1 (one) to include only readings received prior to the current calendar day.

Maximum Records Per File

Determines the number of individual channel records to write to a file. This setting keeps the export file size practical for use in a spreadsheet. For example, if this parameter is set to 1000, and there are 1500 channels of data at task execution time, IEE writes two files: one containing 1000 records, the second containing 500. Use the default value of 0 (zero) to write all records to one file.

Maximum Channels to Export

This parameter prevents IEE from attempting to export of an excessive number of channels. If the limit entered here is exceeded, IEE does not create an export file. IEE writes a warning to the task log and can send a notification to MSMQ, if MSMQ is configured.