Template:— product_role_configuration (prod_role_config)
Context:— UK_Defence

Date: 2009/04/17 11:04:01
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 product_role_configuration.

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 a UK_Defence product role configuration, using Product_configuration .

This information object represents the relationship between a product and the named role (configurations) in which it is planned to be and / or has been in, between certain dates.

For further information about the representation of a product role configuration, see below.

Business perspective

This information object represents the relationship between a product and the named role (configurations) in which it is planned to be and / or has been in, between certain dates.

Business object definition

Figure 1 — Graphical Representation for Business Object Product Role

Record:

This information object represents the relationship between a product and the named role (configurations) in which it is planned to be and / or has been in, between certain dates.

Attribute name	Attribute description	Attribute type	Optionality
Actual Configuration End Date	This is the date on which the related product ceases to be in the related product role.	Intrinsic	Optional
Actual Configuration Start Date	This is the date on which the related product starts to be in the related product role.	Intrinsic	Optional
Description	This is the description of the product role configuration.	Intrinsic	Optional
ID	This is the identifier of the product configuration role.	Identifier	Mandatory
Predicted Configuration End Date	This is the date on which the related product is predicted to cease being in the related product role.	Intrinsic	Optional
Predicted Configuration Start Date	This is the date on which the related product is predicted to start being in the related product role.	Intrinsic	Optional
Related Product	This is the reference to the product that will be, or is in the related product role.	Product	Mandatory
Related Role	This is the reference to the product role in which the related product is or will be.	Product Role	Mandatory

Table 1 — Product attribute details

Model diagrams

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

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

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

Input parameters

The following input parameters are defined for this template:

ID (Type='STRING')

The identifier of the product role configuration.

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

type (Type='CLASS')

This is the name of the type of the class used to classify the identifier and so provide the role or reason for the identification.

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

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

related_product (Type= 'ENTITY (Product)' )

This is the reference to the product that will be, or is in the related product role.

related_role (Type= 'ENTITY (Activity_actual)' )

This is the reference to the product role in which the related product is or will be

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 = $product_role_configuration.prod_conf%

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

prod_conpt(Type='ENTITY (Product_concept)')

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

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

%^target = $product_role_configuration.prod_conpt%

where target is the parameter to which the Product_concept 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 (product_role_configuration) namely: ID, related_product, related_role.
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_concept
%^prod_conpt = Product_concept%
Product_concept.id = '/IGNORE'
Product_concept.name = '/IGNORE'
Product_concept.description = '/IGNORE'
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 -> ^prod_conpt
/assigning_activity(
    role_class_name= '/NULL' role_ecl_id= 'urn:plcs:rdl:std',
    assigned_activity=@related_role,
    items=^prod_conf)/
Item_design_association.design -> @related_product
Item_design_association.configuration -> ^prod_conf

-- assign product role's identifier to activity_actual
/identifier(
    ID=@ID,
    source_organization=@source_organization,
    type=@type,
    items=^prod_conf)/

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Product_concept.id	'/IGNORE'	—
Product_concept.name	'/IGNORE'	—
Product_concept.description	'/IGNORE'	—
Product_configuration.id	'/IGNORE'	—
Product_configuration.name	'/IGNORE'	—
Product_configuration.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:

/Product_role_configuration(product='@2', product_role='@49', ID='ID1234', source_organization='BAE Systems', type='Product_configuration_identification_code')/

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

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

/Product_role_configuration(product='@2', product_role='@49', ID='ID1234', source_organization='BAE Systems', type='Product_configuration_identification_code')/

Figure 5 — Instantiation of Product_role_configuration template

Characterizations

The following section details how the product_role_configuration 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 6 shows the possible characterizations of the template "product_role_configuration".

Figure 6 — Characterizations for Product_role_configuration

The following characterizations may apply:

Characterization Assigning dates

NOTE this characterization is optional.

The predicted and actual effectivity dates can be assigned using theassigning_dated_effectivity template with the classed as Date_time being classified as a type of [Predicted_effectivity]
Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
or Date_time being classified as a type of "Actual effectivity" (urn:plcs:rdl:std:Actual effectivity) . .

/assigning_dated_effectivity(start_year='2008', start_month='03', start_day='10', start_hour='9', start_minute='30', start_second='0', start_sense='.EXACT.', start_hour_offset='0', start_minute_offset='0', end_year='2008', end_month='03', end_day='10', end_hour='17', end_minute='0', end_second='0', end_sense='.EXACT.', end_hour_offset='0', end_minute_offset='0', role_class_name='0', role_ecl_id='Planned_effectivity', items='@240')/

Characterization Assigning description

NOTE this characterization is optional.

The description of the product role configuration can be represented by assigning a descriptor using the assigning_descriptor template.

/assigning_descriptor(descr='rescue configuration for test emergency', class_name='Description', ecl_id='urn:plcs:rdl:std', is_assigned_to='@240')/