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 recommended documentation required, over a defined period of time, to support the Platform, system and equipment for which the associated Support Solution Definition was developed.

The recommended_documentation business object is used by those UK_Defence Data Exchange Specifications that require information about the recommended documentation required, over a defined period of time, to support the Platform, system and equipment for which the associated Support Solution Definition was developed

Figure 1 — Graphical Representation for Business Object Recommended Documentation

Recommended Documentation:

The definition of an Recommended Documentation object is: Data about the recommended documentation required, over a defined period of time, to support the Platform, system and equipment for which the associated Support Solution Definition was developed.

Attribute name	Attribute description	Attribute type	Optionality
Assumptions	This is a reference to the assumptions on which the documentation recommendations are based.	Relationship to Assumption	Optional (0:?)
Constraints	This is a reference to the constraints on which the documentation recommendations are based.	Relationship to Constraint	Optional (0:?)
Documentation	This is a reference to the documents that are recommended for the support of the Platform, system and equipment.	Relationship to Recommended Document	Mandatory (1:?)
ID	This is the identifier of the documentation recommendations.	Identifier	Mandatory
Identifier.id	This is the value of the id attribute of the Identifier applied to the documentation recommendations.	intrinsic	Mandatory
Identifier.type	This attribute is the type associated with the id of the Identifier given to the documentation recommendations.	Recommended_documentation_id_code	Mandatory
Identifier.source_organization	This attribute is the value representing the source organization that provides the id of the Identifier given to the documentation recommendations. This value is assumed to be a type of Organization_identification_code.	Organization_identification_code	Mandatory
Name	This is the name of the documentation recommendations	Identifier	Mandatory
Related support solution	This is the reference to the support solution for which the recommended documentation has been derived.	Relationship to Support Solution Definition	Mandatory
Time period	This is the time period for which the documentation recommendations are made.	Intrinsic	Mandatory
Version	This is the version of the documentation recommendations.	Intrinsic	Mandatory

Table 1 — Recommended Documentationattribute details

The following input parameters are defined for this template:

The following reference parameters are defined for this template:

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.

-- required resource
Required_resource_by_specification
%^doc_req_res_spec = Required_resource_by_specification%

-- assign a quantity to the recommended document and classify it
/assigning_resource_property(
    property_class_name='Estimated_time',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    described_element=^doc_req_res_spec)/
%^property_time_period = $assigning_resource_property.property%

-- assign a value and unit to the recommendation property
/resource_property_numeric(
    value=@time_period,
    unit=@time_period_unit,
    unit_ecl_id='urn:plcs:rdl:uk_defence',
    si_unit='false',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:uk_defence',
    property=^property_time_period)/

-- [optional 0:? assumptions]
/assigning_document(
    doc_ass_role='Related_assumption',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=@assumptions,
    is_assigned_to=^doc_req_res_spec)/

-- [optional 0:? constraints]
Requirement_assignment
Requirement_assignment.assigned_requirement -> @constraints
Requirement_assignment.assigned_to -> ^doc_req_res_spec

-- related support solution
/assigning_document(
    doc_ass_role='Related_support_solution_definition',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=@related_support_solution,
    is_assigned_to=^doc_req_res_spec)/

-- documentation 1:?
/representing_required_resource_relationship(
    req_res_rel_class_name='Related_recommended_document',
    req_res_rel_ecl_id='urn:plcs:rdl:uk_defence',
    relating_req_res=^doc_req_res_spec,
    related_req_res=@documentation)/

-- provide the role of the required_resource
/assigning_reference_data(
    items=^doc_req_res_spec,
    class_name='recommended',
    ecl_id='urn:plcs:rdl:uk_defence')/

-- ID (mandatory)
/identifier(
    ID=@id,
    source_organization=@source_organization,
    type='Recommended_documentation_id_code',
    items=^doc_req_res_spec)/

-- name
/identifier(
    ID=@name,
    source_organization=@source_organization,
    type='Recommended_documentation_name',
    items=^doc_req_res_spec)/

-- version
/assigning_descriptor(
    descr=@version,
    class_name='Recommended_documentation_version',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^doc_req_res_spec)/