Template:— document (doc)
Context:— UK_Defence
Date: 2009/04/17 10:44:16
Revision: 1.3
Template: document

XML references to the Template

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

document

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

Set up a table of the template parameters.
<template_table figure_id="?" instance="?" name="document" context="UK_Defence" >
  <param name="author">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="category">
    <param_value>Unknown_data_type</param_value>
    <description></description>
  </param>
  <param name="description">
    <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="releasing_authority">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="security_classification">
    <param_value>Security_classification_code</param_value>
    <description></description>
  </param>
  <param name="valid_from_date">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="valid_to_date">
    <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="document">
  <param_in name="author" value=""/>
  <param_in name="category" value="Unknown_data_type"/>
  <param_in name="description" value=""/>
  <param_in name="id" value=""/>
  <param_in name="name" value=""/>
  <param_in name="releasing_authority" value=""/>
  <param_in name="security_classification" value="Security_classification_code"/>
  <param_in name="valid_from_date" value=""/>
  <param_in name="valid_to_date" value=""/>
  <param_in name="version" value=""/>
</template_example>

document
/document(author='', category='Unknown_data_type', description='', id='', name='', releasing_authority='', security_classification='Security_classification_code', valid_from_date='', valid_to_date='', version='')/

Path

-- instantiate representing_document
/representing_document(
    doc_id=@id,
    doc_id_class_name='Document_identification_code',
    doc_id_ecl_id='urn:plcs:rdl:uk_defence',
    doc_org_id=@releasing_authority,
    doc_org_id_class_name='Organization_identification_code',
    doc_org_id_ecl_id='urn:plcs:rdl:uk_defence',
    doc_vn_id=@version,
    doc_vn_id_class_name='Version_identification_code',
    doc_vn_id_ecl_id='urn:plcs:rdl:uk_defence',
    doc_vn_org_id=@releasing_authority,
    doc_vn_org_id_class_name='Organization_identification_code',
    doc_vn_org_id_ecl_id='urn:plcs:rdl:uk_defence',
    domain='Product_life_cycle_support',
    domain_ecl_id='urn:plcs:rdl:uk_defence',
    life_cycle_stage='Support_stage',
    life_cycle_stage_ecl_id='urn:plcs:rdl:uk_defence')/

-- assign ref parameters
%^document = $representing_document.document%
%^document_version = $representing_document.document_version%
%^document_definition = $representing_document.document_definition%

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

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

-- document name
/identifier(
    ID=@name,
    source_organization=@releasing_authority,
    type='Document_name',
    items=^document)/

-- security classification
/assigning_security_classification(
    security_class_name=@security_classification,
    security_ecl_id='urn:plcs:rdl:uk_defence',
    items=^document)/

-- author
/assigning_document(
    doc_ass_role='author',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^document_definition,
    is_assigned_to=@author)/

-- releasing authority
/assigning_document(
    doc_ass_role='author',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    assigned_document=^document_definition,
    is_assigned_to=@releasing_authority)/

-- valid from date
Date_or_date_time_assignment
%^valid_from_date = Date_or_date_time_assignment%
^valid_from_date.assigned_date -> @valid_from_date
^valid_from_date.role = 'document_valid_from_date'
^valid_from_date.items -> ^document_definition

-- valid to date
Date_or_date_time_assignment
%^valid_to_date = Date_or_date_time_assignment%
^valid_to_date.assigned_date -> @valid_to_date
^valid_to_date.role = 'document_valid_to_date'
^valid_to_date.items -> ^document_definition
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Date_or_date_time_assignment.role 'document_valid_from_date'
Date_or_date_time_assignment.role 'document_valid_to_date'

XML representation of path

