Template:— plan (pln)
Context:— UK_Defence		 Date: 2009/04/17 10:48:48
Revision: 1.3
CoverContentsDescriptionBus. perspectiveBus. obj.Model diags.Input params.Ref. params.Instantiation pathInstance diags.CharacterizationsIssuesin situ
Template: plan

XML references to the Template

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

plan

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

Set up a table of the template parameters.
<template_table figure_id="?" instance="?" name="plan" context="UK_Defence" >
  <param name="author_last_name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="author_first_name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="author_middle_name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="author_prefix_title">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="author_suffix_title">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="plan_type">
    <param_value>Scheme_identification_code</param_value>
    <description></description>
  </param>
  <param name="description">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="plan_name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="related_tasks">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="purpose">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="context">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="plan_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="releasing_authority">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="subject">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="effective_from_date_year">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="effective_from_date_month">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="effective_from_date_day">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="effective_to_date_year">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="effective_to_date_month">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="effective_to_date_day">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="version">
    <param_value>Version_identification_code</param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="plan">
  <param_in name="author_last_name" value=""/>
  <param_in name="author_first_name" value=""/>
  <param_in name="author_middle_name" value=""/>
  <param_in name="author_prefix_title" value=""/>
  <param_in name="author_suffix_title" value=""/>
  <param_in name="plan_type" value="Scheme_identification_code"/>
  <param_in name="description" value=""/>
  <param_in name="plan_name" value=""/>
  <param_in name="related_tasks" value=""/>
  <param_in name="purpose" value=""/>
  <param_in name="context" value=""/>
  <param_in name="plan_id" value=""/>
  <param_in name="releasing_authority" value=""/>
  <param_in name="subject" value=""/>
  <param_in name="effective_from_date_year" value=""/>
  <param_in name="effective_from_date_month" value=""/>
  <param_in name="effective_from_date_day" value=""/>
  <param_in name="effective_to_date_year" value=""/>
  <param_in name="effective_to_date_month" value=""/>
  <param_in name="effective_to_date_day" value=""/>
  <param_in name="version" value="Version_identification_code"/>
</template_example>

plan
/plan(author_last_name='', author_first_name='', author_middle_name='', author_prefix_title='', author_suffix_title='', plan_type='Scheme_identification_code', description='', plan_name='', related_tasks='', purpose='', context='', plan_id='', releasing_authority='', subject='', effective_from_date_year='', effective_from_date_month='', effective_from_date_day='', effective_to_date_year='', effective_to_date_month='', effective_to_date_day='', version='Version_identification_code')/

Path

/representing_scheme(
    scheme_id=@plan_id,
    scheme_id_class_name=@plan_type,
    scheme_id_ecl_id='urn:plcs:rdl:uk_defence',
    scheme_org_id=@releasing_authority,
    scheme_org_id_class_name='Organization_identification_code',
    scheme_org_id_ecl_id='urn:plcs:rdl:uk_defence',
    scheme_vn_id=@version,
    scheme_vn_id_class_name='Version_identification_code',
    scheme_vn_id_ecl_id='urn:plcs:rdl:std',
    scheme_vn_org_id=@releasing_authority,
    scheme_vn_org_id_class_name='Organization_identification_code',
    scheme_vn_org_id_ecl_id='urn:plcs:rdl:uk_defence')/

-- assign ref parameters
%^scheme = $representing_scheme.scheme%
%^scheme_vn = $representing_scheme.scheme_vn%

-- author, releasing authority
/assigned_person(
    family_name=@author_last_name,
    first_name=@author_first_name,
    ID='Author',
    source_organization=@releasing_authority,
    type='Organization_identification_code',
    middle_name=@author_middle_name,
    prefix_title=@author_prefix_title,
    suffix_title=@author_suffix_title,
    items=^scheme_vn)/

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

-- subject
/assigning_descriptor(
    descr=@subject,
    class_name='Subject',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^scheme)/

-- purpose
/assigning_descriptor(
    descr=@purpose,
    class_name='Purpose',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^scheme)/

-- context
/assigning_descriptor(
    descr=@context,
    class_name='Context_description',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^scheme)/

-- effective from date
/assigning_dated_effectivity(
    items=^scheme_vn,
    start_year=@effective_from_date_year,
    start_month=@effective_from_date_month,
    start_day=@effective_from_date_day,
    start_hour=0,
    start_minute=0,
    start_second=0,
    start_sense=.EXACT.,
    start_hour_offset=0,
    start_minute_offset=0,
    end_year=@effective_to_date_year,
    end_month=@effective_to_date_month,
    end_day=@effective_to_date_day,
    end_hour=0,
    end_minute=0,
    end_second=0,
    end_sense=.EXACT.,
    end_hour_offset=0,
    end_minute_offset=0,
    role_class_name='Actual_effectivity',
    role_ecl_id='urn:plcs:rdl:std')/

-- plan name
/identifier(
    ID=@plan_name,
    source_organization=@releasing_authority,
    type='Plan_name',
    items=^scheme)/

-- Comprises of
Scheme_version_assignment
Scheme_version_assignment.assigned_activity_method -> ^scheme_vn
Scheme_version_assignment.items -> @related_tasks

XML representation of path

