Template:— reportable_item (rep_itm)
Context:— MoDAvDEX		 Date: 2008/01/28 11:50:29
Revision: 1.15
CoverContentsDescriptionModel diags.Input params.Ref. params.Instantiation pathCharacterizationsIssuesin situ

This section specifies the template reportable_item.

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 LITS asset as a reportable item, using Product_as_realized.

It enables the identification of the physical product and its related Part, and provides the mechanism to assign reference data, dates, properties, documents, etc. to the physical product.

For further information about the representation of a reportable item, see Aviation Maintenance DEX: Reportable Item".



Figure 1 —  

Figure 1 —  

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


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

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

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

Figure 3 —  The graphical representation of the eportable_item template

Input parameters
The following input parameters are defined for this template:
serial_number (Type='STRING')
Current Serial Number of the reportable item.
part_number (Type='STRING')
The Current Part Number of the reportable item indicating the design of this product individual.
supplier (Type='STRING')
The supplier of the reportable item.
NSN (Type='STRING', Optional)
Current NSN or code number of the reportable item.
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.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.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.view%
where target is the parameter to which the Product_as_individual_view is bound.
Reportable item view
par_id_assgn(Type='ENTITY (Identification_assignment)')
Allow the Identification_assignment entity instantiated in this path to be referenced when this template is used.
Note: The Identification_assignment entity can be referenced in a template path by:
%^target = $reportable_item.par_id_assgn%
where target is the parameter to which the Identification_assignment is bound.
The identification of the product_as_realized
par_rel(Type='ENTITY (Product_design_version_to_individual)')
Allow the Product_design_version_to_individual entity instantiated in this path to be referenced when this template is used.
Note: The Product_design_version_to_individual entity can be referenced in a template path by:
%^target = $reportable_item.par_rel%
where target is the parameter to which the Product_design_version_to_individual is bound.
The relationship between the Product_as_realized and the Part_version.
part(Type='ENTITY (Part)')
Allow the Part entity instantiated in this path to be referenced when this template is used.
Note: The Part entity can be referenced in a template path by:
%^target = $reportable_item.part%
where target is the parameter to which the Part is bound.
Reportable item part
part_version(Type='ENTITY (Part_version)')
Allow the Part_version entity instantiated in this path to be referenced when this template is used.
Note: The Part_version entity can be referenced in a template path by:
%^target = $reportable_item.part_version%
where target is the parameter to which the Part_version is bound.
Reportable item part version
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.part_view%
where target is the parameter to which the Part_view_definition is bound.
Reportable item part version
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Unique part
Each instance of the entity (Part) within the data set shall be uniquely identified by a combination of the following parameters on this template (reportable_item) namely: part_number, supplier.
The instance is referenced by the following template parameter: part.
The part 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) 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 reference part
-- Note it is assumed that the part is not versioned
/representing_part(
    part_id=@part_number,
    part_id_class_name='Part_identification_code',
    part_id_ecl_id='urn:plcs:rdl:std',
    part_org_id=@supplier,
    part_org_id_class_name='NCAGE_code',
    part_org_id_ecl_id='urn:plcs:rdl:std',
    part_vn_id='/NULL',
    part_vn_id_class_name='Version_identification_code',
    part_vn_id_ecl_id='urn:plcs:rdl:std',
    part_vn_org_id=@supplier,
    part_vn_org_id_class_name='Organization_name',
    part_vn_org_id_ecl_id='urn:plcs:rdl:std',
    domain='Product_life_cycle_support',
    domain_ecl_id='urn:plcs:rdl:std',
    life_cycle_stage='Utilization_stage',
    life_cycle_stage_ecl_id='urn:plcs:rdl:std')/
%^part = $representing_part.part%
%^part_version = $representing_part.version%
%^part_view = $representing_part.view%

-- instantiate representing_product_as_realized
-- Note - it assumed that the item is not versioned
/representing_product_as_realized(
    id=@serial_number,
    id_class_name='Serial_identification_code',
    id_ecl_id='urn:plcs:rdl:std',
    id_owner=@supplier,
    id_owner_class_name='NCAGE_code',
    id_owner_ecl_id='urn:plcs:rdl:std',
    vn_id='/NULL',
    vn_id_class_name='Product_as_individual_identification_code',
    vn_id_ecl_id='urn:plcs:rdl:std',
    vn_id_owner=@supplier,
    vn_id_owner_class_name= 'Organization_name',
    vn_id_owner_ecl_id='urn:plcs:rdl:std',
    life_cycle_stage='Utilization_stage',
    life_cycle_stage_ecl_id='urn:plcs:rdl:std',
    domain='Product_life_cycle_support',
    domain_ecl_id='urn:plcs:rdl:std',
    product_design_version=^part)/
%^par = $representing_product_as_realized.par%
%^pai = $representing_product_as_realized.pai%
%^view = $representing_product_as_realized.view%
%^par_rel = $representing_product_as_realized.par_rel%
%^par_id_assgn = $representing_product_as_realized.par_id_assgn%

-- instantiate representing_resource_item_realization for the NSN
/representing_resource_item_realization(
    res_item_id=@NSN,
    res_item_id_class='NSN_code',
    res_item_id_ecl_id='urn:plcs:rdl:std',
    res_item_id_org_id='LITS',
    res_item_id_org_id_class='Organization_name',
    res_item_id_org_id_ecl_id='urn:plcs:rdl:std',
    res_item_items=^part)/
Characterizations
The following section details how the reportable_item 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 Description of individual part

NOTE   this characterization is optional.

The reportable item can have some descriptive text assigned to it using the template #4 assigning_descriptor. The template parameters are as shown in Table .

Template #4 (Figure 2): assigning_descriptor
Hide template parametersHide all template parametersShow all template parameters
Description
Parameter name: Parameter value: Parameter description:
descr ?Descriptive text? The description of the reportable item
class_name Description The name of the class (External_class) being used to determine type of descriptor.
ecl_id "urn:plcs:rdl:std" The id of the External_class_library that stores the class.
is_assigned_to Template: #1 representing_product_as_realized
ref. parameter: ^par 		The Product_as_realized instantiated by the template representing_product_as_realized
Characterization Description of a part

NOTE   this characterization is optional.

The reportable item can have some descriptive text assigned to it using the template #4 assigning_descriptor. The template parameters are as shown in Table .

Template #4 (Figure 2): assigning_descriptor
Hide template parametersHide all template parametersShow all template parameters
Description
Parameter name: Parameter value: Parameter description:
descr ?Descriptive text? The description of the part
class_name Description The name of the class (External_class) being used to determine type of descriptor.
ecl_id "urn:plcs:rdl:std" The id of the External_class_library that stores the class.
is_assigned_to Template: #2 referencing_part
ref. parameter: ^part 		The Part instantiated by the template referencing_part

© UK MOD 2010 — All rights reserved