Reading XML export

The Reading XML Export task allows you to request data from IEE for export to an external system, using the IEE XML format.

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.

Entity ID

Defines which specific entity (service point, customer, account, premise, meter) to include in the export. This parameter is unavailable unless you select the group or default options next to entity type. The Entity ID name changes depending on the entity type parameter. Entity IDs are also known as Node IDs.

Time Period

Defines the time span of the data to include in the task for exports, reports, and other tasks. Some common time periods include: Today, Yesterday, Month, Month to Date, Week, Week to Date, Year, and Year to Date.

Start Date

Defines the earliest day from which to include data in the export, report, or other task.

End Date

Defines the last day from which to include data in the task. To include the full 24 hours of the last day, the task will be scheduled with an adjusted End Date (that is, adding one day to the End Date entered in the task parameter).

Time Zone

Defines the time zone that corresponds to the time period and start/end dates you select in the task template.

Export Directory

Defines the directory where IEE places the file containing exported data. Accept the IEE default file path or click Search to browse to a directory. This parameter supports the standard IEE macros. Reference as ($ExportDirectory) when configuring a task. Exported data is generated by an export task template or an export API.

Export File Name

Defines the export file name. You can enter a unique file name or accept the default. This parameter supports the standard IEE macros.

Output Time Zone

Defines the time zone to use in the export file, report, or other task. If you omit this parameter, IEE uses the time zone of each service point.

Interval Length

Defines the number of minutes to use for intervals in exported data, in the absence of a specified value for exports and workgroups data.

Rolling Interval

Defines the length of time over which to average the demand, and allows you to smooth demand. Rolling demand may be required for billing purposes. For example, if the export is for billing, and the customer contract specifies billing on a 60 minute rolling demand for data that is metered in 15 minute intervals, set the Rolling Interval Length to 60. When you export the data, there is an interval value every 15 minutes. However, the value is an averaged demand value over 60 minutes that ends at the time stamp for each 15 minute interval. In this case, the averaged intervals are the current interval plus the three previous intervals.

As Metered

Determines if IEE exports data using the metered interval length (instead of specifying an Interval Length). Select this checkbox to enable this parameter.

Allow Chopping

Determines whether IEE should export data if the interval length is larger than was defined in the Interval Length parameter. Select Allow Chopping to export the data despite its longer interval length; allow it to be chopped. Clear this box to exclude intervals with interval lengths exceeding the Interval Length parameter.

First or Last Read

Defines the way IEE includes register reads within the date range for accumulating registers. If you omit this parameter, IEE exports all register reads. The valid values are as follows.

First. Includes only the first read within the export date range, but not the last.
Last. Includes only the last read within the export date range, but not the first.
All. Includes all reads within the date range for accumulating registers.

The default value is All.

Demand Usage

Defines whether the export includes all values in the date range or just the maximum values when exporting register values. To export just the maximum values, the unit of measure (UOM) must be a Demand type. If you omit this parameter, IEE exports all demand values.

Rounding

Determines whether reading values are rounded before export. Use the dropdown to select a value. The valid values are as follows.

None. Do not round.
Round. Round values to the nearest integer.
Truncate and Carry Over. Truncates the value.

Note: If selecting round, you do not need to define the Number of Decimals parameter because rounding occurs to the nearest integer. For example, with rounding selected a reading value of 3.1415 would become 3.00. If you defined two decimals in the Number of Decimals parameter, a reading of 3.1415 would also become 3.00.

Output Usage

Defines whether to export all data using demand or consumption units. The valid values are as follows.

Raw. Export readings as they are stored, with no conversion.
Consumption. Export readings after UCE converts them to consumption values.
Demand. Export readings after UCE converts them to demand values.

The UOM must be set correctly for UCE to make these conversions. If you omit this parameter or if the UOM cannot be converted to consumption or demand, IEE passes through the raw values.
Pulse. Export readings in pulses. With this setting, IEE converts the engineering units data into pulses using the correct multipliers for the period being exported. This functionality can be used if the receiving system is expecting data in pulses.

Number of Decimals

Defines the number of decimal places to include in the values within the exported data.

Export Partial

Defines whether IEE should export data if it only exists for part of the date range. Select True to export readings even if there is only partial data. Select False to disable this feature. The default is False.

External System

Defines any external system to which IEE configuration data can be associated. In many places this parameter provides you with the dropdown menu to select from the external systems configured in the External System table.

Unit Scaling

Determines if IEE outputs all values to the same scale. If you omit this parameter, IEE uses "None". The valid values are as follows.

