Lodestar enhanced export
The Lodestar Enhanced export adapter allows you to request and export data from IEE into a file formatted for use in Lodestar systems. IEE exports data in groups of records. Each group consists of header records and 1 to n interval data records. The number of intervals per record varies and depends on the length of the interval values. The export file is in CSV 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 first day from which to include data in the task.
Tip: Defines the date to start the baseline calculation. Use this parameter to indicate how far back your baseline is needed. Typically, this is the first day of operation or recovery period. If this value is not properly set, it may default to the beginning of time, and Like Days may calculate as far back as historic data is available. This will overwhelm the LikeDayAlgorithmDate table and lead to slower processing.
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.
-
For Rate Event Report, the time zone format is PacificUS, PacificUSNoDst, and EasternUS.
-
For TOU Schedules, the IDs cannot start with a numeric character. For example, "400_TOUSchedule" is not a valid ID. Instead, name the ID "TOUSchedule_400".
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.
Other parameters:
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.
Update Last Read Date
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.
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. Instead of specifying an interval length here, you can check As Metered. If you select As Metered, then the Interval Length option is inactive.
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.
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.
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.
Items Per File
When the Overwrite Existing File parameter is set to Merge, defines the maximum number of export items that are merged into each export file before IEE creates a new export file.
Acct Service Pt Channel
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
Export Status
Defines the data to include in an export based on its validation status for each of the three validation slots.
Primary ID
Defines the Primary ID, which can be:
-
Account ID
-
Account Number
-
Customer ID
-
Device ID
-
Premise ID
-
Recording Device ID
-
Service Point ID
The primary ID appears in the Header 1 record of the export file.
Other Descriptors (1 through 4)
Use the Other Descriptor fields to export additional information in a Lodestar Enhanced export task. The export file includes this information in optional header records. Lodestar's import facility ignores these header records but can use them to pass information to other systems.
Custom Source Code File
Defines the data file to use for the Primary ID or Descriptors for which you selected "Custom" in the Lodestar Enhanced export task template.
Which Channel Number
Determines which IEE configuration channel number to write to the Channel Number position in the export file.
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).
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.
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.