Template:— requirement (reqt)
Context:— UK_Defence
Date: 2009/11/03 10:22:29
Revision: 1.6
Template: requirement

XML references to the Template

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

requirement

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

Set up a table of the template parameters.
<template_table figure_id="?" instance="?" name="requirement" context="UK_Defence" >
  <param name="acceptance_criteria">
    <param_value>Description of assessment criteria</param_value>
    <description></description>
  </param>
  <param name="category">
    <param_value>requirment_category</param_value>
    <description></description>
  </param>
  <param name="context">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="date_required">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="reqt_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="source_organization_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="description">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="priority">
    <param_value>Medium</param_value>
    <description></description>
  </param>
  <param name="version">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="owner">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="required_value">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="required_value_units">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="required_value_si_unit">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="valid_from">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="valid_to">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="version_date">
    <param_value></param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="requirement">
  <param_in name="acceptance_criteria" value="Description of assessment criteria"/>
  <param_in name="category" value="requirment_category"/>
  <param_in name="context" value=""/>
  <param_in name="date_required" value=""/>
  <param_in name="reqt_id" value=""/>
  <param_in name="source_organization_id" value=""/>
  <param_in name="name" value=""/>
  <param_in name="description" value=""/>
  <param_in name="priority" value="Medium"/>
  <param_in name="version" value=""/>
  <param_in name="owner" value=""/>
  <param_in name="required_value" value=""/>
  <param_in name="required_value_units" value=""/>
  <param_in name="required_value_si_unit" value=""/>
  <param_in name="valid_from" value=""/>
  <param_in name="valid_to" value=""/>
  <param_in name="version_date" value=""/>
</template_example>

requirement
/requirement(acceptance_criteria='Description of assessment criteria', category='requirment_category', context='', date_required='', reqt_id='', source_organization_id='', name='', description='', priority='Medium', version='', owner='', required_value='', required_value_units='', required_value_si_unit='', valid_from='', valid_to='', version_date='')/

Path

/representing_requirements(
    req_id=@reqt_id,
    req_id_class_name='Requirement_identification_code',
    req_id_ecl_id='urn:plcs:rdl:std',
    req_org_id=@source_organization_id,
    req_org_id_class_name='Organization_identification_code',
    req_org_id_ecl_id='urn:plcs:rdl:std',
    req_ver_id=@version,
    req_ver_id_class_name='Version_identification_code',
    req_ver_id_ecl_id='urn:plcs:rdl:std',
    req_ver_org_id=@source_organization_id,
    req_ver_org_id_class_name='Organization_identification_code',
    req_ver_org_id_ecl_id='urn:plcs:rdl:std',
    rvd_id='/Null',
    rvd_id_class_name='Requirement_view_definition_identification_code',
    rvd_id_ecl_id='urn:plcs:rdl:std',
    rvd_org_id=@source_organization_id,
    rvd_org_id_class_name='Organization_identification_code',
    rvd_org_id_ecl_id='urn:plcs:rdl:std',
    vdc_lcs_class_name='Support_stage',
    vdc_lcs_ecl_id='urn:plcs:rdl:std',
    vdc_ad_class_name='Product_life_cycle_support',
    vdc_ad_ecl_id='urn:plcs:rdl:std')/

-- re-direct the output from the call..
%^reqt = $representing_requirements.req%
%^reqt_version = $representing_requirements.req_ver%
%^reqt_design_view = $representing_requirements.rvd%
%^reqt_design_contxt = $representing_requirements.vdc%

-- Acceptance criteria
/assigning_descriptor(
    descr=@acceptance_criteria,
    class_name='Acceptance_criteria',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^reqt)/

-- [Optional Category]
/assigning_reference_data(
    items=^reqt,
    class_name=@category,
    ecl_id='urn:plcs:rdl:uk_defence')/

-- [Optional Context]
/assigning_descriptor(
    descr=@context,
    class_name='Context',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^reqt_design_contxt)/

-- name
/identifier(
    items=^reqt,
    ID=@name,
    type='Name',
    source_organization=@source_organization_id)/

-- description
/assigning_descriptor(
    descr=@description,
    class_name='Description',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^reqt)/

