Template:— assigning_partial_document_reference (asg_partial_doc_ref) Date: 2010/01/28 15:28:35
Revision: 1.6

This section specifies the template assigning_partial_document_reference.

NOTE  An explanation of a template and the associated instantiation path is provided in the Template overview section.

Description

This template describes how to represent a reference to a portion of a version of a document.

NOTE    Reference to a document where the version is not known (of not of interest), shall follow the guidelines described in the template assigning_identification.

Model diagrams
The EXPRESS-G diagram in Figure 1 shows the templates and EXPRESS entities that are required to represent the template "assigning_partial_document_reference". The text highlighted in blue shows the template parameters.


Figure 1 —  An EXPRESS-G representation of the Information model for assigning_partial_document_reference

Figure 1 —  An EXPRESS-G representation of the Information model for assigning_partial_document_reference

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure  2 below.


Figure 2 —  The graphical representation of the assigning_partial_document_reference template

Figure 2 —  The graphical representation of the assigning_partial_document_reference template

Input parameters
The following input parameters are defined for this template:
doc_id (Type='STRING')
The identification of the Document being referenced.
doc_id_class_name (Default=Document_identification_code,Type='CLASS')
The name of the External_class that determines the type of identifier given by the input parameter @doc_id.
The following classes and their sub-classes can be used:
classifications: "Document_identification_code" (urn:plcs:rdl:std:Document_identification_code), "Document_name" (urn:plcs:rdl:std:Document_name)
doc_id_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The identification of the External_class_library storing the External_class given by the input parameter @doc_id_class_name.
doc_ver_id (Type='STRING')
The identification of the Document_version being referenced.
doc_ver_id_class_name (Default=Version_identification_code,Type='CLASS')
The name of the External_class that determines the type of identifier given by the input parameter @doc_ver_id.
The following classes and their sub-classes can be used:
classifications: "Progression_identification_code" (urn:plcs:rdl:std:Progression_identification_code)
doc_ver_id_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The identification of the External_class_library storing the External_class given by the input parameter @doc_ver_id_class_name.
org_id (Type='STRING')
The identification or name of the Organization that "owns" the Document and Document_version identifiers (@doc_id and @doc_ver_id).
org_id_class_name (Default=Organization_name,Type='CLASS')
The name of the External_class that determines the type of organization identification (@org_id) being used. For example CAGE code.
The following classes and their sub-classes can be used:
classifications: "Organization_identification_code" (urn:plcs:rdl:std:Organization_identification_code), "Organization_name" (urn:plcs:rdl:std:Organization_name)
org_id_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The identification of the External_class_library storing the External_class given by the input parameter @org_id_class_name
doc_portion (Type='STRING')
A textual description identifying the portion of the document being referenced.
doc_asg_class_name (Default=Partial_document_reference,Type='CLASS')
The name of the External_class that determines the role of Partial_document_assignment, i.e. providing the role of the referenced Document
The following classes and their sub-classes can be used:
classifications: "Partial_document_reference" (urn:plcs:rdl:std:Partial_document_reference)
doc_asg_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The identification of the External_class_library storing the External_class given by the input parameter @doc_asg_class_name.
is_assigned_to (Type= 'SELECT (documented_element_select)' )
The items to which the referenced document is assigned.
Reference parameters
The following reference parameters are defined for this template:
doc(Type='ENTITY (Document)')
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 = $assigning_partial_document_reference.doc%
where target is the parameter to which the Document is bound.
doc_ver(Type='ENTITY (Document_version)')
Allow the Document_version entity instantiated in this path to be referenced when this template is used.
Note: The Document_version entity can be referenced in a template path by:
%^target = $assigning_partial_document_reference.doc_ver%
where target is the parameter to which the Document_version is bound.
partial_doc_asg(Type='ENTITY (Partial_document_assignment)')
Allow the Partial_document_assignment entity instantiated in this path to be referenced when this template is used.
Note: The Partial_document_assignment entity can be referenced in a template path by:
%^target = $assigning_partial_document_reference.partial_doc_asg%
where target is the parameter to which the Partial_document_assignment is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Unique document
Each instance of the entity (Document) within the data set shall be uniquely identified by a combination of the following parameters on this template (assigning_partial_document_reference) namely: doc_id, doc_id_class_name, doc_id_ecl_id, org_id, org_id_class_name, org_id_ecl_id.
The instance is referenced by the following template parameter: doc.
This rule means that there can be only one document (Document) with any given identifier.
Unique constraint: Unique document version
Each instance of the entity (Document_version) within the data set shall be uniquely identified by a combination of the following parameters on this template (assigning_partial_document_reference) namely: doc_id, doc_id_class_name, doc_id_ecl_id, org_id, org_id_class_name, org_id_ecl_id, doc_ver_id, doc_ver_id_class_name, doc_ver_id_ecl_id.
The instance is referenced by the following template parameter: doc_ver.
This rule means that there can be only one version (Document_version) of a document (Document) with any given identifier.
Instantiation path
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

