The retrieve and compare process is as follows:
-
Verify tool registration is done by constructing a name from the domain (defined in argument 2), the current create configuration (as set in the Desktop Client), and the database code (if it is defined in argument 4), and checking this to see if an SPFAuthRegistration record exists in the authoring database with this name. If the check fails, a Tool not registered message is displayed.
-
Verify SPFAdapterFile objects in the database with the adapter code defined in argument3. The two files that need to be present are the tool map schema and the tool adapter header file.
-
Verify the tool map schema and the tool adapter header file are present in the temporary directory on the client. If they are not there, then these files are downloaded from the database to the temporary directory. If they are available on the client, then a date comparison is made to see if the files in the database are newer or not, and only if they are newer will the files be downloaded.
-
The tool adapter header file is read where information such as what document types can be retrieved is extracted. This information is then sent to the data warehouse system.
-
The GUI is displayed and the possible documents that can be retrieved are displayed in the dialog box.
-
On selection of a document, the name of the associated component schema is extracted. Two checks are then made.
-
Verify the component schema exists on the server and is newer than the creation date of the CMF file that is stored in the vault. If it is not, then a call is made to the Schema Component to extract the latest version.
-
Verify a local copy of the component schema exists and is newer than data warehouse version. If it is not, a copy is made.
-
-
The data, map file, and component schema are loaded into the Schema Component and run through the adapter to generate the necessary load file on the client.
-
The load file is stored, displayed in the compare GUI, or loaded into the authoring database.