Summary

The Shipment Confirm email template is used to inform study participants that a shipment has been confirmed. 

Table of Contents


Only the portions of the email marked in blue can be easily modified. If modifying other portions of the email template, view the page related to customizing email templates.

Context Keys

Context Keys are used to access data from the system. Examples of their use can be seen in the following template. These context keys can also be added to the email template or relocated within the template.


  • $!{applicationName} – Study name
  • $site.getName() – Site name

Note: Take care when using the following context keys in ways that differ from the standard setup in the email template. These keys will return unexpected results if not contained within 'if' statements and 'foreach' loops.

  • $confirmPartialShipment – States whether or not the shipment was confirmed as a partial shipment by returning the value ‘true’ or ‘false.’
  • $shipment.getContainers() – List of drug containers in the shipment
  • $drugContainer – Each container in the shipment
  • $drugContainer.getDisplayID() – Drug container’s ID
  • $drugContainer.getTotalCount() – Total number of containers that should be in the kit
  • $drugContainer.getReceivedCount() – Total number of containers received in the kit
  • $drugContainer.getMissingCount() – Total number of containers missing from the kit
  • $drugContainer.getBrokenCount() – Total number of broken containers in the kit

Template

File Name: shipmentConfirm.vm

<html>
<body>
<table border="0" width="80%" align="center">
  <tr>
    <td valign="top">
     <img src="$logoImage">
    </td>
    <td align="right" valign="top">
      <table border="0" valign="top">
        <tr>
          <td>
            <font face="arial" size="3">
              <b>Fountayn</b>
            </font>
          </td>
        </tr>
        <tr>
          <td>
            <font face="arial" size="1">  
              www.fountayn.com
            </font>
          </td>
        </tr>
      </table>
    </td>
  </tr>
  <tr>
    <td colspan="2">
      &nbsp;
    </td>
  </tr>
  <tr>
    <td colspan="2">
       $!{applicationName}<br><br>
    </td>
  </tr>
  <tr>
  
    <td colspan="2">
      &nbsp;
    </td>
  </tr>
  #if ($confirmPartialShipment==true)
  <tr>
    <td colspan="2">
      <b>Site $site.getName() has confirmed the shipment as being received even though it is a partial shipment (i.e. some containers are missing).</b>
    </td>
  </tr>
  <tr>
    <td colspan="2">
      <table width="100%">
        <tr>
          <td>
            <b>Kit ID</b>
          </td>
          <td>
            <b>Total</b>
          </td>
          <td>
            <b>Received</b>
          </td>
          <td>
            <b>Missing</b>
          </td>
          <td>
            <b>Broken</b>
          </td>
        </tr>
      #foreach ($drugContainer in $shipment.getContainers())
        <tr>
          <td>$drugContainer.getDisplayID()</td>
          <td>$drugContainer.getTotalCount()</td>
          <td>$drugContainer.getReceivedCount()</td>
          <td>$drugContainer.getMissingCount()</td>
          <td>$drugContainer.getBrokenCount()</td>
        </tr>
      #end
 #else  
  <tr>
    <td colspan="2">
      <b>Site $site.getName() has indicated that the shipment was received as:</b>
    </td>
  </tr>

  <tr>
    <td colspan="2">
      <table width="100%">
        <tr>
          <td>
            <b>Kit ID</b>
          </td>
          <td>
            <b>Total</b>
          </td>
          <td>
            <b>Received</b>
          </td>
          <td>
            <b>Missing</b>
          </td>
          <td>
            <b>Broken</b>
          </td>
        </tr>
      #foreach ($drugContainer in $shipment.getContainers())
        <tr>
          <td>$drugContainer.getDisplayID()</td>
          <td>$drugContainer.getTotalCount()</td>
          <td>$drugContainer.getReceivedCount()</td>
          <td>$drugContainer.getMissingCount()</td>
          <td>$drugContainer.getBrokenCount()</td>
        </tr>
      #end
      #end
	        
          
      </table>
    </td>
  </tr>
  
</table>
</body>
</html>


Need more help?

Please visit the Fountayn Contact Information page.