Template:— assigning_product_effectivity (asg_prod_eff)
Context:— NDLO

Date: 2008/02/21 16:26:54
Revision: 1.3

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

This section specifies the template assigning_product_effectivity.

NOTE The template has been defined in the context of NDLO. 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 an effectivity assignment to a product as individual effectivity. This allows the assignment of product_as_individual_effectivity to product and support data, e.g. to relate a breakdown_element to its parent product.

Model diagrams

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

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

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

Input parameters

The following input parameters are defined for this template:

items (Type= 'SELECT (

Error ER1: The entity Effectivity_item does not exist
Effectivity_item)'

Error EXP-1: The EXPRESS select type Effectivity_item
does not exist in data/schemas/ap239_arm_lf.xml.
)

eff_asg_class_name (Type='CLASS')

...

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

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

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

The id of the External_class_library that stores the class used to classify the effectivity.

prod_items (Type= 'SELECT (Product_as_individual)'

Error EXP-1: The EXPRESS select type Product_as_individual
does not exist in data/schemas/ap239_arm_lf.xml.
)

prod_ind_eff_class_name (Type='CLASS', Optional)

...

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

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

prod_ind_eff_ecl_id (Type='URN', Optional)

The id of the External_class_library that stores the class used to classify the effectivity.

Reference parameters

The following reference parameters are defined for this template:

eff_asg(Type='ENTITY (Effectivity_assignment)')

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

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

%^target = $assigning_product_effectivity.eff_asg%

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

prod_ind_eff(Type='ENTITY (Product_as_individual_effectivity)')

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

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

%^target = $assigning_product_effectivity.prod_ind_eff%

where target is the parameter to which the Product_as_individual_effectivity 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.

Effectivity_assignment

-- Mark the Effectivity_assignment entity as
-- referable when this template is used by binding it to the reference
-- parameter eff_asg
%^eff_asg = Effectivity_assignment%
Effectivity_assignment.role = '/IGNORE'
Effectivity_assignment.items -> @items

-- provide the role of the effectivity by classifying the Effectivity_assignment
/assigning_reference_data(
    items=^eff_asg,
    class_name=@eff_asg_class_name,
    ecl_id=@eff_asg_ecl_id)/
Product_as_individual_effectivity

-- Mark the Product_as_individual_effectivity entity as
-- referable when this template is used
%^prod_ind_eff = Product_as_individual_effectivity%
^prod_ind_eff.id = '/IGNORE'
^prod_ind_eff.name = '/IGNORE'
^prod_ind_eff.description = '/IGNORE'
^prod_ind_eff.items -> @prod_items

-- Assign the Effectivity_assignment to Product_as_individual_effectivity
^eff_asg.assigned_effectivity -> ^prod_ind_eff

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Effectivity_assignment.role	'/IGNORE'	—
Product_as_individual_effectivity.id	'/IGNORE'	Effectivity.id
Product_as_individual_effectivity.name	'/IGNORE'	Effectivity.name
Product_as_individual_effectivity.description	'/IGNORE'	Effectivity.description

Instance diagrams

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

/assigning_product_effectivity(items='#1', class_name='...', ecl_id='urn:plcs:rdl:std')/

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

Figure 3 — Entities instantiated by assigning_product_effectivity 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_product_effectivity(items='#1', class_name='...', ecl_id='urn:plcs:rdl:std')/

Figure 4 — Instantiation of assigning_product_effectivity template

Characterizations

The following section details how the assigning_product_effectivity 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 following characterizations may apply:

Characterization Assigning classification

NOTE this characterization is optional.

The product_as_individual_effectivity is classified using the assigning_reference_data template with the Product_as_individual_effectivity being classified as a type of [Applicable_product_as_indvidual]
Error RDL1: The class Applicable_product_as_indvidual does not exist in RDL at URI urn:plcs:rdl:std. Check the dexlib/data/refdata/rdl_index.xml
.