Template:— reportable_item_structure (rep_strc)
Context:— MoDAvDEX
Date: 2008/03/10 11:53:26
Revision: 1.14

This section specifies the template reportable_item_structure.

NOTE  The template has been defined in the context of MoDAvDEX. 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 a reportable item structure; that is the reportable item, its parent item and the end item that it is fitted to.

This is described in detail in Aviation Maintenance DEX: Representing installation/removal position on an aircraft".

NOTE    This template does not record the history of installation, simply the position in which the reportable item has been fitted. The installation history is represented by MoDAvDEX.removed_part and MoDAvDEX.fitted_part.

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


Figure 1 —  An EXPRESS-G representation of the Information model for reportable_item_structure

Figure 1 —  An EXPRESS-G representation of the Information model for reportable_item_structure

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure  2 below.


Figure 2 —  The graphical representation of the reportable_item_structure template

Figure 2 —  The graphical representation of the reportable_item_structure template

Input parameters
The following input parameters are defined for this template:
serial_number (Default=/NULL,Type='STRING', Optional)
The serial_number of the reportable item that is input to the activity.
part_number (Default=/NULL,Type='STRING', Optional)
The part_number of the reportable item that is input to the activity.
supplier (Default=/NULL,Type='STRING', Optional)
The supplier of the reportable item that is input to the activity.
NSN (Default=/NULL,Type='STRING', Optional)
The NSN of the reportable item that is input to the activity.
parent_serial_number (Default=/NULL,Type='STRING', Optional)
The serial_number of the reportable item's parent item.
parent_part_number (Default=/NULL,Type='STRING', Optional)
The part_number of the reportable item's parent item.
parent_supplier (Default=/NULL,Type='STRING', Optional)
The supplier of the reportable item's parent item.
parent_NSN (Default=/NULL,Type='STRING', Optional)
The NSN of the reportable item's parent item.
end_serial_number (Default=/NULL,Type='STRING', Optional)
The serial_number of the input reportable item's end item.
end_part_number (Default=/NULL,Type='STRING', Optional)
The part_number of the input reportable item's end item.
end_supplier (Default=/NULL,Type='STRING', Optional)
The supplier of the input reportable item's end item.
end_NSN (Default=/NULL,Type='STRING', Optional)
The NSN of the input reportable item's end item.
position (Type='STRING')
The position in which the reportable item is fitted.
Reference parameters
The following reference parameters are defined for this template:
pai(Type='ENTITY (Product_as_individual)')
Allow the Product_as_individual entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_individual entity can be referenced in a template path by:
%^target = $reportable_item_structure.pai%
where target is the parameter to which the Product_as_individual is bound.
Reportable item
par(Type='ENTITY (Product_as_realized)')
Allow the Product_as_realized entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_realized entity can be referenced in a template path by:
%^target = $reportable_item_structure.par%
where target is the parameter to which the Product_as_realized is bound.
Reportable item version
view(Type='ENTITY (Product_as_individual_view)')
Allow the Product_as_individual_view entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_individual_view entity can be referenced in a template path by:
%^target = $reportable_item_structure.view%
where target is the parameter to which the Product_as_individual_view is bound.
Reportable item view
end_pai(Type='ENTITY (Product_as_individual)')
Allow the Product_as_individual entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_individual entity can be referenced in a template path by:
%^target = $reportable_item_structure.end_pai%
where target is the parameter to which the Product_as_individual is bound.
End item
end_par(Type='ENTITY (Product_as_realized)')
Allow the Product_as_realized entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_realized entity can be referenced in a template path by:
%^target = $reportable_item_structure.end_par%
where target is the parameter to which the Product_as_realized is bound.
End item version
end_view(Type='ENTITY (Product_as_individual_view)')
Allow the Product_as_individual_view entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_individual_view entity can be referenced in a template path by:
%^target = $reportable_item_structure.end_view%
where target is the parameter to which the Product_as_individual_view is bound.
End item view
end_part_view(Type='ENTITY (Part_view_definition)')
Allow the Part_view_definition entity instantiated in this path to be referenced when this template is used.
Note: The Part_view_definition entity can be referenced in a template path by:
%^target = $reportable_item_structure.end_part_view%
where target is the parameter to which the Part_view_definition is bound.
End item part view
parent_pai(Type='ENTITY (Product_as_individual)')
Allow the Product_as_individual entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_individual entity can be referenced in a template path by:
%^target = $reportable_item_structure.parent_pai%
where target is the parameter to which the Product_as_individual is bound.
Parent item
parent_par(Type='ENTITY (Product_as_realized)')
Allow the Product_as_realized entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_realized entity can be referenced in a template path by:
%^target = $reportable_item_structure.parent_par%
where target is the parameter to which the Product_as_realized is bound.
Parent item version
parent_view(Type='ENTITY (Product_as_individual_view)')
Allow the Product_as_individual_view entity instantiated in this path to be referenced when this template is used.
Note: The Product_as_individual_view entity can be referenced in a template path by:
%^target = $reportable_item_structure.parent_view%
where target is the parameter to which the Product_as_individual_view is bound.
Parent item view
promissory(Type='ENTITY (Promissory_usage)')
Allow the Promissory_usage entity instantiated in this path to be referenced when this template is used.
Note: The Promissory_usage entity can be referenced in a template path by:
%^target = $reportable_item_structure.promissory%
where target is the parameter to which the Promissory_usage is bound.
nau(Type='ENTITY (Next_assembly_usage)')
Allow the Next_assembly_usage entity instantiated in this path to be referenced when this template is used.
Note: The Next_assembly_usage entity can be referenced in a template path by:
%^target = $reportable_item_structure.nau%
where target is the parameter to which the Next_assembly_usage is bound.
realization(Type='ENTITY (Breakdown_element_realization)')
Allow the Breakdown_element_realization entity instantiated in this path to be referenced when this template is used.
Note: The Breakdown_element_realization entity can be referenced in a template path by:
%^target = $reportable_item_structure.realization%
where target is the parameter to which the Breakdown_element_realization is bound.
bkdn_elem_def(Type='ENTITY (Breakdown_element_definition)')
Allow the Breakdown_element_definition entity instantiated in this path to be referenced when this template is used.
Note: The Breakdown_element_definition entity can be referenced in a template path by:
%^target = $reportable_item_structure.bkdn_elem_def%
where target is the parameter to which the Breakdown_element_definition is bound.
bkdn(Type='ENTITY (Breakdown)')
Allow the Breakdown entity instantiated in this path to be referenced when this template is used.
Note: The Breakdown entity can be referenced in a template path by:
%^target = $reportable_item_structure.bkdn%
where target is the parameter to which the Breakdown is bound.
The breakdown of the product
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Unique end item
Each instance of the entity (Product_as_individual) within the data set shall be uniquely identified by a combination of the following parameters on this template (reportable_item_structure) namely: end_serial_number, end_part_number, end_supplier.
The instance is referenced by the following template parameter: end_pai.
The end item should only occur once in a data set.
Unique constraint: Unique parent item
Each instance of the entity (Product_as_individual) within the data set shall be uniquely identified by a combination of the following parameters on this template (reportable_item_structure) namely: parent_serial_number, parent_part_number, parent_supplier.
The instance is referenced by the following template parameter: parent_pai.
The parent item should only occur once in a data set.
Unique constraint: Unique reportable item
Each instance of the entity (Product_as_individual) within the data set shall be uniquely identified by a combination of the following parameters on this template (reportable_item_structure) namely: serial_number, part_number, supplier.
The instance is referenced by the following template parameter: pai.
The reportable item should only occur once in a data set.
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.
-- Instantiate the reportable item
/reportable_item(
    serial_number=@serial_number,
    part_number=@part_number,
    supplier=@supplier,
    NSN=@NSN)/

