Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following table lists the required configuration.

Description

Release

Velocity Version

3.8.

3

4.3284

Velocity CUCM Integration Plugin

Build 3.6.11.79

Cisco Unified Call Manager (CUCM)

V12.5.1.10000-22

HTTPS supported Phone Firmware

V11.7 or later

Installing Velocity CUCM Integration Plugin on Velocity

...

  1. After downloading the Velocity CUCM Integration plugin, right-click to Run as administrator.

    Image RemovedImage Added
  2. Enter the Velocity Service Account and its password and click Next.

  3. The Velocity Update wizard for Velocity CUCM Integration starts updating.

  4. After completion, a successful Velocity Update dialog box displays. Click Ok.

  5. Launch Velocity and select Help->About Velocity from the menu.

    Image RemovedImage Added

    The Velocity CUCM Integration plugin installed is displayed as shown below.

...

  1. Go to Call Manager web admin and login to the Cisco Unified CM Administration page.

    Image RemovedImage Added
  2. Navigate from Device ->Device Settings -> Phone Services.

    Image RemovedImage Added
  3. Click “Add New” for new Phone service creation.

  4. The IP Phone Services Configuration page displays as shown below.

    Image RemovedImage Added
  5. Enter a new Service Name and enter the description of the content that the service provides in the Service Description field.
    The user can either configure HTTP(S) or HTTP Service URL:

  6. To configure HTTPS service request, enter the Service URL address.
    The URL syntax is,

    1. <<https://<velocity_IP_Address>/velcucm/api/cucm/?Action=<User_Action>&Username=<velocity_username>&password=<velocity_password>&Address=<door_address>>

    2. For example, <<https://10.151.30.81/velcucm/api/cucm/?Action=MomentaryUnlockDoor&UserName=Administrator&Password=password@1&Address=XNET.001.0001.001.01.DR06>>

  7. Click Save.

    Image RemovedImage Added
  8. To configure the HTTP service request, enter the Service URL address.
    The URL syntax is,
    <<http://<velocity_IP_Address>/velcucm/api/cucm/?Action=<User_Action>&Username=<velocity_username>&password=<velocity_password>&Address=<door_address>>
    For example,
    <<http://10.151.30.81/velcucm/api/cucm/?Action=MomentaryUnlockDoor&UserName=Administrator&Password=password@1&Address=XNET.001.0001.001.01.DR06>>

  9. Click Save after you are done.

    Image RemovedImage Added

The Service URL field is mandatory and accepts both HTTPS and HTTP URLs. If the Service URL and Secure-Service URL are configured, then the Secure-Service URL takes precedence over the Service URL. For HTTPS service requests to work, the user must download the self-signed certificate from Velocity and import it into CUCM.

...

  1. Click any one of the HTTPS supported VoIP phones in the Device Name (Line) list.

    Image RemovedImage Added
  2. Select Subscribe/Unsubscribe Service link from the Related Links drop-down list and click Go

  3. In the new service subscription, select the newly created phone service URL and click Next.

    Image RemovedImage Added
  4. Click the Subscribe button to confirm subscription.

    Image RemovedImage Added
  5. The subscribed services display as shown below.

    Image RemovedImage Added

The service is subscribed to the VoIP phone, but the service does not get displayed until this service is assigned to a phone button.

...

The table lists the functions and commands supported in VoIP Phone.

Function

Command

Access Functions (Only on Doors)

MomentaryUnlockDoor

UnlockDoor

RelockDoor

Relay Control functions (Door base and expansion relays)

TriggerRelay

ForceOnRelay

ForceOnReleaseRelay

ForceOffRelay

ForceOffReleaseRelay

LockDownRelay

LockDownReleaseRelay

LockOpenRelay

LockOpenReleaseRelay

InputControl functions (Door base and expansion inputs)

MaskInput

UnMaskInput

MomentaryMaskInput

Assigning Phone Service URL to a VoIP Phone button

...

  1. Click the “Add a new SURL” link on the Unassigned Associated Items in Modify Button Items as shown below.

    Image RemovedImage Added
  2. Select the Button Service from the drop-down and then select the subscribed phone service.

    Image RemovedImage Added
  3. Click Save and Close.

  4. Click Modify Button Items to associate the Service URL to a button in the Phone Configuration screen.
    The Reorder Phone Button Configuration screen displays.

    Image RemovedImage Added
  5. Associate the phone buttons that need to be managed as shown in the figure above.

  6. After finishing, click Save and Close.

  7. After associating the phone service to a phone button, the VoIP Phone restarts automatically and reconnects with CUCM. The Service URL /Secure Service URL name is listed on the VoIP Phone after the VoIP Phone is restarted.

  8. Press the Phone button to confirm the device command execution that takes place in Velocity.

...

  1. From within the Command prompt type MMC and hit the Enter key.
    The following window will appear.

    Image RemovedImage Added

  2. If prompted select Yes in the User Account Control window

  3. Go to File > Add/Remove Snap-in… as shown below

  4. Select Certificates and click the Add button.

    Image RemovedImage Added
  5. Select the Computer account radio button and click Next.

  6. Select Local computer: (the computer this console is running on) radio button and click Finish.

  7. The certificate shows up as shown below, Click Ok.

    Image RemovedImage Added
  8. Click Certificates (Local Computer).

  9. Expand Personal -> Certificates and select Velocity TLS as shown below.

    Image RemovedImage Added

  10. Right-click VelocityTLS and select All Tasks->Export…

  11. The Certificate Export Wizard window opens, click Next.

    Image RemovedImage Added
  12. Select DER encoded binary X.509(.CER) format radio button and click Next. This exports a certificate to the file system as a DER-encoded .cer file without its private key.

    Image RemovedImage Added

  13. Enter the file name (VelocityTLS_Key) and click Next.

  14. Select File Name from the path and click Finish.

    Image RemovedImage Added
  15. The Certificate Export wizard will display a message indicating the export was successful, click OK.

    Image RemovedImage Added
  16. Go to File -> exit to come out of the Console.

...

  1. Login into Cisco Unified OS Administration.

  2. Navigate to Security and Certificate Management.

    Image RemovedImage Added
  3. Click the “Upload Certificate/Certificate Chain” link.

    Image RemovedImage Added
  4. Select Certificate Purpose as Phone-trust.

    Image RemovedImage Added
  5. Enter the Description (friendly name). Click Browse to upload the downloaded Certificate from your system and click Upload.

    Image RemovedImage Added
  6. Once the Certificate is uploaded into CUCM, the Certificate is displayed as shown below.

    Image RemovedImage Added

The uploaded certificate gets listed and is displayed when it is selected as shown below.

...