representing_product_configuration

Template:— representing_product_configuration (rep_prod_config)

Date: 2008/03/03 12:27:29
Revision: 1.5

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

This section specifies the template representing_product_configuration.

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 identification of a product configuration.

Model diagrams

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

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

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

Input parameters

The following input parameters are defined for this template:

id (Type='STRING')

Identification of the product configuration (Product_configuration).

id_class_name (Type='CLASS')

The name of the class used to classify the product configuration identifier (@id) and to provide the role or reason for the identification.

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

classifications: "Product_configuration_identification_code" (urn:plcs:rdl:std:Product_configuration_identification_code), "Product_configuration_name" (urn:plcs:rdl:std:Product_configuration_name)

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

The id of the External_class_library storing the @id_class_name

org_id (Type='STRING')

The identifier of the Organization that "owns" the product configuration identifier.

org_id_class_name (Default=Organization_name,Type='CLASS')

The name of the class that determines the type of identifier being used for identifying the Organization. For example CAGE code.

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

classifications: "Organization_identification_code" (urn:plcs:rdl:std:Organization_identification_code), "Organization_name" (urn:plcs:rdl:std:Organization_name)

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

The id of the External_class_library storing the definition of the class used to classify the organization identifier.

design (Type= 'SELECT (version_or_definition)' )

The product for which the product configuration is defined (Product_version or Product_view_definition).

item_context (Type= 'ENTITY (Product_concept)' )

Defines the context in which the configuration item has been defined.

Reference parameters

The following reference parameters are defined for this template:

prod_conf(Type='ENTITY (Product_configuration)')

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

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

%^target = $representing_product_configuration.prod_conf%

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

item_desgn_assoc(Type='ENTITY (Item_design_association)')

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

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

%^target = $representing_product_configuration.item_desgn_assoc%

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

Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Product_configuration

Each instance of the entity (Product_configuration) within the data set shall be uniquely identified by a combination of the following parameters on this template (representing_product_configuration) namely: id, id_class_name, id_ecl_id, org_id, org_id_class_name, org_id_ecl_id.
The instance is referenced by the following template parameter: prod_conf.

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.

Product_configuration

-- Mark the Product_configuration entity as
-- referable when this template is used by binding it to the reference
-- parameter ^prod_conf
%^prod_conf = Product_configuration%
Product_configuration.id = '/IGNORE'
Product_configuration.name = '/IGNORE'
Product_configuration.description = '/IGNORE'
Product_configuration.item_context -> @item_context

-- Identification of the Product_configuration
/assigning_identification(
    items=^prod_conf,
    id=@id,
    id_class_name=@id_class_name,
    id_ecl_id=@id_ecl_id,
    org_id=@org_id,
    org_id_class_name=@org_id_class_name,
    org_id_ecl_id=@org_id_ecl_id )/
Item_design_association

-- Mark the Item_design_association entity as
-- referable when this template is used by binding it to the reference
-- parameter ^item_desgn_assoc
Item_design_association.design -> @design
Item_design_association.configuration -> ^prod_conf

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Product_configuration.id	'/IGNORE'	—
Product_configuration.name	'/IGNORE'	—
Product_configuration.description	'/IGNORE'	—

Instance diagrams

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

/representing_product_configuration(design='#1', item_context='#2', id='Normal bike', id_class_name='Product_configuration_name', id_ecl_id='urn:plcs:rdl:std', org_id='Bike Ltd', org_id_class_name='Organization_name', org_id_ecl_id='urn:plcs:rdl:std')/

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

Figure 3 — Entities instantiated by representing_product_configuration 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:

Figure 4 — Entities instantiated by representing_product_configuration template

Characterizations

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