-- bind the entities instantiated by the reportable_item
-- to reference parameters
%^pai = $reportable_item.pai%
%^par = $reportable_item.par%
%^view = $reportable_item.view%

-- Instantiate the end item
/reportable_item(
    serial_number=@end_serial_number,
    part_number=@end_part_number,
    supplier=@end_supplier,
    NSN=@end_NSN)/

-- bind the entities instantiated by the reportable_item
-- to reference parameters
%^end_pai = $reportable_item.pai%
%^end_par = $reportable_item.par%
%^end_view = $reportable_item.view%
%^end_part_view = $reportable_item.part_view%

-- Instantiate the parent item
/reportable_item(
    serial_number=@parent_serial_number,
    part_number=@parent_part_number,
    supplier=@parent_supplier,
    NSN=@parent_NSN)/

-- bind the entities instantiated by the reportable_item
-- to reference parameters
%^parent_pai = $reportable_item.pai%
%^parent_par = $reportable_item.par%
%^parent_view = $reportable_item.view%
/representing_promissory_usage(
    top_level_part=^end_view,
    constituent_part=^view,
    quantity='1',
    location_indicator=@position,
    unit='Count',
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='false')/
%^promissory = $representing_promissory_usage.promissory_usage%
/representing_assembly_structure(
    parent=^parent_view,
    child=^view,
    location_indicator=@position,
    quantity='1',
    unit='Count',
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='false')/
%^nau = $representing_assembly_structure.nau%
/installation_position(
    end_item_number=@end_part_number,
    position=@position,
    reportable_item_view=^view,
    end_item_part_view=^end_view)/
