Configuring the Epic-EVS Integration / Configuring the Email Integration |
Configure the email integration by editing the <emailConfig> section of the pluginproperties.xml file, a structured XML document. All the settings in this section are required.
To configure the email integration:
Tag | Value |
---|---|
<emailConfig> <serverType/> |
Enter the type of mail server based on the protocol you are using. Possible values include pop3 (Post Office Protocol 3) or imap (Internet Message Access Protocol). |
<emailConfig> <host/> |
Enter the DNS name of your mail server (exchange.yourcompany.local, for example). |
<emailConfig> <userName/> |
Enter the user name for accessing the mailbox that your IT administrator reserved for EVS email (VoceraEVS@yourcompany.com, for example). |
<emailConfig> <password/> |
Enter the obfuscated password the EVS server must use to log in to the mailbox. This password must be obfuscated manually by Vocera and supplied to you. Note: When providing the password, make sure that any special characters are encoded using the proper escape sequences.
See Appendix: Special Characters in XML for more details.
|
<emailConfig> <checkIntervalMillis/> |
Enter the time in milliseconds that the system waits between mail checks. During a mail check, the EVS server connects with the mail host to check for new mail. If you do not specify a value, the default is 10000 (the minimum). If you specify anything smaller, EVS treats it as 10000. |
<emailConfig> <additionalProperties/> |
Specify the port number used by the mail server and whether the EVS uses SSL to connect. This field takes two comma-separated properties in the following format:
For example, a typical value for this field is pop3.port=445,pop3.ssl.enable=false. |
The email configuration is now complete. Following is an example of a typical email configuration.
<EmailConfig> <serverType>imap</ServerType> <host>exchange.voceraclinic.local</Host> <userName>vcts@voceraclinic.com</UserName> <password>vcts2ADT</Password> <checkIntervalMillis>7000</CheckIntervalMillis> <additionalProperties>imap.port=445,imap.ssl.enable=true</AdditionalProperties> </EmailConfig>