<refpath
   template="plan">
   <call_template
      name="representing_scheme"
      business_context="UK_Defence">
      <param_in
         name="scheme_id"
         value="@plan_id">
         
      </param_in>
      <param_in
         name="scheme_id_class_name"
         value="@plan_type">
         
      </param_in>
      <param_in
         name="scheme_id_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="scheme_org_id"
         value="@releasing_authority">
         
      </param_in>
      <param_in
         name="scheme_org_id_class_name"
         value="'Organization_identification_code'">
         
      </param_in>
      <param_in
         name="scheme_org_id_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="scheme_vn_id"
         value="@version">
         
      </param_in>
      <param_in
         name="scheme_vn_id_class_name"
         value="'Version_identification_code'">
         
      </param_in>
      <param_in
         name="scheme_vn_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="scheme_vn_org_id"
         value="@releasing_authority">
         
      </param_in>
      <param_in
         name="scheme_vn_org_id_class_name"
         value="'Organization_identification_code'">
         
      </param_in>
      <param_in
         name="scheme_vn_org_id_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
   </call_template>
   <comment>
      assign ref parameters
   </comment>
   <bind
      parameter="scheme">
      <template_instance
         template="representing_scheme"
         parameter="scheme">
         
      </template_instance>
   </bind>
   <bind
      parameter="scheme_vn">
      <template_instance
         template="representing_scheme"
         parameter="scheme_vn">
         
      </template_instance>
   </bind>
   <comment>
      author, releasing authority
   </comment>
   <call_template
      name="assigned_person"
      business_context="UK_Defence">
      <param_in
         name="family_name"
         value="@author_last_name">
         
      </param_in>
      <param_in
         name="first_name"
         value="@author_first_name">
         
      </param_in>
      <param_in
         name="ID"
         value="'Author'">
         
      </param_in>
      <param_in
         name="source_organization"
         value="@releasing_authority">
         
      </param_in>
      <param_in
         name="type"
         value="'Organization_identification_code'">
         
      </param_in>
      <param_in
         name="middle_name"
         value="@author_middle_name">
         
      </param_in>
      <param_in
         name="prefix_title"
         value="@author_prefix_title">
         
      </param_in>
      <param_in
         name="suffix_title"
         value="@author_suffix_title">
         
      </param_in>
      <param_in
         name="items"
         value="^scheme_vn">
         
      </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="^scheme">
         
      </param_in>
   </call_template>
   <comment>
      subject
   </comment>
   <call_template
      name="assigning_descriptor"
      business_context="UK_Defence">
      <param_in
         name="descr"
         value="@subject">
         
      </param_in>
      <param_in
         name="class_name"
         value="'Subject'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^scheme">
         
      </param_in>
   </call_template>
   <comment>
      purpose
   </comment>
   <call_template
      name="assigning_descriptor"
      business_context="UK_Defence">
      <param_in
         name="descr"
         value="@purpose">
         
      </param_in>
      <param_in
         name="class_name"
         value="'Purpose'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^scheme">
         
      </param_in>
   </call_template>
   <comment>
      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_description'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^scheme">
         
      </param_in>
   </call_template>
   <comment>
      effective from date
   </comment>
   <call_template
      name="assigning_dated_effectivity"
      business_context="UK_Defence">
      <param_in
         name="items"
         value="^scheme_vn">
         
      </param_in>
      <param_in
         name="start_year"
         value="@effective_from_date_year">
         
      </param_in>
      <param_in
         name="start_month"
         value="@effective_from_date_month">
         
      </param_in>
      <param_in
         name="start_day"
         value="@effective_from_date_day">
         
      </param_in>
      <param_in
         name="start_hour"
         value="0">
         
      </param_in>
      <param_in
         name="start_minute"
         value="0">
         
      </param_in>
      <param_in
         name="start_second"
         value="0">
         
      </param_in>
      <param_in
         name="start_sense"
         value=".EXACT.">
         
      </param_in>
      <param_in
         name="start_hour_offset"
         value="0">
         
      </param_in>
      <param_in
         name="start_minute_offset"
         value="0">
         
      </param_in>
      <param_in
         name="end_year"
         value="@effective_to_date_year">
         
      </param_in>
      <param_in
         name="end_month"
         value="@effective_to_date_month">
         
      </param_in>
      <param_in
         name="end_day"
         value="@effective_to_date_day">
         
      </param_in>
      <param_in
         name="end_hour"
         value="0">
         
      </param_in>
      <param_in
         name="end_minute"
         value="0">
         
      </param_in>
      <param_in
         name="end_second"
         value="0">
         
      </param_in>
      <param_in
         name="end_sense"
         value=".EXACT.">
         
      </param_in>
      <param_in
         name="end_hour_offset"
         value="0">
         
      </param_in>
      <param_in
         name="end_minute_offset"
         value="0">
         
      </param_in>
      <param_in
         name="role_class_name"
         value="'Actual_effectivity'">
         
      </param_in>
      <param_in
         name="role_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
   </call_template>
   <comment>
      plan name
   </comment>
   <call_template
      name="identifier"
      business_context="UK_Defence">
      <param_in
         name="ID"
         value="@plan_name">
         
      </param_in>
      <param_in
         name="source_organization"
         value="@releasing_authority">
         
      </param_in>
      <param_in
         name="type"
         value="'Plan_name'">
         
      </param_in>
      <param_in
         name="items"
         value="^scheme">
         
      </param_in>
   </call_template>
   <comment>
      Comprises of
   </comment>
   <instantiate
      entity="Scheme_version_assignment"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Scheme_version_assignment"
            attribute="assigned_activity_method"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="scheme_vn">
            
         </bound_parameter>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Scheme_version_assignment"
            attribute="items"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="related_tasks">
            
         </param_in_ref>
      </source>
   </assign>
</refpath>

© UK MOD 2010 — All rights reserved