%^realization = $installation_position.realization%
%^bkdn = $installation_position.bkdn%
%^bkdn_elem_def = $installation_position.bkdn_elem_def%
Characterizations
The following section details how the reportable_item_structure 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 following characterizations may apply:
Characterization Reportable item properties

NOTE   this characterization is optional.

A number of properties, such as life properties, can be assigned to the reportable item, its end and parent item. This is described in Aviation Maintenance DEX: Representing properties on a reportable item" and defined by the templates #7, #8, #9 MoDAvDEX.reportable_item_property.

The parameters used by the templates are shown in the following tables:

Template #7, #8, #9 (Figure 1): reportable_item_property
Description
Parameter name: Parameter value: Parameter description:
property_name   The class name corresponding to the property name.
property_value   The value of the property. The data type must also be indicated in this parameter, e.g. "ANY_NUMBER_VALUE(5)".
property_unit   The class name of the unit in which the value is expressed.
unit_ecl_id urn:plcs:rdl:LITS The identifier of the External_class_library storing the definition of the class referenced by the parameter @unit_class_name.
si_unit   Value should be set to true if the unit is a SI base unit defined by ISO, i.e. kilogram (kg) for Mass, second (s) for Time, metre (m) for Displacement, ampere (A) for Electrical current, kelvin (K) for Temperature, mole (mol) for Amount of substance, and candela (cd) for Luminous intensity. If this is not the case it should be set to false.
Note that the representation of true and false depends on exchange format. In Part 11 (a STEP file) true is represented by the string ".T.", and false by ".F.", while in Part 28 (XML) they are represented by text strings "true" and "false".
year   The year component of the date the property value was measured.
month   The month component of the date the property value was measured.
day   The day component of the date the property value was measured.
hour   The hour component of the date the property value was measured.
minute   The minute component of the date the property value was measured. This parameter is optional. If not given, it will remain unset.
second   The second component of the date the property value was measured. This parameter is optional. If not given, it will remain unset.
org_id   The name or identifier of the organization declaring the property.
value_type   meter_reading - the value measured on the meter; cumulative - the cumulative value taking into account the changing of meters; sortie - the value of sortie related data not use for calculating life. E.g fuel consumed.
described_element Template: #1,#3,#5 MoDAvDEX.reportable_item
ref. parameter: ^view
The Product_as_individual_view of the item to which a property is assigned

© UK MOD 2010 — All rights reserved