Automated Data Exchange in AVEVA Change Manager

This feature handles both import and export of data based on the configuration settings made in TIM.WDA.SystemApplication.Config.xml. Your administrator can configure the export and import folders using the <DataExchange exportPath="C:\DocumentManager.TIM\Export" importPath="C:\DocumentManager.TIM\Import"/> element in web.config.xml during the installation. For more information, refer to AVEVA NET Gatekeeper and AVEVA Change Manager Administration Guide.

Automated Data Exchange: Data Export

You can use AVEVA Change Manager to export a Modification Project. Projects that are marked for data exchange can be periodically exported into an export file on your local Windows folder. You can use the Data Exchange: Configure Modification Projects page under the System Settings page to configure data exchange management for Modification Projects and Work Packages.

The Data Exchange section is visible only if the DataExchange value is set to true in the following DataManagementEnabledFor section of the TIM.ApplicationFactory.xml file. The data export XML file name conforms to the <ModificationProjectCategoryCode>_<ContractorCode>_<ModificationProjectCode>_<CreationDateAndTime>.xml naming convention:

<WDA.Application.Configuration xmlns="WDA.Application.Configuration">
<ApplicationSettings>
<Group name="TIM.ApplicationProfile" xmlns="TIM.Application.Configuration">
<DataManagementEnabledFor>
<DataExchange value="true"/>
</DataManagementEnabledFor>
</Group>
</ApplicationSettings>
</WDA.Application.Configuration>

To configure data exchange for Modification Projects and Work Packages:

1. In System Settings, access the Data Exchange: Configure Modification Projects page.

2. Either add or select a Modification Projects Category to the Modification Projects Categories tab. Use the New Category link to add a Modification Project Category, and select the statuses that the associated Working Sets need to conform to.

3. The Modification Projects tab contains the list of Modification Projects available for export. If a new Modification Project needs to be added, click Add Modification Project and select from the list of Assets in the context of Modification Projects.

4. In the details page, select the Data Exchange corresponding to a Modification Project. The Working Set and Work Package details that correspond to the Modification Project are displayed in the XML file, grouped by the Work Package code.

5. In the Modification Projects Categories tab, provide the category code and category name in the respective fields.

6. Generate an export XML file.

The export path is configured in the web.config file. You can use the following path in the file to configure the XML path for export:

<configuration>
<TIM>
<DataExchange exportPath="C:\DocumentManager.TIM\Export" />
</TIM>
</configuration>

Notes:

- When the Contractor role is enabled, while the Modification Project is exported, a contractor's folder is created in the export path. The name of this folder is the same as the contractor's code, and the folder contains the data export files that relate to the Modification Project.

- If neither the Working Set nor any of its underlying Tags, Documents, Attributes and References are updated, the Working Set is skipped, and the export file for the Working Set is not created in the export directory.

- When a Modification Project Category is not assigned to a Modification Project, only the Active Working Sets are exported. When a Modification Project Category is assigned to a Modification Project, only those Working Sets statuses that are specified in the Modification Project Category are exported. If no status is specified in the Modification Project Category, you cannot export the corresponding Modification Project and the data export files is not created. The Modification Projects tab contains the list of Modification Projects available for export. If you to need to add a Modification Project , click Add Modification Project and select from the list of Assets in the context of Modification Projects.

Note: A list of external Modification Projects is displayed only if you integrate the data with AVEVA WorkMate™.

- The structure of the Modification Project XML is subject to the application configuration. For example, if Work Packages are enabled, the Modification Project export file contains Work Package collection. If Work Packages are not enabled, the Working Sets are collected under a dummy or empty Work Package.

Automated Data Exchange: Data Import

Based on the system configuration, in TIM.WDA.SystemApplication.Config.xml, AVEVA Change Manager uses an import service to periodically check for XML files available for import from the C:\DocumentManager.TIM folder. AVEVA Change Manager periodically inspects an inbound Windows folder configured by your administrator for a Working Set Bulk Upload XML file or set of files. The application validates the files being uploaded, and reports errors that occur in an XML file, which is available in the sub-folder configured by the import service. Once the file is imported, the import service automatically creates an outbound folder for the file to place the result. Ensure that the NETWORK SERVICE account has the required permissions for AVEVA Change Manager to access the C:\DocumentManager.TIM\ImportCM\<Customer Name> folder. You can use the settings in the TIM.DataExchange.ImportService import service to automate the process.

Note: The Brownfield Bulk Upload Working Set XML file should not contain the projectOwnerName attribute because this attribute is applicable for AVEVA NET Gatekeeper.