-- Mark the Document entity as
-- referable when this template is used by binding it to the reference
-- parameter doc
%^doc = Document%
Document.id = '/IGNORE'
Document.name = '/IGNORE'
Document.description = '/IGNORE'

-- assign the identification to the Document
/assigning_identification(
    items=^doc,
    id=@doc_id,
    id_class_name=@doc_id_class_name,
    id_ecl_id=@doc_id_ecl_id,
    org_id=@org_id,
    org_id_class_name=@org_id_class_name,
    org_id_ecl_id=@org_id_ecl_id)/

-- Mark the Document_version entity as
-- referable when this template is used by binding it to the reference
-- parameter doc_ver
Document_version
%^doc_ver = Document_version%
Document_version.id = '/IGNORE'
Document_version.description = '/IGNORE'

-- assign the identification to the Document_version
/assigning_identification(
    items=^doc_ver,
    id=@doc_ver_id,
    id_class_name=@doc_ver_id_class_name,
    id_ecl_id=@doc_ver_id_ecl_id,
    org_id=@org_id,
    org_id_class_name=@org_id_class_name,
    org_id_ecl_id=@org_id_ecl_id)/

-- assign the referenced portion of a document to the entity given by the
-- input parameter @is_assigned_to
-- and classify it as 'Document_reference' or subtype thereof
/assigning_partial_document(
    doc=^doc_ver,
    is_assigned_to=@is_assigned_to,
    doc_asg_role=@doc_asg_class_name,
    doc_asg_role_ecl_id=@doc_asg_ecl_id,
    doc_portion=@doc_portion)/

-- Mark the Partial_document_assignment entity in the template assigning_partial_document as
-- referable when this template is used by binding it to the reference
-- parameter doc_asg
%^partial_doc_asg = $assigning_partial_document.partial_doc_asg%
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Document.id '/IGNORE' Product.id
Document.name '/IGNORE' Product.name
Document.description '/IGNORE' Product.description
Document_version.id '/IGNORE' Product_version.id
Document_version.description '/IGNORE' Product_version.description
Instance diagrams
The instance diagram in Figure  3 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/assigning_partial_document_reference(doc_id='BICYCLEXXXAAA-AAA-DA1-00-00-0000-341A-A', doc_id_class_name='Data_module_code', doc_id_ecl_id='urn:plcs:rdl:sample', doc_ver_id='1', doc_ver_id_class_name='Issue_number', doc_ver_id_ecl_id='urn:plcs:rdl:sample', org_id='ASD', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std', doc_asg_class_name='Partial_document_reference', doc_asg_ecl_id='urn:plcs:rdl:std', doc_portion='Figure 3', is_assigned_to='#1')/
(an illustration of the consolidated assigning_partial_document_reference template is shown in Figure 4 below.)


Figure 3 —  Entities instantiated by assigning_partial_document_reference template

Figure 3 —  Entities instantiated by assigning_partial_document_reference template

The instance diagram in Figure 4 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:
/assigning_partial_document_reference(doc_id='BICYCLEXXXAAA-AAA-DA1-00-00-0000-341A-A', doc_id_class_name='Data_module_code', doc_id_ecl_id='urn:plcs:rdl:sample', doc_ver_id='1', doc_ver_id_class_name='Issue_number', doc_ver_id_ecl_id='urn:plcs:rdl:sample', org_id='ASD', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std', doc_asg_class_name='Partial_document_reference', doc_asg_ecl_id='urn:plcs:rdl:std', doc_portion='Figure 3', is_assigned_to='#1')/


Figure 4 —  Instantiation of assigning_partial_document_reference template

Figure 4 —  Instantiation of assigning_partial_document_reference template

Characterizations
No common characterizations of the template assigning_partial_document_reference have been identified. However, the ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.

© OASIS 2010 — All rights reserved