To reserve a document, it is necessary to create a form for the document master and relate it to the document master class.
The form for reserving the document master has the following standard sections:
Name |
Display as |
Purpose |
Level |
---|---|---|---|
DocNameDesc_C-Section |
Main details |
Activate, Revise, Copy, Create |
$1/$2/$3 |
ISPFReservedDocument-Section** |
Document properties |
Copy, Create, Query, Update, GetInfo |
Not specified as it is used on a vendor doc master form on a single level |
DocGenDetails_QI-Section |
General details |
GetInfo, Query |
$3 |
** This section is different from the regular document form section in that it has a different display item for the document state that has a default value of RESERVED_INACTIVE.
A form can still be created for a document version for the regular creation of a complete document, as described in Basic document configuration. Because the ISPFDocumentMaster interface is optionally realized, the following hidden section has to be created and attached to the form to ensure that this interface is instantiated.
Name |
Display as |
Purpose |
---|---|---|
ISPFDocumentMaster-Section |
Document Master Interface |
Create |
-
To reserve a document, we do not instantiate ISPFDocumentMaster.
-
To create a document, we need to instantiate ISPFDocumentMaster, but this is an optional interface; it does not have any properties, so it is not created by default. The only way to force its creation is to create an interface display item on the form.
Display item
Name: Doc-ISPFDocumentMasterIDef
Type: Interface Definition
Interface: ISPFDocumentMaster
Default Create value = True
This display item would appear on the form as a Boolean, but the whole section is hidden, as no user input is required.