Template:— MoDAvDEXmessage_ownership_change (MoDAvmsg_own_chg) Context:— MoDAvDEX |
Date: 2008/02/03 07:53:26 Revision: 1.11
|
This section specifies the template MoDAvDEXmessage_ownership_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 a reportable item's ownership.
Ownership change messages represent a record of the change of ownership of a reportable item.
The messages are triggered whenever an ownership change occurs.
The EXPRESS-G diagram in
Figure
2
shows the templates and EXPRESS entities that are required
to represent the template
"MoDAvDEXmessage_ownership_change".
The text highlighted in blue shows the template parameters.
Figure 2 — An EXPRESS-G representation of the Information model for MoDAvDEXmessage_ownership_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_ownership_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 activity that led to the change of ownership.
The identifier of the organization who conducted the activity.
Calendar_date year_component of date the activity was conducted.
Calendar_date month_component of date the activity was conducted.
Calendar_date day_component of date the activity was conducted.
Local_time year_component of the date and time the activity was conducted.
Local_time month_component of the date and time the activity was conducted.
This parameter is optional. If not given, it will remain unset.
Local_time day_component of the date and time the activity was conducted .
This parameter is optional. If not given, it will remain unset.
The class defining the type of activity that changed the ownership.
The following classes and their sub-classes can be used:
The serial_number of the reportable item whose ownership has changed.
The part_number of the reportable item whose ownership has changed.
supplier (Default=/NULL,Type='STRING', Optional)
The supplier of the reportable item whose ownership has changed.
NSN (Default=/NULL,Type='STRING', Optional)
The NSN of the reportable item whose ownership has changed.
The identifier of the reportable item's previous owner.
new_own (Default=/NULL,Type='STRING')
The identifier of the reportable item's new owner.
Calendar_date year_component.
Calendar_date month_component.
Calendar_date day_component.
Local_time year_component of the date and time.
Local_time month_component of the date and time.
This parameter is optional. If not given, it will remain unset.
Local_time day_component of the date and time.
This parameter is optional. If not given, it will remain unset.
Calendar_date year_component.
Calendar_date month_component.
Calendar_date day_component.
Local_time year_component of the date and time.
Local_time month_component of the date and time.
This parameter is optional. If not given, it will remain unset.
Local_time day_component of the date and time.
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_ownership_change.message%
where
target
is the parameter to which the
Message
is bound.
Allow the
Product_as_realized
entity instantiated in this path to be referenced when this template is used.
%^target = $MoDAvDEXmessage_ownership_change.par%
%^target = $MoDAvDEXmessage_ownership_change.view%
Allow the
Activity_actual
entity instantiated in this path to be referenced when this template is used.
%^target = $MoDAvDEXmessage_ownership_change.act_act%
Allow the
Organization
entity instantiated in this path to be referenced when this template is used.
Note: The
Organization
entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_ownership_change.prev_own%
where
target
is the parameter to which the
Organization
is bound.
Allow the
Organization
entity instantiated in this path to be referenced when this template is used.
Note: The
Organization
entity can be referenced in a template path by:
%^target = $MoDAvDEXmessage_ownership_change.curr_own%
where
target
is the parameter to which the
Organization
is bound.
Allow the
Activity_method
entity instantiated in this path to be referenced when this template is used.
%^target = $MoDAvDEXmessage_ownership_change.act_method%
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.
/
representing_typical_activity(
id='/NULL',
id_class_name='Activity_method_identification_code',
id_ecl_id='urn:plcs:rdl:std',
id_owner='LITS',
id_owner_class_name='Organization_name',
id_owner_ecl_id='urn:plcs:rdl:std',
type=@activity_type,
type_ecl_id='urn:plcs:rdl:std')/
%^act_method = $representing_typical_activity.act_method%
-- instantiate activity_actual /
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=^act_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%
/
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)/
%^message = $MoDAvDEXmessage.message%
-- 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_activity /
assigning_activity(
role_class_name='Activity_input',
role_ecl_id='urn:plcs:rdl:std',
assigned_activity=^act_act,
items=^par)/
-- instantiate assigning_organization for the previous owner /
assigning_organization(
org_id=@prev_own,
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)/
%^prev_own = $assigning_organization.organization_assgn%
-- instantiate assigning_organization for the new owner /
assigning_organization(
org_id=@new_own,
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)/
%^curr_own = $assigning_organization.organization_assgn%
-- instantiate assigning_time for date of current owner /
assigning_time(
date_class_name='Date_actual_start',
date_ecl_id='urn:plcs:rdl:std',
year=@to_year,
month=@to_month,
day=@to_day,
hour=@to_hour,
minute=@to_minute,
second=@to_second,
sense='.EXACT.',
hour_offset='0',
minute_offset='0',
items=^curr_own)/
-- instantiate assigning_time for date previous owner /
assigning_time(
date_class_name='Date_actual_end',
date_ecl_id='urn:plcs:rdl:std',
year=@from_year,
month=@from_month,
day=@from_day,
hour=@from_hour,
minute=@from_minute,
second=@from_second,
sense='.EXACT.',
hour_offset='0',
minute_offset='0',
items=^prev_own)/
Characterizations
No common characterizations of the template
MoDAvDEXmessage_ownership_change
have been identified. However, the ISO 10303-239 EXPRESS model
may enable other assignments to the entities instantiated by the template.