assigning_justification

Template:— assigning_justification (asg_just)

Date: 2008/02/28 14:43:25
Revision: 1.15

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

This section specifies the template assigning_justification.

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 and describe a justification, the reason for something. E.g. the reason why some activity was performed differently than planned.

This template gives a basic capability to represent a textual description of the justification or reason for something. It may be combined with template assigning_justification_support_item to identify the reasons for something in more detail. This is achieved by relating the justification to data elements that gave rise to the reason. e.g. by assigning supporting documentation, defined states, property values, or other items that supports the justification.

Model diagrams

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

Grey areas and templates with dashed lines are not included in the template, but may be used to further characterize the template.

AP239 Issue (RBN-5)

The ISO-10303-239 1st edition does not support the assignment of a document to a Justification.

This has been raised as issue, RBN-5, against ISO 10303-239. The EXPRESS schema has been modified in DEXlib (Long form: dexlib/data/schemas/ap239_arm_lf.exp, short form: dexlib/data/schemas/ap239_arm_sf.exp). These changes will be made to ISO 10303-239 as a Technical Corrigendum at some stage.

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

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

Input parameters

The following input parameters are defined for this template:

just_item (Type= 'SELECT (justification_item)' )

The item to which the Justification_assignment is assigned.

just_asgn_role (Default=Justification_assignment_role,Type='CLASS', Optional)

The type of Justification_assignment. The type allows the explicit representation of the reason for something to be represented by reference data.

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

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

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

The identifier of the External_class_library storing the definition of the class referenced by the parameter @just_asgn_role.

just_txt (Type='STRING')

The text describing the purpose of or reason for the justification.

Reference parameters

The following reference parameters are defined for this template:

just_asgn(Type='ENTITY (Justification_assignment)')

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

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

%^target = $assigning_justification.just_asgn%

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

justification(Type='ENTITY (Justification)')

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

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

%^target = $assigning_justification.justification%

where target is the parameter to which the Justification 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 Reading Capability Templates help section.

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

-- Mark the Justification_assignment entity as
-- referenceable when this template is used by binding it to the reference
-- parameter just_assgn
%^just_asgn = Justification_assignment%
Justification_assignment.description = '/IGNORE'
Justification_assignment.role = '/IGNORE'
Justification_assignment.item -> @just_item
Justification_assignment.justification -> ^justification

-- provide the role of the identification by classifying the Justification_assignment
/assigning_reference_data(
    items=^just_asgn,
    class_name=@just_asgn_role,
    ecl_id=@role_ecl_id)/

-- provide a description of the Justification
/assigning_descriptor(
    descr=@just_txt,
    class_name='Documented_justification',
    ecl_id='urn:plcs:rdl:std',
    is_assigned_to=^justification)/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Justification.id	'/IGNORE'	—
Justification.name	'/IGNORE'	—
Justification.description	'/IGNORE'	—
Justification.context_description	'/IGNORE'	—
Justification_assignment.description	'/IGNORE'	—
Justification_assignment.role	'/IGNORE'	—

Instance diagrams

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

/assigning_justification(just_item='#1', just_asgn_role='Task_justification', role_ecl_id='urn:plcs:rdl:std', just_txt='Instructions required for how to oil the bike chain.')/

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

Figure 3 — Entities instantiated by assigning_justification 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_justification(just_item='#1', just_asgn_role='Task_justification', role_ecl_id='urn:plcs:rdl:std', just_txt='Instructions required for how to oil the bike chain.')/

Figure 4 — Instantiation of assigning_justification template

Characterizations

The following section details how the assigning_justification template can be optionally characterized by assigning other constructs to it. These are characterizations commonly applied to the template. The ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.

The EXPRESS-G diagram in Figure 5 shows the possible characterizations of the template "assigning_justification".

Figure 5 — Characterizations for assigning justification template

The following characterizations may apply:

Characterization Assigning date and time

NOTE this characterization is optional.

Dates can be associated with the assignment of property value representation by using the templates assigning_time.

A creation date is commonly assigned to the template assigning_justification

The date of creation of the justification is represented by using the template assigning_time to assign a date and time to Justification (reference parameter ^justification ) The date and time assignment is classified as: "Date_actual_creation" (urn:plcs:rdl:std:Date_actual_creation) to indicate that it is the date (and time) when the justification was actually created.

Other dates may be assigned instead.

Characterization Assigning Identification

NOTE this characterization is optional.

The Justification is identified by assigning it an identifier through the use of template assigning_identification.

Characterization Assigning Approval

NOTE this characterization is optional.

The Justification can be "approved" by assigning an approval through the use of template assigning_approval

Characterization Classifying Justification

NOTE this characterization is optional.

The Justification can be classified, e.g. cost, is represented using the template assigning_reference_data.