Template:— MoDAvDEXmessage_inventory_loss (MoDAvmsg_inv_loss)
Context:— MoDAvDEX
Date: 2008/02/08 07:49:40
Revision: 1.8

This section specifies the template MoDAvDEXmessage_inventory_loss.

NOTE  The template has been defined in the context of MoDAvDEX. 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 loss of a reportable item from the inventory

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


Figure 1 —  An EXPRESS-G representation of the Information model for MoDAvDEXmessage_inventory_loss

Figure 1 —  An EXPRESS-G representation of the Information model for MoDAvDEXmessage_inventory_loss

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure  2 below.


Figure 2 —  The graphical representation of the MoDAvDEXmessage_inventory_loss template

Figure 2 —  The graphical representation of the MoDAvDEXmessage_inventory_loss template

Input parameters
The following input parameters are defined for this template:
msg_identifier (Default=/NULL,Type='STRING')
The identifier of the ModAvDEX message.
sent_year (Type= 'TYPE (year_number)' )
Calendar_date year_component of date message is sent.
sent_month (Type= 'TYPE (month_in_year_number)' )
Calendar_date month_component of date message is sent.
sent_day (Type= 'TYPE (day_in_month_number)' )
Calendar_date day_component of date message is sent.
sent_hour (Type= 'TYPE (hour_in_day)' )
Local_time year_component of the date and time the message is sent.
sent_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time month_component of the date and time the message is sent. This parameter is optional. If not given, it will remain unset.
sent_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time day_component of the date and time the message is sent. This parameter is optional. If not given, it will remain unset.
sender_organization (Type='STRING')
The name or identifier of the sending organization.
receiver_organization (Type='STRING')
The name or identifier of the receiving organization.
contract_identifier (Type='STRING')
The name or identifier of the contract.
extract_year (Type= 'TYPE (year_number)' )
Calendar_date year_component of date message is extracted.
extract_month (Type= 'TYPE (month_in_year_number)' )
Calendar_date month_component of date message is extracted.
extract_day (Type= 'TYPE (day_in_month_number)' )
Calendar_date day_component of date message is extracted.
extract_hour (Type= 'TYPE (hour_in_day)' )
Local_time year_component of the date and time the message is extract.ed.
extract_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time month_component of the date and time the message is extracted. This parameter is optional. If not given, it will remain unset.
extract_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time day_component of the date and time the message is extracted. This parameter is optional. If not given, it will remain unset.
security_class (Type='CLASS')
The name of the class being used to classify the security level. (Security_classification_assignment)
The following classes and their sub-classes can be used:
classifications: [ModAvDEX_Security_classification]
[warning:]Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
activity_identifier (Default=/NULL,Type='STRING')
The identifier of the activity being reported in the message.
activity_organization (Default=/NULL,Type='STRING')
The identifier of the organization who conducted the activity.
activity_year (Type= 'TYPE (year_number)' )
Calendar_date year_component of date the activity was conducted.
activity_month (Type= 'TYPE (month_in_year_number)' )
Calendar_date month_component of date the activity was conducted.
activity_day (Type= 'TYPE (day_in_month_number)' )
Calendar_date day_component of date the activity was conducted.
activity_hour (Type= 'TYPE (hour_in_day)' )
Local_time year_component of the date and time the activity was conducted.
activity_minute (Type= 'TYPE (minute_in_hour)' , Optional)
Local_time month_component of the date and time the activity was conducted. This parameter is optional. If not given, it will remain unset.
activity_second (Type= 'TYPE (second_in_minute)' , Optional)
Local_time day_component of the date and time the activity was conducted . This parameter is optional. If not given, it will remain unset.
serial_number (Type='STRING')
The serial number.
part_number (Type='STRING')
The Part number of the design of this product individual.
supplier (Type='STRING')
The supplier of the reportable item.
NSN (Type='STRING', Optional)
Current NSN or code number of the reportable item.
Reference parameters
The following reference parameters are defined for this template:
message(Type='ENTITY (Message)')
Allow the Message entity instantiated in this path to be referenced when this template is used.
Note: The Message entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_inventory_loss.message%
where target is the parameter to which the Message is bound.
par(Type='ENTITY (Product_as_realized)')
Allow the Product_as_realized entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_realized entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_inventory_loss.par%
where target is the parameter to which the Product_as_realized is bound.
view(Type='ENTITY (Product_as_individual_view)')
Allow the Product_as_individual_view entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_individual_view entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_inventory_loss.view%
where target is the parameter to which the Product_as_individual_view is bound.
act_act(Type='ENTITY (Activity_actual)')
Allow the Activity_actual entity instantiated in this path to be referenced when this template is used.
Note: The Activity_actual entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_inventory_loss.act_act%
where target is the parameter to which the Activity_actual is bound.
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 = $MoDAvDEXmessage_inventory_loss.res_event%
where target is the parameter to which the Decreasing_resource_event is bound.
state_decom(Type='ENTITY (State_observed)')
Allow the State_observed entity instantiated in this path to be referenced when this template is used.
Note: The State_observed entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_inventory_loss.state_decom%
where target is the parameter to which the State_observed 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.
-- instantiate reportable_item
/reportable_item(
    serial_number=@serial_number,
    part_number=@part_number,
    supplier=@supplier,
    NSN=@NSN)/
