IPerity » Developers » Compass User Manual


Compass User Manual

1. Online Management and Login

You can find Compass at demo.iperity.com. If you don’t have an account yet, you can create one here.

Here you can see the login screen of Compass as depicted in figure 1. You need to enter your username and password and press ‘Login’ to enter the site.

Figure 1: Login screen

2. My Settings

Here you find information about your settings and the availability of the phone. An example is given in figure 2.

Figure 2: My settings
2.1. Personal Information

Here you can adjust your password and email address.

2.2. Phone

Here you can find the phone settings, adjust them, and manage your call waiting settings.

2.3. Call Forwarding

Here you can manage incoming calls. For example, when you are busy, could not answer the phone or are not reachable.

2.4. Queues

Here you can find the queues to which you have been added. For example, the type of phone calls you can expect (for example sales of support).

3. Service Codes

You can change your telephony settings within Compass by dialling service codes. Service codes always start with an asterisk (*), followed by the desired service code and followed by the settings, depending on the requested service code. You can also configure these service codes as speed dials with the function keys of your phone if programming function keys are supported for your type of phone. Below you can find the currently implemented service codes and their explanation.

3.1. *1: Login and Logout From Your Phone

By dialling *1, you can log into your phone. If you were not logged in, you will hear a voice asking for your extension and then (optionally) to enter your pin code, followed by the pound key (#). If you have configured a pin code for your extension, you will be requested to enter the code as well. If the pin code is correct, you will hear a voice indicating you have been logged on.
If a pin code is not configured for your extension, you will not be asked for it either. When the entered extension is known within your company, a voice will directly tell you you have been logged on. Whenever you enter an invalid extension, you will be informed of this and the phone will be hung up immediately. If you enter a correct extension, but an invalid pin code, you may retry your pin code up to two times. Therefore, if you enter an invalid pin code three times in a row, the phone will be hung up. If you were already logged on to the phone and dial *1, you will be logged off of your phone. This will also be indicated by the voice, saying “goodbye”.

3.2. *48: Login and Logout from a Queue

You can dial a service code, starting with *48, to log in or log out from a queue within your company. The service code has to be followed by another asterisk and the queue shortcode. This queue shortcode can be configured by your administrator. By default, when you log in to a queue, your identity will be configured in a way that your personal call forwards will not be followed in case you receive a call from the queue. Apart from that, your identity will have priority 1 in the queue. This implies that your phone will ring immediately, according to the queueing strategy, when an outside caller enters the specified queue.

It is possible to change these default settings by appending more parameters when dialling the service code. All parameters are separated by asterisks (*). As mentioned, the first setting is mandatory and is the queue shortcode. The second setting is optional and is used to indicate whether your personal call forwards should be followed. A one (1) tells Compass to follow them, a zero (0) lets the platform know you do not want your forwards to be followed.

With the last setting, you can control with which priority you will enter the queue. This priority can be either 1, 2 or 3. The priority indicates the amount of use of the queue that should be reached before incoming calls will be attempted to be delivered on your phone.

The optional settings can only be configured when you are currently logged out from the queue. If you pass extra settings whilst you are already logged in to the queue, you will be logged out from the queue. The extra settings will be ignored. Below are a few examples to clarify the use of *48:

*48*8 If you are logged on to the queue with shortcode 8, you will be logged off. If you are not currently a member of the queue, you will be added to it with priority 1 and have your personal call forwards disabled if you receive calls from this queue.

*48*2*1 Log into the queue with shortcode 2 with priority 1. Your personal forwards will be followed when you receive calls from that queue.

*48*4*0*2 Log into the queue with shortcode 4 with priority 2. Your personal call forwards will not be followed.

3.3. *49: Queue Pause

If you temporarily don’t want to receive any calls from a queue, it is possible to ’pause’ that particular queue. You will remain a member, but no new calls will be offered to your phone. It is possible to pause multiple queues at the same time. Pause is activated by dialling a service code, starting with *49, followed by another * and a queue shortcode. This sequence will mark you as paused in the corresponding queue. If you are already paused in the corresponding queue, this sequence will unpause you for the corresponding queue. If you dial *49 without a shortcode, you will be unpaused in all queues you are a member of.

*49*8 Pause queue with shortcode 8. Your identity will no longer receive new calls from the queue.

*49*27 Pause queue with shortcode 27.

*49*27 When you dial the same service code again, you will be unpaused in this queue. If there are any callers waiting you will receive new calls within seconds.

*49 Unpause all queues.

4. Hosted Voice TAPI

4.1. Installation

If there is an older version of Hosted Voice TAPI installed, remove this version before proceeding.

Download Hosted Voice TAPI from the Downloads section at demo.iperity.com. When the installation starts, the following screen appears:

Figure 3: TAPI configuration

Here you fill in the following values:

  • Username: your-username@uc.demo.iperity.com
  • Password: your Compass password

The button “Check” checks if you have entered the correct values and if a connection can be established.

4.2. Uninstall

To uninstall the Hosted Voice TAPI Driver, go to Control Panel and choose “Uninstall a program”. Here the Hosted Voice TAPI Driver can be removed.

4.3. Shortcut for Making a Call Using Outlook 2010

This is optional

  1. Go to “File”, “Options”
  2. Select “Customise Ribbon”
  3. On the right side, expand “Start” (contacts) and add a new group, labelled “Call”
  4. Choose the category “Commands Not in the Ribbon” on the left
  5. Pick “Call” and press “Add”, which adds the “Call” command to the newly added group
  6. Click “OK”
  7. When viewing contacts, a button “Call” appears in the Ribbon on the top of the window
  8. If “Start Call” does not ring your phone, follow these extra steps:
    1. Click “Dialing Options...”
    2. Under “Connect using line”, pick “Hosted Voice TAPI Driver”
Figure 4: Check TAPI configuration
Figure 5: Uninstall TAPI driver
Figure 6: Outlook TAPI shortcut
Figure 7: Outlook TAPI example
4.4. Known Issues

There is a known issue if Office 2007 or Office 2010 is used in combination with Office Communicator 2007. A description and solution of this problem can be found at support.microsoft.com.

5. XMPP Presence

This manual is based on Pidgin. This XMPP client is available for Windows and Linux. For other operating systems, you can use Adium (Mac OS X) adium.im, or any other XMPP client. Please use this setting to setup your XMPP client:

  • Username: your-username@uc.demo.iperity.com
  • Password: Your Compass password
5.1. Installing Pidgin

Download Pidgin here: pidgin.im. At first start Pidgin will ask for your account details (see figure 8 in the chapter 5.2.1. Users). Fill in the following details:

  • Address: your-username@uc.demo.iperity.com
  • Password: Your Compass password

The ’Add’ button will add your account to Pidgin.

5.2. Overview of XMPP Features

Once logged on, one can view users and start phone calls from the XMPP client.

5.2.1. Users

In the XMPP client, one can see the availability of all other users:

  • “On the phone with”. The user is on the phone. More details are visible when available.
  • “Ringing to”. The user is starting a phone call. More details are visible when available.
  • “Connecting to”. The user is starting a phone call, but the phone is not ringing yet. More details are visible when available.
  • “Ringing from”. The phone for this user is ringing. More details are visible when available.

Users that are currently not logged in on a phone, will be invisible in the XMPP client or appear “offline”. New users in Compass will be added to your contact list within two hours.

Figure 8: Configuring Pidgin
5.2.2. Starting Phone Calls

It’s also possible to start phone calls from within your XMPP client. If you want to call a colleague, you can preview his status within the XMPP client. You need to start a chat by selecting this user. In the chat screen, type the following text “!Dial”, then press Enter. Your phone will start ringing. Once you answer the call your colleague will be dialled.There is also a group called “Company” with a company user. Whenever you type a telephone number in the chat screen, your phone will start ringing. Once you answer your call, the required number will be automatically

There is also a group called “Company” with a company user. Whenever you type a telephone number in the chat screen, your phone will start ringing. Once you answer your call, the required number will be automatically dialled. There are no restrictions for this feature regarding brand or type of telephone hardware.