-- owner
Organization_or_person_in_organization_assignment
Organization_or_person_in_organization_assignment.items -> ^reqt_version
Organization_or_person_in_organization_assignment.assigned_entity -> @owner

-- priority
/assigning_reference_data(
    items=^reqt,
    class_name=@priority,
    ecl_id='urn:plcs:rdl:uk_defence')/

-- [Optional date_required]
Date_or_date_time_assignment
Date_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items -> ^reqt_version
Date_or_date_time_assignment.assigned_date -> @date_required

-- [Optional required_value, required_value_unit]
/property(
    a_property_of=^reqt_design_view,
    ID='Required value',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    value=@required_value,
    unit=@required_value_units,
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit=@required_value_si_unit,
    disposition='Required')/

-- [Optional valid_from]
Date_or_date_time_assignment
Date_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items -> ^reqt_version
Date_or_date_time_assignment.assigned_date -> @valid_from

-- [Optional valid_to]
Date_or_date_time_assignment
Date_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items -> ^reqt_version
Date_or_date_time_assignment.assigned_date -> @valid_to

-- version_date
Date_or_date_time_assignment
Date_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items -> ^reqt_version
Date_or_date_time_assignment.assigned_date -> @version_date
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Date_or_date_time_assignment.role '/IGNORE'
Date_or_date_time_assignment.role '/IGNORE'
Date_or_date_time_assignment.role '/IGNORE'
Date_or_date_time_assignment.role '/IGNORE'

XML representation of path

