Adding a Facility

You can add a new facility to the list of physical locations from the Vocera Platform Web Console.

  1. Select Facilities in the Manage section.
    The Hospital Locations page displays.
  2. Click the Add Facility button.
  3. In the General section, click the cursor in the Name field and enter the name for your new facility.
  4. Complete the fields listed in the table below. An asterisk * indicates that a value must be entered for this field.


    Maximum Length


    Name *


    The name must start with a letter or digit. It must contain only letters, digits, spaces, apostrophes ('), underscores (_), or dashes (-). No other characters are allowed.



    An optional abbreviation to represent this facility name.

    Time Zone*


    Use the Time Zone dropdown menu to select a time zone for the facility.

    Emergency Broadcast Group


    (Optional) Use the Emergency Broadcast Group field to specify the name of the group that receives emergency broadcasts for this facility.

    You also set an emergency group for each functional group in your organization. For more information, see About Emergency Broadcast.

    Enable Code Lavender


    Check the Enable Code Lavender checkbox to enable Code Lavender for this facility. This option is off (unchecked) by default.

    For more information on configuring Code Lavender, see Configuring Code Lavender.

    Enable Easter Eggs


    Uncheck the Enable Easter Eggs checkbox to disable the Easter Eggs commands. This option is enabled (checked) by default.

    For more information on Easter Eggs, see Playing with Easter Eggs.

    Initiate Emergency Broadcast Silently


    Specifies whether to initiate emergency broadcasts at this facility silently, that is, without playing a chime first. This option is available only if a group is specified in the Emergency Broadcast Group field at the facility and group. By default, the option is not selected, see Initiating Emergency Broadcast Silently for more information.

    Note: This field is not available for Groups. A silent emergency broadcast is configured at the Facilities level only and applies to all emergency groups for the entire facility including panic groups set per group.

    If Voice Service is used, provide the following information.

    Name Maximum Length Description

    Cost Center


    (Optional) Use the Cost Center field to specify a cost center for the facility.

    Alternate Spoken Name


    (Optional) Use the Alternate Spoken Name field to enable Vocera to recognize variations of the exact facility name.

    For example, if users commonly refer to a facility by a nickname or an acronym, enter that variation here.

    Spoken Name Count


    (Optional) The Spoken Name Count field displays the total number of names that you can use in a voice command for this facility. It includes the names of users, groups, facilities, contacts entries, and all possible alternate names, such as spellings of user names and the singular and plural names of groups.

    Note: This field contains a display-only value, and it does not appear in the data-loading template.
  5. Select the Enable Telephony Integration checkbox to allow Vocera and your phone system to communicate with each other and configure the fields related to basic telephony information.

    When the Enable Telephony Integration checkbox is not selected, all telephony related fields are also disabled.

    You can clear the Enable Telephony Integration checkbox and click the Save button to disable telephony features for a facility. Vocera saves your telephony settings but disables communication to the PBX.

    1. Enter the Telephony - Basic Information for the following fields:
      Name Maximum Length Description

      Number of Lines

      3 digits

      Specify the number of lines you want to provision for each telephony service in the Number of Lines field. Enter either of the following values, whichever is smaller:

      • The number of lines supported by your license.

      • The number of lines provisioned by the PBX for a single telephony service.

      If you are configuring a high availability array, enter the number of lines available to a single telephony service, not the total number of lines available to all services. For example, if you have 2 Vocera SIP Telephony Gateway (VSTG) services and your license contains 48 lines, specify 24 in this field to give each service 24 lines for a total of 48.

      The number of lines that you provision for each telephony service is decremented from the number of lines in your license.

      Local Area Code

      3 digits

      Enter the area code of the region in which the Voice Service is installed in the Local Area Code field.
      Omit Area Code when Dialing Locally


      Check the Omit Area Code field when dialing locally. If your PBX requires you to dial local calls without using the area code you can enable this option.

      By default, Vocera includes the area code in the dialing string, even when dialing a local number. Check this field if your PBX or locale requires you to omit the area code when dialing local calls.

      Voice Hunt Group


      Specify the area code and phone numbers of the DID lines or hunt group you set up for the Vocera system in the Vocera Hunt Group Numbers fields.

      There are two hunt group number fields:

      • Guest Access — This number is for guest access to the Vocera system. When callers dial the Guest Access number, they are allowed to place a call but are not identified to the called person. Because guest users are not authenticated, they can call other users, but they cannot issue voice commands.

        To use the Guest Access number with numeric pagers, enter an asterisk after the last digit of the phone number. When a user sends a numeric page, Vocera passes the value that you enter in this field to the pager and then passes the user's desk extension to the pager. Some pagers display the asterisk as a hyphen, separating the desk extension from the Vocera number.

      • Direct Access — This number is for specially licensed user access to the Vocera system. This field is used only if Calling and Called Party Information is enabled on the PBX.

        Vocera uses the Caller ID feature to automatically authenticate users when they call the Direct Access phone number from their desk phone or cell phone.

      Default Local Access Code


      Specify the sequence of numbers you use to get an outside line. For example, a PBX might require you to dial a 0 or a 9 or an 8 to get an outside line.

      By default, Vocera prepends this access code to any number within the local area code.

      Default Long-Distance Access Code


      Specify the sequence of numbers you enter before placing a long distance call. For example, a PBX system might require you to dial a 9 to get an outside line and then dial a 1 before a long-distance telephone number. In this situation, the Default Long-Distance Access Code is 91.

      By default, Vocera prepends this access code to any number that includes an area code that is not the local area code.

      Company Voicemail Access Code


      Use the Company Voicemail Access Code field to specify the sequence of numbers you use to access the company’s voice mail system.

      A typical entry includes X, then the sequence of digits that you dial to get into the voicemail system from an internal phone, and possibly special dialing characters such as the * or # to indicate the end of the sequence.

      SIP Settings


      Specify the SIP settings:
      • Call Signaling Address — Enter the call signaling address for your IP PBX or VoIP gateway. For PBX failover support, enter a comma-separated list (up to 256 characters) of call signaling addresses for two or more PBXs or gateways in order of preference. Enter each call signaling address in this format:

        The Port is optional. If you do not specify a port, port 5060 (the default) is used.

        VSTG uses only one PBX or gateway at a time. If you specify multiple call signaling addresses, VSTG tries each PBX or gateway in the order specified and uses the first one that responds. If that PBX or gateway goes down, Vocera SIP Telephony Gateway switches to another one.

        The preference order of call signaling addresses is important. If the Vocera SIP Telephony Gateway is currently using the PBX for the second call signaling address, and then the PBX for the first call signaling address becomes active, Vocera SIP Telephony Gateway automatically switches to the first PBX.
        Note: The Vocera SIP Telephony Gateway uses the response to a SIP OPTIONS message to determine if the PBX or gateway is currently available. The OPTIONS message is sent every 30 seconds by default. For more information on configuring Vocera SIP Telephony Gateway to use an OPTIONS message for keep-alive, see Detecting the Connection to the IP PBX. If the PBX or gateway is not configured to support SIP OPTIONS, then entering a second call signaling address has no effect. In some situations, using TCP as the signaling transport protocol reduces the length of time required for the VSTG to recognize that the current PBX is down and move to the next PBX in the list.
      • Call Party Number — Enter the DID number, including the area code, of the Vocera trunk (the number of digits depends on the locale). Outgoing calls use this value as the caller ID. However, you can configure Vocera SIP Telephony Gateway to use caller information contained in the dial signal from the Voice Service as the caller ID.
    2. Expand the Telephony - Access Code Exceptions section and click Add Exceptions to add an exception for the entire area code, a specific prefix, or for a range of numbers within an area code.

      By default, numbers in the local area code use the Default Local Access Code, and all others use the Default Long-Distance Access Code. For more information on Telephony-Access Code Exceptions, see Access Code Exceptions more information.

    3. Expand the Telephony - Toll Exceptions section and click Add Exceptions to add any exceptions for an entire area code, a specific prefix, or for a range of numbers within an area code.
      You must add an exception to this list in either of the following situations:
      • When a number or range of numbers in your local area code is a toll call.

      • When a number or range of numbers outside your area code is a toll-free call.

      For more information on Toll Exception configuration, see Toll Exceptions.

    4. Expand the Telephony -DID Information section and click Add DID to specify the range of Direct Inward Dialing (DID) extensions that are available for use by Vocera users.
      If your PBX administrator provides a hunt group number as part of the DID range, do not include it in the range of DID extensions you specify here. The extensions on this page are for use by users only.

      For more information on DID configuration, see Direct Inward Dialing.

    5. Specify Telephony Personal Identification Numbers (PINs) in Telephony -PINs section.
      • PIN for Long Distance Calls — Enter a PIN for a facility. If a telephony PIN is not specified in the user's profile, and the user does not belong to a group that has a PIN, then the facility PIN is used. The facility-level telephony PIN is used for long distance numbers specified in Contacts. It is also used for group forwarding numbers, unless the group is a department group with a PIN number specified, in which case the department group PIN is used.
      • PIN Template— Specify a template for adding a PIN to a dialing sequence. A PIN template can include digits, special characters, and PIN macros.

        When a dialing sequence includes a PIN, this value defines the format that the Vocera system uses to send it to the PBX. Every site that has its own PBX can define a PIN and a PIN template. Sites that share a PBX use the PIN and PIN template defined for the Global facility.

        For more information on Telephony-PINs, see Telephony PINs.

    6. Expand the Telephony - Dynamic Extensions section and select the Enable Dynamic Extensions checkbox to assign dynamic extensions on demand to users who need them.
      • Extension Range — Enter a value for the First Extension and Last Extension
      • Assignment Type — Select one of the following two assignment types:
        • Choose Permanent to assign users extension that does not expire.
        • Choose Temporary to assign a lease duration value and specify the minimum amount of time that an extension is assigned to a user.
    7. Expand the Telephony - Sharing section and click Add to specify information for other Facilities sharing this Telephony service information.

      You can add a Facility name, Guest Access Number, Direct Access Number, and the Tie Line Prefix information. For information on Telephony-Sharing configuration, see Shared Telephony Configuration.

  6. Select one of the following to close the dialog.
    • Save — to add the new hospital location to the system.
    • Cancel — to return to the All Facilities page without adding a facility.