Template:— modification (mod)
Context:— UK_Defence

Date: 2009/04/17 10:13:33
Revision: 1.3

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 modification.

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 a change to a configuration item and the activity that embodies the change on a product.

The change process to a CI after the formal establishment of the product configuration baseline is defined in source DEF STAN 05-57 Issue 5 [Derived]

Business perspective

The modification business object is used by those UK_Defence Data Exchange Specifications that require information about the relationship between a change to a configuration item and the activity that embodies the change on a product.

Business object definition

Figure 1 — Graphical Representation for Business Object Modification

Modification Feedback Parameter:

The definition of a modification object is: Data about the relationship between a change to a configuration item and the activity that embodies the change on a product.

Attribute name	Attribute description	Attribute type	Optionality
Embodiment Method	This is the reference to the Activity that performs the embodiment of the change on the product.	Relationship to Activity	Mandatory
ID	This is the identifier of the Modification.	Identifier	Mandatory
Related Change	This is the reference to the Change that is embodied on the product by the embodiment method.	Relationship to Change Definition	Mandatory

Table 1 — Modification attribute details

Model diagrams

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

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

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

Input parameters

The following input parameters are defined for this template:

embodiment_method (Type= 'ENTITY (Activity)' )

This is the reference to the Activity that performs the embodiment of the change on the product.

ID (Type='STRING')

This is the identifier of the Modification.

source_organization (Type='STRING')

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

related_change (Type= 'ENTITY (Activity_actual)' )

This is the reference to the Change that is embodied on the product by the embodiment method.

Reference parameters

The following reference parameters are defined for this template:

modification(Type='ENTITY (Applied_activity_assignment)')

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

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

%^target = $modification.modification%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Modification

Each instance of the entity (Applied_activity_assignment) within the data set shall be uniquely identified by a combination of the following parameters on this template (modification) namely: embodiment_method, ID, related_change.
The instance is referenced by the following template parameter: modification.

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_activity
/assigning_activity(
    role_class_name='Modification',
    role_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_activity=@embodiment_method,
    items=@related_change)/
%^modification = $assigning_activity.appl_act%

-- ID (mandatory)
/identifier(
    ID=@ID,
    source_organization=@source_organization,
    type='Modification_identifier',
    items=^modification)/

Instance diagrams

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

/modification(ID='Mod123', source_organization='UK_Defence', embodiment_method='@1', related_change='@116')/

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

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

/modification(ID='Mod123', source_organization='UK_Defence', embodiment_method='@1', related_change='@116')/

Figure 5 — Instantiation of modification template

Characterizations

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