Template:— support_solution_performance_analysis (sup_sol_per_an)
Context:— UK_Defence
Date: 2009/04/17 12:07:43
Revision: 1.3

This section specifies the template support_solution_performance_analysis.

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 an analysis that has been performed on support feedback for the purposes of determining whether specific performance metrics have been met. The results of each Performance Analysis are recorded by means of relationships from the information objects that are generated by the analysis and the Performance Analysis object itself.

Business perspective

This information object represents an analysis that has been performed on support feedback for the purposes of determining whether specific performance metrics have been met. The results of each Performance Analysis are recorded by means of relationships from the information objects that are generated by the analysis and the Performance Analysis object itself.

Business object definition


Figure 1 —  Graphical Representation for Business Object Support Solution Performance Analysis

Figure 1 —  Graphical Representation for Business Object Support Solution Performance Analysis

Support Solution Performance Analysis:

Attribute name

Attribute description

Attribute type

Optionality

Conducted by The people and/or organizations that conducted the support analysis. Relationship to Person(s) and/or Organization(s). Mandatory (1:?)
Date of Analysis The date and time on which the support analysis was conducted. intrinsic Mandatory
Description The description of the support analysis. intrinsic Optional
ID The identifier of the support analysis. intrinsic Mandatory
Methodology used This is the reference to the document that defines the methodology used for the analysis. Relationship to Document Optional
Name This is the name of the support analysis. intrinsic Mandatory
Related PSE Constituent The constituent of the platform system equipment that is the subject of the support analysis. Relationship to Platform System Equipment Constituent Mandatory
Related support feedback The reference to any support feedback that has been used to inform the analysis. Relationship to Support Feedback Optional (0:?)
Results Valid Period The period for which any results related to the support analysis, are valid. Intrinsic Optional
Version The version of the support analysis. Intrinsic Mandatory

Table 1 — Support Solution Performance Analysis attribute details inherited from Support Analysis

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


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

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

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 support_solution_performance_analysis template

Figure 3 —  The graphical representation of the support_solution_performance_analysis template

Input parameters
The following input parameters are defined for this template:
conducted_by (Type= 'SELECT (organization_or_person_in_organization_select)' )
The reference to the person or organization that conducted the support analysis.
date_of_analysis (Type= 'SELECT (date_or_date_time_select)' )
The reference to the date and time on which the support analysis was conducted.
description (Type='STRING', Optional)
The description of the support analysis. If this attribute is not required, the relevant assigning_descriptor template should not be instantiated.
ID (Type='STRING')
The identifier of the support analysis.
source_organization (Type='STRING')
The identifier of the organization responsible for identifying the support analysis.
methodology_used (Type= 'ENTITY (Document)' )
The identifier of the support analysis.
name (Type='STRING', Optional)
The name of the support analysis. If this attribute is not required, the relevant identifier template should not be instantiated.
related_PSE_constituent (Type= 'SELECT (documented_element_select)' )
The reference to the constituent of the platform system equipment that is the subject of the support analysis. If this attribute is not required, the relevant assigning_dated_effectivity template should not be instantiated.
related_support_feedback (Type= 'ENTITY (Activity_actual)' , Optional)
The reference to the constituent of the platform system equipment that is the subject of the support analysis. If this attribute is not required, the relevant assigning_dated_effectivity template should not be instantiated.
results_valid_period_start (Type= 'ENTITY (Date_time)' , Optional)
The date and time from which the support analysis is valid. If this attribute is not required, the relevant Effectivity_assignment and Dated_effectivity entities should not be instantiated.
results_valid_period_end (Type= 'ENTITY (Date_time)' , Optional)
The date and time until which the support analysis is valid.
version (Type='STRING')
The version of the support analysis.
Reference parameters
The following reference parameters are defined for this template:
support_solution_performance_analysis(Type='ENTITY (Document)')
Allow the Document entity instantiated in this path to be referenced when this template is used.
Note: The Document entity can be referenced in a template path by:
%^target = $support_solution_performance_analysis.support_solution_performance_analysis%
where target is the parameter to which the Document is bound.
support_solution_performance_analysis_version(Type='ENTITY (Document_version)')
Allow the Document_version entity instantiated in this path to be referenced when this template is used.
Note: The Document_version entity can be referenced in a template path by:
%^target = $support_solution_performance_analysis.support_solution_performance_analysis_version%
where target is the parameter to which the Document_version is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Support_solution_performance_analysis
Each instance of the entity (Document_version) within the data set shall be uniquely identified by a combination of the following parameters on this template (support_solution_performance_analysis) namely: ID, related_PSE_constituent, version.
The instance is referenced by the following template parameter: support_solution_performance_analysis_version.
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.
-- Representing document
/representing_document(
    doc_id=@ID,
    doc_id_class_name='Support_solution_performance_analysis_identifier',
    doc_id_ecl_id='urn:plcs:rdl:uk_defence',
    doc_org_id=@source_organization,
    doc_org_id_class_name='Organization_name',
    doc_org_id_ecl_id='urn:plcs:rdl:std',
    doc_vn_id=@version,
    doc_vn_id_class_name='Version_identification_code',
    doc_vn_id_ecl_id='urn:plcs:rdl:std',
    doc_vn_org_id='/NULL',
    doc_vn_org_id_class_name='Organization_name',
    doc_vn_org_id_ecl_id='urn:plcs:rdl:std',
    domain='Product_life_cycle_support',
    domain_ecl_id='urn:plcs:rdl:std',
    life_cycle_stage='Support_stage',
    life_cycle_stage_ecl_id='urn:plcs:rdl:std')/