None
Units
KiloUnits
MegaUnits

Export Engineering Units

Defines the way IEE exports the register reading values. IEE's default behavior is to export the actual register reading value as recorded, instead of using derived engineering unit values such as kWh or kVarh.

None is the default behavior. With this setting, IEE does not calculate register consumption when exporting data.
With Boundry Readings. Determines that the XML reading export is configured to calculate and export register readings on the export period boundaries in cases where interval channels with a linked register channel exist. The calculated reads are also used to calculate a consumption delta value, also exported. These readings are not stored.
Without Boundry Readings. Determines that the XML reading export is not configured to calculate and export register readings on the export period boundaries in cases where interval channels with a linked register channel exist.

Update Cycle Data End Time

Determines whether IEE updates the cycle data end time at the end of the export. This parameter prevents IEE from automatically picking up a new date range when a user manually exports a file. If you use this parameter, you should also enter a Schedule ID.

Overwrite Existing File

Defines the way the export should continue if the export file already exists. The valid values are as follows.

Merge. Merges the new file into the old file.
Overwrite. Replaces the old file.
Unique. Appends a sequence number to generate a unique file name.

Max Items Per File

When the Overwrite Existing File parameter is set to Merge, the Max Items Per File parameter defines the maximum number of export items that are merged into each export file before IEE creates a new export file.

Account Channel Reason

Defines the type of channel associated with the account service point to export. The valid values for this parameter are defined in the Account Service Point Channel Reason table. Common reasons are as follows:

Billing
Marketing
Load Research
None
Non-Billing

Only Export Data of These Validation Statuses

Defines the validation statuses to include in export data. Select the checkboxes to limit the exported data to only those values with particular validation statuses. IEE includes three validation slots, and you can define validation statuses for each slot. Clear the checkbox to export all validation statuses.

Ignore validation status conditions for register channel contributors

Defines whether the exporting of register channels or formula channels with register channel contributors depend on the validation status condition of the register channel data. When the checkbox is selected, validation status conditions of the register channel data do not affect whether or not the export proceeds. When the checkbox is cleared, IEE handles validation status conditions of the register channel data the same way that it handles interval channel data.

Preferred Source Validation Status

Generates export reports based on external collection system's status code options, rather than IEE Validation, Editing, and Estimation (VEE) status codes. Valid values are Any and Valid.

Setting the Preferred Source Validation parameter to Valid, causes IEE to keep in the collection only those readings with statuses of Passed or Manually Accepted. Setting the Preferred Source Validation parameter to Any causes IEE to keep all readings in the collection regardless of the collection system's validation status.

Exclude Formula Channel

Determines whether the export file includes an associated formula channel. Select the checkbox to exclude the formula channel. Clear the checkbox to include the formula channel.

Aggregate on Export

Determines whether IEE eliminates separate aggregation tasks that would normally run before the export. Reducing the number of tasks generated on an automated C&I cycle improves performance and reduces the overall cycle processing completion time. Run aggregation on stored formula channels, which store the data and then export the aggregated data in the results. If the export does not run because of some other condition such as 'Export partial = false', then no aggregation takes place.

A channel that holds data calculated from a formula. The data can be regularly or irregularly spaced data.

Force Complete

Determines if the export is able to run with partial data. Select True to allow the export to run with partial data. As more data arrives, the export picks up where it left off. Select False to force the export task to wait until all data is available before exporting. Forced Complete supports exporting a collection of linked service point channels (for example, linked to accounts).

Channel Selection Grid

Determines whether to add a row to the channel selection grid. Click Add Row to create a new row. Use the dropdown lists to select the type of data to include in the report. To delete a row, select the row and click Delete Row.

This grid acts as a filter for the data you want to export. The grid may contain any combination of items. If the grid contains any items, then data must meet the criteria for at least one of these rows to be included in the export.

For example, if you click Add Row and select Register from the Channel Type dropdown list, IEE only exports register channel data. If you click Add Row, select Interval from the Channel Type dropdown list and select Received from the Power Flow dropdown list, IEE only exports interval data received by the utility. If you add two rows to the grid, one for register channel and one for interval channel, IEE exports both register channel data and interval channel data.

All Data Since Last Export

Determines whether the export file contains all data since the last export on cycle ran.

Version of Data

Select a version of data to export. The valid values are as follows.

Current Version. Exports the current version of data for the time period.
Version Date. Exports the most recent version of data for the time period as of the specified Version date and time.
Significance. Exports the most recent version of data for the selected Significance type. Significance types are created by IEE administrators, some Significance types are billing, load research, settlements, or other purposes.