Template:— swedish_defence_assigning_document_reference (sd_asg_doc_ref)
Context:— FMV

Date: 2008/02/21 16:26:08
Revision: 1.2

Cover Contents Description Model diags.Input params.Ref. params.Instantiation path Instance diags.Characterizations Issues in situ

This section specifies the template swedish_defence_assigning_document_reference.

NOTE The template has been defined in the context of FMV. 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.

Description

This template describes how to represent a reference to a document, without any version identification.

Model diagrams

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

Figure 1 — An EXPRESS-G representation of the Information model for swedish_defence_assigning_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 swedish_defence_assigning_document_reference template

Input parameters

The following input parameters are defined for this template:

id (Type='STRING')

The identifier for the document being referenced.

id_class_name (Type='CLASS')

The name of the class used to classify the document identifier.

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)

id_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The id of the External_class_library storing the @id_class_name class

org_id (Type='STRING')

The identifier of the organization that "owns" the document identifier.

org_id_class_name (Type='CLASS')

The name of the class being used to classify the identification of the organization. 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 id of the External_class_library storing the @org_id_class_name class

doc_asg_class_name (Type='CLASS')

The name of the class being used to classify the Document_assignment, i.e. providing the role of the referenced Document

The following classes and their sub-classes can be used:

classifications: "Document_assignment" (urn:plcs:rdl:std:Document_assignment)

doc_asg_ecl_id (Default=urn:plcs:rdl:std,Type='URN')

The id of the External_class_library storing the @doc_asg_class_name class

is_assigned_to (Type= 'SELECT (documented_element_select)' )

The items to which the 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 = $swedish_defence_assigning_document_reference.doc%

where target is the parameter to which the Document is bound.

doc_asg(Type='ENTITY (Document_assignment)')

Allow the Document_assignment entity instantiated in this path to be referenced when this template is used.

Note: The Document_assignment entity can be referenced in a template path by:

%^target = $swedish_defence_assigning_document_reference.doc_asg%

where target is the parameter to which the 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 (swedish_defence_assigning_document_reference) namely: id, id_class_name, 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.

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=@id,
    id_class_name=@id_class_name,
    id_ecl_id=@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 document to the entity given by the
-- input parameter @is_assigned_to
-- and classify it as 'Document_reference' or subtype thereof
/assigning_document(
    assigned_document=^doc,
    is_assigned_to=@is_assigned_to,
    doc_ass_role=@doc_asg_class_name,
    doc_ar_ecl_id=@doc_asg_ecl_id)/

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

Instance diagrams

The instance diagram in Figure 3 shows an example of the EXPRESS entities and templates that are instantiated by the template:

/swedish_defence_assigning_document_reference(id='BICYCLEXXXAAA-AAA-DA1-00-00-0000-341A-A', id_class_name='Data_module_code', id_ecl_id='urn:plcs:rdl:sample', org_id='FMV', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std', doc_asg_class_name='Document_reference', doc_asg_ecl_id='urn:plcs:rdl:std', is_assigned_to='#1')/

(an illustration of the consolidated swedish_defence_assigning_document_reference template is shown in Figure 4 below.)

Figure 3 — Entities instantiated by swedish_defence_assigning_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:

Figure 4 — Instantiation of swedish_defence_assigning_document_reference template

Characterizations

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