Template:— cost_analysis (cst_anly) Context:— UK_Defence |
Date: 2010/03/15 14:22:41 Revision: 1.5
|
This section specifies the template cost_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.
This template describes how to represent the record of a Cost Analysis of the related PSE constituent having been conducted.
The results of the analysis may be recorded in an associated document, or they may exist as a set of related, structured information
objects.
The Cost Analysis business object is used by those UK_Defence Data Exchange Specifications that require information
about the cost analysis of a product.
All MoD projects and programmes have to be able to demonstrate Value for Money in spending the public purse. It is therefore
critical that costs at all stages of the project can be monitored and assessed to ensure that they fall within predicted budgets.
Major projects will probably use a Whole Life Cost model in some form or another and, along with assessments of the operational
performance of the project’s equipment, cost is likely to be the prime success factor.
Figure 1 — Graphical Representation for Business Object Cost Analysis
Cost Analysis:
The definition of the Cost Analysis object is:
This information to represent the record of a Cost Analysis of the related PSE constituent.
Attribute name
|
Attribute description
|
Attribute type
|
Optionality
|
Results |
This is the reference to the document that contains the results of the analysis. |
Relationship to Document |
Optional |
Table 1 — Cost Analysis attribute details.
NOTE
The inherited attributes are detailed in the Support Analysis business object below.
Figure 2 — Graphical Representation for Business Object Support analysis
Support analysis:
The definition of a support analysis object is: This information object represents the record of an analysis process having
been conducted.
Attribute name
|
Attribute description
|
Attribute type
|
Optionality
|
Conducted by |
The people and/or organizations that conducted the support analysis. |
SELECT objects: Person; Organization. |
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 |
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. |
Platform System Equipment Constituent |
Mandatory |
Results Valid Period |
The period for which any results related to the support anlaysis, are valid. |
Intrinsic |
Optional |
Version |
The version of the support analysis. |
intrinsic |
Mandatory |
Table 2 — Support Analysis attribute details
The EXPRESS-G diagram in
Figure
3
shows the templates and EXPRESS entities that are required
to represent the template
"cost_analysis".
The text highlighted in blue shows the template parameters.
Figure 3 — An EXPRESS-G representation of the Information model for cost_analysis
The graphic for the template to be used in other EXPRESS-G diagrams
is shown in Figure
4
below.
Figure 4 — The graphical representation of the cost_analysis template
The following input parameters are defined for this template:
The description of the cost analysis. If this attribute is not required, the relevant
assigning_descriptor template should not be instantiated.
The name of the cost analysis. If this attribute is not required, the relevant
identifier template should not be instantiated.
The name of the organization responsible for identifying the cost analysis. If this attribute is not required, the relevant
identifier template should not be instantiated.
The identifier of the cost analysis.
The identifier of the organization responsible for identifying the cost analysis.
The version of the cost analysis.
The reference to the person or organization that conducted the cost analysis.
The reference to the constituent of the platform system equipment that is the subject of the cost analysis. If this
attribute is not required, the relevant
assigning_dated_effectivity template should not be instantiated.
The reference to the date and time on which the cost analysis was conducted.
The date and time until which the cost analysis is valid.
The reference to the Document that provides the results of the cost analysis.
The following reference parameters are defined for this template:
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 = $cost_analysis.cost_analysis%
where
target
is the parameter to which the
Document
is bound.
Allow the
Document_version
entity instantiated in this path to be referenced when this template is used.
%^target = $cost_analysis.cost_analysis_version%
Allow the
Document_definition
entity instantiated in this path to be referenced when this template is used.
%^target = $cost_analysis.cost_analysis_definition%
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.
-- Support analysis represented using Representing document (why not just use Document?) /
representing_document(
doc_id=@ID,
doc_id_class_name='Cost_analysis_identifier',
doc_id_ecl_id='urn:plcs:rdl:uk_defence',
doc_org_id=@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_identification_code',
doc_vn_org_id_ecl_id='urn:plcs:rdl:std',
domain='Through_life_support_standard',
domain_ecl_id='urn:plcs:rdl:uk_defence',
life_cycle_stage='Support_stage',
life_cycle_stage_ecl_id='urn:plcs:rdl:std')/
%^cost_analysis = $representing_document.document%
%^cost_analysis_version = $representing_document.document_version%
%^cost_analysis_definition = $representing_document.document_definition%
-- Create relationship to conducting organization Organization_or_person_in_organization_assignmentOrganization_or_person_in_organization_assignment.items ->
^cost_analysis
Organization_or_person_in_organization_assignment.assigned_entity ->
@Conducted_byOrganization_or_person_in_organization_assignment.role = '/IGNORE'
-- Date of analysis Date_or_date_time_assignmentDate_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items ->
^cost_analysis_version
Date_or_date_time_assignment.assigned_date ->
@Date_of_analysis-- [optional Description] /
assigning_descriptor(
descr=@Description,
class_name='Cost_analysis_description',
ecl_id='urn:plcs:rdl:uk_defence',
is_assigned_to=^cost_analysis)/
-- Name /
identifier(
ID=@Name,
source_organization=@Name_source_organization,
type='Cost_analysis_name',
items=^cost_analysis)/
-- Related PSE constituent Document_assignmentDocument_assignment.role = '/IGNORE'
Document_assignment.assigned_document ->
^cost_analysis_version
Document_assignment.is_assigned_to ->
@Related_PSE_constituent-- Results Valid Period Dated_effectivityDated_effectivity.id = '/IGNORE'
Dated_effectivity.name = '/IGNORE'
Dated_effectivity.description = '/IGNORE'
Dated_effectivity.start_bound ->
@Results_valid_period_startDated_effectivity.end_bound ->
@Results_valid_period_end%^dated_effectivity =
Dated_effectivity%
Effectivity_assignmentEffectivity_assignment.role = '/IGNORE'
Effectivity_assignment.items ->
^cost_analysis_version
Effectivity_assignment.assigned_effectivity ->
^dated_effectivity
%^effectivity_assignment =
Effectivity_assignment%
/
assigning_reference_data(
class_name='Results_valid_period',
ecl_id='urn:plcs:rdl:std',
items=^effectivity_assignment)/
-- [Optional relationship to the Results (Document)] /
assigning_document(
assigned_document=^cost_analysis,
doc_ass_role='Cost_analysis_results',
doc_ar_ecl_id='urn:plcs:rdl:UK_Defence',
is_assigned_to=@Results)/
The following entities are instantiated with attributes as specified:
The instance diagram in Figure
5
shows an example of the EXPRESS entities and templates that are instantiated by the template:
/cost_analysis(Description='This is my cost analysis', Name='My Cost Analysis', Name_source_organization='CBIS', ID='CST-001', ID_source_organization='CBIS', Version='01', Conducted_by='@228', Related_PSE_constituent='@113', Date_of_analysis='@57', Results_valid_period_end='@223', Results_valid_period_start='@218', Results='@261')/
(an illustration of the consolidated cost_analysis template is shown in
Figure
6 below.)
Figure 5 — Entities instantiated by cost_analysis template
The instance diagram in
Figure
6
shows the graphic symbol for the template that is to be
used in other instance diagrams. The example template is:
/cost_analysis(Description='This is my cost analysis', Name='My Cost Analysis', Name_source_organization='CBIS', ID='CST-001', ID_source_organization='CBIS', Version='01', Conducted_by='@228', Related_PSE_constituent='@113', Date_of_analysis='@57', Results_valid_period_end='@223', Results_valid_period_start='@218', Results='@261')/
Figure 6 — Instantiation of cost_analysis template
Characterizations
No common characterizations of the template
cost_analysis
have been identified. However, the ISO 10303-239 EXPRESS model
may enable other assignments to the entities instantiated by the template.