Template:— representing_message (rep_msg) Date: 2010/02/26 01:54:41
Revision: 1.32
Template: representing_message

XML references to the Template

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

representing_message

Set up a hyperlink to the template definition.
<template_ref name="representing_message" capability="messaging"/>

Set up a table of the template parameters.
<template_table figure_id="?" instance="" name="representing_message" capability="messaging">
  <param name="rep_msg_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_msg_id_class_name">
    <param_value>Message_identification_code</param_value>
    <description></description>
  </param>
  <param name="rep_msg_id_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="rep_msg_id_owner">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="rep_msg_id_owner_class_name">
    <param_value>Organization_name</param_value>
    <description></description>
  </param>
  <param name="rep_msg_id_owner_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="date_class_name">
    <param_value>Date_actual_extraction</param_value>
    <description></description>
  </param>
  <param name="date_ecl_id">
    <param_value>urn:plcs:rdl:std</param_value>
    <description></description>
  </param>
  <param name="year">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="month">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="day">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="hour">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="minute">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="second">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="sense">
    <param_value>exact</param_value>
    <description></description>
  </param>
  <param name="hour_offset">
    <param_value>0</param_value>
    <description></description>
  </param>
  <param name="minute_offset">
    <param_value>0</param_value>
    <description></description>
  </param>
  <param name="ap239_id_class_name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="ap239_id_ecl_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="dex_id_class_name">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="dex_id_ecl_id">
    <param_value></param_value>
    <description></description>
  </param>
  <param name="content">
    <param_value></param_value>
    <description></description>
  </param>
</template_table>

Setup a template_example:
<template_example name="representing_message">
  <param_in name="rep_msg_id" value=""/>
  <param_in name="rep_msg_id_class_name" value="Message_identification_code"/>
  <param_in name="rep_msg_id_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="rep_msg_id_owner" value=""/>
  <param_in name="rep_msg_id_owner_class_name" value="Organization_name"/>
  <param_in name="rep_msg_id_owner_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="date_class_name" value="Date_actual_extraction"/>
  <param_in name="date_ecl_id" value="urn:plcs:rdl:std"/>
  <param_in name="year" value=""/>
  <param_in name="month" value=""/>
  <param_in name="day" value=""/>
  <param_in name="hour" value=""/>
  <param_in name="minute" value=""/>
  <param_in name="second" value=""/>
  <param_in name="sense" value="exact"/>
  <param_in name="hour_offset" value="0"/>
  <param_in name="minute_offset" value="0"/>
  <param_in name="ap239_id_class_name" value=""/>
  <param_in name="ap239_id_ecl_id" value=""/>
  <param_in name="dex_id_class_name" value=""/>
  <param_in name="dex_id_ecl_id" value=""/>
  <param_in name="content" value=""/>
</template_example>

representing_message
/representing_message(rep_msg_id='', rep_msg_id_class_name='Message_identification_code', rep_msg_id_ecl_id='urn:plcs:rdl:std', rep_msg_id_owner='', rep_msg_id_owner_class_name='Organization_name', rep_msg_id_owner_ecl_id='urn:plcs:rdl:std', date_class_name='Date_actual_extraction', date_ecl_id='urn:plcs:rdl:std', year='', month='', day='', hour='', minute='', second='', sense='exact', hour_offset='0', minute_offset='0', ap239_id_class_name='', ap239_id_ecl_id='', dex_id_class_name='', dex_id_ecl_id='', content='')/

Path

Message

-- Mark the Message entity as
-- referable when this template is used by binding it to the reference
-- parameter message
%^message = Message%
Message.id = '/IGNORE'
Message.message_type = '/IGNORE'
Message.purpose = '/IGNORE'
Message.contains -> Content_item_selected

-- Mark the Content_item_selected entity as
-- referable when this template is used by binding it to the reference
-- parameter content_item
%^content_item = Content_item_selected%
Content_item_selected.contents -> @content
Content_item_selected.item_identifier = '/IGNORE'
Content_item_selected.item_type = '/IGNORE'
Content_item_selected.access_comment = '/IGNORE'

-- assign ID to message
/assigning_identification(
    id=@rep_msg_id,
    id_class_name=@rep_msg_id_class_name,
    id_ecl_id=@rep_msg_id_ecl_id,
    org_id=@rep_msg_id_owner,
    org_id_class_name=@rep_msg_id_owner_class_name,
    org_id_ecl_id=@rep_msg_id_owner_ecl_id,
    items=^message)/

-- provide the version of the AP
/assigning_reference_data(
    items=^message,
    class_name=@dex_id_class_name,
    ecl_id=@dex_id_ecl_id)/

-- provide the version of the AP
/assigning_reference_data(
    items=^message,
    class_name=@ap239_id_class_name,
    ecl_id=@ap239_id_ecl_id)/

