Template:— MoDAvDEXmessage_serviceability_change (MoDAvmsg_ser_chg) Context:— MoDAvDEX |
Date: 2008/02/03 07:53:26 Revision: 1.11
|
This section specifies the template MoDAvDEXmessage_serviceability_change.
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.
This template describes how to represent a message reporting the
change of serviceability of a reportable item.
Serviceability change messages represent a record of the change of serviceability status of a reportable item.
The messages are triggered whenever a serviceability change occurs.
The EXPRESS-G diagram in
Figure
2
shows the templates and EXPRESS entities that are required
to represent the template
"MoDAvDEXmessage_serviceability_change".
The text highlighted in blue shows the template parameters.
Figure 2 — An EXPRESS-G representation of the Information model for MoDAvDEXmessage_serviceability_change
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 MoDAvDEXmessage_serviceability_change template
The following input parameters are defined for this template:
The identifier of the message.
Calendar_date year_component of the date that the message was sent.
Calendar_date month_component of the date that the message was sent.
Calendar_date day_component of the date that the message was sent.
Local_time hour_component of the date and time that the message was sent.
Local_time minute_component of the date and time that the message was sent. This
parameter is optional. If not given, it will remain unset.
Local_time second_component of the date and time that the message was sent. This
parameter is optional. If not given, it will remain unset.
The name or identifier of the sending organization.
The name or identifier of the receiving organization.
The name or identifier of the contract.
Calendar_date year_component of the date that the information in the message was
extracted from the sending system.
Calendar_date month_component of the date that the information in the message
was extracted from the sending system.
Calendar_date day_component of the date that the information in the message was
extracted from the sending system.
Local_time hour_component of the date that the information in the message was
extracted from the sending system.
Local_time minute_component of the date that the information in the message was
extracted from the sending system. This parameter is optional. If not given, it will remain
unset.
Local_time day_component of the date and time the message is extracted. This
parameter is optional. If not given, it will remain unset.
The following classes and their sub-classes can be used:
classifications: [ModAvDEX_Security_classification]
Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
The identifier of the work order.
The serial_number of the reportable item whose serviceability status has changed.
The part_number of the reportable item whose serviceability status has changed.
supplier (Default=/NULL,Type='STRING', Optional)
The supplier of the reportable item whose serviceability status has changed.
NSN (Default=/NULL,Type='STRING', Optional)
The NSN of the reportable item whose serviceability status has changed.
The new serviceability state of the reportable item.
The following classes and their sub-classes can be used:
classifications: [ModAvDEX_serviceability_state]
Error RDL4: The URI urn:plcs:rdl:LITS is not listed in dexlib/data/refdata/rdl_index.xml
The organization that owned the reportable item when the state changed.
Calendar_date year_component. Year state changed.
Calendar_date month_component. Month state changed.
Calendar_date day_component. Day state changed.
Local_time hour_component of the date and time. Hour state changed.
Local_time minute_component of the date and time. Minute state changed.
This parameter is optional. If not given, it will remain unset.
Local_time second_component of the date and time. Second state changed.
This parameter is optional. If not given, it will remain unset.
The following reference parameters are defined for this template:
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_serviceability_change.message%
where
target
is the parameter to which the
Message
is bound.
Allow the
Work_order
entity instantiated in this path to be referenced when this template is used.
Note: The
Work_order
entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_serviceability_change.work_order%
where
target
is the parameter to which the
Work_order
is bound.
Allow the
Directed_activity
entity instantiated in this path to be referenced when this template is used.
%^target = $MoDAvDEXmessage_serviceability_change.dir_act%
Allow the
Product_as_realized
entity instantiated in this path to be referenced when this template is used.
%^target = $MoDAvDEXmessage_serviceability_change.par%
%^target = $MoDAvDEXmessage_serviceability_change.view%
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_serviceability_change.serv_state%
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.
/
ref_work_order(
wo_id=@wo_id)/
%^dir_act = $ref_work_order.dir_act%
%^work_order = $ref_work_order.work_order%
-- Instantiate the reportable item /
reportable_item(
serial_number=@serial_number,
part_number=@part_number,
supplier=@supplier,
NSN=@NSN)/
%^par = $reportable_item.par%
%^view = $reportable_item.view%
-- instantiate assigning_organization for the owner of reportable item /
assigning_organization(
org_id=@own_organization,
org_id_class_name='Organization_name',
org_id_ecl_id='urn:plcs:rdl:std',
org_assgn_class_name='Owner_of',
org_assgn_ecl_id='urn:plcs:rdl:std',
items=^par)/
-- instantiate assigning_activity /
assigning_activity(
role_class_name='Activity_input',
role_ecl_id='urn:plcs:rdl:std',
assigned_activity=^dir_act,
items=^par)/
-- Instantiate the message /
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=^dir_act)/
%^message = $MoDAvDEXmessage.message%
/
assigning_asserted_state(
state_class_name=@serviceability_state,
state_ecl_id='urn:plcs:rdl:LITS',
assigned_to=^par)/
%^serv_state = $assigning_asserted_state.state_assert%
-- instantiate assigning_activity /
assigning_activity(
role_class_name='Activity_input',
role_ecl_id='urn:plcs:rdl:std',
assigned_activity=^dir_act,
items=^serv_state)/
-- instantiate assigning_time for date of current state /
assigning_time(
date_class_name='Date_actual_start',
date_ecl_id='urn:plcs:rdl:std',
year=@state_year,
month=@state_month,
day=@state_day,
hour=@state_hour,
minute=@state_minute,
second=@state_second,
sense='.EXACT.',
hour_offset='0',
minute_offset='0',
items=^serv_state)/
Characterizations
No common characterizations of the template
MoDAvDEXmessage_serviceability_change
have been identified. However, the ISO 10303-239 EXPRESS model
may enable other assignments to the entities instantiated by the template.