Template:— recommended_documentation (rec_doct)
Context:— UK_Defence
Date: 2009/04/17 11:15:01
Revision: 1.6
Template: recommended_documentation

XML references to the Template

These can be cut and pasted into the XML as required.

recommended_documentation

Set up a hyperlink to the template definition.
<template_ref name="recommended_documentation" context="UK_Defence" />

Set up a table of the template parameters.
<template_table figure_id="?" instance="?" name="recommended_documentation" context="UK_Defence" >
  <param name="assumptions">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="constraints">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="documentation">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="source_organization">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="related_support_solution">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="time_period">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="time_period_unit">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="version">
    <param_value></param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="recommended_documentation">
  <param_in name="assumptions" value=""/>
  <param_in name="constraints" value=""/>
  <param_in name="documentation" value=""/>
  <param_in name="id" value=""/>
  <param_in name="source_organization" value=""/>
  <param_in name="name" value=""/>
  <param_in name="related_support_solution" value=""/>
  <param_in name="time_period" value=""/>
  <param_in name="time_period_unit" value=""/>
  <param_in name="version" value=""/>
</template_example>

recommended_documentation
/recommended_documentation(assumptions='', constraints='', documentation='', id='', source_organization='', name='', related_support_solution='', time_period='', time_period_unit='', version='')/

Path

-- 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)/

XML representation of path

<refpath
   template="recommended_documentation">
   <comment>
      required resource
   </comment>
   <instantiate
      entity="Required_resource_by_specification"
      context="UK_Defence">
      
   </instantiate>
   <bind
      parameter="doc_req_res_spec">
      <express_entity
         entity="Required_resource_by_specification"
         context="UK_Defence">
         
      </express_entity>
   </bind>
   <comment>
      assign a quantity to the recommended document and classify it
   </comment>
   <call_template
      name="assigning_resource_property"
      business_context="UK_Defence">
      <param_in
         name="property_class_name"
         value="'Estimated_time'">
         
      </param_in>
      <param_in
         name="property_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="described_element"
         value="^doc_req_res_spec">
         
      </param_in>
   </call_template>
   <bind
      parameter="property_time_period">
      <template_instance
         template="assigning_resource_property"
         parameter="property">
         
      </template_instance>
   </bind>
   <comment>
      assign a value and unit to the recommendation property
   </comment>
   <call_template
      name="resource_property_numeric"
      business_context="UK_Defence">
      <param_in
         name="value"
         value="@time_period">
         
      </param_in>
      <param_in
         name="unit"
         value="@time_period_unit">
         
      </param_in>
      <param_in
         name="unit_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="si_unit"
         value="'false'">
         
      </param_in>
      <param_in
         name="context"
         value="'Numerical_representation_context'">
         
      </param_in>
      <param_in
         name="context_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="property"
         value="^property_time_period">
         
      </param_in>
   </call_template>
   <comment>
      [optional 0:? assumptions]
   </comment>
   <call_template
      name="assigning_document"
      business_context="UK_Defence">
      <param_in
         name="doc_ass_role"
         value="'Related_assumption'">
         
      </param_in>
      <param_in
         name="doc_ar_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="assigned_document"
         value="@assumptions">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^doc_req_res_spec">
         
      </param_in>
   </call_template>
   <comment>
      [optional 0:? constraints]
   </comment>
   <instantiate
      entity="Requirement_assignment"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Requirement_assignment"
            attribute="assigned_requirement"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="constraints">
            
         </param_in_ref>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Requirement_assignment"
            attribute="assigned_to"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="doc_req_res_spec">
            
         </bound_parameter>
      </source>
   </assign>
   <comment>
      related support solution
   </comment>
   <call_template
      name="assigning_document"
      business_context="UK_Defence">
      <param_in
         name="doc_ass_role"
         value="'Related_support_solution_definition'">
         
      </param_in>
      <param_in
         name="doc_ar_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="assigned_document"
         value="@related_support_solution">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^doc_req_res_spec">
         
      </param_in>
   </call_template>
   <comment>
      documentation 1:?
   </comment>
   <call_template
      name="representing_required_resource_relationship"
      business_context="UK_Defence">
      <param_in
         name="req_res_rel_class_name"
         value="'Related_recommended_document'">
         
      </param_in>
      <param_in
         name="req_res_rel_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="relating_req_res"
         value="^doc_req_res_spec">
         
      </param_in>
      <param_in
         name="related_req_res"
         value="@documentation">
         
      </param_in>
   </call_template>
   <comment>
      provide the role of the required_resource
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="UK_Defence">
      <param_in
         name="items"
         value="^doc_req_res_spec">
         
      </param_in>
      <param_in
         name="class_name"
         value="'recommended'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
   </call_template>
   <comment>
      ID (mandatory)
   </comment>
   <call_template
      name="identifier"
      business_context="UK_Defence">
      <param_in
         name="ID"
         value="@id">
         
      </param_in>
      <param_in
         name="source_organization"
         value="@source_organization">
         
      </param_in>
      <param_in
         name="type"
         value="'Recommended_documentation_id_code'">
         
      </param_in>
      <param_in
         name="items"
         value="^doc_req_res_spec">
         
      </param_in>
   </call_template>
   <comment>
      name
   </comment>
   <call_template
      name="identifier"
      business_context="UK_Defence">
      <param_in
         name="ID"
         value="@name">
         
      </param_in>
      <param_in
         name="source_organization"
         value="@source_organization">
         
      </param_in>
      <param_in
         name="type"
         value="'Recommended_documentation_name'">
         
      </param_in>
      <param_in
         name="items"
         value="^doc_req_res_spec">
         
      </param_in>
   </call_template>
   <comment>
      version
   </comment>
   <call_template
      name="assigning_descriptor"
      business_context="UK_Defence">
      <param_in
         name="descr"
         value="@version">
         
      </param_in>
      <param_in
         name="class_name"
         value="'Recommended_documentation_version'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^doc_req_res_spec">
         
      </param_in>
   </call_template>
</refpath>

© UK MOD 2010 — All rights reserved