Template:— system_function (sys_fcn)
Context:— UK_Defence
Date: 2009/04/17 12:15:20
Revision: 1.2

This section specifies the template system_function.

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 reference the functionality realized by a system.

Business perspective

This information object represents the realization of a function by a system designed to perform that function.

Business object definition

This information object represents the relationship between a system and the functions that it is designed to perform.



Figure 1 —  Graphical Representation for Business Object System Function.

Figure 1 —  Graphical Representation for Business Object System Function.

Attribute name

Attribute description

Attribute type

Optionality

id This attribute provides the identification of the breakdown item. Identifier Mandatory
Identifier.id This is the value of the id attribute of the Identifier applied to the Physical Breakdown Item System intrinsic Mandatory
Identifier.type This attribute is the type associated with the id of the Identifier given to the Physical Breakdown Item System This attribute indicates the type of functional items covered by the breakdown. This must be one of the classes provided. realization_identification_code Mandatory
Identifier.source_organization This attribute is the value representing the source organization that provides the id of the Identifier given to the Physical Breakdown Item System This value is assumed to be a type of Organization_identification_code. Organization_identification_code Mandatory
Function This is the reference to the function that the related system has been designed to fulfil. Function Mandatory
System This is the reference to the system that has been designed to fulfill the related functions. System Mandatory

Table 1 — physical_breakdown_item_system attribute details

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


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

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

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

Figure 3 —  The graphical representation of the system_function template

Input parameters
The following input parameters are defined for this template:
realization_id (Type='STRING')
This is the identifier of the system breakdown item functionality relationship
realization_id_type (Default=System_realization_identification_code,Type='CLASS')
This attribute is provides the type associated with the id of the Identifier given to the relationship. This must be one of the classes provided.
The following classes and their sub-classes can be used:
classifications: [System_realization_identification_code]
[warning:]Error RDL4: The URI urn:plcs:rdl:uk_defence is not listed in dexlib/data/refdata/rdl_index.xml
id_source_organization (Type='STRING')
The identifier of the organization that owns the id. It is assumed that this will be of type Organization_identification_code and not an Organization name.
system_breakdown_item (Type= 'ENTITY (System_element_definition)' )
This is the system breadkdown element definition that is realizing the function.
is_realization_of (Type= 'ENTITY (Functional_element_definition)' )
The functional element definition being realized.
Reference parameters
The following reference parameters are defined for this template:
realization_relationship(Type='ENTITY (View_definition_usage)')
Allow the View_definition_usage entity instantiated in this path to be referenced when this template is used.
Note: The View_definition_usage entity can be referenced in a template path by:
%^target = $system_function.realization_relationship%
where target is the parameter to which the View_definition_usage is bound.
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_breakdown_element_realization(
    breakdown=@system_breakdown_item,
    product=@is_realization_of,
    class_name='System_realization',
    class_ecl_id='urn:plcs:rdl:uk_defence')/
%^realization_relationship = $representing_breakdown_element_realization.bkdn_elem_real%

-- assign name to breakdown_element
/assigning_identification(
    id=@realization_id,
    id_class_name=@realization_id_type,
    id_ecl_id='urn:plcs:rdl:uk_defence',
    org_id=@id_source_organization,
    org_id_class_name='Organization_identification_code',
    org_id_ecl_id='urn:plcs:rdl:uk_defence',
    items=^realization_relationship)/
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/system_function(realization_id='14649', realization_id_type='System_realization_identification_code', id_source_organization='6421', system_breakdown_item='@691', is_realization_of='@600')/
(an illustration of the consolidated system_function template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by system_function template

Figure 4 —  Entities instantiated by system_function 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:
/system_function(realization_id='14649', realization_id_type='System_realization_identification_code', id_source_organization='6421', system_breakdown_item='@691', is_realization_of='@600')/


Figure 5 —  Instantiation of system_function template

Figure 5 —  Instantiation of system_function template

Characterizations
The following section details how the system_function template can be optionally characterized by assigning other constructs to it. These are characterizations commonly applied to the template. The ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.
The EXPRESS-G diagram in Figure 6 shows the possible characterizations of the template "system_function".


Figure 6 —  Characterizations for system_function

Figure 6 —  Characterizations for system_function

The following characterizations may apply:
Characterization Applicability date

NOTE   this characterization is optional.

A UK_Defence.system_function may have effectivities assigned to it, such as an actual or planned effectivity, through the use of the following templates (or those based upon these): assigning_dated_effectivity. The following template calls show how these characterizations might be instantiated.

/assigning_dated_effectivity(start_year='2005', start_month='11', start_day='22', start_hour='15', start_minute='15', start_second='00', start_sense='ahead', start_hour_offset='2', role_class_name='Actual_effectivity', role_ecl_id='urn:plcs:rdl:std', items='@@@@')/
/assigning_dated_effectivity(start_year='2005', start_month='11', start_day='22', start_hour='15', start_minute='15', start_second='00', start_sense='ahead', start_hour_offset='2', role_class_name='Planned_effectivity', role_ecl_id='urn:plcs:rdl:std', items='@@@@')/

NOTE    The type of effectivity is described through the application of reference data. In this case the reference data specifies that it is a 'Planned Effectivity', or 'Actual Effectivty' - but other types can be created.

Characterization Property

NOTE   this characterization is optional.

A UK_Defence.system_function may have specific properties assigned to it, through the use of the following templates (or those based upon these): UK_Defence.property. The following template calls show how these characterizations might be instantiated.

/property(property_identifier='', property_ecl_id='', property_value='', property_unit='', unit_ecl_id='', si_unit='', disposition='', a_property_of='')/
Characterization Status Assignment

NOTE   this characterization is optional.

An UK_Defence.system_function may have one or more status assigned to it, through the use of the following templates (or those based upon these): UK_Defence.status_assignment. The following template calls show how these characterizations might be instantiated.

/status_assignment(assigned_status='', assigned_status_ecl_id='', ID='', ID_type='', ID_organization='', subject='', type='', type_ecl_id='')/
Characterization Document Association

NOTE   this characterization is optional.

An UK_Defence.system_function may have specific documents assigned to it, through the use of the following templates (or those based upon these): UK_Defence.document_association , and the associated UK_Defence.document . The following template calls show how these characterizations might be instantiated.

/document_association(id='', type='', source_organization='', purpose='', related_document='', related_item='')/

© UK MOD 2010 — All rights reserved