<refpath
   template="requirement">
   <call_template
      name="representing_requirements"
      business_context="UK_Defence">
      <param_in
         name="req_id"
         value="@reqt_id">
         
      </param_in>
      <param_in
         name="req_id_class_name"
         value="'Requirement_identification_code'">
         
      </param_in>
      <param_in
         name="req_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="req_org_id"
         value="@source_organization_id">
         
      </param_in>
      <param_in
         name="req_org_id_class_name"
         value="'Organization_identification_code'">
         
      </param_in>
      <param_in
         name="req_org_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="req_ver_id"
         value="@version">
         
      </param_in>
      <param_in
         name="req_ver_id_class_name"
         value="'Version_identification_code'">
         
      </param_in>
      <param_in
         name="req_ver_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="req_ver_org_id"
         value="@source_organization_id">
         
      </param_in>
      <param_in
         name="req_ver_org_id_class_name"
         value="'Organization_identification_code'">
         
      </param_in>
      <param_in
         name="req_ver_org_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="rvd_id"
         value="'/Null'">
         
      </param_in>
      <param_in
         name="rvd_id_class_name"
         value="'Requirement_view_definition_identification_code'">
         
      </param_in>
      <param_in
         name="rvd_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="rvd_org_id"
         value="@source_organization_id">
         
      </param_in>
      <param_in
         name="rvd_org_id_class_name"
         value="'Organization_identification_code'">
         
      </param_in>
      <param_in
         name="rvd_org_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="vdc_lcs_class_name"
         value="'Support_stage'">
         
      </param_in>
      <param_in
         name="vdc_lcs_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="vdc_ad_class_name"
         value="'Product_life_cycle_support'">
         
      </param_in>
      <param_in
         name="vdc_ad_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
   </call_template>
   <comment>
      re-direct the output from the call..
   </comment>
   <bind
      parameter="reqt">
      <template_instance
         template="representing_requirements"
         parameter="req">
         
      </template_instance>
   </bind>
   <bind
      parameter="reqt_version">
      <template_instance
         template="representing_requirements"
         parameter="req_ver">
         
      </template_instance>
   </bind>
   <bind
      parameter="reqt_design_view">
      <template_instance
         template="representing_requirements"
         parameter="rvd">
         
      </template_instance>
   </bind>
   <bind
      parameter="reqt_design_contxt">
      <template_instance
         template="representing_requirements"
         parameter="vdc">
         
      </template_instance>
   </bind>
   <comment>
      Acceptance criteria
   </comment>
   <call_template
      name="assigning_descriptor"
      business_context="UK_Defence">
      <param_in
         name="descr"
         value="@acceptance_criteria">
         
      </param_in>
      <param_in
         name="class_name"
         value="'Acceptance_criteria'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^reqt">
         
      </param_in>
   </call_template>
   <comment>
      [Optional Category]
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="UK_Defence">
      <param_in
         name="items"
         value="^reqt">
         
      </param_in>
      <param_in
         name="class_name"
         value="@category">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
   </call_template>
   <comment>
      [Optional Context]
   </comment>
   <call_template
      name="assigning_descriptor"
      business_context="UK_Defence">
      <param_in
         name="descr"
         value="@context">
         
      </param_in>
      <param_in
         name="class_name"
         value="'Context'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^reqt_design_contxt">
         
      </param_in>
   </call_template>
   <comment>
      name
   </comment>
   <call_template
      name="identifier"
      business_context="UK_Defence">
      <param_in
         name="items"
         value="^reqt">
         
      </param_in>
      <param_in
         name="ID"
         value="@name">
         
      </param_in>
      <param_in
         name="type"
         value="'Name'">
         
      </param_in>
      <param_in
         name="source_organization"
         value="@source_organization_id">
         
      </param_in>
   </call_template>
   <comment>
      description
   </comment>
   <call_template
      name="assigning_descriptor"
      business_context="UK_Defence">
      <param_in
         name="descr"
         value="@description">
         
      </param_in>
      <param_in
         name="class_name"
         value="'Description'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^reqt">
         
      </param_in>
   </call_template>
   <comment>
      owner
   </comment>
   <instantiate
      entity="Organization_or_person_in_organization_assignment"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Organization_or_person_in_organization_assignment"
            attribute="items"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="reqt_version">
            
         </bound_parameter>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Organization_or_person_in_organization_assignment"
            attribute="assigned_entity"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="owner">
            
         </param_in_ref>
      </source>
   </assign>
   <comment>
      priority
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="UK_Defence">
      <param_in
         name="items"
         value="^reqt">
         
      </param_in>
      <param_in
         name="class_name"
         value="@priority">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
   </call_template>
   <comment>
      [Optional date_required]
   </comment>
   <instantiate
      entity="Date_or_date_time_assignment"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="equals"
      context="UK_Defence">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="role"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <string
            value="'/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="items"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="reqt_version">
            
         </bound_parameter>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="assigned_date"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="date_required">
            
         </param_in_ref>
      </source>
   </assign>
   <comment>
      [Optional required_value, required_value_unit]
   </comment>
   <call_template
      name="property"
      business_context="UK_Defence">
      <param_in
         name="a_property_of"
         value="^reqt_design_view">
         
      </param_in>
      <param_in
         name="ID"
         value="'Required value'">
         
      </param_in>
      <param_in
         name="property_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="value"
         value="@required_value">
         
      </param_in>
      <param_in
         name="unit"
         value="@required_value_units">
         
      </param_in>
      <param_in
         name="unit_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="si_unit"
         value="@required_value_si_unit">
         
      </param_in>
      <param_in
         name="disposition"
         value="'Required'">
         
      </param_in>
   </call_template>
   <comment>
      [Optional valid_from]
   </comment>
   <instantiate
      entity="Date_or_date_time_assignment"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="equals"
      context="UK_Defence">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="role"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <string
            value="'/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="items"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="reqt_version">
            
         </bound_parameter>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="assigned_date"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="valid_from">
            
         </param_in_ref>
      </source>
   </assign>
   <comment>
      [Optional valid_to]
   </comment>
   <instantiate
      entity="Date_or_date_time_assignment"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="equals"
      context="UK_Defence">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="role"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <string
            value="'/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="items"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="reqt_version">
            
         </bound_parameter>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="assigned_date"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="valid_to">
            
         </param_in_ref>
      </source>
   </assign>
   <comment>
      version_date
   </comment>
   <instantiate
      entity="Date_or_date_time_assignment"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="equals"
      context="UK_Defence">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="role"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <string
            value="'/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="items"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="reqt_version">
            
         </bound_parameter>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="assigned_date"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="version_date">
            
         </param_in_ref>
      </source>
   </assign>
</refpath>

© UK MOD 2010 — All rights reserved