Template:— inventory_item_receipt (invntry_itm_recpt)
Context:— UK_Defence
Date: 2009/04/17 09:34:16
Revision: 1.6

This section specifies the template inventory_item_receipt.

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 the receipt of an inventory item.

Business perspective

An Inventory Item Receipt is the receipt of an inventory item.

Business object definition

This information object represents the information about an Inventory Item Receipt.



Figure 1 —  A MOOD Business Architect representation of the Business Object: Inventory Item Receipt

Figure 1 —  A MOOD Business Architect representation of the Business Object: Inventory Item Receipt

The attributes of the Inventory Item Receipt object are tabled below.

Attribute name

Attribute description

Attribute type

Optionality

Date received This is the date on which the inventory item is received. Relationship to Date_time Mandatory
Denomination of quantity This is the denomination quantity of the item being received. EXAMPLE:
- Box of 100
- 25kg bag
- Each
intrinsic Mandatory
Id This is the identifier of the inventory item receipt. intrinsic Mandatory
Identifier.id This is the value of the id attribute of the Identifier applied to the inventory item receipt. intrinsic Mandatory
Identifier.type This attribute is the type associated with the id of the Identifier given to the inventory item receipt. Inventory_item_receipt_id_code Mandatory
Identifier.source_organization This attribute is the value representing the source organization that provides the id of the Identifier given to the inventory item receipt. This value is assumed to be a type of Organization_identification_code. Organization_identification_code Mandatory
Quantity received This is the quantity of the inventory item that is received. intrinsic Mandatory
Received by This is a reference to the organizational unit receiving the inventory item. Relationship to Organizational Unit Mandatory
Related item This is a reference to the related inventory item. Relationship to Inventory Item Mandatory
Related item issue This is the reference to the inventory item issue that may have lead to the receipt. Relationship to Inventory Item Issue Optional

Table 1 — Inventory Item Receipt attribute details

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


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

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

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

Figure 3 —  The graphical representation of the inventory_item_receipt template

Input parameters
The following input parameters are defined for this template:
date_received (Type= 'SELECT (date_or_date_time_select)' )
The date on which the inventory item is received.
denomination_of_quantity (Type='STRING')
The denomination of quantity of the item received.
id (Type='STRING')
The identifier applied to inventory item receipt.
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.
quantity_received (Type= 'TYPE (any_number_value)' )
The quantity of the inventory item received.
received_by (Type= 'ENTITY (Organization)' )
The related organizational unit receiving the inventory item.
related_item (Type= 'ENTITY (Managed_resource)' )
The related inventory item.
Reference parameters
The following reference parameters are defined for this template:
inc_res_event(Type='ENTITY (Increasing_resource_event)')
Allow the Increasing_resource_event entity instantiated in this path to be referenced when this template is used.
Note: The Increasing_resource_event entity can be referenced in a template path by:
%^target = $inventory_item_receipt.inc_res_event%
where target is the parameter to which the Increasing_resource_event 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.
-- quantity_received
/representing_value_with_unit(
    value=@quantity_received,
    unit=@denomination_of_quantity,
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='false')/
%^value_with_unit = $representing_value_with_unit.value%

-- inventory item receipt
Increasing_resource_event
Increasing_resource_event.quantity -> ^value_with_unit
Increasing_resource_event.resource -> @related_item
%^inc_res_event = Increasing_resource_event%

-- date_received
Date_or_date_time_assignment
%^date_received_date = Date_or_date_time_assignment%
^date_received_date.assigned_date -> @date_received
^date_received_date.role = 'inventory_item_receipt_date_received_date'
^date_received_date.items -> ^inc_res_event

-- id
/identifier(
    ID=@id,
    source_organization=@source_organization,
    type='Inventory_item_receipt_id_code',
    items=^inc_res_event )/

-- received_by
Organization_or_person_in_organization_assignment
Organization_or_person_in_organization_assignment.role = '/IGNORE'
Organization_or_person_in_organization_assignment.items -> ^inc_res_event
Organization_or_person_in_organization_assignment.assigned_entity -> @received_by

-- optional related_item_issue
-- use Resource_event_relationship relationship template
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Date_or_date_time_assignment.role 'inventory_item_receipt_date_received_date'
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:
/inventory_item_receipt(date_received='#27', denomination_of_quantity='box', id='inv_item_receipt_123', source_organization='6421', quantity_received='1', received_by='#32', related_item='#131')/
(an illustration of the consolidated inventory_item_receipt template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by inventory_item_receipt template

Figure 4 —  Entities instantiated by inventory_item_receipt 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:
/inventory_item_receipt(date_received='#27', denomination_of_quantity='box', id='inv_item_receipt_123', source_organization='6421', quantity_received='1', received_by='#32', related_item='#131')/


Figure 5 —  Instantiation of inventory_item_receipt template

Figure 5 —  Instantiation of inventory_item_receipt template

Characterizations
No common characterizations of the template inventory_item_receipt 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