%^support_solution_performance_analysis = $representing_document.document%
%^support_solution_performance_analysis_version = $representing_document.document_version%

-- Create relationship to conducting organization
Organization_or_person_in_organization_assignment
Organization_or_person_in_organization_assignment.items -> ^support_solution_performance_analysis
Organization_or_person_in_organization_assignment.assigned_entity -> @conducted_by
Organization_or_person_in_organization_assignment.role = '/IGNORE'

-- Date of analysis
Date_or_date_time_assignment
Date_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items -> ^support_solution_performance_analysis
Date_or_date_time_assignment.assigned_date -> @date_of_analysis

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

-- Name
/identifier(
    ID=@name,
    source_organization=@source_organization,
    type='Support_solution_performance_analysis_name',
    items=^support_solution_performance_analysis)/

-- Related PSE constituent
Document_assignment
Document_assignment.role = '/IGNORE'
Document_assignment.assigned_document -> ^support_solution_performance_analysis
Document_assignment.is_assigned_to -> @related_PSE_constituent
%^rel_PSE_const = Document_assignment%
/assigning_reference_data(
    class_name='Related_PSE_constituent',
    ecl_id='urn:plcs:rdl:uk_defence',
    items=^rel_PSE_const)/

-- Related support feedback
Document_assignment
Document_assignment.role = '/IGNORE'
Document_assignment.assigned_document -> ^support_solution_performance_analysis
Document_assignment.is_assigned_to -> @related_support_feedback
%^rel_sup_fbk = Document_assignment%
/assigning_reference_data(
    class_name='Related_support_feedback',
    ecl_id='urn:plcs:rdl:uk_defence',
    items=^rel_sup_fbk)/

-- Methodology used
Document_assignment
Document_assignment.role = '/IGNORE'
Document_assignment.assigned_document -> ^support_solution_performance_analysis
Document_assignment.is_assigned_to -> @methodology_used
%^meth_used = Document_assignment%
/assigning_reference_data(
    class_name='Methodology_used',
    ecl_id='urn:plcs:rdl:uk_defence',
    items=^meth_used)/

-- Results Valid Period
Dated_effectivity
Dated_effectivity.id = '/IGNORE'
Dated_effectivity.name = '/IGNORE'
Dated_effectivity.description = '/IGNORE'
Dated_effectivity.start_bound -> @results_valid_period_start
Dated_effectivity.end_bound -> @results_valid_period_end
%^dated_effectivity = Dated_effectivity%
Effectivity_assignment
Effectivity_assignment.role = '/IGNORE'
Effectivity_assignment.items -> ^support_solution_performance_analysis
Effectivity_assignment.assigned_effectivity -> ^dated_effectivity
%^effectivity_assignment = Effectivity_assignment%
/assigning_reference_data(
    class_name='Results_valid_period',
    ecl_id='urn:plcs:rdl:uk_defence',
    items=^effectivity_assignment)/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Organization_or_person_in_organization_assignment.role '/IGNORE'
Date_or_date_time_assignment.role '/IGNORE'
Document_assignment.role '/IGNORE'
Document_assignment.role '/IGNORE'
Document_assignment.role '/IGNORE'
Dated_effectivity.id '/IGNORE' Effectivity.id
Dated_effectivity.name '/IGNORE' Effectivity.name
Dated_effectivity.description '/IGNORE' Effectivity.description
Effectivity_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:
/support_solution_performance_analysis(conducted_by='@176', date_of_analysis='@57', description='This is the descriptionof SA01', ID='SA01', source_organization='UK_Defence', methodology_used='@384', name='Name of analysis', related_PSE_constituent='@113', related_support_feedback='@251', results_valid_period_start='@218', results_valid_period_end='@223', version='2')/
(an illustration of the consolidated support_solution_performance_analysis template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by support_solution_performance_analysis template

Figure 4 —  Entities instantiated by support_solution_performance_analysis 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:
/support_solution_performance_analysis(conducted_by='@176', date_of_analysis='@57', description='This is the descriptionof SA01', ID='SA01', source_organization='UK_Defence', methodology_used='@384', name='Name of analysis', related_PSE_constituent='@113', related_support_feedback='@251', results_valid_period_start='@218', results_valid_period_end='@223', version='2')/


Figure 5 —  Instantiation of support_solution_performance_analysis template

Figure 5 —  Instantiation of support_solution_performance_analysis template

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