Configuring a Vocera CUCM Adapter

These settings enable direct communication between the Vocera CUCM Adapter and the Vocera Platform.

Select an empty field and begin typing, or select an existing value and type over it. To keep an existing value, do not edit that field.
  1. Access the Vocera Platform Web Console and navigate to the adapters.
  2. Select New Adapter in the Action menu, or select an adapter you wish to configure and then select Edit, to display the configuration fields. The configuration fields are the same for new and existing adapters.
  3. Navigate to the New Adapter option, or navigate to an existing adapter to edit. See Creating a New Adapter and Editing an Adapter for instruction as needed.
    The configuration fields are the same for new and existing adapters.
  4. Complete the configuration fields as described in the table.
    Configuration Field Description
    Component Name Click the Component Name field to display a list of the systems and devices that the Vocera Platform currently supports. Select the name of the adapter to create.
    Reference Name Enter a short descriptive name in the Reference Name field to uniquely identify an adapter instance. It may demonstrate the adapter function or other information; for example, Production adapter may differentiate a live adapter from a development or "sandbox" adapter.
    Enabled Select the Enabled checkbox to allow the Vocera Platform to use the new adapter. The Vocera Platform ignores the adapter if this option is disabled.
    Required Datasets If more than one dataset exists that meets the adapter's requirements, select the appropriate datasets for the new adapter to function correctly. The system searches for the datasets that meet the adapters requirements. If the datasets already exist, the system will use them. If the datasets do not exist, the system will create them automatically. Select Create in the drop-down menu to create a new dataset to meet the organization's requirements.
    JTAPI Library Settings

    Select the version of the Communications Manager and the JTAPI library to use for all Vocera CUCM Adapters in the organization's installation. The CUCM version selected in this field must match the version of CUCM to which the adapter will be connecting.

    Warning: Changing the JTAPI library version affects all instances of the Vocera CUCM Adapter, and initiates an immediate automatic re-start of the Vocera CUCM Adapter.

    If the JTAPI library version you require does not appear in the drop-down menu, refer to the Downloading a JTAPI Library documentation for download instructions.

    Common Settings Configuration Field Description
    CUCM Address One through Five

    Enter the unique address for each of the customer's CUCM servers in the order they are meant to be used. There can be one to five CUCM servers for any single Vocera CUCM Adapter. Each of the CUCM Address boxes is optional, but if no server address is entered, this adapter is unable to connect to a Communications Manager.

    Type in all addresses exactly as provided by the client organization's CUCM system administrator, one per text box; leave unused Address fields blank. Each entry must be an IP Address, a Fully Qualified Domain Name (FQDN), or an unqualified DNS hostname (PQDN) belonging to a CUCM server.

    Use the following standards to complete the server address fields:

    Server Address Type Description
    IP addresses Unique numerical labels assigned to each device on a computer network, in standard IP Address format (xxx.xxx.xxx.xxx, where each xxx is a number from 0-255)
    Fully Qualified Domain Names (FQDN) The complete hostname for a specific computer on a network; e.g., cucmserver30.mydomain.com
    Partially Qualified Domain Name (PQDN) Usually a single word or phrase indicating only the computer's "DNS Name"; e.g., cucmserver30
    Note: DNS hostnames must be registered on the Appliance configured in the Network Settings and may not contain spaces or punctuation other than a hyphen. Appliances using hostnames that contain underscores or spaces may not be compatible with devices that try to connect to them. Connecting to a CUCM server that contains those characters is not recommended or supported.
    Associate Users

    Select this checkbox if the Cisco phones are configured for user login. Do not select this checkbox if Vocera Platform manages the phone-to-user association.

    Default User

    Select a user's login in the Default User drop-down list. The user names displayed in the list are non-system users who are Active and are not authenticated by LDAP. If you select a Default User when PIN Authentication bypass for Cisco phones is enabled, this will allow any individual to access Vocera Platform without entering a PIN on the device.

    Select the Default User setting to apply the Security Policies associated with the customer's roles. All of the customer's Cisco phones that the adapter is aware of will use these default user settings.

    • If the default user is configured for PIN Authentication, all users authenticate with that user's PIN when they access the Vocera Platform from Cisco phones.
    • If the default user is configured for PIN Authentication and PIN Authentication Bypass for Cisco Phones, customers are not required to authenticate when they access the Vocera Platform from Cisco phones. See the Vocera Platform Administration Guide for information about these security policies.

    Warning: A default user MUST be set. If a default user is not defined, the user is forced to re-authenticate after every session timeout. This may cause a user to miss notifications.
    Login Enter the Login for the user account. This Login must match exactly (including capitalization) the User ID and Password specified in the Cisco Unified Communications Manager described in Creating an Application User.

    These fields allow the Vocera Platform to authenticate with the CUCM server(s) entered in the CUCM Address fields.

    Password Enter the Password for the user account. This Password must match exactly (including capitalization) the User ID and Password specified in the Cisco Unified Communications Manager described in Creating an Application User.

    These fields allow the Vocera Platform to authenticate with the CUCM server(s) entered in the CUCM Address fields.

  5. Select one of the available options to exit the adapter configuration page. See Saving an Adapter for details.