%^par = $reportable_item.par%
%^view = $reportable_item.view%
%^res_item = Resource_item%
Resource_item.name = '/IGNORE'
Resource_item.description = '/IGNORE'
Resource_item.resource_items -> ^par
%^mng_res = Managed_resource%
Managed_resource.name = '/IGNORE'
Managed_resource.description = '/IGNORE'
Managed_resource.item -> ^res_item
/representing_count(
    value='1')/
%^count = $representing_count.count%
%^res_event = Decreasing_resource_event%
Decreasing_resource_event.name = '/IGNORE'
Decreasing_resource_event.description = '/IGNORE'
Decreasing_resource_event.quantity -> ^count
Decreasing_resource_event.resource -> ^mng_res
/assigning_asserted_state(
    state_class_name='Decommissioned',
    state_ecl_id='urn:plcs:rdl:ModAvDex',
    assigned_to=^par)/
%^state_decom = $assigning_asserted_state.state_obs%
/representing_activity_actual(
    id=@activity_identifier,
    id_class_name='Activity_identification_code',
    id_ecl_id='urn:plcs:rdl:std',
    id_owner=@activity_organization,
    id_owner_class_name='Organization_name',
    id_owner_ecl_id='urn:plcs:rdl:std',
    method='',
    date_class_name='Date_actual_start',
    date_ecl_id='urn:plcs:rdl:std',
    year=@activity_year,
    month=@activity_month,
    day=@activity_day,
    hour=@activity_hour,
    minute=@activity_minute,
    second=@activity_second,
    sense='.EXACT.',
    hour_offset='0',
    minute_offset='0')/
%^act_act = $representing_activity_actual.act_act%

-- instantiate MoDAvDEXmessage
/MoDAvDEXmessage(
    msg_identifier=@msg_identifier,
    sent_year=@sent_year,
    sent_month=@sent_month,
    sent_day=@sent_day,
    sent_hour=@sent_hour,
    sent_minute=@sent_minute,
    sent_second=@sent_second,
    sender_organization=@sender_organization,
    receiver_organization=@receiver_organization,
    contract_identifier=@contract_identifier,
    extract_year=@extract_year,
    extract_month=@extract_month,
    extract_day=@extract_day,
    extract_hour=@extract_hour,
    extract_minute=@extract_minute,
    extract_second=@extract_second,
    security_class=@security_class,
    content=^act_act)/

-- instantiate assigning_activity
/assigning_activity(
    role_class_name='Activity_input',
    role_ecl_id='urn:plcs:rdl:std',
    assigned_activity=^act_act,
    items=^res_event)/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Resource_item.name '/IGNORE'
Resource_item.description '/IGNORE'
Managed_resource.name '/IGNORE'
Managed_resource.description '/IGNORE'
Decreasing_resource_event.name '/IGNORE' Resource_event.name
Decreasing_resource_event.description '/IGNORE' Resource_event.description
Characterizations
No common characterizations of the template MoDAvDEXmessage_inventory_loss 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