How to Configure Web Services

Configure the web services integration by editing the <epicRestWebService> section of the pluginproperties.xml file, a structured XML document.

You must specify a value for <baseURL> in the web services configuration parameters. In all other cases, the default values provided for the parameters in pluginproperties.xml are sufficient unless you want to customize the web services integration.

To configure the web services integration:

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.

Specify the URL of the Epic system's web services end point as follows.

Tag	Value
<epicRestWebService> <baseUrl/>	Specify the URL of the Epic system's web services end point between the <baseUrl> and </baseUrl> tags to configure the integration. For example, the entry for an Open Epic staging system may look like <baseUrl>https://open-ic.epic.com/Interconnect-FHIR/wcf/Epic.Access.GeneratedServices/EVS.svc/rest/</baseUrl>.

Tag

Value

<epicRestWebService>
   <baseUrl/>

Specify the URL of the Epic system's web services end point between the <baseUrl> and </baseUrl> tags to configure the integration.

For example, the entry for an Open Epic staging system may look like <baseUrl>https://open-ic.epic.com/Interconnect-FHIR/wcf/Epic.Access.GeneratedServices/EVS.svc/rest/</baseUrl>.

Specify how often Vocera retries updating the Epic cleaning request status to "Complete" (if the first attempt fails) by setting values for the tags in the <epicRestWebService><complete><retry> section of the pluginproperties.xml file.

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

Tag	Value
<epicRestWebService> <complete> <retry> <timeout/>	Use the <timeout/> tag to specify the total duration of time (in seconds) that may elapse during web service retries when Vocera EVS attempts to update the Epic cleaning request to "Complete". When this time is exceeded, a timeout occurs. By default, the value is 60 seconds. If a timeout occurs, Vocera EVS sends an escalation message as specified in the <voice><escalation><message> routine.
<epicRestWebService> <complete> <retry> <interval/>	Use the <interval/> tag to specify the amount of time (in seconds) that Vocera will wait before attempting to retry updating the Epic cleaning request status to "Complete", if the previous request failed. By default, the value is 5 seconds.

Tag

Value

<epicRestWebService>
   <complete>
      <retry>
         <timeout/>

Use the <timeout/> tag to specify the total duration of time (in seconds) that may elapse during web service retries when Vocera EVS attempts to update the Epic cleaning request to "Complete". When this time is exceeded, a timeout occurs. By default, the value is 60 seconds.

If a timeout occurs, Vocera EVS sends an escalation message as specified in the <voice><escalation><message> routine.

<epicRestWebService>
   <complete>
      <retry>
         <interval/>

Use the <interval/> tag to specify the amount of time (in seconds) that Vocera will wait before attempting to retry updating the Epic cleaning request status to "Complete", if the previous request failed. By default, the value is 5 seconds.

Specify how often Vocera retries updating the Epic cleaning request status to "In progress" (if the first attempt fails) by setting values for the tags in the <epicRestWebService><inprogress><retry> section of the pluginproperties.xml file.

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

Tag	Value
<epicRestWebService> <inprogress> <retry> <timeout/>	Use the <timeout/> tag to specify the total duration of time (in seconds) that may elapse during web service retries when Vocera EVS attempts to update the Epic cleaning request to "In progress". When this time is exceeded, a timeout occurs. By default, the value is 60 seconds. If a timeout occurs, Vocera EVS sends an escalation message as specified in the <voice><escalation><message> routine.
<epicRestWebService> <inprogress> <retry> <interval/>	Use the <interval/> tag to specify the amount of time (in seconds) that Vocera will wait before attempting to retry updating the Epic cleaning request status to "In progress", if the previous request failed. By default, the value is 5 seconds.

Tag

Value

<epicRestWebService>
   <inprogress>
      <retry>
         <timeout/>

Use the <timeout/> tag to specify the total duration of time (in seconds) that may elapse during web service retries when Vocera EVS attempts to update the Epic cleaning request to "In progress". When this time is exceeded, a timeout occurs. By default, the value is 60 seconds.

If a timeout occurs, Vocera EVS sends an escalation message as specified in the <voice><escalation><message> routine.

<epicRestWebService>
   <inprogress>
      <retry>
         <interval/>

Use the <interval/> tag to specify the amount of time (in seconds) that Vocera will wait before attempting to retry updating the Epic cleaning request status to "In progress", if the previous request failed. By default, the value is 5 seconds.

Save and close the pluginproperties.xml file.

The web services configuration is now complete. Following is an example of a typical web services configuration.

<epicRestWebService>
  <baseUrl>https://open-ic.epic.com/Interconnect-FHIR/wcf/Epic.Access.GeneratedServices/EVS.svc/rest/</baseUrl>
    <complete>
        <retry>
            <timeout>60</timeout>
            <interval>5</interval>
        </retry>
    </complete>
    <inprogress>
        <retry>
            <timeout>60</timeout>
            <interval>5</interval>
        </retry>
    </inprogress>
</epicRestWebService>