The Exchange Data functionality enables you to export data and documents to CSV files. You can validate and export these CSV files to a target system using Data Validator. To use this feature, you must create a custom method using the delivered SPFExchangeData client API and associate it with the type of object you want to export.
The Exchange Data command allows you to:
-
Create a report configuration object to generate basic and inverted CSV files using view definitions and graph definitions, respectively.
-
Create an export details object that contains all the required parameters to run a Data Validator job or to generate a control file in XML format for silently running a Data Validator job, to validate the documents and data in CSV files and export them to a target system.
The report configuration object contains details of view definitions and graph definitions, as well as additional parameters, such as the type of CSV file, inclusion of superseded revisions and working revisions, CFIHOS format for export, and so on. For more information on how to create view definitions and graph definitions, see Create a Graph Definition and Create a View Definition. The view definitions and graph definitions are used to gather objects by traversing relationships.
The custom method configured using the SPFExchangeData client API and the graph definition
used for generating CSV files must be configured on the same interface definition.
Mappings for CSV files using Data Validator
You configure the mapping for importing data using Data Validator. Data Validator imports data in CSV format into the staging system where the validation takes place. Data Validator uses import definitions to map the column headers in the input CSV file to the correct column headers for objects, properties, and relationships in the staging area. The import mapping not only uses the physical column headers that already exist in the input data file, but also supports other column headers that are computed or provided by the user during the import process. Data Validator validates the quality of the incoming data in the supplied files before they are loaded into the system. For more information on import mappings for documents and data, see Document mappings and Tag mappings.
Access groups and roles
Two access groups, SPFExchangeDataAdmin and SPFExchangeDataUser, and two roles, ExchangeData Administrator and ExchangeData User, are delivered with the software.
The SPFExchangeDataAdmin access group and the ExchangeData Administrator role enable you to access the Exchange Data menu options and associated methods for creating and finding the report configuration and export details objects. These access groups and roles are mapped to the Superuser user group by default. If required, they can be mapped to other users. For more information about access groups and roles, see How to Configure the Security Model.
The following work process diagram illustrates the steps involved in the export of data and documents to CSV files, and the subsequent validation and export of these CSV files to a target system using Data Validator.
Click a box in the diagram to go to the associated procedure.