Template:— inventory_item_issue (invntry_itm_iss)
Context:— UK_Defence		 Date: 2009/11/05 14:47:34
Revision: 1.7
CoverContentsDescriptionBus. perspectiveBus. obj.Model diags.Input params.Ref. params.Instantiation pathInstance diags.CharacterizationsIssuesin situ

This section specifies the template inventory_item_issue.

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 issue of an inventory item, which may be triggered by a demand

Business perspective

An Inventory Item Issue is the issue of an inventory item, which may be triggered by a demand

Business object definition

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



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

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

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

Attribute name

Attribute description

Attribute type

Optionality
Denomination of quantity This is the denomination quantity of the item being issued. EXAMPLE:
- Box of 100
- 25kg bag
- Each 		intrinsic Mandatory
Id This is the identifier of the inventory item issue. intrinsic Mandatory
Identifier.id This is the value of the id attribute of the Identifier applied to the inventory item issue. intrinsic Mandatory
Identifier.type This attribute is the type associated with the id of the Identifier given to the inventory item issue. Inventory_item_issue_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 issue. This value is assumed to be a type of Organization_identification_code. Organization_identification_code Mandatory
Issue date This is the date the inventory item is issued. Relationship to Date_time Mandatory
Issued by This is the reference to the person that issued the inventory item. Relationship to Person Optional
Issued for activity This is the reference to the activity for which the item may be issued. Relationship to Person Optional
Issued for product This is the reference to the product for which the item may be issued.
For example, an aero engine may be issued for a specific aircraft. 		Relationship to Person Optional
Issued from This is the reference to organizational unit that issues the inventory item. Relationship to Organizational Unit Mandatory
Issued to This is the reference to the organizational unit to which the inventory item is issued. Relationship to Organizational Unit Mandatory
Quantity This is the quantity of the inventory item that is issued. intrinsic Mandatory
Related demand This is the reference to the Inventory item demand to which this issue relates. Relationship to Inventory Item Demand Optional
Related demand response This is a reference to the related Inventory item demand response that may trigger the issue. Relationship to Inventory Item Demand Response Optional
Related inventory item This is the reference to the related Inventory item that is issued. Relationship to Inventory Item Mandatory
Related resource allocation This is the reference to the resource allocation against which the inventory item issue may have been made. Relationship to Resource Allocation Optional

Table 1 — Inventory Item Issue 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_issue". The text highlighted in blue shows the template parameters.


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

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

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

Figure 3 —  The graphical representation of the inventory_item_issue template

Input parameters
The following input parameters are defined for this template:
denomination_of_quantity (Type='STRING')
The denomination of quantity of the item issued.
id (Type='STRING')
The identifier applied to inventory item issue.
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.
issue_date (Type= 'SELECT (date_or_date_time_select)' )
The date on which the inventory item is issued.
issued_by (Type= 'ENTITY (Organization)' , Optional)
The related person that issued the inventory item.
issued_for_activity (Type= 'ENTITY (Activity)' , Optional)
The related activity for which the item may be issued.
issued_from (Type= 'ENTITY (Organization)' )
The related organizational unit issuing the inventory item.
issued_to (Type= 'ENTITY (Organization)' )
The related organizational unit to which the inventory item is issued.
quantity (Type= 'TYPE (any_number_value)' )
The quantity of the inventory item issued.
related_demand_response (Type= 'ENTITY (Required_resource)' , Optional)
The related Inventory item demand response that may trigger the issue.
related_inventory_item (Type= 'ENTITY (Managed_resource)' )
The related inventory item issued.
related_resource_allocation (Type= 'ENTITY (Managed_resource)' , Optional)
The related resource allocation against which the inventory item issue may have been made.
Reference parameters
The following reference parameters are defined for this template:
dec_res_event(Type='ENTITY (Decreasing_resource_event)')
Allow the Decreasing_resource_event entity instantiated in this path to be referenced when this template is used.
Note: The Decreasing_resource_event entity can be referenced in a template path by:
%^target = $inventory_item_issue.dec_res_event%
where target is the parameter to which the Decreasing_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
/representing_value_with_unit(
    value=@quantity,
    unit=@denomination_of_quantity,
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='false')/
%^value_with_unit = $representing_value_with_unit.value%

-- inventory item issue
Decreasing_resource_event
Decreasing_resource_event.quantity -> ^value_with_unit
Decreasing_resource_event.resource -> @related_inventory_item
%^dec_res_event = Decreasing_resource_event%

-- id
/identifier(
    ID=@id,
    source_organization=@source_organization,
    type='Inventory_item_issue_id_code',
    items=^dec_res_event )/

-- issue_date
Date_or_date_time_assignment
%^date_issue_date = Date_or_date_time_assignment%
^date_issue_date.assigned_date -> @issue_date
^date_issue_date.role = 'inventory_item_issue_date_issued'
^date_issue_date.items -> ^dec_res_event

-- issued_from
Organization_or_person_in_organization_assignment
Organization_or_person_in_organization_assignment.role = '/IGNORE'
Organization_or_person_in_organization_assignment.items -> ^dec_res_event
Organization_or_person_in_organization_assignment.assigned_entity -> @issued_from

-- issued_to
Organization_or_person_in_organization_assignment
Organization_or_person_in_organization_assignment.role = 'issued_to'
Organization_or_person_in_organization_assignment.items -> ^dec_res_event
Organization_or_person_in_organization_assignment.assigned_entity -> @issued_to

-- [optional related_demand_response]
-- use resource_event_correspondence_relationship relationship entity
Resource_event_correspondence_relationship
Resource_event_correspondence_relationship.relating -> ^dec_res_event
Resource_event_correspondence_relationship.related -> @related_demand_response

-- [optional issued_by]
Organization_or_person_in_organization_assignment
Organization_or_person_in_organization_assignment.role = 'issued_by'
Organization_or_person_in_organization_assignment.items -> ^dec_res_event
Organization_or_person_in_organization_assignment.assigned_entity -> @issued_by

-- [optional issued_for_activity]
Applied_activity_assignment
Applied_activity_assignment.items -> ^dec_res_event
Applied_activity_assignment.assigned_activity -> @issued_for_activity

-- [optional related_resource_allocation]
Resource_as_realized_relationship
Resource_as_realized_relationship.related -> ^dec_res_event
Resource_as_realized_relationship.relating -> @related_resource_allocation
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Date_or_date_time_assignment.role 'inventory_item_issue_date_issued' —
Organization_or_person_in_organization_assignment.role '/IGNORE' —
Organization_or_person_in_organization_assignment.role 'issued_to' —
Organization_or_person_in_organization_assignment.role 'issued_by' —
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_issue(denomination_of_quantity='box', id='inv_item_issue_123', source_organization='6421', issue_date='#28', issued_from='#33', issued_to='#132', quantity='1', related_inventory_item='#231')/
(an illustration of the consolidated inventory_item_issue template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by inventory_item_issue template

Figure 4 —  Entities instantiated by inventory_item_issue 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_issue(denomination_of_quantity='box', id='inv_item_issue_123', source_organization='6421', issue_date='#28', issued_from='#33', issued_to='#132', quantity='1', related_inventory_item='#231')/


Figure 5 —  Instantiation of inventory_item_issue template

Figure 5 —  Instantiation of inventory_item_issue template

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