Template:— activity_resource_feedback (act_res_fbk)
Context:— UK_Defence
Date: 2009/11/03 17:06:39
Revision: 1.4

This section specifies the template activity_resource_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.

Description

This template describes how to represent feedback from an actual activity that is performed on specific dates.

Business perspective

The activity resource feedback business object is used by those UK_Defence Data Exchange Specifications that require information about the feedback from an actual activity that is performed on specific dates.

Business object definition


Figure 1 —  Graphical Representation for Business Object Activity Resource Feedback

Figure 1 —  Graphical Representation for Business Object Activity Resource Feedback

Activity Resource Feedback:

The definition of an Activity Resource Feedback object is: Data about the identification of the feedback from an actual activity that is performed on specific dates.

Attribute name

Attribute description

Attribute type

Optionality

Quality of resource This is a qualitative assessment of whether the resource was suitable for the related activity Intrinsic Optional
Quantity sufficiency This is an assessment of whether the quantity of the resource was sufficient for the activity. Intrinsic Optional
Quantity used This is the measure of the resource that has actually been used when the feedback is made. Intrinsic Optional
Related activity This is the reference to the activity for which the resource feedback is made. Relationship to Activity Mandatory
Related resource This is the reference to the activity resource about which feedback has been created Relationship to Facility, Utility, Inventory Item, Person with skill, Person or Organization with Qualification or Document Mandatory
Timeliness This is an assessment of whether the activity resource was delivered on time. Intrinsic Optional

Table 1 — Activity Resource Feedback attribute details

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


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

Figure 2 —  An EXPRESS-G representation of the Information model for activity_resource_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 activity_resource_feedback template

Figure 3 —  The graphical representation of the activity_resource_feedback template

Input parameters
The following input parameters are defined for this template:
quality_of_resource (Type='STRING', Optional)
This is a qualitative assessment of whether the resource was suitable for the related activity.
quantity_sufficiency (Type='STRING', Optional)
This is an assessment of whether the quantity of the resource was sufficient for the activity.
quantity_used (Type= 'ENTITY (Assigned_property)' , Optional)
This is the measure of the resource that has actually been used when the feedback is made.
related_activity (Type= 'ENTITY (Activity)' )
This is the reference to the activity for which the resource feedback is made.
related_resource (Type= 'SELECT (activity_item)' )
This is the reference to the activity resource about which feedback has been created.
timeliness (Type='STRING', Optional)
This is an assessment of whether the activity resource was delivered on time.
description (Type='STRING', Optional)
This is the description of the Activity Resource Feedback.
ID (Type='STRING')
This is the identifier of the Activity Resource Feedback.
source_organization (Type='STRING')
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.
record_date_year (Type= 'TYPE (year_number)' )
The year component of the date and time on which the activity resource feedback record was made.
record_date_month (Type= 'TYPE (month_in_year_number)' )
The month component of the date and time on which the activity resource feedback record was made.
record_date_day (Type= 'TYPE (day_in_month_number)' )
The day component of the date and time on which the activity resource feedback record was made.
record_date_hour (Type= 'TYPE (hour_in_day)' )
The hour component of the date and time on which the activity resource feedback record was made.
record_date_minute (Type= 'TYPE (minute_in_hour)' , Optional)
The minute component of the date and time on which the activity resource feedback record was made. This parameter is optional. If not given, it will remain unset.
record_date_second (Type= 'TYPE (second_in_minute)' , Optional)
The second component of the date and time on which the activity resource feedback record was made. This parameter is optional. If not given, it will remain unset.
recorded_by (Type= 'SELECT (organization_or_person_in_organization_select)' )
This is the reference to the person or system which recorded the feedback
Reference parameters
The following reference parameters are defined for this template:
act_res_fbk(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 = $activity_resource_feedback.act_res_fbk%
where target is the parameter to which the Activity_actual is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Activity_resource_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 (activity_resource_feedback) namely: related_activity, ID, recorded_by.
The instance is referenced by the following template parameter: act_res_fbk.
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.
Activity_method
Activity_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='Activity_resource_feedback_identifier',
    id_ecl_id='urn:plcs:rdl:uk_defence',
    id_owner=@source_organization,
    id_owner_class_name='Identifier_owner',
    id_owner_ecl_id='urn:plcs:rdl:uk_defence, date_class_name=')/
