Template:— hardcopy_document (hardcpy_doc)
Context:— UK_Defence |
Date: 2009/04/17 11:55:49
Revision: 1.3
|
This section specifies the template hardcopy_document.
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 template describes how to represent the UK_Defence concept of a hardcopy document in terms of PLCS
model elements (templates, entities, and reference data).
This information object represents a document that is in hardcopy form.
The EXPRESS-G diagram in
Figure
2
shows the templates and EXPRESS entities that are required
to represent the template
"hardcopy_document".
The text highlighted in blue shows the template parameters.
Figure 2 — An EXPRESS-G representation of the Information model for hardcopy_document
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 hardcopy_document template
The following input parameters are defined for this template:
The author of the document.
category (Default=Unknown_data_type,Type='CLASS')
The category of the document contents.
The description of the document.
The identifier of the document (Document_identification_code).
The name of the document.
The version identifier of the Digital_document (Version_identification_code).
An Organization representing the publishing authority of the Document. This attribute represents ownership and the authority
to release the document, even if the document has been prepared by a different organization.
The security classification of the Document. Actual sub-classification codes need to be determined by the exchange partners
and added to the reference data library.
The following classes and their sub-classes can be used:
classifications: [Security_classification_code]![[warning:]](../../../../../../images/dex/warning.gif)
Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
The valid from date of document.
The valid to date of document.
The physical location of the document.
The following reference parameters are defined for this template:
Allow the
Document
entity instantiated in this path to be referenced when this template is used.
Note: The
Document
entity can be referenced in a template path by:
%^target = $hardcopy_document.document%
where
target
is the parameter to which the
Document
is bound.
Allow the
Document_version
entity instantiated in this path to be referenced when this template is used.
%^target = $hardcopy_document.document_version%
Allow the
Document_definition
entity instantiated in this path to be referenced when this template is used.
%^target = $hardcopy_document.document_definition%
%^target = $hardcopy_document.physical_document_definition%
Allow the
Hardcopy
entity instantiated in this path to be referenced when this template is used.
Note: The
Hardcopy
entity can be referenced in a template path by:
%^target = $hardcopy_document.hardcopy%
where
target
is the parameter to which the
Hardcopy
is bound.
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.
-- document subtype /
document(
author=@author,
category=@category,
description=@description,
id=@id,
name=@name,
version=@version,
releasing_authority=@releasing_authority,
security_classification=@security_classification,
valid_from_date=@valid_from_date,
valid_to_date=@valid_to_date)/
-- assign ref parameters %^document = $document.document%
%^document_version = $document.document_version%
%^document_definition = $document.document_definition%
-- hardcopy file /
representing_hardcopy_file(
hardcopy_id='',
hardcopy_id_class_name='',
hardcopy_id_ecl_id='',
hardcopy_org_id='',
hardcopy_org_id_class_name='',
hardcopy_org_id_ecl_id='',
hardcopy_vn_id='',
hardcopy_vn_id_class_name='',
hardcopy_vn_id_ecl_id='',
hardcopy_vn_org_id='',
hardcopy_vn_org_id_class_name='',
hardcopy_vn_org_id_ecl_id='',
cont_data_type_class_name='',
cont_data_type_ecl_id='' )/
-- assign ref parameters %^hardcopy = $representing_hardcopy_file.hardcopy%
Physical_document_definitionPhysical_document_definition.defined_version ->
^document_version
Physical_document_definition.components ->
^hardcopy
-- physical location Location_assignmentLocation_assignment.entity_for_location ->
^hardcopy
Location_assignment.location_for_assignment ->
@physical_location
The instance diagram in Figure
4
shows an example of the EXPRESS entities and templates that are instantiated by the template:
/hardcopy_document(author='#193', category='Manual', description='CADMID Best Practice', id='JSP 886 Vol 13', name='Project 886 JSP Best Practice', version='Issue 2', releasing_authority='#226', security_classification='Security_classification_code(A)', valid_from_date='#262', physical_location='#159')/
(an illustration of the consolidated hardcopy_document template is shown in
Figure
5 below.)
Figure 4 — Entities instantiated by hardcopy_document 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:
/hardcopy_document(author='#193', category='Manual', description='CADMID Best Practice', id='JSP 886 Vol 13', name='Project 886 JSP Best Practice', version='Issue 2', releasing_authority='#226', security_classification='Security_classification_code(A)', valid_from_date='#262', physical_location='#159')/
Figure 5 — Instantiation of hardcopy_document template
Characterizations
No common characterizations of the template
hardcopy_document
have been identified. However, the ISO 10303-239 EXPRESS model
may enable other assignments to the entities instantiated by the template.
