Template:— recommended_item_stockholding (recomm_item_stckhlding)
Context:— UK_Defence		 Date: 2009/04/17 11:15:01
Revision: 1.8
CoverContentsDescriptionBus. perspectiveBus. obj.Model diags.Input params.Ref. params.Instantiation pathInstance diags.CharacterizationsIssuesin situ

This section specifies the template recommended_item_stockholding.

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 UK_Defence concept of recommended item stockholding in terms of PLCS model elements (templates, entities, and reference data).

Business perspective

This information object specifies the recommended stockholding locations and the level of stock holding at each location for a selected item of supply.

Business object definition

This information object specifies the recommended stockholding locations and the level of stock holding at each location for a selected item of supply.



Figure 1 —  Graphical Representation for Business Object Recommended Item Stockholding

Figure 1 —  Graphical Representation for Business Object Recommended Item Stockholding

Attribute name

Attribute description

Attribute type

Optionality
Assumptions This is a reference to the assumptions on which the recommended item stockholding is based. Relationship to Assumption. Optional (0:?)
Constraints This is a reference to the constraints on which the recommended item stockholding is based. Relationship to Constraint. Optional (0:?)
Context This is the reference to the recommended item stockholdings that provides the context for this item. Relationship to Recommended Item Stockholdings Mandatory
ID This is the identifier of the of the recommended item stockholding. Identifier Mandatory
Identifier.id This is the value of the id attribute of the Identifier applied to the recommended item stockholding. intrinsic Mandatory
Identifier.type This attribute is the type associated with the id of the Identifier given to the recommended item stockholding. Recommended_item_stockholding_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 recommended item stockholding. This value is assumed to be a type of Organization_identification_code. Organization_identification_code Mandatory
Initial Provisioning Quantity This specifies the initial quantities of items of supply required in this stockholding, to support the Plaform, system or equipment for a set period of time. intrinsic Mandatory
Item Identification This is a reference to the Item of supply to be managed by the recommended stockholding. Relationship to Item of Supply. Mandatory
Location This specifies the location of the recommended item stockholding. This could be an organization based Location e.g RAF Wyton, a geographical location or a facility. Relationship to SELECT items Facility or Location. Mandatory
Maximum Stock Level This specifies the maximum quantity of the related item of supply to be kept in this stockholding. intrinsic Mandatory
Minimum Stock Level This specifies the mimimum quantity of the related item of supply to be kept in this stockholding. intrinsic Mandatory
Name This is the name of the recommended item stockholding. intrinsic Mandatory
Time Period This is the time period for which the recommended item stockholding is made. intrinsic Mandatory
Version This is the version of the recommended item stockholding. intrinsic Mandatory

Table 1 — Recommended Item Stockholding attribute details

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


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

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

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

Figure 3 —  The graphical representation of the recommended_item_stockholding template

Input parameters
The following input parameters are defined for this template:
assumptions (Type= 'ENTITY (Document_version)' , Optional)
The related assumptions.
constraints (Type= 'ENTITY (Requirement_view_definition)' , Optional)
The related constraints.
context (Type= 'ENTITY (Required_resource)' )
The related recommended item stockholding.
id (Type='STRING')
The identifier applied to the recommended stockholding.
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.
initial_provisioning_quantity (Type='STRING')
The quantity of the item of supply.
item_identification (Type= 'ENTITY (Resource_item)' )
The recommended item of supply.
location (Type= 'SELECT (resource_assignment_item)' )
The related location or facility.
maximum_stock_level (Type='STRING')
The maximum stock level of the stockholding recommendations.
minimum_stock_level (Type='STRING')
The minimum stock level of the stockholding recommendations.
name (Type='STRING')
The name of the stockholding recommendations.
time_period (Type='STRING')
The time period of the recommendation.
time_period_units (Default=Man_hour,Type='CLASS', Optional)
The time for which the resource is allocated to the activity.
The following classes and their sub-classes can be used:
classifications: "Time_unit" (urn:plcs:rdl:std:Time_unit), "Context_dependent_unit" (urn:plcs:rdl:std:Context_dependent_unit)
version (Type='STRING')
The version of the recommendation.
Reference parameters
The following reference parameters are defined for this template:
req_res_by_spec(Type='ENTITY (Required_resource_by_specification)')
Allow the Required_resource_by_specification entity instantiated in this path to be referenced when this template is used.
Note: The Required_resource_by_specification entity can be referenced in a template path by:
%^target = $recommended_item_stockholding.req_res_by_spec%
where target is the parameter to which the Required_resource_by_specification is bound.
req_res_by_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 = $recommended_item_stockholding.req_res_by_res_item%
where target is the parameter to which the Required_resource_by_resource_item is bound.
stockholding_res_item(Type='ENTITY (Resource_item)')
Allow the Resource_item entity instantiated in this path to be referenced when this template is used.
Note: The Resource_item entity can be referenced in a template path by:
%^target = $recommended_item_stockholding.stockholding_res_item%
where target is the parameter to which the Resource_item is bound.
res_item_ass(Type='ENTITY (Resource_item_assignment)')
Allow the Resource_item_assignment entity instantiated in this path to be referenced when this template is used.
Note: The Resource_item_assignment entity can be referenced in a template path by:
%^target = $recommended_item_stockholding.res_item_ass%
where target is the parameter to which the Resource_item_assignment 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.
-- required resource
Required_resource_by_specification
%^req_res_by_spec = Required_resource_by_specification%

