Template:— support_analysis (sup_anl) Context:— UK_Defence |
Date: 2010/03/08 22:47:49 Revision: 1.5
|
This section specifies the template support_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 UK_Defence concept of a support analysis in terms of PLCS
model elements (templates, entities, and reference data).
This information object represents the record of an analysis process having been conducted.
Subtypes of this object type record specific types of analyses.
The results of each support analysis are recorded by means of relationships from the information objects that are
generated by the analysis and the support analysis object itself.
Figure 1 — 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 |
Table 1 — Record attribute details
The EXPRESS-G diagram in
Figure
2
shows the templates and EXPRESS entities that are required
to represent the template
"support_analysis".
The text highlighted in blue shows the template parameters.
Figure 2 — An EXPRESS-G representation of the Information model for support_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_analysis template
The following input parameters are defined for this template:
The reference to the person or organization that conducted the support analysis.
The reference to the date and time on which the support analysis was conducted.
The description of the support analysis. If this attribute is not required, the relevant
assigning_descriptor template should not be instantiated.
The identifier of the support analysis.
The identifier of the organization responsible for identifying 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.
The name of the organization responsible for identifying the support analysis. If this attribute is not required, the relevant
identifier template should not be instantiated.
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.
The date and time until which the support analysis is valid.
The version of the support 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 = $support_analysis.support_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 = $support_analysis.support_analysis_version%
Allow the
Document_definition
entity instantiated in this path to be referenced when this template is used.
%^target = $support_analysis.support_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.
-- Representing document /
representing_document(
doc_id=@ID,
doc_id_class_name='Support_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')/
%^support_analysis = $representing_document.document%
%^support_analysis_version = $representing_document.document_version%
%^support_analysis_definition = $representing_document.document_definition%
-- Create relationship to conducting organization Organization_or_person_in_organization_assignmentOrganization_or_person_in_organization_assignment.items ->
^support_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 ->
^support_analysis
Date_or_date_time_assignment.assigned_date ->
@Date_of_analysis-- [optional Description] /
assigning_descriptor(
descr=@Description,
class_name='Support_analysis_identifier',
ecl_id='urn:plcs:rdl:uk_defence',
is_assigned_to=^support_analysis)/
-- Name /
identifier(
ID=@Name,
source_organization=@Name_source_organization,
type='Support_analysis_name',
items=^support_analysis)/
-- Related PSE constituent Document_assignmentDocument_assignment.role = '/IGNORE'
Document_assignment.assigned_document ->
^support_analysis
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 ->
^support_analysis
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)/
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:
/support_analysis(Conducted_by='@239', Conducted_by='@240', Date_of_analysis='@108', Description='Support analysis description', ID='SA01', ID_source_organization='UK_Defence', Name='Support analysis name', Name_source_organization='UK_Defence', Related_PSE_constituent='@113', Results_valid_from_year='2009', Results_valid_from_month='1', Results_valid_from_day='10', Results_valid_from_hour='9', Results_valid_from_minute='0', Results_valid_from_second='0', Results_valid_to_year='2009', Results_valid_to_month='2', Results_valid_to_day='11', Results_valid_to_hour='17', Results_valid_to_minute='0', Results_valid_to_second='0', Version='2')/
(an illustration of the consolidated support_analysis template is shown in
Figure
5 below.)
Figure 4 — Entities instantiated by support_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_analysis(Conducted_by='@239', Conducted_by='@240', Date_of_analysis='@108', Description='Support analysis description', ID='SA01', ID_source_organization='UK_Defence', Name='Support analysis name', Name_source_organization='UK_Defence', Related_PSE_constituent='@113', Results_valid_from_year='2009', Results_valid_from_month='1', Results_valid_from_day='10', Results_valid_from_hour='9', Results_valid_from_minute='0', Results_valid_from_second='0', Results_valid_to_year='2009', Results_valid_to_month='2', Results_valid_to_day='11', Results_valid_to_hour='17', Results_valid_to_minute='0', Results_valid_to_second='0', Version='2')/
Figure 5 — Instantiation of support_analysis template
Characterizations
No common characterizations of the template
support_analysis
have been identified. However, the ISO 10303-239 EXPRESS model
may enable other assignments to the entities instantiated by the template.