Template:— hardcopy_document (hardcpy_doc)
Context:— UK_Defence
Date: 2009/04/17 11:55:49
Revision: 1.3
Template: hardcopy_document

XML references to the Template

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

hardcopy_document

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

Set up a table of the template parameters.
<template_table figure_id="?" instance="?" name="hardcopy_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="version">
    <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="physical_location">
    <param_value></param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="hardcopy_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="version" 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="physical_location" value=""/>
</template_example>

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

Path

-- document subtype
/document(
    author=@author,
    category=@category,
    description=@description,
    id=@id,
    name=@name,
    version=@version,
    releasing_authority=@releasing_authority,
    security_classification=@security_classification,
    valid_from_date=@valid_from_date,
    valid_to_date=@valid_to_date)/

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

-- hardcopy file
/representing_hardcopy_file(
    hardcopy_id='',
    hardcopy_id_class_name='',
    hardcopy_id_ecl_id='',
    hardcopy_org_id='',
    hardcopy_org_id_class_name='',
    hardcopy_org_id_ecl_id='',
    hardcopy_vn_id='',
    hardcopy_vn_id_class_name='',
    hardcopy_vn_id_ecl_id='',
    hardcopy_vn_org_id='',
    hardcopy_vn_org_id_class_name='',
    hardcopy_vn_org_id_ecl_id='',
    cont_data_type_class_name='',
    cont_data_type_ecl_id='' )/

-- assign ref parameters
%^hardcopy = $representing_hardcopy_file.hardcopy%
Physical_document_definition
Physical_document_definition.defined_version -> ^document_version
Physical_document_definition.components -> ^hardcopy

-- physical location
Location_assignment
Location_assignment.entity_for_location -> ^hardcopy
Location_assignment.location_for_assignment -> @physical_location

XML representation of path

<refpath
   template="hardcopy_document">
   <comment>
      document subtype
   </comment>
   <call_template
      name="document"
      business_context="UK_Defence">
      <param_in
         name="author"
         value="@author">
         
      </param_in>
      <param_in
         name="category"
         value="@category">
         
      </param_in>
      <param_in
         name="description"
         value="@description">
         
      </param_in>
      <param_in
         name="id"
         value="@id">
         
      </param_in>
      <param_in
         name="name"
         value="@name">
         
      </param_in>
      <param_in
         name="version"
         value="@version">
         
      </param_in>
      <param_in
         name="releasing_authority"
         value="@releasing_authority">
         
      </param_in>
      <param_in
         name="security_classification"
         value="@security_classification">
         
      </param_in>
      <param_in
         name="valid_from_date"
         value="@valid_from_date">
         
      </param_in>
      <param_in
         name="valid_to_date"
         value="@valid_to_date">
         
      </param_in>
   </call_template>
   <comment>
      assign ref parameters
   </comment>
   <bind
      parameter="document">
      <template_instance
         template="document"
         parameter="document">
         
      </template_instance>
   </bind>
   <bind
      parameter="document_version">
      <template_instance
         template="document"
         parameter="document_version">
         
      </template_instance>
   </bind>
   <bind
      parameter="document_definition">
      <template_instance
         template="document"
         parameter="document_definition">
         
      </template_instance>
   </bind>
   <comment>
      hardcopy file
   </comment>
   <call_template
      name="representing_hardcopy_file"
      business_context="UK_Defence">
      <param_in
         name="hardcopy_id"
         value="''">
         
      </param_in>
      <param_in
         name="hardcopy_id_class_name"
         value="''">
         
      </param_in>
      <param_in
         name="hardcopy_id_ecl_id"
         value="''">
         
      </param_in>
      <param_in
         name="hardcopy_org_id"
         value="''">
         
      </param_in>
      <param_in
         name="hardcopy_org_id_class_name"
         value="''">
         
      </param_in>
      <param_in
         name="hardcopy_org_id_ecl_id"
         value="''">
         
      </param_in>
      <param_in
         name="hardcopy_vn_id"
         value="''">
         
      </param_in>
      <param_in
         name="hardcopy_vn_id_class_name"
         value="''">
         
      </param_in>
      <param_in
         name="hardcopy_vn_id_ecl_id"
         value="''">
         
      </param_in>
      <param_in
         name="hardcopy_vn_org_id"
         value="''">
         
      </param_in>
      <param_in
         name="hardcopy_vn_org_id_class_name"
         value="''">
         
      </param_in>
      <param_in
         name="hardcopy_vn_org_id_ecl_id"
         value="''">
         
      </param_in>
      <param_in
         name="cont_data_type_class_name"
         value="''">
         
      </param_in>
      <param_in
         name="cont_data_type_ecl_id"
         value="'' ">
         
      </param_in>
   </call_template>
   <comment>
      assign ref parameters
   </comment>
   <bind
      parameter="hardcopy">
      <template_instance
         template="representing_hardcopy_file"
         parameter="hardcopy">
         
      </template_instance>
   </bind>
   <instantiate
      entity="Physical_document_definition"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Physical_document_definition"
            attribute="defined_version"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="document_version">
            
         </bound_parameter>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Physical_document_definition"
            attribute="components"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="hardcopy">
            
         </bound_parameter>
      </source>
   </assign>
   <comment>
      physical location
   </comment>
   <instantiate
      entity="Location_assignment"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Location_assignment"
            attribute="entity_for_location"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="hardcopy">
            
         </bound_parameter>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Location_assignment"
            attribute="location_for_assignment"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="physical_location">
            
         </param_in_ref>
      </source>
   </assign>
</refpath>

© UK MOD 2010 — All rights reserved