Configuration export task adapter

Export task template parameter. Request exports by the following request types.

• External System. Exports any entities created or updated since the Last Export Date in the External System table. When the export completes, the Last Export Date is updated accordingly.

• Group. Export all entities that are in the specified groups.

• ID. Export all entities with IDs matching the specified mask.

• Last Update Date. Export all entities that have changed since the specified update date, from all external systems.

• Program. Export all entities created from the specified program. Enter a program ID or search for an ID.

• Status. Export all entities with the specified status.

• User-Defined Attribute. Export all entities with the specified User-Defined Attribute (UDA). The request parameters allow you to define the UDA by name or value or both.

Defines the request parameters for the export task. Select the request type first to show the request parameters. The request parameters depend on the request type. For example, selecting the External System request type shows the External System request parameter. Selecting the Status request type shows the Entity Type, Start Date, and Status request parameters. For more information about request types, see Request 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.

Note: After selecting a meter ID, place the cursor over the Gear icon () to view the meter's capabilities. If a meter ID is not specified, meter capabilities are not applicable.

• External System. The external system of the data to export. This parameter shows with a Request Type of External System.

• Group. The type and ID for the group to include in the export. This parameter shows with a Request Type of Group.

• Entity ID. The specific entity or group to include in the export. This parameter shows with a Request Type of ID.

• Name. The exact name of the user-defined attribute of the data to export. This parameter shows with a Request Type of User-Defined Attribute.

• Start Date/Time. The earliest date and time stamp for the data to export. The export includes all data that was created or updated from this time forward. Select a Start Date from the calendar, then enter the time (hh:mm). This parameter shows with a Request Type of Last Update Date or Status.

• Status. The status of the data to export. Click Search. Click a status to select it, then click OK. This parameter shows with a Request Type of Status.

• Value. The value of the user-defined attribute to export. If the UDA does not have this value, it is not included in the export. This parameter shows with the Request Type of User-Defined Attribute.

Determines whether to export the configuration instance or both the instance and the program. Configuration type is an export task template parameter for program-based configurations.

Export task template parameter. A typical configuration model has a hierarchy of elements. For example, a Service Point may be connected to a Meter and also an Account and a Premise. This parameter controls how much of the hierarchy to export.

• Single. Export the entity itself. For example, if exporting by Meter, only the Meter would be exported.

• Direct. Export the entity and any directly connected entities. For example, if the hierarchy contains Meter, Service Point, and Premise, and the export is by Meter, only the Meter and Service Point would be exported.

• Full. Export the entity and any other entities connected to it either directly or indirectly. If the export is by Meter and the hierarchy contains Meter, Service Point, and Premise, the Meter, Service Point, Account, and Premise would be exported.

Determines whether to export all versions of the entity. Entity configuration in IEE may have multiple versions over time. This is common in the case of account changes or meter swaps. Select to export all versions of the entity. Leave blank to export only the current version (as of the time of the export).

Determines whether to include the linkage information with export data. Linkage information conveys how channels are linked to meters and service points. This is typically embedded in the program information. Select the check box to export this information with the instance. Leave the check box blank to exclude the linkage information.

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.

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