Modifying the Vocera Staff Assignment Configuration File

After the Vocera Voice Server is installed and the Tomcat service is started, the Vocera Staff Assignment application automatically generates a configuration file on the server. You can edit the configuration file to configure the application. The file is named app.config and it is located in the following folder:

\vocera\data\applications\staffassignment

The app.config file is NOT synchronized continuously with Vocera cluster nodes, unlike Vocera Voice Server database transactions. However, the file is saved along with the Vocera Voice Server data during a scheduled or manual backup, and it is automatically copied from the active Vocera node to standby nodes during a remote restore.

Configuration of Vocera Staff Assignment is optional. The default configuration may work fine for you. You can edit the file in any text editor, such as Notepad.

Note: Property names in the app.config file are case-sensitive.

The following table describes the Vocera Staff Assignment application properties in alphabetical order (they may appear in a different order in the app.config file):

Table 1. Vocera Staff Assignment application properties
Property Description
appDescription

Descriptive text for the Vocera Staff Assignment application, which appears at the top of the Vocera Staff Assignment page. The default is Vocera Staff Assignment Premier or Vocera Staff Assignment, depending on your license.

checkBedRoleType

Sets whether to check whether Bed/Role groups that are assigned to a unit are "Subdepartments," and if so to change them automatically to "Ordinary" groups. Enter 1 (Yes) or 0 (No). The default is 1. For more details on how Vocera Staff Assignment handles departments and subdepartments, see Handling Departments and Subdepartments.

checkDB(hrs)

Hours between Vocera Staff Assignment database validation. Vocera Staff Assignment database Staff and Group names are compared with the Vocera Voice Server database. Invalid Vocera Staff Assignment database entries are removed. The default is 4, meaning the Vocera Staff Assignment database is validated every 4 hours.

Note: If you modify this property, you must restart the Tomcat service to load the new value.

columnCount

The number of staff columns for each bed or role. Enter an integer from 2 to 8. The default is 4.

columnNames

A comma-separate list of up to 8 column names for the Assignments tab. The default list is "1st Member, 2nd Member, 3rd Member, 4th Member, 5th Member, 6th Member, 7th Member, 8th Member".

Note: For optimal display, try to limit column names to 15 characters or less.

logMsgs

Sets whether to log Vocera Staff Assignment activity (including logins, errors, assignments) to the \vocera\logs\staffassignment folder on the Vocera Voice Server. Enter 0 (no logging) or 1 (logging enabled). The default is 1.

maxLogFiles

Maximum number of log files. The default is 100, and the maximum is 5000.

Note: If you modify this property, you must restart the Tomcat service to load the new value.

maxLogLines

Maximum lines of activity per log file. The default is 50000.

Note: If you modify this property, you must restart the Tomcat service to load the new value.

maxNotesSize Maximum number of characters per notes entry. The default is 500.
maxUnitGroups Maximum Bed/Roles that can be assigned to a Unit. The default is 200.
maxUnitUsers Maximum Staff Users and Staff Groups that can be assigned to a Unit. The default is 200.
serverIP

Comma-separated list of Vocera Voice Server cluster IP addresses, in dotted-decimal notation. On each standby Vocera Voice Server, this property must be updated manually. On the active Vocera Voice Server, this property is automatically updated when a user logs into Vocera Staff Assignment.

If you have a standalone Vocera Voice Server, enter its IP address.

serverIPalias

Comma-separated list of Vocera Voice Server cluster IP address mappings, in dotted-decimal notation. You should only use this property if you have a Vocera Voice Server cluster and your Vocera Voice Server computers have dual NIC cards, one for a "private" IP address and one for a "public" IP address.

For each IP address mapping, separate the private IP address from the public address with a ">" character. For example, if 10.98.2.101 and 10.98.2.102 are the private IP addresses and 101.0.0.1 and 101.0.0.2 are the public IP addresses, you would enter the following value for the serverIPalias property:

serverIPalias = 10.98.2.101>101.0.0.1, 10.98.2.102>101.0.0.2

If you need to enter values in the serverIPalias property, make sure you enter the private IP addresses for Vocera Voice Server cluster nodes in the serverIP property.

sitePermissions

Sets whether users who log into Vocera Staff Assignment can view and edit units at all sites or only units at their site. Enter "allSites" (the default) or "userSite". Users with system administration permission can always view and edit units from all sites.

Note: You may also see staffPrimary and staffSecondary properties in the app.config file, but those properties are obsolete and have been replaced by the columnNames and columnCount properties.