Graceful Registration

This 'how to' article explains Graceful Registration, how the Jabber Voice and Video SDK implements it, and what you need to know to use it.

Please note: from May 1 2013 Graceful Registration is available for both Windows and Mac. 

The Background

Cisco Unified Communications Manager version 9.0 and higher includes a feature known as Graceful Registration. This feature provides a way to manage two or more clients registered to the same CSF device. Graceful Registration lets you tell users they're already logged in on one client when they try to log in from a different client. You can then let users decide if they want to log in and end the registration to the CSF device on the already logged in client.

Registration Types

Before the Graceful Registration feature was introduced, there were two options for registration:

  • Normal registration on Cisco Unified Communications Manager versions up to 8.5
  • Duplicate registration on Cisco Unified Communications Manager versions 8.5 up to 9.0

Normal Registration

The user is logged in to client A and registered to the CSF device. When the user logs in to client B, the following happens:

  1. Client B takes over registration to the CSF device.
  2. Client A registers to the CSF device after a set interval and takes over registration from client B.
  3. If the user remains logged in to client B, it will register to the CSF device after a set interval and take over registration from client A.

In effect, normal registration does not support multiple registration to the same CSF device. When two or more clients are logged in, they repeatedly register to the CSF device at intervals and take over registration from other clients. The result is that users cannot maintain registration to their CSF device and cannot reliably make calls.

Duplicate Registration

The user is logged in to client A and registered to the CSF device. When the user logs in to client B, the following happens:

  1. Client B takes over registration to the CSF device.
  2. The user gets a message on client A that notifies the user they are logged out.
  3. Any calls in progress on client A end.

Graceful Registration

The user is logged in to client A and registered to the CSF device. When the user logs in to client B, the following happens:

  1. Client B does not log in.
  2. Client B notifies the user that client A is logged in.

This is where the Jabber SDK lets you add a choice for users. You can prompt users and ask them if they really want to log on to client B and end the registration to the CSF device on client A.

How Graceful Registration Works

CWIC exposes a registerPhone function. This function manages how phones register to Cisco Unified Communications Manager.

You configure Graceful Registration with the following argument of the registerPhone function:

forceRegistration
Type: Boolean
Default: False

Example Where False

                jQuery('#phone').cwic('registerPhone', {
                    forceRegistration: false
                });

If false, one of the following happens:

  • Log in fails with return code 'eDeviceAlreadyRegistered' if the user is logged in elsewhere. You can then give users the option to log in with { forceRegistration: true }.
  • Log in succeeds if the user is not logged in elsewhere.

Example Where True

                jQuery('#phone').cwic('registerPhone', {
                    forceRegistration: true
                });

If true, the following happens: Log in succeeds and any other registrations are logged out. The eConnectionTerminated event is fired. This event tells remote clients that they are logged out.