Calculation and formatting
From the AMI Data Export task template Calculation and Formatting tab, you can define properties that control how data is calculated and formatted. The following parameters are specific parameters related to the AMI Data Export task template:
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
Determines the output interval length. Select the output interval length. All possible values are a factor of 60.
The default value is 15.
As Metered
Determines if IEE exports data using the metered interval length (instead of specifying an Interval Length). Select this check box to enable this parameter.
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 timestamp for each 15 minute interval. In this case, the averaged intervals are the current interval plus the three previous intervals.
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.
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.
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 Boundary Reads
Determines if the boundary reads will be part of the export. Check this box to include the boundary reads. Clear the box to not include the boundary reads.
If the box is checked, the First or Last Read field and the Use Calculated Boundary Read check box are both enabled.
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.
Use Calculated Boundary Read
The XML reading export can be 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.
Check this box to include calculated boundary reads with the export. Clear the box to not include the boundary reads. The default setting is a clear check box.
When this box is checked, the following fields are enabled to provide more information about the calculation:
Maximum Days from Boundary to Base Reads
Defines the number of days that will comprise a base read. This setting is dependant on the value of the First or Last Read field.
-
If the value of First or Last Read is First, the number of days you enter here will be before the reading period.
-
If the value of First or Last Read is Last, the number of days you enter here will be after the reading period.
-
If the value of First or Last Read is All, the number of days you enter here will be both before and after the reading period.
The default number of days specified here is 3. This check box is enabled only when Use Calculated Boundary Reads is checked.
Boundary Read Quality
Determines the level of quality for the calculated read. The valid values are as follows.
-
Any. A contiguous set of interval data is required between the base and the boundary point, but the quality of the interval reads does not matter. Status of the base read does not factor into the selection process, except for when the readings are marked with a status of Missing or Empty, then the readings are deemed absent and are therefore ineligible. Use this option if the goal of the calling process is to get balanced readings.
-
High. A contiguous set of interval data is required between the base and the boundary point. The base read and the interval data cannot be marked with the status of Estimated, Edited or Estimation Needed. Use this option if the goal of the calling process is to get more accurate readings.
The default value is Any. This field is enabled only when the Use Calculated Boundary Read is checked.
Boundary Read Calculation Method
Determines the method used to calculate the register value for the boundary read. The valid values are as follows.
-
Same Base Favor End. Start and Stop register reads are calculated using the same actual reading that is closest to the last interval in the period. Both Start and Stop reads are calculated from the same actual read. Use this method to achieve the most balanced result.
-
Independent Use Closest. Uses the closest actual register read to the first interval in the period to calculate the Start read, and uses the closest actual register read to the last interval to calculate the Stop read. The calculated Start and Stop reads are calculated independently of each other. Use this method to achieve the most accurate result.
The default value is Same Base Favor End. This field is enabled only when Use Calculated Boundary Read is checked.
For more information about Task Template Parameters in the bottom pane, see Task template parameters.
Click Save.