Configuring the Epic-EVS Integration / Configuring the Epic Voice Integration |
Configure the voice integration by editing the <voice> section of the pluginproperties.xml, a structured XML document.
In most situations, the default values Vocera provides in the <voice> section of pluginproperties.xml are sufficient. However, if you want Vocera to send an escalation notification when a cleaning request delivery fails, you must specify a value for <voceraID> in the message escalation parameters. When <voceraID> is not specified, Vocera discards the escalation message.
In all other cases, the default values Vocera provides for the parameters in the <voice> section of pluginproperties.xml are sufficient, unless you want to customize the integration.
To configure the voice integration:
Specify a value within each pair of begin and end tags as follows:
Tag | Value |
---|---|
<voice> <delete> <retry> <timeout/> |
Use the <timeout/> tag to specify the total duration of time (in seconds) that may elapse during message delete retries before a timeout occurs. By default, the value is 600 seconds. |
<voice> <delete> <retry> <interval/> |
Use the <interval/> tag to specify the total duration of time (in seconds) that Vocera will wait before attempting to delete a message, if the previous deletion attempt failed. By default, the value is 30 seconds. |
Values in this section override values in the same section of evs.xml.
Specify a value within each pair of begin and end tags as follows:
Tag | Value |
---|---|
<voice> <send> <retry> <timeout/> |
Use the <timeout/> tag to specify the total duration of time (in seconds) that may elapse during message send retries before a timeout occurs. By default, the value is 600 seconds. |
<voice> <send> <retry> <interval/> |
Use the <interval/> tag to specify the amount of time (in seconds) that Vocera will wait before attempting to re-send a message, if the previous delivery has failed. By default, the value is 30 seconds. |
Values in this section override values in the same section of evs.xml.
Customize the escalation routine by specifying a value within each pair of begin and end tags as follows:
Tag | Value |
---|---|
<voice> <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. The value for this property overrides the value specified for the same property in evs.xml. |
<voice> <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 following variables:
|
<voice> <escalation> <message> <priority/> |
Use the <priority/> tag to specify one of the following VMI message priorities:
The value for this property overrides the value specified for the same property in evs.xml. |
<voice> <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:
The value for this property overrides the value specified for the same property in evs.xml. |
Customize the message by specifying a value within each pair of begin and end tags as follows:
Tag | Value |
---|---|
<voice> <message> <messageTemplate/> |
Use the <messageTemplate/> tag to specify a message that the Vocera device
will auto-enunciate when it receives a cleaning request. You may use any combination
of plain text and the following variables:
|
<voice> <message> <priority/> |
Use the <priority/> tag to specify one of the following VMI message priorities:
The value for this property overrides the value specified for the same property in evs.xml. |
<voice> <message> <tone/> |
Optionally use the <tone/> tag to specify the filename of a custom audio tone to play when a cleaning request 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:
The value for this property overrides the value specified for the same property in evs.xml. |
The voice configuration is now complete. Following is an example of a typical voice configuration.
<voice> <delete> <retry> <timeout>600</timeout> <interval>30</interval> </retry> </delete> <send> <retry> <timeout>600</timeout> <interval>30</interval> </retry> </send> <escalation> <message> <voceraID>Epic Administrator</voceraID> <messageTemplate>Clean request ${BEVID} for housekeeper ${HKRID} Bed ${Bed} failed, please investigate.... </messageTemplate> <priority>0</priority> <tone></tone> </message> </escalation> <message> <messageTemplate>Clean request for Bed ${Bed}</messageTemplate> <priority>0</priority> <tone></tone> </message> </voice>