Output tab
From the AMI Data Export task template Output tab, you can define properties that control the export output. The following parameters are specific parameters related to the AMI Data Export task template:
Output Format
Determines the output format of the exported data. The output format options are taken from the TaskAdapter table. The valid values are as follows.
The fields on the Output tab change depending on whether the Output Format is a file or a web service call. If the output format is a file format, the Export Directory and Export File Name are required.
An output format is required when creating an AMI Data Export task template.
File Output Parameters
Maximum Items Per File
Defines the maximum number of items per output file or per message, depending on the output format. Enter the maximum number of items to be saved in the output. For file formats, the default value is 10,000. For a web service output format, the default value is 1000.
A value in this field is required.
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.
This field is enabled if the Output Format is a file format. You must specify the Export Directory if the field is enabled. You can use standard IEE macros.
The default value is ($ExportDirectory)\<subdir> where <subdir> varies by output format.
For example:
The subdirectory for output format CIM Part 9 Xml File is CIMPart9
The subdirectory for output format Itron Reading Xml File is ItronReadingXml.
Export File
Defines the export file name. You can enter a unique file name or accept the default. This parameter supports the standard IEE macros.
This field is enabled if the Output Format is a file format. You must specify a filename if this field is enabled. The default value is ($RequestID)_($TaskID)_($ChunkNumber).xml where:
($RequestID) is the RequestID from the AdeEntity table
($TaskID) is the TaskID from the Task table
($ChunkNumber) is the ChunkSequenceNumber from the TaskChunk table
The Optional value is ($RequestID)_($TaskID)_($ChunkNumber)_($ServicePointID).xml where:
($ServicePointID) is the ServicePointID from the ServicePoint table
-
When ServicePointID is specified, the "Maximum Items Per File" is changed to 1. This value cannot be changed.
-
When an export is initiated by a group, a separate export file is created for each service point and each file will contain data for one service point.
-
ServicePointID is not case sensitive.
Output Register Reads to Separate File
Determines whether register reads are output to a separate file. Select to save the register reads in a separate file from the interval reads and the events. Selecting this box enables the Export Directory and Export File fields within the group box.
The Export File default name is derived by inserting the Task ID and Chunk Number at the end of the file name, before the extension.
For example:
CIMRegister3435-122.xml
Output Events to Separate File
Indicates whether events are output to a separate file. This option displays for all file output formats. Check this box to save events in a separate file from the interval and register reads. Checking this box enables the Export Directory and Export File fields within the group box.
The Export File name here is derived by inserting the Task ID and Chunk Number at the end of the file name, before the extension.
For example:
CIMEvent3435-122.xml
If web service is the Output Format, the field label here changes to Output Events in Separate Web Service Call.
This field is automatically checked and disabled when the Output Format = Xml File – Itron Reading Format and the Include Events parameter on the
Data selection tab is checked.
Web Service Output Parameters
Maximum Items Per Message
Defines the maximum number of items per output file or per message, depending on the output format. Enter the maximum number of items to be saved in the output. For file formats, the default value is 10,000. For a web service output format, the default value is 1000.
A value in this field is required.
Output Register Reads to Separate Message
Determines whether IEE exports register reads in a separate web services message. Select to export register reads in a separate web service message from interval data. Clear to export register reads in the same message as interval data. This parameter displays when the output format is web services.
Output Events to Separate Message
Determines whether IEE exports events in a separate web services message. Select to export events separately from interval data. If you select this parameter, use the Data Selection tab to define event-related parameters such as reading status and summary statistics. Clear to exclude events from the export. This parameter displays when the output format is web services.
For more information about Task Template Parameters in the bottom pane, see Task template parameters.
Click Save.