Template:— record (rec)
Context:— UK_Defence
Date: 2009/04/17 11:32:30
Revision: 1.3
Template: record

XML references to the Template

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

record

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

Set up a table of the template parameters.
<template_table figure_id="?" instance="?" name="record" context="UK_Defence" >
  <param name="Comment">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Date_created">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Date_stored">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Name_source_organization">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="ID">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="ID_source_organization">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="record_of">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Storage_location">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Storage_media">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Storage_media_shelf_life_value">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Storage_media_shelf_life_unit">
    <param_value></param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="record">
  <param_in name="Comment" value=""/>
  <param_in name="Date_created" value=""/>
  <param_in name="Date_stored" value=""/>
  <param_in name="Name" value=""/>
  <param_in name="Name_source_organization" value=""/>
  <param_in name="ID" value=""/>
  <param_in name="ID_source_organization" value=""/>
  <param_in name="record_of" value=""/>
  <param_in name="Storage_location" value=""/>
  <param_in name="Storage_media" value=""/>
  <param_in name="Storage_media_shelf_life_value" value=""/>
  <param_in name="Storage_media_shelf_life_unit" value=""/>
</template_example>

record
/record(Comment='', Date_created='', Date_stored='', Name='', Name_source_organization='', ID='', ID_source_organization='', record_of='', Storage_location='', Storage_media='', Storage_media_shelf_life_value='', Storage_media_shelf_life_unit='')/

Path

-- record
/representing_document(
    doc_id=@ID,
    doc_id_class_name='Record_identification_code',
    doc_id_ecl_id='urn:plcs:rdl:uk_defence',
    doc_org_id=@ID_source_organization,
    doc_org_id_class_name='Organization_identification_code',
    doc_org_id_ecl_id='urn:plcs:rdl:std',
    doc_vn_id='',
    doc_vn_id_class_name='Document_version_identification_code',
    doc_vn_id_ecl_id='urn:plcs:rdl:std',
    doc_vn_org_id='/NULL',
    doc_vn_org_id_class_name='Organization_identification_code',
    doc_vn_org_id_ecl_id='urn:plcs:rdl:std',
    domain='Through_life_support_standard',
    domain_ecl_id='urn:plcs:rdl:uk_defence',
    life_cycle_stage='Support_stage',
    life_cycle_stage_ecl_id='urn:plcs:rdl:std')/
%^record = $representing_document.document%

-- [optional Comment]
/assigning_descriptor(
    descr=@Comment,
    class_name='Record_comment',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^record)/

-- Date created
Date_or_date_time_assignment
Date_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items -> ^record
Date_or_date_time_assignment.assigned_date -> @Date_created

-- [optional Name]
/identifier(
    ID=@Name,
    source_organization=@Name_source_organization,
    type='Record_name',
    items=^record)/

-- [1:M Record of]
/assigning_document(
    doc_ass_role='Record_of',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^record,
    assigned_document=@record_of)/

-- Storage location
Location_assignment
Location_assignment.entity_for_location -> ^record
Location_assignment.location_for_assignment -> @Storage_location
Location_assignment.description = '/IGNORE'
Location_assignment.role = '/IGNORE'
%^location_assignment = Location_assignment%

-- Storage date
Date_or_date_time_assignment
Date_or_date_time_assignment.role = '/IGNORE'
Date_or_date_time_assignment.items -> ^record
Date_or_date_time_assignment.assigned_date -> @Date_stored

-- Record of
/assigning_document(
    doc_ass_role='Record_of',
    doc_ar_ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^record,
    assigned_document=@record_of)/

-- Storage media
/assigning_reference_data(
    items=^record,
    class_name=@Storage_media,
    ecl_id='urn:plcs:rdl:uk_defence')/

-- [optional Storage media shelf life]
/property(
    a_property_of=^record,
    ID='Storage_media_shelf_life',
    property_ecl_id='urn:plcs:rdl:uk_defence',
    value=@Storage_media_shelf_life_value,
    unit=@Storage_media_shelf_life_unit,
    unit_ecl_id='urn:plcs:rdl:std',
    si_unit='false',
    disposition='Predicted')/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Date_or_date_time_assignment.role '/IGNORE'
Location_assignment.description '/IGNORE'
Location_assignment.role '/IGNORE'
Date_or_date_time_assignment.role '/IGNORE'

XML representation of path

