How to Configure Email Pass-Through Handling

Customize the email pass-through integration by editing the <voiceOther> section of the pluginproperties.xml, a structured XML document.

1. On the Vocera Environmental Services Integration server, open the \vocera\evs\resources\plugin\epic\pluginproperties.xml file in a text editor, if it is not already open.
2. Specify how often Vocera re-sends an email pass-through message to a user's device (if the first delivery attempt fails) by setting values for the tags in the <voiceOther><send><retry> section of the pluginproperties.xml file.

   Specify a value within each pair of begin and end tags as follows:

   Tag	Value
   <voiceOther> <send> <retry> <timeout/>	Use the <timeout/> tag to specify the total duration of time (in seconds) that may elapse during email pass-through retries before a timeout occurs. By default, the value is 3600 seconds.
   <voiceOther> <send> <retry> <interval/>	Use the <interval/> tag to specify the amount of time (in seconds) that Vocera will wait before attempting to re-send an email pass-through message, if the previous delivery has failed. By default, the value is 600 seconds.

3. Specify the text for an escalation message template as well as other customizations such as a tone, priority, and recipient in the <voiceOther><escalation><message> section of the pluginproperties.xml file. Vocera initiates an escalation if a message pass-through attempt results in an unrecoverable failure.

   Customize the escalation routine by specifying a value within each pair of begin and end tags as follows:

   Tag	Value
   <voiceOther> <escalation> <message> <voceraID/>	Use the <voceraID/> tag to specify the name of a Vocera group name or User ID as the recipient of the failure message. If you do not specify a value, Vocera EVS discards failure messages.
   <voiceOther> <escalation> <message> <messageTemplate/>	Use the <messageTemplate/> tag to specify a message that the Vocera device will auto-enunciate when it receives an escalation. You may use any combination of plain text and the ${HKRID} variable, which is auto-enunciated as the Environmental Services employee ID.
   <voiceOther> <escalation> <message> <priority/>	Use the <priority/> tag to specify one of the following VMI message priorities: 0 for normal priority 1 for high priority 2 for urgent priority
   <voiceOther> <escalation> <message> <tone/>	Optionally use the <tone/> tag to specify the filename of a custom audio tone to play when an escalation arrives on a Vocera device. If you do not specify a custom tone, the Vocera device plays the default message "clunk" sound. The custom tone file has the following requirements: Location: \vocera\data\prompts\custom Audio Format: 16 bit Monophonic WAV PCM Sampling Rate: 8000 samples/second

4. Specify any tone and priority customizations for the pass-through message, as well as custom content for the message (if necessary) in the <voiceOther><message> section of the pluginproperties.xml file.

   Customize the message by specifying a value within each pair of begin and end tags as follows:

   Tag	Value
   <voiceOther> <message> <messageTemplate/>	Use the <messageTemplate/> tag to specify a message that the Vocera device will auto-enunciate in a pass-through email message. Important: You typically do not want to provide custom content for this message template. Vocera automatically passes through the content of the email. If you provide a custom message template, Vocera sends it instead of the email content.
   <voiceOther> <message> <priority/>	Use the <priority/> tag to specify one of the following VMI message priorities: 0 for normal priority 1 for high priority 2 for urgent priority
   <voiceOther> <message> <tone/>	Optionally use the <tone/> tag to specify the filename of a custom audio tone to play when a pass-through message arrives on a Vocera device. If you do not specify a custom tone, the Vocera device plays the default message "clunk" sound. The custom tone file has the following requirements: Location: \vocera\data\prompts\custom Audio Format: 16 bit Monophonic WAV PCM Sampling Rate: 8000 samples/second

5. Save the pluginproperties.xml file and continue with the voice integration.

<voiceOther>
    <send>
        <retry>
            <timeout>3600</timeout>
            <interval>600</interval>
        </retry>
    </send>
    <escalation>
        <message>
            <voceraID></voceraID>
            <messageTemplate></messageTemplate>
            <priority>0</priority>
            <tone></tone>
        </message>
    </escalation>
    <message>
        <messageTemplate></messageTemplate>
        <priority>0</priority>
        <tone></tone>
    </message>
</voiceOther>