Template:— product_usage_feedback (prod_us_fbk)
Context:— UK_Defence |
Date: 2010/03/19 15:05:33
Revision: 1.9
|
This section specifies the template product_usage_feedback.
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.
This template describes how to represent information related to the operation of the PSE.
The product usage feedback business object is used by those UK_Defence Data Exchange
Specifications that require information related to the operation of the PSE.
Figure 1 — Graphical Representation for Business Object Product Usage Feedback
Product Usage Feedback:
The definition of an Product Usage Feedback object is:
Data about information related to the operation of the PSE.
|
Attribute name
|
Attribute description
|
Attribute type
|
Optionality
|
| Actual mission |
This is the actual mission the product was being used on when the usage was reported |
Relationship to Mission |
Mandatory |
| End location |
This is the location of the product when the reported use ended. |
Relationship to Location |
Mandatory |
| End time |
This is the end time of the reported usage period. |
Intrinsic |
Mandatory |
| Extraordinary operating |
This is a description of operating conditions outside design parameters when the usage was reported. |
Intrinsic |
Mandatory |
| Operational theatre |
This is the reference to the operational theatre in which the related product was used. |
Relationship to Operational theatre |
Mandatory |
| Related product |
This is the reference to the related product. |
Relationship to Related product |
Mandatory |
| Role |
This is a reference to the role in which the product was being used when the usage was reported. |
Relationship to Product Role |
Mandatory |
| Start location |
This is the location of the product when the reported use started. |
Relationship to Location |
Mandatory |
| Start time |
This is the start time of the reported usage period. |
Intrinsic |
Mandatory |
| Who Reported |
This is the name of the person reporting the product usage |
Intrinsic |
Mandatory |
Table 1 — Product Usage Feedback attribute details
The EXPRESS-G diagram in
Figure
2
shows the templates and EXPRESS entities that are required
to represent the template
"product_usage_feedback".
The text highlighted in blue shows the template parameters.
Figure 2 — An EXPRESS-G representation of the Information model for product_usage_feedback
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 product_usage_feedback template
The following input parameters are defined for this template:
This is the actual mission the product was being used on when the usage was reported.
This is a description of the Product usage.
This is the location of the product when the reported use ended.
This is the end time of the reported usage period
This is a description of operating conditions outside design parameters when the usage was reported.
This is the identifier of the product usage report.
The organization that created the identifier. Additionally
a Person or Information System could be defined when either of these are the source; see Identifier template.
This is the location of the product when the reported use ended.
This is a reference to the related Product.
This is a reference to the role in which the product was being used when the usage was reported.
This is the location of the product when the reported use started.
The year component of the start date and time the reported usage period.
The month component of the start date and time the reported usage period.
The day component of the start date and time the reported usage period.
The hour component of the start date and time the reported usage period.
The minute component of the start date and time the reported usage period.
This parameter is optional. If not given, it will remain unset.
The second component of the start date and time the reported usage period.
This parameter is optional. If not given, it will remain unset.
This is the name of the person reporting the product usage.
This is the date and time on which the support feedback record was made.
This is the reference to the person or system which recorded the feedback
The following reference parameters are defined for this template:
Allow the
Activity_actual
entity instantiated in this path to be referenced when this template is used.
%^target = $product_usage_feedback.prod_usage_fbk%
The following parameter combinations specify a uniqueness constraint:
Unique constraint: Product_Usage_Feedback
Each instance of the
entity
(
Activity_actual)
within the data set shall be uniquely identified
by a combination of the following parameters on this
template (product_usage_feedback) namely:
ID,
related_product,
recorded_by.
The
instance is
referenced by the following template parameter:
prod_usage_fbk.
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.
Activity_methodActivity_method.name = '/IGNORE'
Activity_method.description = '/IGNORE'
Activity_method.consequence = '/IGNORE'
Activity_method.purpose = '/IGNORE'
%^act_method =
Activity_method%
/
representing_activity_actual(
id=@ID,
id_class_name='Product_usage_feedback_identifier',
id_ecl_id='urn:plcs:rdl:uk_defence',
id_owner=@source_organization,
id_owner_class_name='Owner_of',
id_owner_ecl_id='urn:plcs:rdl:uk_defence, date_class_name=')/
%^prod_usage_fbk = $representing_activity_actual.act_act%
-- [Optional Description] /
assigning_descriptor(
descr=@description,
class_name='Description',
ecl_id='urn:plcs:rdl:std',
is_assigned_to=^prod_usage_fbk)/
-- extraordinary_operating /
assigning_descriptor(
descr=@extraordinary_operating_conditions,
class_name='Extraordinary_operating_description',
ecl_id='urn:plcs:rdl:uk_defence',
is_assigned_to=^prod_usage_fbk)/
-- relationship to mission Activity_relationshipActivity_relationship.name = '/IGNORE'
Activity_relationship.description = '/IGNORE'
Activity_relationship.relating_activity ->
^prod_usage_fbk
Activity_relationship.related_activity ->
@actual_mission%^act_mission =
Activity_relationship%
/
assigning_reference_data(
items=^act_mission,
class_name='Actual_mission',
ecl_id='urn:plcs:rdl:uk_defence')/
-- relationship to end time Date_or_date_time_assignmentDate_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items ->
^prod_usage_fbk
Date_or_date_time_assignment.assigned_date ->
@end_time%^end_date_time =
Date_or_date_time_assignment%
/
assigning_reference_data(
items=^end_date_time,
class_name='Date_actual_end',
ecl_id='urn:plcs:rdl:std')/
-- relationship to record_date Date_or_date_time_assignmentDate_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items ->
^prod_usage_fbk
Date_or_date_time_assignment.assigned_date ->
@record_date%^record_date_time =
Date_or_date_time_assignment%
/
assigning_reference_data(
items=^record_date_time,
class_name='Record_date',
ecl_id='urn:plcs:rdl:uk_defence')/
-- relationship to product_role Activity_relationshipActivity_relationship.name = '/IGNORE'
Activity_relationship.description = '/IGNORE'
Activity_relationship.relating_activity ->
^prod_usage_fbk
Activity_relationship.related_activity ->
@role%^role =
Activity_relationship%
/
assigning_reference_data(
items=^role,
class_name='Role',
ecl_id='urn:plcs:rdl:uk_defence')/
-- state StateState.name = '/IGNORE'
State.description = '/IGNORE'
%^state =
State%
-- relationship to operational theatre State_assertionState_assertion.name = '/IGNORE'
State_assertion.description = '/IGNORE'
State_assertion.asserted_state ->
^state
State_assertion.conformance_state ->
@operational_theatre-- relationship to state Applied_activity_assignmentApplied_activity_assignment.role = '/IGNORE'
Applied_activity_assignment.items ->
^state
Applied_activity_assignment.assigned_activity ->
^prod_usage_fbk
%^op_theatre =
Applied_activity_assignment%
/
assigning_reference_data(
items=^op_theatre,
class_name='Operational_theatre_assignment',
ecl_id='urn:plcs:rdl:uk_defence')/
-- relationship to start location Applied_activity_assignmentApplied_activity_assignment.role = '/IGNORE'
Applied_activity_assignment.items ->
@start_locationApplied_activity_assignment.assigned_activity ->
^prod_usage_fbk
%^start_loc =
Applied_activity_assignment%
/
assigning_reference_data(
items=^start_loc,
class_name='Start_location_assignment',
ecl_id='urn:plcs:rdl:uk_defence')/
-- relationship to end location Applied_activity_assignmentApplied_activity_assignment.role = '/IGNORE'
Applied_activity_assignment.items ->
@end_locationApplied_activity_assignment.assigned_activity ->
^prod_usage_fbk
%^end_loc =
Applied_activity_assignment%
/
assigning_reference_data(
items=^end_loc,
class_name='End_location_assignment',
ecl_id='urn:plcs:rdl:uk_defence')/
-- relationship to product Applied_activity_assignmentApplied_activity_assignment.role = '/IGNORE'
Applied_activity_assignment.items ->
@related_productApplied_activity_assignment.assigned_activity ->
^prod_usage_fbk
%^prod =
Applied_activity_assignment%
/
assigning_reference_data(
items=^prod,
class_name='Serialised_asset',
ecl_id='urn:plcs:rdl:uk_defence')/
-- relationship to recorded by Applied_activity_assignmentApplied_activity_assignment.role = '/IGNORE'
Applied_activity_assignment.items ->
@recorded_byApplied_activity_assignment.assigned_activity ->
^prod_usage_fbk
%^rec_by =
Applied_activity_assignment%
/
assigning_reference_data(
items=^rec_by,
class_name='Recorded_by',
ecl_id='urn:plcs:rdl:uk_defence')/
-- relationship to who reported Applied_activity_assignmentApplied_activity_assignment.role = '/IGNORE'
Applied_activity_assignment.items ->
@who_reportedApplied_activity_assignment.assigned_activity ->
^prod_usage_fbk
%^who_rep =
Applied_activity_assignment%
/
assigning_reference_data(
items=^who_rep,
class_name='Reporting_person_assignment',
ecl_id='urn:plcs:rdl:uk_defence')/
The following entities are instantiated with attributes as specified:
The instance diagram in Figure
4
shows an example of the EXPRESS entities and templates that are instantiated by the template:
/product_usage_feedback(actual_mission='@257', description='This is the description of the Product Usage Feedback', end_location='@759', end_time='@800', extraordinary_operating_conditions=' This is the extraordinary operating description', ID='PUF123', source_organization='UK_Defence', operational_theatre='@406', related_product='@467', role='@542', start_location='@223', start_time_year='2009', start_time_month='2', start_time_day='28', start_time_hour='10', start_time_minute='30', start_time_second='0', who_reported='@434', record_date='@865', recorded_by='@850')/
(an illustration of the consolidated product_usage_feedback template is shown in
Figure
5 below.)
Figure 4 — Entities instantiated by product_usage_feedback 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:
/product_usage_feedback(actual_mission='@257', description='This is the description of the Product Usage Feedback', end_location='@759', end_time='@800', extraordinary_operating_conditions=' This is the extraordinary operating description', ID='PUF123', source_organization='UK_Defence', operational_theatre='@406', related_product='@467', role='@542', start_location='@223', start_time_year='2009', start_time_month='2', start_time_day='28', start_time_hour='10', start_time_minute='30', start_time_second='0', who_reported='@434', record_date='@865', recorded_by='@850')/
Figure 5 — Instantiation of product_usage_feedback template
Characterizations
No common characterizations of the template
product_usage_feedback
have been identified. However, the ISO 10303-239 EXPRESS model
may enable other assignments to the entities instantiated by the template.
