Template:— dues_in (dues_in)
Context:— UK_Defence
Date: 2009/04/17 11:16:56
Revision: 1.9

This section specifies the template dues_in.

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 inventory items that are due to be delivered to the issuing organizational unit.

Business perspective

A Dues In represents inventory items that are due to be delivered to the issuing organizational unit.

Business object definition

This information object represents the information about a Dues In.



Figure 1 —  A MOOD Business Architect representation of the Business Object: Dues In

Figure 1 —  A MOOD Business Architect representation of the Business Object: Dues In

The attributes of the Dues In object are tabled below.

Attribute name

Attribute description

Attribute type

Optionality

Cleared by This is a reference to the related receipt or discrepancy report that clears the dues in. Relationship to Inventory Item Receipt or Discrepancy Report Optional
Id This is the identifier of the dues in. Identifier Mandatory
Identifier.id This is the value of the id attribute of the Identifier applied to the dues in. intrinsic Mandatory
Identifier.type This attribute is the type associated with the id of the Identifier given to the dues in. Dues_in_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 dues in. This value is assumed to be a type of Organization_identification_code. Organization_identification_code Mandatory
Quantity This is the quantity of the inventory items due to be delivered to the receiving organizational unit. intrinsic Mandatory
Related demand This is a reference to related inventory item demand that causes the dues in to be created. Relationship to Inventory Item Demand Mandatory
Related item issue This is a reference to the related inventory item issue that satisfies the dues in. Relationship to Inventory Item Issue Optional
When due This is the date the Inventory item is due to be delivered to the receiving organizational unit. intrinsic Mandatory

Table 1 — Dues In attribute details

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


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

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

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

Figure 3 —  The graphical representation of the dues_in template

Input parameters
The following input parameters are defined for this template:
id (Type='STRING')
The identifier applied to the dues in.
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 (Type= 'TYPE (any_number_value)' )
The inventory items quantity to be delivered.
related_demand (Type= 'ENTITY (Applied_activity_assignment)' )
The related inventory item demand.
related_item_of_supply (Type= 'ENTITY (Resource_item)' )
The related item of supply.
when_due (Type= 'SELECT (date_or_date_time_select)' )
The date on which the inventory item is to be delivered.
Reference parameters
The following reference parameters are defined for this template:
req_res_asst(Type='ENTITY (Required_resource_assignment)')
Allow the Required_resource_assignment entity instantiated in this path to be referenced when this template is used.
Note: The Required_resource_assignment entity can be referenced in a template path by:
%^target = $dues_in.req_res_asst%
where target is the parameter to which the Required_resource_assignment is bound.
req_res_item(Type='ENTITY (Required_resource_by_resource_item)')
Allow the Required_resource_by_resource_item entity instantiated in this path to be referenced when this template is used.
Note: The Required_resource_by_resource_item entity can be referenced in a template path by:
%^target = $dues_in.req_res_item%
where target is the parameter to which the Required_resource_by_resource_item is bound.
value_with_unit(Type='ENTITY (Value_with_unit)')
Allow the Value_with_unit entity instantiated in this path to be referenced when this template is used.
Note: The Value_with_unit entity can be referenced in a template path by:
%^target = $dues_in.value_with_unit%
where target is the parameter to which the Value_with_unit 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.
-- dues in
Required_resource_by_resource_item

-- Item_of_supply
Required_resource_by_resource_item.resource_item -> @related_item_of_supply

-- [optional quantity]
/representing_value_with_unit(
    value=@quantity,
    unit='Count',
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='false')/
%^value_with_unit = $representing_value_with_unit.value%
Required_resource_by_resource_item.required_quantity -> ^value_with_unit
%^req_res_item = Required_resource_by_resource_item%

-- id
/identifier(
    ID=@id,
    source_organization=@source_organization,
    type='Dues_in_id_code',
    items=^req_res_item )/

-- [optional cleared_by]
-- use inventory_document_assignment or inventory_resource_event_relationship relationship templates
-- related_demand
Required_resource_assignment
Required_resource_assignment.assigned_resource -> ^req_res_item
Required_resource_assignment.item -> @related_demand
%^req_res_asst = Required_resource_assignment%

-- when_due
Date_or_date_time_assignment
%^when_due_date = Date_or_date_time_assignment%
^when_due_date.assigned_date -> @when_due
^when_due_date.role = 'dues_in_when_due_date'
^when_due_date.items -> ^req_res_item
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Date_or_date_time_assignment.role 'dues_in_when_due_date'
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/dues_in(id='dues_in_123', source_organization='6421', quantity='1', related_demand='#185', related_item_of_supply='#3', when_due='#416')/
(an illustration of the consolidated dues_in template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by dues_in template

Figure 4 —  Entities instantiated by dues_in 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:
/dues_in(id='dues_in_123', source_organization='6421', quantity='1', related_demand='#185', related_item_of_supply='#3', when_due='#416')/


Figure 5 —  Instantiation of dues_in template

Figure 5 —  Instantiation of dues_in template

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