<refpath
   template="document">
   <comment>
      instantiate representing_document
   </comment>
   <call_template
      name="representing_document"
      business_context="UK_Defence">
      <param_in
         name="doc_id"
         value="@id">
         
      </param_in>
      <param_in
         name="doc_id_class_name"
         value="'Document_identification_code'">
         
      </param_in>
      <param_in
         name="doc_id_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="doc_org_id"
         value="@releasing_authority">
         
      </param_in>
      <param_in
         name="doc_org_id_class_name"
         value="'Organization_identification_code'">
         
      </param_in>
      <param_in
         name="doc_org_id_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="doc_vn_id"
         value="@version">
         
      </param_in>
      <param_in
         name="doc_vn_id_class_name"
         value="'Version_identification_code'">
         
      </param_in>
      <param_in
         name="doc_vn_id_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="doc_vn_org_id"
         value="@releasing_authority">
         
      </param_in>
      <param_in
         name="doc_vn_org_id_class_name"
         value="'Organization_identification_code'">
         
      </param_in>
      <param_in
         name="doc_vn_org_id_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="domain"
         value="'Product_life_cycle_support'">
         
      </param_in>
      <param_in
         name="domain_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="life_cycle_stage"
         value="'Support_stage'">
         
      </param_in>
      <param_in
         name="life_cycle_stage_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
   </call_template>
   <comment>
      assign ref parameters
   </comment>
   <bind
      parameter="document">
      <template_instance
         template="representing_document"
         parameter="document">
         
      </template_instance>
   </bind>
   <bind
      parameter="document_version">
      <template_instance
         template="representing_document"
         parameter="document_version">
         
      </template_instance>
   </bind>
   <bind
      parameter="document_definition">
      <template_instance
         template="representing_document"
         parameter="document_definition">
         
      </template_instance>
   </bind>
   <comment>
      category
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="UK_Defence">
      <param_in
         name="items"
         value="^document_definition">
         
      </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>
      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="^document">
         
      </param_in>
   </call_template>
   <comment>
      document name
   </comment>
   <call_template
      name="identifier"
      business_context="UK_Defence">
      <param_in
         name="ID"
         value="@name">
         
      </param_in>
      <param_in
         name="source_organization"
         value="@releasing_authority">
         
      </param_in>
      <param_in
         name="type"
         value="'Document_name'">
         
      </param_in>
      <param_in
         name="items"
         value="^document">
         
      </param_in>
   </call_template>
   <comment>
      security classification
   </comment>
   <call_template
      name="assigning_security_classification"
      business_context="UK_Defence">
      <param_in
         name="security_class_name"
         value="@security_classification">
         
      </param_in>
      <param_in
         name="security_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="items"
         value="^document">
         
      </param_in>
   </call_template>
   <comment>
      author
   </comment>
   <call_template
      name="assigning_document"
      business_context="UK_Defence">
      <param_in
         name="doc_ass_role"
         value="'author'">
         
      </param_in>
      <param_in
         name="doc_ar_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="assigned_document"
         value="^document_definition">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="@author">
         
      </param_in>
   </call_template>
   <comment>
      releasing authority
   </comment>
   <call_template
      name="assigning_document"
      business_context="UK_Defence">
      <param_in
         name="doc_ass_role"
         value="'author'">
         
      </param_in>
      <param_in
         name="doc_ar_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="assigned_document"
         value="^document_definition">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="@releasing_authority">
         
      </param_in>
   </call_template>
   <comment>
      valid from date
   </comment>
   <instantiate
      entity="Date_or_date_time_assignment"
      context="UK_Defence">
      
   </instantiate>
   <bind
      parameter="valid_from_date">
      <express_entity
         entity="Date_or_date_time_assignment"
         context="UK_Defence">
         
      </express_entity>
   </bind>
   <assign
      assignment_type="points-to">
      <target>
         <bound_parameter
            name="valid_from_date.assigned_date">
            
         </bound_parameter>
      </target>
      <source>
         <param_in_ref
            name="valid_from_date">
            
         </param_in_ref>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="UK_Defence">
      <target>
         <bound_parameter
            name="valid_from_date.role">
            
         </bound_parameter>
      </target>
      <source>
         <string
            value=" 'document_valid_from_date' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <bound_parameter
            name="valid_from_date.items">
            
         </bound_parameter>
      </target>
      <source>
         <bound_parameter
            name="document_definition">
            
         </bound_parameter>
      </source>
   </assign>
   <comment>
      valid to date
   </comment>
   <instantiate
      entity="Date_or_date_time_assignment"
      context="UK_Defence">
      
   </instantiate>
   <bind
      parameter="valid_to_date">
      <express_entity
         entity="Date_or_date_time_assignment"
         context="UK_Defence">
         
      </express_entity>
   </bind>
   <assign
      assignment_type="points-to">
      <target>
         <bound_parameter
            name="valid_to_date.assigned_date">
            
         </bound_parameter>
      </target>
      <source>
         <param_in_ref
            name="valid_to_date">
            
         </param_in_ref>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="UK_Defence">
      <target>
         <bound_parameter
            name="valid_to_date.role">
            
         </bound_parameter>
      </target>
      <source>
         <string
            value=" 'document_valid_to_date' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <bound_parameter
            name="valid_to_date.items">
            
         </bound_parameter>
      </target>
      <source>
         <bound_parameter
            name="document_definition">
            
         </bound_parameter>
      </source>
   </assign>
</refpath>

© UK MOD 2010 — All rights reserved