assigning_business_specific_reference

Template:— assigning_business_specific_reference_data (asg_bs_rd)
Capability:assigning_reference_data
The use of this template is deprecated. (2007-04-23)

Date: 2009/04/09 14:00:39
Revision: 1.16

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

Deprecation: Template assigning_business_specific_reference_data

The use of template,assigning_business_specific_reference_data, has been deprecated since 2007-04-23.

Use assigning_reference_data instead.

This section specifies the template assigning_business_specific_reference_data.

NOTE The template has been defined in the context of the capability assigning_reference_data which provides an overall description of the relevant parts of the ISO 10303-239 information model and a description 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 the classification of something as being a member of a class in a given business specific reference data library. The template supports the recommended approach in doing this, namely that a reference is provided for that business specific class back to the leaf superclass in the plcs reference data library.

This template illustrates the recommended approach for exchanging classifications done, based on business specific reference data libraries.

This template is based on the same assumptions as the template assigning_reference_data, namely that:

The External_class_library .description attribute is not populated;
The External_class name attribute uniquely identifies the class in the reference data library (i.e. External_class .id is not required).

Model diagrams

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

Figure 9 — Attribute values set by the template 'assigning_business_specific_reference_data'.

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure 10 below.

Figure 10 — Graphical representation of the template 'assigning_business_specific_reference_data'.

Input parameters

The following input parameters are defined for this template:

class_name (Type='CLASS')

The name of the class in the business specific reference data library (External_class) being used to classify something

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

classifications: "PLCS-ARM-LF-THING" (urn:plcs:rdl:std:PLCS-ARM-LF-THING)

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

The id of the business_specific External_class_library that stores the class.

plcs_class_name (Type='CLASS')

The name of the first plcs superclass encountered in the plsc standard reference data library (External_class) when traversing the class hierarchy for the assigned business specific (External_class).

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

classifications: "PLCS-ARM-LF-THING" (urn:plcs:rdl:std:PLCS-ARM-LF-THING)

items (Type= 'SELECT (classification_item)' )

The items to which the External_class is assigned.

Reference parameters

The following reference parameters are defined for this template:

ext_class(Type='ENTITY (External_class)')

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

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

%^target = $assigning_business_specific_reference_data.ext_class%

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

Classification_assignment
Classification_assignment.role = '/IGNORE'
Classification_assignment.items -> @items
Classification_assignment.assigned_class -> External_class

-- Instantiate the business specific class
-- Mark the External_class entity as referable when this template is used.
-- In other words, bind the External_class instance to the reference
-- parameter ext_class
%^ext_class = External_class%
External_class.id = '/IGNORE'
External_class.description = '/IGNORE'
External_class.name = @class_name
External_class_library
External_class.external_source -> External_class_library
External_class_library.id = @ecl_id

-- Instantiate a subset
Subset

-- Assign Subset.subset to the business specific class
Subset.subset -> ^ext_class
Subset.name = 'Specialization'
Subset.id = '/IGNORE'
Subset.description = '/IGNORE'

-- Assign Subset.subset to the PLCS class
External_class
Subset.superset -> External_class
External_class.id = '/IGNORE'
External_class.description = '/IGNORE'
External_class.name = @plcs_class_name
External_class_library
External_class.external_source -> External_class_library
External_class_library.id = 'urn:plcs:rdl:std'

The following entities are instantiated with attributes as specified:

Entity in path	Value	Inherited from
Classification_assignment.role	'/IGNORE'	—
External_class.id	'/IGNORE'	Class.id
External_class.description	'/IGNORE'	Class.description
External_class.name	@class_name	Class.name
External_class_library.id	@ecl_id	—
Subset.name	'Specialization'	—
Subset.id	'/IGNORE'	—
Subset.description	'/IGNORE'	—
External_class.id	'/IGNORE'	Class.id
External_class.description	'/IGNORE'	Class.description
External_class.name	@plcs_class_name	Class.name
External_class_library.id	'urn:plcs:rdl:std'	—

Instance diagrams

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

/assigning_business_specific_reference_data(items='#2', class_name='My_org_part_identification_code', ecl_id='urn:plcs:rdl:my_rdl', plcs_class_name='Part_identification_code')/

(an illustration of the consolidated assigning_business_specific_reference_data template is shown in Figure 12 below.)

Figure 11 — Instance diagram instantiated by the template example

The instance model in STEP ASCII exchange file format (ISO 10303 Part 21 syntax) is:


                  #1=PART('/IGNORE', '/IGNORE', '/IGNORE');
                  #2=IDENTIFICATION_ASSIGNMENT('TYRES-010101', '/IGNORE', '/IGNORE', (#1));
                  #3=EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:my_rdl', '$');
                  #4=EXTERNAL_CLASS('/NULL', 'My_org_part_identification_code', '/IGNORE', #3);
                  #5=CLASSIFICATION_ASSIGNMENT(#4, (#2), '/IGNORE');
                  #6=EXTERNAL_CLASS_LIBRARY('urn:plcs:rdl:std', '$');
                  #7=EXTERNAL_CLASS('/NULL', 'Part_identification_code', '/IGNORE', #6);
                  #8=SUBSET('/IGNORE', 'Specialization', '/IGNORE', #4, #7);;

The instance model in STEP XML exchange file format (ISO 10303 Part 28 ed.2 syntax) is:

The instance diagram in Figure 12 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:

/assigning_business_specific_reference_data(items='#2', class_name='My_org_part_identification_code', ecl_id='urn:plcs:rdl:my_rdl', plcs_class_name='Part_identification_code')/

Figure 12 — Invocation of template - graphical presentation

Characterizations

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