Template:— electronic_document (elec_doc)
Context:— UK_Defence		 Date: 2009/04/17 11:17:51
Revision: 1.3
CoverContentsDescriptionBus. perspectiveBus. obj.Model diags.Input params.Ref. params.Instantiation pathInstance diags.CharacterizationsIssuesin situ
Template: electronic_document

XML references to the Template

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

electronic_document

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

Set up a table of the template parameters.
<template_table figure_id="?" instance="?" name="electronic_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="file_version">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="logical_location">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="media_filename">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="media_format">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="media_id">
    <param_value></param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="electronic_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="file_version" value=""/>
  <param_in name="logical_location" value=""/>
  <param_in name="media_filename" value=""/>
  <param_in name="media_format" value=""/>
  <param_in name="media_id" value=""/>
</template_example>

electronic_document
/electronic_document(author='', category='Unknown_data_type', description='', id='', name='', version='', releasing_authority='', security_classification='Security_classification_code', valid_from_date='', valid_to_date='', file_version='', logical_location='', media_filename='', media_format='', media_id='')/

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%

-- electronic file
/representing_digital_file(
    dig_file_id=@media_filename,
    dig_file_id_class_name='',
    dig_file_id_ecl_id='',
    dig_file_org_id='',
    dig_file_org_id_class_name='',
    dig_file_org_id_ecl_id='',
    dig_file_vn_id=@file_version,
    dig_file_vn_id_class_name='',
    dig_file_vn_id_ecl_id='',
    dig_file_vn_org_id='',
    dig_file_vn_org_id_class_name='',
    dig_file_vn_org_id_ecl_id='',
    cont_data_type_class_name='',
    cont_data_type_ecl_id='' )/

[warning:]Error t2: the template representing_digital_file does not have a parameter name [dig_file_vn_id]. Parameters are: dig_file_id dig_file_id_class_name dig_file_id_ecl_id dig_file_org_id dig_file_org_id_class_name dig_file_org_id_ecl_id cont_data_type_class_name cont_data_type_ecl_id

[warning:]Error t2: the template representing_digital_file does not have a parameter name [dig_file_vn_id_class_name]. Parameters are: dig_file_id dig_file_id_class_name dig_file_id_ecl_id dig_file_org_id dig_file_org_id_class_name dig_file_org_id_ecl_id cont_data_type_class_name cont_data_type_ecl_id

[warning:]Error t2: the template representing_digital_file does not have a parameter name [dig_file_vn_id_ecl_id]. Parameters are: dig_file_id dig_file_id_class_name dig_file_id_ecl_id dig_file_org_id dig_file_org_id_class_name dig_file_org_id_ecl_id cont_data_type_class_name cont_data_type_ecl_id

[warning:]Error t2: the template representing_digital_file does not have a parameter name [dig_file_vn_org_id]. Parameters are: dig_file_id dig_file_id_class_name dig_file_id_ecl_id dig_file_org_id dig_file_org_id_class_name dig_file_org_id_ecl_id cont_data_type_class_name cont_data_type_ecl_id

[warning:]Error t2: the template representing_digital_file does not have a parameter name [dig_file_vn_org_id_class_name]. Parameters are: dig_file_id dig_file_id_class_name dig_file_id_ecl_id dig_file_org_id dig_file_org_id_class_name dig_file_org_id_ecl_id cont_data_type_class_name cont_data_type_ecl_id

[warning:]Error t2: the template representing_digital_file does not have a parameter name [dig_file_vn_org_id_ecl_id]. Parameters are: dig_file_id dig_file_id_class_name dig_file_id_ecl_id dig_file_org_id dig_file_org_id_class_name dig_file_org_id_ecl_id cont_data_type_class_name cont_data_type_ecl_id

-- assign ref parameters
%^digital_file = $representing_digital_file.digital_file%
Digital_document_definition
Digital_document_definition.defined_version -> ^document_version
Digital_document_definition.files -> ^digital_file

-- media format
/assigning_reference_data(
    items=^digital_file,
    class_name=@media_format,
    ecl_id='urn:plcs:rdl:uk_defence')/

-- media id
/assigning_reference_data(
    items=^digital_file,
    class_name=@media_id,
    ecl_id='urn:plcs:rdl:uk_defence')/

-- logical location
/assigning_location(
    la_class_name='',
    la_ecl_id='',
    loc_id=@logical_location,
    loc_id_class_name='',
    loc_id_ecl_id='',
    loc_org_id='',
    loc_org_id_class_name='',
    loc_org_id_ecl_id='',
    entity_for_location=^digital_file)/

XML representation of path

<refpath
   template="electronic_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>
      electronic file
   </comment>
   <call_template
      name="representing_digital_file"
      business_context="UK_Defence">
      <param_in
         name="dig_file_id"
         value="@media_filename">
         
      </param_in>
      <param_in
         name="dig_file_id_class_name"
         value="''">
         
      </param_in>
      <param_in
         name="dig_file_id_ecl_id"
         value="''">
         
      </param_in>
      <param_in
         name="dig_file_org_id"
         value="''">
         
      </param_in>
      <param_in
         name="dig_file_org_id_class_name"
         value="''">
         
      </param_in>
      <param_in
         name="dig_file_org_id_ecl_id"
         value="''">
         
      </param_in>
      <param_in
         name="dig_file_vn_id"
         value="@file_version">
         
      </param_in>
      <param_in
         name="dig_file_vn_id_class_name"
         value="''">
         
      </param_in>
      <param_in
         name="dig_file_vn_id_ecl_id"
         value="''">
         
      </param_in>
      <param_in
         name="dig_file_vn_org_id"
         value="''">
         
      </param_in>
      <param_in
         name="dig_file_vn_org_id_class_name"
         value="''">
         
      </param_in>
      <param_in
         name="dig_file_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="digital_file">
      <template_instance
         template="representing_digital_file"
         parameter="digital_file">
         
      </template_instance>
   </bind>
   <instantiate
      entity="Digital_document_definition"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Digital_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="Digital_document_definition"
            attribute="files"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="digital_file">
            
         </bound_parameter>
      </source>
   </assign>
   <comment>
      media format
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="UK_Defence">
      <param_in
         name="items"
         value="^digital_file">
         
      </param_in>
      <param_in
         name="class_name"
         value="@media_format">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
   </call_template>
   <comment>
      media id
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="UK_Defence">
      <param_in
         name="items"
         value="^digital_file">
         
      </param_in>
      <param_in
         name="class_name"
         value="@media_id">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
   </call_template>
   <comment>
      logical location
   </comment>
   <call_template
      name="assigning_location"
      business_context="UK_Defence">
      <param_in
         name="la_class_name"
         value="''">
         
      </param_in>
      <param_in
         name="la_ecl_id"
         value="''">
         
      </param_in>
      <param_in
         name="loc_id"
         value="@logical_location">
         
      </param_in>
      <param_in
         name="loc_id_class_name"
         value="''">
         
      </param_in>
      <param_in
         name="loc_id_ecl_id"
         value="''">
         
      </param_in>
      <param_in
         name="loc_org_id"
         value="''">
         
      </param_in>
      <param_in
         name="loc_org_id_class_name"
         value="''">
         
      </param_in>
      <param_in
         name="loc_org_id_ecl_id"
         value="''">
         
      </param_in>
      <param_in
         name="entity_for_location"
         value="^digital_file">
         
      </param_in>
   </call_template>
</refpath>

© UK MOD 2010 — All rights reserved