%^act_res_fbk = $representing_activity_actual.act_act%

-- [Optional Description]
/assigning_descriptor(
    descr=@description,
    class_name='Description',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^act_res_fbk)/

-- [Optional quality_of_resource]
/assigning_descriptor(
    descr=@quality_of_resource,
    class_name='Quality_of_resource',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^act_res_fbk)/

-- [Optional quantity_sufficiency]
/assigning_descriptor(
    descr=@quantity_sufficiency,
    class_name='Quantity_sufficiency',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^act_res_fbk)/

-- [Optional timeliness]
/assigning_descriptor(
    descr=@timeliness,
    class_name='Timeliness',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^act_res_fbk)/

-- relationship to parameters measured
Applied_activity_assignment
Applied_activity_assignment.role = '/IGNORE'
Applied_activity_assignment.items -> @quantity_used
Applied_activity_assignment.assigned_activity -> ^act_res_fbk
%^quant_used = Applied_activity_assignment%
/assigning_reference_data(
    items=^quant_used,
    class_name='Property',
    ecl_id='urn:plcs:rdl:uk_defence')/

-- relationship to related activity
Applied_activity_assignment
Applied_activity_assignment.role = '/IGNORE'
Applied_activity_assignment.items -> @related_activity
Applied_activity_assignment.assigned_activity -> ^act_res_fbk
%^rel_act = Applied_activity_assignment%
/assigning_reference_data(
    items=^rel_act,
    class_name='Related_activity',
    ecl_id='urn:plcs:rdl:uk_defence')/

-- relationship to recorded_by
Applied_activity_assignment
Applied_activity_assignment.role = '/IGNORE'
Applied_activity_assignment.items -> @recorded_by
Applied_activity_assignment.assigned_activity -> ^act_res_fbk
%^record_by = Applied_activity_assignment%
/assigning_reference_data(
    items=^record_by,
    class_name='Recorded_by',
    ecl_id='urn:plcs:rdl:uk_defence')/

-- relationship to resource
Applied_activity_assignment
Applied_activity_assignment.role = '/IGNORE'
Applied_activity_assignment.items -> @related_resource
Applied_activity_assignment.assigned_activity -> ^act_res_fbk
%^rel_resource = Applied_activity_assignment%
/assigning_reference_data(
    items=^rel_resource,
    class_name='Resource',
    ecl_id='urn:plcs:rdl:uk_defence')/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Activity_method.name '/IGNORE'
Activity_method.description '/IGNORE'
Activity_method.consequence '/IGNORE'
Activity_method.purpose '/IGNORE'
Applied_activity_assignment.role '/IGNORE'
Applied_activity_assignment.role '/IGNORE'
Applied_activity_assignment.role '/IGNORE'
Applied_activity_assignment.role '/IGNORE'
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/activity_resource_feedback(quality_of_resource='Resource was suitable', quantity_sufficiency='Resource was sufficient', quantity_used='@1049', related_activity='@919', related_resource='@1147', timeliness='Activity resource was delivered to schedule', description='This is the description of the Activity Resource Feedback', ID='ARF123', source_organization='UK_Defence', record_date_year='2009', record_date_month='2', record_date_day='28', record_date_hour='10', record_date_minute='30', record_date_second='0', recorded_by='@1124')/
(an illustration of the consolidated activity_resource_feedback template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by activity_resource_feedback template

Figure 4 —  Entities instantiated by activity_resource_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:
/activity_resource_feedback(quality_of_resource='Resource was suitable', quantity_sufficiency='Resource was sufficient', quantity_used='@1049', related_activity='@919', related_resource='@1147', timeliness='Activity resource was delivered to schedule', description='This is the description of the Activity Resource Feedback', ID='ARF123', source_organization='UK_Defence', record_date_year='2009', record_date_month='2', record_date_day='28', record_date_hour='10', record_date_minute='30', record_date_second='0', recorded_by='@1124')/


Figure 5 —  Instantiation of activity_resource_feedback template

Figure 5 —  Instantiation of activity_resource_feedback template

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