Template:— budget (bdgt)
Context:— UK_Defence
Date: 2010/03/17 16:34:49
Revision: 1.4
Template: budget

XML references to the Template

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

budget

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

Set up a table of the template parameters.
<template_table figure_id="?" instance="?" name="budget" context="UK_Defence" >
  <param name="administered_by">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="allocated_by">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="allocated_to">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="amount_value">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="amount_unit">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="category">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="holder">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="start_date">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="end_date">
    <param_value></param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="budget">
  <param_in name="administered_by" value=""/>
  <param_in name="allocated_by" value=""/>
  <param_in name="allocated_to" value=""/>
  <param_in name="amount_value" value=""/>
  <param_in name="amount_unit" value=""/>
  <param_in name="category" value=""/>
  <param_in name="holder" value=""/>
  <param_in name="id" value=""/>
  <param_in name="name" value=""/>
  <param_in name="start_date" value=""/>
  <param_in name="end_date" value=""/>
</template_example>

budget
/budget(administered_by='', allocated_by='', allocated_to='', amount_value='', amount_unit='', category='', holder='', id='', name='', start_date='', end_date='')/

Path

-- Instantiate a document to establish the basic budget object Id
/document(
    author=@administered_by,
    category=@category,
    description='/IGNORE',
    id=@id,
    name=@name,
    releasing_authority=@allocated_by,
    security_classification='Security_classification_code',
    valid_from_date=@start_date,
    valid_to_date=@end_date,
    version='/IGNORE')/
%^budget = $document.document_definition%
/assigning_document(
    assigned_document=^budget,
    doc_ass_role='Budget_allocated_to',
    doc_ar_ecl_id='urn:plcs:rdl:UK_Defence',
    is_assigned_to=@allocated_to)/
/assigning_document(
    assigned_document=^budget,
    doc_ass_role='Budget_holder',
    doc_ar_ecl_id='urn:plcs:rdl:UK_Defence',
    is_assigned_to=@holder)/
/assigning_product_property(
    property_class_name='Budget_amount',
    property_ecl_id='urn:plcs:rdl:UK_Defence',
    described_element=^budget)/

-- Assign reference parameter
%^property = $assigning_product_property.property%
/product_property_numeric(
    value=@amount_value,
    unit=@amount_unit,
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='.F.',
    context='Numerical_representation_context',
    context_ecl_id='urn:plcs:rdl:std',
    property=^property)/

XML representation of path

<refpath
   template="budget">
   <comment>
      Instantiate a document to establish the basic budget object Id
   </comment>
   <call_template
      name="document"
      business_context="UK_Defence">
      <param_in
         name="author"
         value="@administered_by">
         
      </param_in>
      <param_in
         name="category"
         value="@category">
         
      </param_in>
      <param_in
         name="description"
         value="'/IGNORE'">
         
      </param_in>
      <param_in
         name="id"
         value="@id">
         
      </param_in>
      <param_in
         name="name"
         value="@name">
         
      </param_in>
      <param_in
         name="releasing_authority"
         value="@allocated_by">
         
      </param_in>
      <param_in
         name="security_classification"
         value="'Security_classification_code'">
         
      </param_in>
      <param_in
         name="valid_from_date"
         value="@start_date">
         
      </param_in>
      <param_in
         name="valid_to_date"
         value="@end_date">
         
      </param_in>
      <param_in
         name="version"
         value="'/IGNORE'">
         
      </param_in>
   </call_template>
   <bind
      parameter="budget">
      <template_instance
         template="document"
         parameter="document_definition">
         
      </template_instance>
   </bind>
   <call_template
      name="assigning_document"
      business_context="UK_Defence">
      <param_in
         name="assigned_document"
         value="^budget">
         
      </param_in>
      <param_in
         name="doc_ass_role"
         value="'Budget_allocated_to'">
         
      </param_in>
      <param_in
         name="doc_ar_ecl_id"
         value="'urn:plcs:rdl:UK_Defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="@allocated_to">
         
      </param_in>
   </call_template>
   <call_template
      name="assigning_document"
      business_context="UK_Defence">
      <param_in
         name="assigned_document"
         value="^budget">
         
      </param_in>
      <param_in
         name="doc_ass_role"
         value="'Budget_holder'">
         
      </param_in>
      <param_in
         name="doc_ar_ecl_id"
         value="'urn:plcs:rdl:UK_Defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="@holder">
         
      </param_in>
   </call_template>
   <call_template
      name="assigning_product_property"
      business_context="UK_Defence">
      <param_in
         name="property_class_name"
         value="'Budget_amount'">
         
      </param_in>
      <param_in
         name="property_ecl_id"
         value="'urn:plcs:rdl:UK_Defence'">
         
      </param_in>
      <param_in
         name="described_element"
         value="^budget">
         
      </param_in>
   </call_template>
   <comment>
      Assign reference parameter
   </comment>
   <bind
      parameter="property">
      <template_instance
         template="assigning_product_property"
         parameter="property">
         
      </template_instance>
   </bind>
   <call_template
      name="product_property_numeric"
      business_context="UK_Defence">
      <param_in
         name="value"
         value="@amount_value">
         
      </param_in>
      <param_in
         name="unit"
         value="@amount_unit">
         
      </param_in>
      <param_in
         name="unit_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="si_unit"
         value="'.F.'">
         
      </param_in>
      <param_in
         name="context"
         value="'Numerical_representation_context'">
         
      </param_in>
      <param_in
         name="context_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="property"
         value="^property">
         
      </param_in>
   </call_template>
</refpath>

© UK MOD 2010 — All rights reserved