The User Interface
Content Manager DataPort is designed to generate a configuration file via DataPort.exe for the import or export process you want to carry out. That configuration file is then processed by DataPortEngine.exe to complete the import or export job. When using the Content Manager DataPort UI the following methods of the interface will be called by the DataPort UI at different times in order to gather and store the appropriate information in the configuration file.
- KwikSelectCaption is the caption that appears above the source data location field in the UI. When the native Tab Delimited File Format is selected and the Data Direction is set to Import this caption reads Import File Path. You can replace this caption by returning a string in the KwikselectCaption method that best represents your data location. For example, if the source data is a SQL database you could return “Import Database” or “SQL Connection”.
- Browse is called when a user clicks the KwickSelect button on the source data location field (Import File Path when using native Tab Delimited file format). Here you can give what assistance you want to the user to generate an appropriate value for source data location. Your code will later have to use this value to identify and connect to the location of the source data. To continue the above SQL example, this could be a database connection string.
- GetFieldNames is called when the source data location is changed. This enables a refresh of the fields for the field to field map.
- Validate is called when the source data location is changed by typing rather than the Browse and the field loses focus. This enables you to indicate if the entry typed by the user is valid or not.
The same methods are called when doing an export except for GetFieldNames which is only used in import data formatters.
Now that the configuration file has the required information Content Manager DataPort can execute the configuration and complete the import or export.