Template:— message (msg)
Context:— UK_Defence		 Date: 2010/03/22 12:23:19
Revision: 1.4
CoverContentsDescriptionBus. perspectiveBus. obj.Model diags.Input params.Ref. params.Instantiation pathInstance diags.CharacterizationsIssuesin situ
Template: message

XML references to the Template

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

message

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

Set up a table of the template parameters.
<template_table figure_id="?" instance="?" name="message" context="UK_Defence" >
  <param name="Communication_medium">
    <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="Date_created_year">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Date_created_month">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Date_created_day">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Date_created_hour">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Date_created_minute">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Date_created_second">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Purpose">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Recipient_organization">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Security_Classification">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Contents">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="Related_contract">
    <param_value></param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="message">
  <param_in name="Communication_medium" value=""/>
  <param_in name="ID" value=""/>
  <param_in name="ID_source_organization" value=""/>
  <param_in name="Date_created_year" value=""/>
  <param_in name="Date_created_month" value=""/>
  <param_in name="Date_created_day" value=""/>
  <param_in name="Date_created_hour" value=""/>
  <param_in name="Date_created_minute" value=""/>
  <param_in name="Date_created_second" value=""/>
  <param_in name="Purpose" value=""/>
  <param_in name="Recipient_organization" value=""/>
  <param_in name="Security_Classification" value=""/>
  <param_in name="Contents" value=""/>
  <param_in name="Related_contract" value=""/>
</template_example>

message
/message(Communication_medium='', ID='', ID_source_organization='', Date_created_year='', Date_created_month='', Date_created_day='', Date_created_hour='', Date_created_minute='', Date_created_second='', Purpose='', Recipient_organization='', Security_Classification='', Contents='', Related_contract='')/

Path

-- Message
/representing_message(
    rep_msg_id=@ID,
    rep_msg_id_class_name='Message_identification_code',
    rep_msg_id_ecl_id='urn:plcs:rdl:std',
    rep_msg_id_owner=@ID_source_organization,
    rep_msg_id_owner_class_name='Organization_name',
    rep_msg_id_owner_ecl_id='urn:plcs:rdl:std',
    date_class_name='Date_actual_creation',
    date_ecl_id='urn:plcs:rdl:std',
    year=@Date_created_year,
    month=@Date_created_month,
    day=@Date_created_day,
    hour=@Date_created_hour,
    minute=@Date_created_minute,
    second=@Date_created_second,
    sense='.EXACT.',
    hour_offset='0',
    minute_offset='0',
    ap239_id_class_name='AP239_ed1_tc1_message',
    ap239_id_ecl_id='urn:plcs:rdl:std',
    dex_id_class_name='DEX_message_uk_defence',
    dex_id_ecl_id='urn:plcs:rdl:uk_defence',
    content=@Contents)/
%^message = $representing_message.message%

-- Purpose
/assigning_descriptor(
    descr=@Purpose,
    class_name='Purpose',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^message)/

-- Recipient (organization)
/assigning_organization(
    org_id=@Recipient_organization,
    org_id_class_name='Organization_name',
    org_id_ecl_id='urn:plcs:rdl:std',
    org_assgn_class_name='Receiver_of',
    org_assgn_ecl_id='urn:plcs:rdl:std',
    items=^message)/

-- Security classification
/assigning_security_classification(
    security_class_name=@Security_Classification,
    security_ecl_id='urn:plcs:rdl:uk_defence',
    items=^message)/

-- Communication medium
/assigning_reference_data(
    items=^message,
    class_name=@Communication_medium,
    ecl_id='urn:plcs:rdl:uk_defence')/

-- Contract reference
Contract_assignment
Contract_assignment.items -> ^message
Contract_assignment.assigned_contract -> @Related_contract

XML representation of path

<refpath
   template="message">
   <comment>
      Message
   </comment>
   <call_template
      name="representing_message"
      business_context="UK_Defence">
      <param_in
         name="rep_msg_id"
         value="@ID">
         
      </param_in>
      <param_in
         name="rep_msg_id_class_name"
         value="'Message_identification_code'">
         
      </param_in>
      <param_in
         name="rep_msg_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="rep_msg_id_owner"
         value="@ID_source_organization">
         
      </param_in>
      <param_in
         name="rep_msg_id_owner_class_name"
         value="'Organization_name'">
         
      </param_in>
      <param_in
         name="rep_msg_id_owner_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="date_class_name"
         value="'Date_actual_creation'">
         
      </param_in>
      <param_in
         name="date_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="year"
         value="@Date_created_year">
         
      </param_in>
      <param_in
         name="month"
         value="@Date_created_month">
         
      </param_in>
      <param_in
         name="day"
         value="@Date_created_day">
         
      </param_in>
      <param_in
         name="hour"
         value="@Date_created_hour">
         
      </param_in>
      <param_in
         name="minute"
         value="@Date_created_minute">
         
      </param_in>
      <param_in
         name="second"
         value="@Date_created_second">
         
      </param_in>
      <param_in
         name="sense"
         value="'.EXACT.'">
         
      </param_in>
      <param_in
         name="hour_offset"
         value="'0'">
         
      </param_in>
      <param_in
         name="minute_offset"
         value="'0'">
         
      </param_in>
      <param_in
         name="ap239_id_class_name"
         value="'AP239_ed1_tc1_message'">
         
      </param_in>
      <param_in
         name="ap239_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="dex_id_class_name"
         value="'DEX_message_uk_defence'">
         
      </param_in>
      <param_in
         name="dex_id_ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="content"
         value="@Contents">
         
      </param_in>
   </call_template>
   <bind
      parameter="message">
      <template_instance
         template="representing_message"
         parameter="message">
         
      </template_instance>
   </bind>
   <comment>
      Purpose
   </comment>
   <call_template
      name="assigning_descriptor"
      business_context="UK_Defence">
      <param_in
         name="descr"
         value="@Purpose">
         
      </param_in>
      <param_in
         name="class_name"
         value="'Purpose'">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
      <param_in
         name="is_assigned_to"
         value="^message">
         
      </param_in>
   </call_template>
   <comment>
      Recipient (organization)
   </comment>
   <call_template
      name="assigning_organization"
      business_context="UK_Defence">
      <param_in
         name="org_id"
         value="@Recipient_organization">
         
      </param_in>
      <param_in
         name="org_id_class_name"
         value="'Organization_name'">
         
      </param_in>
      <param_in
         name="org_id_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="org_assgn_class_name"
         value="'Receiver_of'">
         
      </param_in>
      <param_in
         name="org_assgn_ecl_id"
         value="'urn:plcs:rdl:std'">
         
      </param_in>
      <param_in
         name="items"
         value="^message">
         
      </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="^message">
         
      </param_in>
   </call_template>
   <comment>
      Communication medium
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="UK_Defence">
      <param_in
         name="items"
         value="^message">
         
      </param_in>
      <param_in
         name="class_name"
         value="@Communication_medium">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="'urn:plcs:rdl:uk_defence'">
         
      </param_in>
   </call_template>
   <comment>
      Contract reference
   </comment>
   <instantiate
      entity="Contract_assignment"
      context="UK_Defence">
      
   </instantiate>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Contract_assignment"
            attribute="items"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <bound_parameter
            name="message">
            
         </bound_parameter>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Contract_assignment"
            attribute="assigned_contract"
            context="UK_Defence">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="Related_contract">
            
         </param_in_ref>
      </source>
   </assign>
</refpath>

© UK MOD 2010 — All rights reserved