Template:— related_documents (reld_docs)
Context:— UK_Defence |
Date: 2009/04/17 11:32:30
Revision: 1.3
|
This section specifies the template related_documents.
NOTE
The template has been defined in the context of
UK_Defence.
Refer to the business context for details of related templates.
NOTE
An explanation of a template and the associated instantiation path is
provided in the
Template overview
section.
This information object represents the relationship between two documents.
The definition of the related_documents object is:
This information object represents the relationship between a UK_Defence.Document and another occurrence of UK_Defence.Document.
There may be zero, one or many related Documents.
Figure 1 — Graphical Representation for Business Object Related_documents
|
Attribute name
|
Attribute description
|
Attribute type
|
Optionality
|
| Category |
This is the category of the document relationship. |
Intrinsic |
Mandatory |
| Description |
This is the description of the document relationship. |
Intrinsic |
Optional |
| ID |
This is the identifier of the document relationship. |
Identifier |
Mandatory |
| Identifier.id |
This is the value of the id attribute of the Identifier applied to the
Document Relationship.
|
intrinsic |
Mandatory |
| Identifier.type |
This attribute is the type associated with the id of the Identifier given
to the Document Relationship. This must be one of the classes provided.
|
Document_definition_relationship_identification_code |
Mandatory |
| Identifier.source_organization |
This attribute is the value representing the source organization that
provides the id of the Identifier given to the Document Relationship. This value is assumed to be a
type of Organization_identification_code.
|
Organization_identification_code |
Mandatory |
| Related_document |
This is the reference to the "child" in the document relationship. |
Relationship to Document |
Mandatory |
| Relating_document |
This is the reference to the "parent" in the document relationship. |
Relationship to Document |
Mandatory |
Table 1 — Related_document attribute details
The EXPRESS-G diagram in
Figure
2
shows the templates and EXPRESS entities that are required
to represent the template
"related_documents".
The text highlighted in blue shows the template parameters.
Figure 2 — An EXPRESS-G representation of the Information model for related_documents
The graphic for the template to be used in other EXPRESS-G diagrams
is shown in Figure
3
below.
Figure 3 — The graphical representation of the related_documents template
The following input parameters are defined for this template:
category (Default=Related_document,Type='CLASS')
The organization or information system that created the associated identifier. Alternatively this could be set to /NULL when
Person or Information System is the source; see Identifier template characterizations.
The following reference parameters are defined for this template:
%^target = $related_documents.doc_def_reln%
The instantiation path shown below specifies the entities that are to be
instantiated by the template.
A description of templates and the syntax for the instantiation path is
provided in the
Templates Help/Information section.
The following entities are instantiated with attributes as specified:
The instance diagram in Figure
4
shows an example of the EXPRESS entities and templates that are instantiated by the template:
/related_documents(category='Related_document', description='Supporting manual documentation', id='89494', source_organization='6421', relating_document='#270', related_document='#271')/
(an illustration of the consolidated related_documents template is shown in
Figure
5 below.)
Figure 4 — Entities instantiated by related_documents template
The instance diagram in
Figure
5
shows the graphic symbol for the template that is to be
used in other instance diagrams. The example template is:
/related_documents(category='Related_document', description='Supporting manual documentation', id='89494', source_organization='6421', relating_document='#270', related_document='#271')/
Figure 5 — Instantiation of related_documents template
The following section details how the
related_documents
template can be optionally characterized by assigning
other constructs to it. These are characterizations commonly
applied to the template. The ISO 10303-239 EXPRESS model may enable
other assignments to the entities instantiated by the template.
The EXPRESS-G diagram in Figure
6
shows the possible characterizations of the template
"related_documents".
Figure 6 — Characterizations for related_documents
The following characterizations may apply:
Characterization Actual applicability date
NOTE this characterization is optional.
/assigning_dated_effectivity(start_year='2005', start_month='11', start_day='22', start_hour='15', start_minute='15', start_second='00', start_sense='ahead', start_hour_offset='2', role_class_name='Actual_effectivity', role_ecl_id='urn:plcs:rdl:std', items='@@@@')/
Characterization Planned applicability date
NOTE this characterization is optional.
/assigning_dated_effectivity(start_year='2005', start_month='11', start_day='22', start_hour='15', start_minute='15', start_second='00', start_sense='ahead', start_hour_offset='2', role_class_name='Planned_effectivity', role_ecl_id='urn:plcs:rdl:std', items='@@@@')/
Characterization Status Assignment
NOTE this characterization is optional.
An UK_Defence.related_documents
may have one or more status assigned to it, through the use of the following templates (or those based upon these):
UK_Defence.status_assignment.
The following template calls show how these characterizations
might be instantiated.
/status_assignment(assigned_status='', assigned_status_ecl_id='', ID='', ID_type='', ID_organization='', subject='', type='', type_ecl_id='')/
![[warning:]](../../../../../../images/dex/warning.gif){kind=small}
Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