<refpath
   template="record">
   <comment>
      record
   </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="'Record_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="@ID_source_organization">
         
      </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:std'">
         
      </param_in>
      <param_in
         name="doc_vn_id"
         value="''">
         
      </param_in>
      <param_in
         name="doc_vn_id_class_name"
         value="'Document_version_identification_code'">
         
      </param_in>
      <param_in
         name="doc_vn_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="doc_vn_org_id"
         value="'/NULL'">
         
      </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:std'">
         
      </param_in>
      <param_in
         name="domain"
         value="'Through_life_support_standard'">
         
      </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:std'">
         
      </param_in>
   </call_template>
   <bind
      parameter="record">
      <template_instance
         template="representing_document"
         parameter="document">
         
      </template_instance>
   </bind>
   <comment>
      [optional Comment]
   </comment>
   <call_template
      name="assigning_descriptor"
      business_context="UK_Defence">
      <param_in
         name="descr"
         value="@Comment">
         
      </param_in>
      <param_in
         name="class_name"
         value="'Record_comment'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^record">
         
      </param_in>
   </call_template>
   <comment>
      Date created
   </comment>
   <instantiate
      entity="Date_or_date_time_assignment"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="equals"
      context="UK_Defence">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="role"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="items"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="record">
            
         </bound_parameter>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="assigned_date"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="Date_created">
            
         </param_in_ref>
      </source>
   </assign>
   <comment>
      [optional Name]
   </comment>
   <call_template
      name="identifier"
      business_context="UK_Defence">
      <param_in
         name="ID"
         value="@Name">
         
      </param_in>
      <param_in
         name="source_organization"
         value="@Name_source_organization">
         
      </param_in>
      <param_in
         name="type"
         value="'Record_name'">
         
      </param_in>
      <param_in
         name="items"
         value="^record">
         
      </param_in>
   </call_template>
   <comment>
      [1:M Record of]
   </comment>
   <call_template
      name="assigning_document"
      business_context="UK_Defence">
      <param_in
         name="doc_ass_role"
         value="'Record_of'">
         
      </param_in>
      <param_in
         name="doc_ar_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^record">
         
      </param_in>
      <param_in
         name="assigned_document"
         value="@record_of">
         
      </param_in>
   </call_template>
   <comment>
      Storage 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="record">
            
         </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="Storage_location">
            
         </param_in_ref>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="UK_Defence">
      <target>
         <express_attribute
            entity="Location_assignment"
            attribute="description"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="UK_Defence">
      <target>
         <express_attribute
            entity="Location_assignment"
            attribute="role"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <bind
      parameter="location_assignment">
      <express_entity
         entity="Location_assignment"
         context="UK_Defence">
         
      </express_entity>
   </bind>
   <comment>
      Storage date
   </comment>
   <instantiate
      entity="Date_or_date_time_assignment"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="equals"
      context="UK_Defence">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="role"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="items"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="record">
            
         </bound_parameter>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Date_or_date_time_assignment"
            attribute="assigned_date"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="Date_stored">
            
         </param_in_ref>
      </source>
   </assign>
   <comment>
      Record of
   </comment>
   <call_template
      name="assigning_document"
      business_context="UK_Defence">
      <param_in
         name="doc_ass_role"
         value="'Record_of'">
         
      </param_in>
      <param_in
         name="doc_ar_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^record">
         
      </param_in>
      <param_in
         name="assigned_document"
         value="@record_of">
         
      </param_in>
   </call_template>
   <comment>
      Storage media
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="UK_Defence">
      <param_in
         name="items"
         value="^record">
         
      </param_in>
      <param_in
         name="class_name"
         value="@Storage_media">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
   </call_template>
   <comment>
      [optional Storage media shelf life]
   </comment>
   <call_template
      name="property"
      business_context="UK_Defence">
      <param_in
         name="a_property_of"
         value="^record">
         
      </param_in>
      <param_in
         name="ID"
         value="'Storage_media_shelf_life'">
         
      </param_in>
      <param_in
         name="property_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="value"
         value="@Storage_media_shelf_life_value">
         
      </param_in>
      <param_in
         name="unit"
         value="@Storage_media_shelf_life_unit">
         
      </param_in>
      <param_in
         name="unit_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="si_unit"
         value="'false'">
         
      </param_in>
      <param_in
         name="disposition"
         value="'Predicted'">
         
      </param_in>
   </call_template>
</refpath>

© UK MOD 2010 — All rights reserved