Template:— work_order_relationship (wk_ord_rel)
Context:— UK_Defence

Date: 2010/03/15 15:09:16
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 work_order_relationship.

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 relationship between two work orders, where the related work order was originated by or derived from the relating work order.

Business perspective

The Work Order Relationship business object is used by those UK_Defence Data Exchange Specifications to represent a relationship between two work orders, where the related work order was originated by or derived from the relating work order.

Business object definition

Figure 1 — Graphical Representation for Business Object Work Order Relationship

Work Order Relationship

The definition of a Work Order Relationship object is: This information object represents information about the relationship between two work orders, where the related work order was originated by or derived from the relating work order.

Attribute name	Attribute description	Attribute type	Optionality
Description	The description of the relationship of the related work order with respect to the relating work order.	Intrinsic	Optional
ID	This is the identifier of the work order relationahip.	Identifier	Mandatory
Related work order	The reference to the work order that has been derived from the relating work order.	Work Order	Mandatory
Relating work order	The reference to the work requirement from which the related work requirement was derived.	Work Order	Mandatory

Table 1 — Work Order Relationship attribute details

Model diagrams

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

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

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

Input parameters

The following input parameters are defined for this template:

description (Type='STRING', Optional)

This is a description of the relationship of the related work order with respect to the relating work order.

ID (Type='STRING')

This is the identifier of the work order relationahip.

source_organization (Type='STRING')

The organization that created the associated identifier. Additionally a Person or Information System could be defined when either of these are the source; see Identifier template characterizations

related_work_order (Type= 'ENTITY (Work_order)' )

The reference to the work order that has been derived from the relating work order.

relating_work_order (Type= 'ENTITY (Work_order)' )

The reference to the work requirement from which the related work requirement was derived.

Reference parameters

The following reference parameters are defined for this template:

wrk_ord_rel(Type='ENTITY (Activity_relationship)')

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

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

%^target = $work_order_relationship.wrk_ord_rel%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Unique work order relationship

Each instance of the entity (Activity_relationship) within the data set shall be uniquely identified by a combination of the following parameters on this template (work_order_relationship) namely: ID, related_work_order, relating_work_order.
The instance is referenced by the following template parameter: wrk_ord_rel.

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.

-- instantiate Activity_relationship
Activity_relationship
%^wrk_ord_rel = Activity_relationship%
Activity_relationship.name = 'change_relationship'
Activity_relationship.description = '/IGNORE'
Activity_relationship.relating_activity -> @relating_work_order
Activity_relationship.related_activity -> @related_work_order
/identifier(
    ID=@ID,
    source_organization=@source_organization,
    type='Organization_identification_code',
    items=^wrk_ord_rel)/
%^worid = $identifier.identifier%

-- [Optional Description]
/assigning_descriptor(
    descr=@description,
    class_name='Description',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^worid)/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Activity_relationship.name	'change_relationship'	—
Activity_relationship.description	'/IGNORE'	—

Instance diagrams

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

/work_order_relationship(description='This is a description of WOR123', ID='WOR123', source_organization='UK_Defence', related_work_order='@100', relating_work_order='@1')/

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

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

/work_order_relationship(description='This is a description of WOR123', ID='WOR123', source_organization='UK_Defence', related_work_order='@100', relating_work_order='@1')/

Figure 5 — Instantiation of work_order_relationship template

Characterizations

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