-- assigning an actual date of the message - the date the message was created
/assigning_time(
    date_class_name=@date_class_name,
    date_ecl_id=@date_ecl_id,
    year=@year,
    month=@month,
    day=@day,
    hour=@hour,
    minute=@minute,
    second=@second,
    sense=@sense,
    hour_offset=@hour_offset,
    minute_offset=@minute_offset,
    items= ^message)/
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Message.id '/IGNORE'
Message.message_type '/IGNORE'
Message.purpose '/IGNORE'
Content_item_selected.item_identifier '/IGNORE' Content_item.item_identifier
Content_item_selected.item_type '/IGNORE' Content_item.item_type
Content_item_selected.access_comment '/IGNORE' Content_item.access_comment

XML representation of path

<refpath
   template="representing_message">
   <instantiate
      entity="Message"
      context="">
      
   </instantiate>
   <comment>
      Mark the Message entity as
   </comment>
   <comment>
      referable when this template is used by binding it to the reference
   </comment>
   <comment>
      parameter message
   </comment>
   <bind
      parameter="message">
      <express_entity
         entity="Message"
         context="">
         
      </express_entity>
   </bind>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Message"
            attribute="id"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Message"
            attribute="message_type"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Message"
            attribute="purpose"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Message"
            attribute="contains"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <express_entity
            entity="Content_item_selected"
            context="">
            
         </express_entity>
      </source>
   </assign>
   <comment>
      Mark the Content_item_selected entity as
   </comment>
   <comment>
      referable when this template is used by binding it to the reference
   </comment>
   <comment>
      parameter content_item
   </comment>
   <bind
      parameter="content_item">
      <express_entity
         entity="Content_item_selected"
         context="">
         
      </express_entity>
   </bind>
   <assign
      assignment_type="points-to">
      <target>
         <express_attribute
            entity="Content_item_selected"
            attribute="contents"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <param_in_ref
            name="content">
            
         </param_in_ref>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Content_item_selected"
            attribute="item_identifier"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Content_item_selected"
            attribute="item_type"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <assign
      assignment_type="equals"
      context="">
      <target>
         <express_attribute
            entity="Content_item_selected"
            attribute="access_comment"
            context="">
            
         </express_attribute>
      </target>
      <source>
         <string
            value=" '/IGNORE' ">
            
         </string>
      </source>
   </assign>
   <comment>
      assign ID to message
   </comment>
   <call_template
      name="assigning_identification"
      business_context="">
      <param_in
         name="id"
         value="@rep_msg_id">
         
      </param_in>
      <param_in
         name="id_class_name"
         value="@rep_msg_id_class_name">
         
      </param_in>
      <param_in
         name="id_ecl_id"
         value="@rep_msg_id_ecl_id">
         
      </param_in>
      <param_in
         name="org_id"
         value="@rep_msg_id_owner">
         
      </param_in>
      <param_in
         name="org_id_class_name"
         value="@rep_msg_id_owner_class_name">
         
      </param_in>
      <param_in
         name="org_id_ecl_id"
         value="@rep_msg_id_owner_ecl_id">
         
      </param_in>
      <param_in
         name="items"
         value="^message">
         
      </param_in>
   </call_template>
   <comment>
      provide the version of the AP
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="">
      <param_in
         name="items"
         value="^message">
         
      </param_in>
      <param_in
         name="class_name"
         value="@dex_id_class_name">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="@dex_id_ecl_id">
         
      </param_in>
   </call_template>
   <comment>
      provide the version of the AP
   </comment>
   <call_template
      name="assigning_reference_data"
      business_context="">
      <param_in
         name="items"
         value="^message">
         
      </param_in>
      <param_in
         name="class_name"
         value="@ap239_id_class_name">
         
      </param_in>
      <param_in
         name="ecl_id"
         value="@ap239_id_ecl_id">
         
      </param_in>
   </call_template>
   <comment>
      assigning an actual date of the message - the date the message was created
   </comment>
   <call_template
      name="assigning_time"
      business_context="">
      <param_in
         name="date_class_name"
         value="@date_class_name">
         
      </param_in>
      <param_in
         name="date_ecl_id"
         value="@date_ecl_id">
         
      </param_in>
      <param_in
         name="year"
         value="@year">
         
      </param_in>
      <param_in
         name="month"
         value="@month">
         
      </param_in>
      <param_in
         name="day"
         value="@day">
         
      </param_in>
      <param_in
         name="hour"
         value="@hour">
         
      </param_in>
      <param_in
         name="minute"
         value="@minute">
         
      </param_in>
      <param_in
         name="second"
         value="@second">
         
      </param_in>
      <param_in
         name="sense"
         value="@sense">
         
      </param_in>
      <param_in
         name="hour_offset"
         value="@hour_offset">
         
      </param_in>
      <param_in
         name="minute_offset"
         value="@minute_offset">
         
      </param_in>
      <param_in
         name="items"
         value=" ^message">
         
      </param_in>
   </call_template>
</refpath>

© OASIS 2010 — All rights reserved