Template:— consignment (conmt)
Context:— UK_Defence		 Date: 2009/04/17 10:52:56
Revision: 1.3
CoverContentsDescriptionBus. perspectiveBus. obj.Model diags.Input params.Ref. params.Instantiation pathInstance diags.CharacterizationsIssuesin situ

This section specifies the template consignment.

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 set of one or more items that is to be, or has been, transported from the consignor to the consignee.

Business perspective

This information object represents a batch of items that is to be moved.

Business object definition


Figure 1 —  Graphical Representation for Business Object Consignment

Figure 1 —  Graphical Representation for Business Object Consignment

Consignment:

Attribute name

Attribute description

Attribute type

Optionality
Consignee This is the reference to the person or organization that is the intended recipient of the consignment Relationship to SELECT of Person or Organization Mandatory
Consignor This is the reference to the organization or person that consigns the consignment Relationship to SELECT of Person or Organization Mandatory
ID This is the identifier of the consignment Relationship to Identifier Mandatory

Table 1 — Consignment attribute details:

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


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

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

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

Figure 3 —  The graphical representation of the consignment template

Input parameters
The following input parameters are defined for this template:
consignee (Type= 'SELECT (organization_or_person_in_organization_select)' )
This is the reference to the person or organization that is the intended recipient of the consignment.
consignor (Type= 'SELECT (organization_or_person_in_organization_select)' )
This is the reference to the organization or person that consigns the consignment.
ID (Type='STRING')
The identifier of the consignment.
source_organization (Type='STRING')
The organization or information system that created the associated identifier. Alternatively this could be set to "/NULL" when Person or Information System is the source; see Identifier template characterizations
Reference parameters
The following reference parameters are defined for this template:
consignment(Type='ENTITY (Product_group)')
Allow the Product_group entity instantiated in this path to be referenced when this template is used.
Note: The Product_group entity can be referenced in a template path by:
%^target = $consignment.consignment%
where target is the parameter to which the Product_group is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Consignment
Each instance of the entity (Product_group) within the data set shall be uniquely identified by a combination of the following parameters on this template (consignment) namely: ID, consignee, consignor.
The instance is referenced by the following template parameter: consignment.
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.
-- instantiate product group
/referencing_product_group(
    prod_grp_id=@ID,
    prod_grp_id_class='Consignment_identifier',
    prod_grp_id_ecl_id='urn:plcs:rdl:uk_defence',
    prod_grp_org_id=@source_organization,
    prod_grp_org_id_class='Organization_name_or_identification_code',
    prod_grp_org_id_ecl_id='urn:plcs:rdl:std')/

-- assign ref parameter
%^consignment = $referencing_product_group.prod_grp%

-- consignor (mandatory)
Organization_or_person_in_organization_assignment

-- Set the Organization_or_person_in_organization_assignment attribute role to be ignored
Organization_or_person_in_organization_assignment.role = '/IGNORE'

-- Assign the Organization_or_person_in_organization_assignment to the anomaly
Organization_or_person_in_organization_assignment.items -> ^consignment

-- Create the Detected_by parameter
Organization_or_person_in_organization_assignment.assigned_entity -> @consignor
%^consignor = Organization_or_person_in_organization_assignment%

-- assigning_reference_data
/assigning_reference_data(
    items=^consignor,
    class_name='Consignor',
    ecl_id='urn:plcs:rdl:uk_defence')/

-- consignee (mandatory)
Organization_or_person_in_organization_assignment

-- Set the Organization_or_person_in_organization_assignment attribute role to be ignored
Organization_or_person_in_organization_assignment.role = '/IGNORE'

-- Assign the Organization_or_person_in_organization_assignment to the anomaly
Organization_or_person_in_organization_assignment.items -> ^consignment

-- Create the Detected_by parameter
Organization_or_person_in_organization_assignment.assigned_entity -> @consignee
%^consignee = Organization_or_person_in_organization_assignment%

-- assigning_reference_data
/assigning_reference_data(
    items=^consignee,
    class_name='Consignee',
    ecl_id='urn:plcs:rdl:uk_defence')/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Organization_or_person_in_organization_assignment.role '/IGNORE' —
Organization_or_person_in_organization_assignment.role '/IGNORE' —
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/consignment(consignee='@92', consignee='@207', ID='C123', source_organization='UK_Defence')/
(an illustration of the consolidated consignment template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by consignment template

Figure 4 —  Entities instantiated by consignment 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:
/consignment(consignee='@92', consignee='@207', ID='C123', source_organization='UK_Defence')/


Figure 5 —  Instantiation of consignment template

Figure 5 —  Instantiation of consignment template

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

© UK MOD 2010 — All rights reserved