-- item of supply resource item
/representing_resource_item_realization(
    res_item_id='',
    res_item_id_class='',
    res_item_id_ecl_id='urn:plcs:rdl:std',
    res_item_id_org_id='',
    res_item_id_org_id_class='',
    res_item_id_org_id_ecl_id='urn:plcs:rdl:std')/
%^stockholding_res_item = $representing_resource_item_realization.res_item%

-- required resource resource item
Required_resource_by_resource_item
Required_resource_by_resource_item.resource_item -> ^stockholding_res_item
%^req_res_by_res_item = Required_resource_by_resource_item%

-- item identification
Resource_item_relationship
Resource_item_relationship.relating -> ^stockholding_res_item
Resource_item_relationship.related -> @item_identification

-- relate required resources specification and resource item
/representing_required_resource_relationship(
    req_res_rel_class_name='Required_resource_relationship',
    req_res_rel_ecl_id='urn:plcs:rdl:std',
    relating_req_res=^req_res_by_spec,
    related_req_res=^req_res_by_res_item)/

-- [Optional assumptions 0:?]
/assigning_document(
    doc_ass_role='Related_assumption',
    doc_ar_ecl_id='urn:plcs:rdl:std',
    assigned_document=@assumptions,
    is_assigned_to=^req_res_by_spec)/

-- [Optional constraints 0:?]
Requirement_assignment
Requirement_assignment.assigned_requirement -> @constraints
Requirement_assignment.assigned_to -> ^req_res_by_spec

-- location
Resource_item_assignment
Resource_item_assignment.assigned_resource -> ^stockholding_res_item
Resource_item_assignment.item -> @location

-- time period
/assigning_resource_property(
    property_class_name='Resource_property_time_period',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=^req_res_by_spec)/
%^property_time_period = $assigning_resource_property.property%
/resource_property_numeric(
    value=@time_period,
    unit=@time_period_units,
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='false',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:std',
    property=^property_time_period)/

-- initial provisioning quantity
/assigning_resource_property(
    property_class_name='Resource_property_initial_provisioning_quantity',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=^req_res_by_spec)/
%^property_quantity = $assigning_resource_property.property%
/resource_property_numeric(
    value=@initial_provisioning_quantity,
    unit='Count',
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='false',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:std',
    property=^property_quantity)/

-- maximum stock level
/assigning_resource_property(
    property_class_name='Resource_property_maximum_stock_level',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=^req_res_by_spec)/
%^property_max_stck = $assigning_resource_property.property%
/resource_property_numeric(
    value=@maximum_stock_level,
    unit='Count',
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='false',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:std',
    property=^property_max_stck)/

-- minimum stock level
/assigning_resource_property(
    property_class_name='Resource_property_minimum_stock_level',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=^req_res_by_spec)/
%^property_min_stck = $assigning_resource_property.property%
/resource_property_numeric(
    value=@minimum_stock_level,
    unit='Count',
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='false',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:std',
    property=^property_min_stck)/

-- provide the role of the resource_allocation
/assigning_reference_data(
    items=^req_res_by_spec,
    class_name='recommended',
    ecl_id='urn:plcs:rdl:uk_defence')/

-- id
/identifier(
    ID=@id,
    source_organization=@source_organization,
    type='Recommended_item_stockholding_id_code',
    items=^req_res_by_spec )/

-- name
/identifier(
    ID=@name,
    source_organization=@source_organization,
    type='Recommended_item_stockholding_name',
    items=^req_res_by_spec )/

-- version
/assigning_descriptor(
    descr=@version,
    class_name='Recommended_item_stockholding_version',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^req_res_by_spec)/

-- context
/representing_required_resource_relationship(
    req_res_rel_class_name='Context_assignment',
    req_res_rel_ecl_id='urn:plcs:rdl:uk_defence',
    relating_req_res=@context,
    related_req_res=^req_res_by_spec)/
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/recommended_item_stockholding(assumptions='#75', constraints='#152', context='#871', id='rec_stckhlding_1', source_organization='6421', initial_provisioning_quantity='1', item_identification='#407', location='#755', maximum_stock_level='1', minimum_stock_level='1', name='Pump_stockholding', time_period='24', time_period_units='Hour', version='1', related_support_solution='#372')/
(an illustration of the consolidated recommended_item_stockholding template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by recommended_item_stockholding template

Figure 4 —  Entities instantiated by recommended_item_stockholding 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:
/recommended_item_stockholding(assumptions='#75', constraints='#152', context='#871', id='rec_stckhlding_1', source_organization='6421', initial_provisioning_quantity='1', item_identification='#407', location='#755', maximum_stock_level='1', minimum_stock_level='1', name='Pump_stockholding', time_period='24', time_period_units='Hour', version='1', related_support_solution='#372')/


Figure 5 —  Instantiation of recommended_item_stockholding template

Figure 5 —  Instantiation of recommended_item_stockholding template

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