Template:— cumulative_product_usage_feedback (cum_prod_us_fbk)
Context:— UK_Defence
Date: 2009/04/17 11:06:27
Revision: 1.4

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

Description

This template describes how to represent the cumulative product usage at the time at a particular point in time.

Business perspective

The Cumulative Product Usage Feedback business object is used by those UK_Defence Data Exchange Specifications that require information about the cumulative product usage at the time at a particular point in time.

Business object definition


Figure 1 —  Graphical Representation for Business Object Cumulative Product Usage Feedback

Figure 1 —  Graphical Representation for Business Object Cumulative Product Usage Feedback

Cumulative Product Usage Feedback:

The definition of a Cumulative Product Usage Feedback object is: Data about the cumulative product usage at the time at a particular point in time.

Attribute name

Attribute description

Attribute type

Optionality

Related product This is a reference to the related Product. Relationship to Product Mandatory
Type This is the type of the cumulative usage. This may be used, for example, to qualify the named usage with an additional description. Example: It may be necessary to know the cumulative usage of an equipment (in miles) at a certain performance level (over 100 mph). The latter parameter would be recorded by this attribute Intrinsic Optional
Usage This is the value that is measured. Relationship to Measure with unit Mandatory

Table 1 — Product Cumulative Product Usage 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 "cumulative_product_usage_feedback". The text highlighted in blue shows the template parameters.


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

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

Figure 3 —  The graphical representation of the cumulative_product_usage_feedback template

Input parameters
The following input parameters are defined for this template:
record_date (Type= 'ENTITY (Date_time)' )
This is the date the usage value was recorded.
description (Type='STRING', Optional)
This is the textual description of the usage.
ID (Type='STRING')
This is the identifier of the Cumulative product usage report.
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.
recorded_by (Type= 'ENTITY (Person)' )
This is the name of the person who recorded the cumulative usage.
related_product (Type= 'ENTITY (Product_as_individual)' )
This is a reference to the related Product.
type (Type='STRING', Optional)
This is the type of the cumulative usage.
usage_unit (Type='CLASS')
The class name corresponding to the unit in which the usage value is measured.
The following classes and their sub-classes can be used:
classifications: "Unit" (urn:plcs:rdl:std:Unit)
usage_value (Type= 'TYPE (any_number_value)' )
The value of the cumulative usage. The data type must also be indicated in this parameter, e.g. "ANY_NUMBER_VALUE(5)".
Reference parameters
The following reference parameters are defined for this template:
cum_prod_usage(Type='ENTITY (Assigned_property)')
Allow the Assigned_property entity instantiated in this path to be referenced when this template is used.
Note: The Assigned_property entity can be referenced in a template path by:
%^target = $cumulative_product_usage_feedback.cum_prod_usage%
where target is the parameter to which the Assigned_property is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Cumulative_Product_Usage_Feedback
Each instance of the entity (Assigned_property) within the data set shall be uniquely identified by a combination of the following parameters on this template (cumulative_product_usage_feedback) namely: ID, recorded_by.
The instance is referenced by the following template parameter: cum_prod_usage.
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.
-- assign a quantity to the product and classify it
/assigning_product_property(
    property_class_name='Cumulative_product_usage',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=@related_product)/
%^cum_prod_usage = $assigning_product_property.property%

-- assign a value and unit to the asset's book value property
/product_property_numeric(
    value=@usage_value,
    unit=@usage_unit,
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='.false.',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:uk_defence',
    property=^cum_prod_usage)/

-- ID (mandatory)
/identifier(
    ID=@ID,
    source_organization=@source_organization,
    type='Cumulative_product_usage_identifier',
    items=^cum_prod_usage)/

-- Description
/assigning_descriptor(
    descr=@description,
    class_name='Description',
    ecl_id='urn:plcs:rdl:std',
    is_assigned_to=^cum_prod_usage)/

-- Recorded by (mandatory)
Organization_or_person_in_organization_assignment

-- Set the Organization_or_person_in_organization_assignment attribute role to be ignored
Organization_or_person_in_organization_assignment.role = '/IGNORE'

-- Assign the Organization_or_person_in_organization_assignment to the property
Organization_or_person_in_organization_assignment.items -> ^cum_prod_usage

-- Create the Recorded_by parameter
Organization_or_person_in_organization_assignment.assigned_entity -> @recorded_by

-- record_date
Date_or_date_time_assignment
Date_or_date_time_assignment.items -> ^cum_prod_usage
Date_or_date_time_assignment.assigned_date -> @record_date
%^cumulative_date_time = Date_or_date_time_assignment%
/assigning_reference_data(
    items=^cumulative_date_time,
    class_name='Date_cumulative_product_usage_recorded',
    ecl_id='urn:plcs:rdl:uk_defence')/
/assigning_reference_data(
    items=^cum_prod_usage,
    class_name=@type,
    ecl_id='urn:plcs:rdl:uk_defence')/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Organization_or_person_in_organization_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:
/cumulative_product_usage_feedback(record_date='@53', description='This is the description of the cumulative product usage', ID='CPU123', source_organization='UK_Defence', recorded_by='@80', related_product='@113', type='above 150 kph', usage_unit='kilometre', usage_value='ANY_NUMBER_VALUE(300)')/
(an illustration of the consolidated cumulative_product_usage_feedback template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by cumulative_product_usage_feedback template

Figure 4 —  Entities instantiated by cumulative_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:
/cumulative_product_usage_feedback(record_date='@53', description='This is the description of the cumulative product usage', ID='CPU123', source_organization='UK_Defence', recorded_by='@80', related_product='@113', type='above 150 kph', usage_unit='kilometre', usage_value='ANY_NUMBER_VALUE(300)')/


Figure 5 —  Instantiation of cumulative_product_usage_feedback template

Figure 5 —  Instantiation of cumulative_product_usage_feedback template

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