A design basis document has to be configured in order to store retrieved data as a design basis and compare it with further data being retrieved and existing data. Standard document and file classes need to be created as shown below. They need to be in the authoring schema component, for example, ProcessD.
The document master realizes a primary interface and the following standard document interfaces:
-
IObject
-
ISPFClassifiedItem
-
ISPFDocument
-
ISPFDocumentMaster
-
ISPFDocumentObject
-
ISPFNonPublishedDocMaster
The document revision realizes a primary interface and the following standard document interfaces:
-
IObject
-
ISPFDocumentObject
-
ISPFDocumentRevision
-
ISPFNonPublishedDocRevision
-
ISPFWorkflowItem
The document version realizes a primary interface and the following standard document interfaces:
-
IObject
-
ISPFDocumentObject
-
ISPFDocumentVersion
-
ISPFExportableItem
-
ISPFFileComposition
-
ISPFNonPublishedDocVersion
-
ISPFOwnedObj
A dedicated file class is configured that realizes a primary interface and the following standard document interfaces:
-
IObject
-
ISPFAlternateRenditionComposition
-
ISPFBusinessFile
-
ISPFDesignBasisFile
-
ISPFFile
-
ISPFMarkupComposition
-
ISPFNavigationFileComposition
-
ISPFOwnedObj
There is no need to configure any create method as these documents are created on retrieve. It is usual to create a QFind menu option based on the document revision primary interface.
The documents are classified which means a document category needs to be created under the System Documents node, for example Retrieved Process Document.
To utilize the design basis document, the adapter header file to be edited:
-
Set the DesignBasisComponentSchema UID, for example ProcessDesignComponent.
-
Set the OnRetrieve Action to:
-
DesignBasisLoad - Creates a design basis document and attaches the transformed data, the delete instructions, and any view files to it.
-
DesignBasisLoadAndCompare - Similar to action DesignBasisLoad, but launches the Compare dialog box with the results.
-
-
Set the DesignBasisClassification to the document category of the document, for example Retrieved Process Document.
As well as comparing the incoming data on retrieve, various compare methods can be configured to compare data on the shortcut menu of the design basis document.
For more information about the APIs and methods used to compare with design basis or to compare with the latest retrieved data, see CompareDBasis client API or CompareLatestRetrievedData client API.