Template:- OASIS:Document

The Document template describes how to represent a document. It covers the minimum requirements to represent a Document DocumentVersion and DocumentDefinition or its specialization DigitalDocumentDefinition.

NOTE    In previous editions of PLCS DEXlib organization that do not version documents were recommended to set the identification of the DocumentVersion to "/NULL", i.e. the attribute identifier of entity Identification contains the string "/NULL" to indicate that no version information is relevant or intended. The current recommendation is to provide no versionId. This will result a single un-identified DocumentVersion being produced if a DocumentVersion is required, i.e. when a DocumentDefinition is created.

The SysML Block Definition diagram in Figure 1 shows how a Document is represented in the PLCS PSM.

Template Properties

The following Part, Reference, and Value properties are defined for this template:

References:
viewDefinitionContext [0..1] (Template: OASIS:ViewDefinitionContext)
files [0..*] (Block: Ap239Ap233Psm:DigitalFile)
The content of a digital document.
hardcopies [0..*] (Block: Ap239Ap233Psm:Hardcopy)
The content of a physical document.
Parts:
ids [1..*] (Template: OASIS:Identification)
The collection of identifiers of the document. There shall be at least one identifier that is the document number. Hence there shall be at least one identifier classified to be a "Document_identification_code" or a sub-class of "Document_identification_code".
The reference data used in Template: OASIS:Identification is restricted as follows:
RDL constraint 1:
There must be one identifier that is the document number.
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
descriptions [0..*] (Template: OASIS:Descriptor)
The descriptions of the document.
versionId [0..1] (Template: OASIS:Identification)
The identifier of the document version.
NOTE    If no versionId is specified a unique, unidentified DocumentVersion is created.
The reference data used in Template: OASIS:Identification is restricted as follows:
RDL constraint 1:
The identifier must be a version identifier.
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
classifiedAs [0..*] (Template: OASIS:Classifier)
The classification of the document.
The reference data used in Template: OASIS:Classifier is restricted as follows:
RDL constraint 1:
The reference data for:
OASIS:Classifier.class -> ExternalOwlClass.class
is restricted to classes that are subclasses of the following class: