Template:— document_association (doc_assn)
Context:— UK_Defence

Date: 2009/04/17 11:15:54
Revision: 1.2

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

This section specifies the template document_association.

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.

Description

This template describes how to represent the UK_Defence concept of a document association in terms of PLCS model elements (templates, entities, and reference data).

Business perspective

This information object represents the association of a Document with another information object.

Example uses of this may be to associate policy or standards documents with Task objects or to associate drawings with Product Design objects.

Business object definition

This information object represents the association of a Document with another information object.

Figure 1 — Graphical Representation for Business Object Document Association

Attribute name	Attribute description	Attribute type	Optionality
ID	This is the identifier of the Document Association relationship.	Identifier	Mandatory
Identifier.id	This is the value of the id attribute of the Identifier applied to the Document Association.	intrinsic	Mandatory
Identifier.type	This attribute is the type associated with the id of the Identifier given to the Document Association. This must be one of the classes provided.	Standard or Design	Mandatory
Identifier.source_organization	This attribute is the value representing the source organization that provides the id of the Identifier given to the Document Association. This value is assumed to be a type of Organization_identification_code.	Organization_identification_code	Mandatory
Identification Date	This is the date and time on which the Document Association was created.	Intrinsic	Optional
Purpose	This attribute provides the role of the Document assigned.	Intrinsic	Mandatory
Related Document	This is the reference to the Document that is associated with the Related Item.	Document	Mandatory
Related Item	This is the reference to the item to which the Related document is associated.	documented_element_select	Mandatory

Table 1 — Document association attribute details

Model diagrams

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

Figure 2 — An EXPRESS-G representation of the Information model for document_association

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 document_association template

Input parameters

The following input parameters are defined for this template:

id (Type='STRING')

The identifier of the document assignment.

type (Default=Document_assignment_identification_code,Type='CLASS')

This attribute is provides the type associated with the id of the Identifier given to the Document_assignment. This must be one of the classes provided.

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

classifications: [Document_assignment_identification_code]

Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml

source_organization (Type='STRING')

The organization or information system that created the associated identifier. Alternatively this could be set to /NULL and when Person or Information System is the source; see Identifier template characterizations.

purpose (Default=Document_association,Type='CLASS')

The role of the document assignment.

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

classifications: "Document_assignment" (urn:plcs:rdl:std:Document_assignment), [Document_association]

Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
[Book_of_reference]

Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml

identification_date_year (Type= 'TYPE (year_number)' , Optional)

Year_component of the date and time of the document assignment. This parameter is optional. If not given, it will remain unset.

identification_date_month (Type= 'TYPE (month_in_year_number)' , Optional)

Month_component of the date and time of the document assignment. This parameter is optional. If not given, it will remain unset.

identification_date_day (Type= 'TYPE (day_in_month_number)' , Optional)

Day_component of the date and time of the document assignment. This parameter is optional. If not given, it will remain unset.

identification_date_hour (Type= 'TYPE (hour_in_day)' , Optional)

Hour_component of the date and time of the document assignment. f not given, it will remain unset.

identification_date_minute (Type= 'TYPE (minute_in_hour)' , Optional)

Minute_component of the date and time of the document assignment. This parameter is optional. If not given, it will remain unset

identification_date_second (Type= 'TYPE (second_in_minute)' , Optional)

Second_component of the date and time of the document assignment. This parameter is optional. If not given, it will remain unset.

related_document (Type= 'SELECT (assigned_document_select)' )

The assigned document.

related_item (Type= 'SELECT (documented_element_select)' )

The item to which the document is assigned.

Reference parameters

The following reference parameters are defined for this template:

doc_assoc(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 = $document_association.doc_assoc%

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

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.

/assigning_document(
    doc_ass_role=@purpose,
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=@related_document,
    is_assigned_to=@related_item)/

-- assign ref parameters
%^doc_assoc = $assigning_document.doc_asg%

-- id
/identifier(
    ID=@id,
    source_organization=@source_organization,
    type='Document_assignment_identification_code',
    items=^doc_assoc)/

-- identification date
/assigning_time(
    date_class_name='Date_time',
    date_ecl_id='urn:plcs:rdl:uk_defence',
    year=@identification_date_year,
    month=@identification_date_month,
    day=@identification_date_day,
    hour=@identification_date_hour,
    minute=@identification_date_minute,
    second=@identification_date_second,
    sense='.EXACT.',
    hour_offset='0',
    minute_offset='0',
    items=^doc_assoc)/

Instance diagrams

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

/document_association(id='BR000200', type='Document_assignment_identification_code', source_organization='6421', purpose='Book_of_reference', identification_date_year='2003', identification_date_month='04', identification_date_day='15', identification_date_hour='12', identification_date_minute='00', identification_date_second='0', related_document='@225', related_item='@126')/

(an illustration of the consolidated document_association template is shown in Figure 5 below.)

Figure 4 — Entities instantiated by document_association 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:

Figure 5 — Instantiation of document_association template

Characterizations

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