Metaswitch Hosted IP PBX Administrator Guide Version 7.2 Issue 1 30 Sep 2010 Document Number VPM-531-0100
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL Notices Copyright 2010 Metaswitch Networks. All rights reserved. This document contains Metaswitch Confidential Information and is provided to the recipient under the terms of the Non-Disclosure Agreement currently in force. This manual is issued on a controlled basis to a specific person on the understanding that no part of the Metaswitch Networks product code or documentation (including this manual) will be copied or distributed without prior agreement in writing from Metaswitch Networks. Metaswitch Networks reserves the right to, without notice, modify or revise all or part of this document and/or change product features or specifications and shall not be responsible for any loss, cost, or damage, including consequential damage, caused by reliance on these materials. Metaswitch and the Metaswitch logo are trademarks of Metaswitch Networks. Other brands and products referenced herein are the trademarks or registered trademarks of their respective holders. Metaswitch Networks 1001 Marina Village Parkway Suite 100 Alameda, CA 94501 http://www.metaswitch.com 2 Notices Version 7.2 Issue 1 30 Sep 2010
CONFIDENTIAL Metaswitch Hosted IP PBX Administrator Guide Table of contents Notices 2 Table of contents 3 1 Introduction 7 1.1 Purpose of this Guide 7 1.2 Other Guides 7 2 Business Group Administrator CommPortal 8 2.1 Accessing 8 2.2 Logging In 9 2.3 Using CommPortal 10 3 Lines 11 3.1 Moving Lines Between Departments 12 3.2 Logging Into a Users Account 14 4 Phones 15 4.1 Modify Phone Description 16 4.2 Moving Phones between Departments 16 4.3 Assigning a Line to a Phone 17 4.4 Removing a Line from a Phone 17 4.5 Phone Profiles 17 4.5.1 Managing Phone Profiles 17 4.5.2 Adding a New Phone Profile 18 4.5.3 Modifying a Phone Profile 19 4.5.4 Logging Out of Phone Profiles 24 4.6 Modifying Phone Configuration as User 25 4.7 Copying Phone Configuration 25 4.8 Installing a New Phone 26 4.9 Replacing with an identical phone model 28 4.9.1 Replacing with a different phone model 30 5 Multiple Appearance Directory Numbers (MADNs) 32 5.1 Viewing MADNs 32 5.2 Viewing and Modifying MADN 33 5.2.1 MADN Lines 33 5.2.2 Other Settings 35 5.3 Changing MADN settings 35 6 Multi Line Hunt Groups (MLHGs) 36 6.1 Viewing MLHGs 36 6.2 Moving MLHGs to another Department 36 6.3 Viewing and Modifying MLHG 36 6.3.1 MLHG Pilots 37 6.3.2 MLHG Lines 38 6.3.3 Settings 39 Table of contents 3 Version 7.2 Issue 1 30 Sep 2010
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 7 Call Pickup Groups 41 7.1 Viewing Call Pickup Groups 41 7.2 Moving Call Pickup Groups to another Department 41 7.3 Adding Call Pickup Groups 42 7.4 Deleting Call Pickup Groups 42 7.5 Viewing and Modifying Call Pickup Groups 42 7.5.1 Lines 43 7.5.2 Settings 44 8 Short Codes 45 8.1 Viewing Short Codes 45 8.2 Moving Short Codes to another Department 45 8.3 Adding Short Codes 46 8.4 Adding Short Code Ranges 46 8.5 Deleting Short Codes and Short Code Ranges 47 8.6 Modifying Short Codes 48 8.7 Modifying Short Code Ranges 49 9 Extensions 50 9.1 Viewing Extensions 50 9.2 Adding Extensions 50 9.3 Adding Extension Ranges 51 9.4 Deleting Extensions and Extension Ranges 52 9.5 Modifying Extensions 52 9.6 Modifying Extension Ranges 53 10 Account Codes 54 10.1 Viewing and Modifying Account Code Settings 54 10.2 Modifying Settings 55 10.2.1 Modifying Call Types Requiring Account Codes 55 10.2.2 Choosing Validated or Non-validated Account Codes 56 10.2.3 Setting Account Code Length 56 10.2.4 Blocking Access after Incorrect Account Codes 56 10.2.5 Setting Individual Line Properties 57 10.2.6 Configuring Account Codes 59 10.3 Viewing and Modifying Account Code Settings for a Line 60 11 External Calls 63 12 Number Blocks 67 13 Auto-Attendant 68 13.1 Overview 68 13.2 Easy Attendant 69 13.2.1 Planning Your Easy Attendant 69 13.2.2 Configuring Easy Attendant 70 13.3 Premium Attendant 74 13.3.1 Planning Your Premium Attendant 74 13.3.2 Logging into Premium Attendant 75 13.3.3 Configuring Premium Attendant Schedule 76 13.3.4 Configuring Premium Attendant Announcements 78 4 Table of contents Version 7.2 Issue 1 30 Sep 2010
CONFIDENTIAL Metaswitch Hosted IP PBX Administrator Guide 13.3.5 Configuring Premium Attendant Menus 81 13.3.6 Configuring Premium Attendant Extensions 84 13.3.7 Configuring Premium Attendant Advanced Options 85 13.3.8 Activating Premium Attendant 86 14 Music on Hold 87 14.1 CommPortal Access 87 14.1.1 Logging In 87 14.1.2 Viewing and Changing Your Security Settings 88 14.1.3 Managing Recordings 89 14.1.4 Assigning Recordings to Lines 91 14.2 Phone Access 93 14.2.1 Logging In 93 14.2.2 Using 94 15 Glossary 96 15.1 CommPortal 96 15.2 Logging Into CommPortal as Another User 96 15.3 Phones 97 15.4 Phone Numbers 97 15.5 MAC addresses 98 15.6 Departments 98 15.7 Phone Profiles 99 15.7.1 Phone Profile Graphical View 99 15.7.2 Phone Profile Table View 99 15.7.3 Copying Phone Configuration 100 15.8 Network 100 15.9 Multiple Appearance Directory Numbers 101 15.10 Multi Line Hunt Groups 102 15.11 Call Pickup Groups 103 15.12 Short Codes 103 15.13 Extensions 103 15.14 Account Codes 104 15.15 Auto Attendant - Update with EA/PA 105 15.16 Music on Hold 105 15.16.1 Music on Hold Performing Rights 106 Table of contents 5 Version 7.2 Issue 1 30 Sep 2010
1 Introduction 1.1 Purpose of this Guide Welcome to your new phone system! This Guide is intended to help Administrators of a Metaswitch Hosted IP PBX phone system perform the various tasks needed to administer the system, such as Adding new lines to the system Setting up your call groups Configuring your automated receptionist. It is split into sections which describe how to configure aspect of your phone system. There is a Glossary at the end of this Guide which explains the important concepts your phone system uses. 1.2 Other Guides There are other Guides which you may need to refer to when administering your phone system, and you will need to provide to the users of your phone system. These are: Metaswitch Hosted IP PBX End User Quick References. These are two page quick reference cards which describe the basic features of your new phones. You should distribute these Quick References to all of your end users. Metaswitch Hosted IP PBX End User Quick Start Guide. This is a quick guide to the basic and some of the more advanced features of your new phones. You should distribute copies of this document to all of your end users. Metaswitch Hosted IP PBX End User Guide. This is the more detailed version of the previous document, which describes how end users should use all of the functions and features of your phone system. You may only want to provide this guide to your more advanced power users, but you should understand its contents so you can provide help and guidance to your colleagues. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 7
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 2 CommPortal Business Group Administrator (BG Admin) CommPortal provides a web interface to your phone system, and allows end users and Business Administrators to modify their settings. There are two CommPortal interfaces. 1. The first is for regular users to manage their business telephony settings. 2. The second is for Business Administrators to modify both global settings for the business and to modify end-users' settings. The second of these interfaces is the one which you will use to administer the phone system and is described by this document. For more details on using the first interface, please see the Metaswitch Hosted IP PBX End User Guide. 2.1 Accessing CommPortal BG Admin To access the Business Group Administrator CommPortal interface point a browser at https://hosted.sp.net/bg. CommPortal is supported on Windows 2000, Windows XP, Windows 2003,Windows Vista and Windows 7, using the following browser versions: Internet Explorer 7 and above Mozilla Firefox 2.0 and above JavaScript must be enabled. 8 Table of contents Version 7.2 Issue 1 30 Sep 2010
2.2 Logging Into CommPortal BG Admin The following shows a sample CommPortal login page. To log into CommPortal, follow these steps: 1. Enter a phone number with administrative access 2. Enter the password 3. Click on Login. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 9
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 2.3 Using CommPortal BG Admin Once you are logged into CommPortal you are presented with the Business Group Administrator s homepage. Down the left hand side of this page are a series of links which take you to the different pages within CommPortal. The main panel shows the contents of the page you ve selected. In the top right hand the top of the page is the name of the user you are logged in as and icons which: Log you out of CommPortal. Refresh the current CommPortal page. Open a new browser window with detailed help on using the current page. 10 Table of contents Version 7.2 Issue 1 30 Sep 2010
3 Managing Lines with BG Admin The Lines page is the CommPortal Business Group Administrator s homepage and it will display once you ve logged in. This menu shows all the lines within the department that you are an administrator of. To view lines that are in sub-departments, select the sub-department using the dropdown list at the top of the page. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 11
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 3.1 Creating and Managing Departments The BG Admin has the ability to create departments within the business group. To create a business group follow these steps: 1. From the BG Admin Page select the Departments link on the left of the page. And click the Add Department button at the bottom of the page and the following dialog appears. 2. Enter the following information: 1. Department Name 2. Parent Directory If this is a top level department, you will use the Business Group Name. If this is a sub department, this will be the Upper level department 3. Operator Number Enter the number of the line that will act as operator for this department 4. If you plan to limit the number of calls allowed for this Department, enter the following information a. Incoming & Outgoing Enter the total number of combined concurrent calls that this department will be permitted to have active at any given time. b. Incoming Enter the total number of concurrent incoming calls that this department will be permitted to have active at any given time. c. Outgoing Enter the number of concurrent outgoing calls that this department will be permitted to have active at any given time. 12 Table of contents Version 7.2 Issue 1 30 Sep 2010
Example Departments: NOTE: To allow any mix of incoming & outgoing enter the same value in all three fields, or set both the Incoming and the Outgoing fields to Unlimited. 3.2 Moving Lines Between Departments To move lines between Departments, follow these steps: 1. Select the line using the checkbox to the left of the line 2. Select the department you wish to move the line to using the drop-down list at the bottom of the page. 3. Click on the Move button. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 13
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 3.3 Logging into a Users Account To log on as a regular user, follow these steps: 1. Select the Individual Line icon to the right of the line. 2. This will launch the regular CommPortal interface for that line in a new browser window. For more details on modifying settings on behalf of an individual user see the Metaswitch Hosted IP PBX End User Guide. 14 Table of contents Version 7.2 Issue 1 30 Sep 2010
4 Managing Phones with BG Admin To access the Phones page select the Phones link on the left hand side of the page. This page shows you all of the known phones in the current department. To view the phones in sub-departments, select a different department using the drop-down list at the top of the page. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 15
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 4.1 Modify Phone Description To change the description given to a phone, follow these steps: 1. Click on the current description of the phone. 2. Enter the new description. 3. Click on the Apply button. 4.2 Moving Phones between Departments To move a phone between departments, follow these steps: 1. Select the phone you wish to move using the checkbox to the left of the phone. 2. Select the department you wish to move the phone to using the drop-down list at the bottom of the page. 3. Click on the Assign to Department button. 16 Table of contents Version 7.2 Issue 1 30 Sep 2010
4.3 Assigning a Line to a Phone To assign a phone to a line, follow these steps: 1. Select the phone you wish to assign a line to using the checkbox to the left of the phone. 2. Enter the number of the line you wish to assign to the phone using the Enter number box at the bottom of the page. 3. Click on the Assign to Line button. 4.4 Removing a Line from a Phone You may wish to remove a line from a phone if, for example, the phone breaks and you need to assign a new phone to the user. To remove a line from a phone, follow these steps: 1. Select the phone by using the checkbox to the left of the phone. 2. Select the department the unassigned phone should be part of. 3. Click on the Assign to Department button. 4.5 Phone Profiles Note that managing phone profiles requires Adobe Flash version 9.0 or greater. 4.5.1 Managing Phone Profiles To manage the phone profiles for the department you are an administrator for, follow these steps: 1. Click the manage your phone profiles link towards the top of the page. 2. This launches a new window with the Phone Profile Editor. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 17
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 4.5.2 Adding a New Phone Profile By default a department does not contain any phone profiles. To add a new phone profile, follow these steps: 1. Click on the Create new profile button. 2. Select the type of phone you want to create a profile for. 3. Click on OK. 4. This creates a default profile for the phone. 18 Table of contents Version 7.2 Issue 1 30 Sep 2010
4.5.3 Modifying a Phone Profile To modify a phone profile, follow these steps: 1. Place your mouse over the picture of the phone whose profile you want to modify. 2. Select Edit from the drop-down list that appears. Configuration Views There are two views of the phone profile configuration: 1. The graphical phone view. To select this view, click on the phone icon at the bottom right of the window. This is the default view. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 19
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 2. A table view. To select the table view click on the table icon at the bottom right of the window. Graphical View To configure a phone key, follow these steps: 1. To see if a key can be configured place your mouse pointer over it. If the key glows blue it can be configured. If it glows red it cannot be configured. 2. To select a key to be configured, click on that key. 3. From the drop-down list select a function for this key. 20 Table of contents Version 7.2 Issue 1 30 Sep 2010
4. Select a label for this key. If the phone you are configuring has a display next to the key, this is the label which will appear on the phone display for that key. If you are assigning certain types of function to a key you will also need to enter a value for that key. The functions which require this extra value are: Speed Dial. The value is the telephone number to be called. Enhanced Speed Dial. The value is the telephone number to be called. Monitored Extension. The value is the extension number to monitor. Enhanced Monitored Extension. The value is the extension number to monitor. Directed Pickup. The value is the extension number you wish to pick up calls for. Paging Group. Select a paging group from the drop down menu. Depending on your phone model and the level of the phone service you have subscribed to these features may not all be available to you. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 21
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 5. Click on OK. 6. This change has now been temporarily stored to this phone profile. To permanently save a change click on Save changes. Note that changes will not be applied to the actual phones themselves until they are rebooted. Abandon any changes you have made in this session or since you last saved by clicking on Discard Changes. 22 Table of contents Version 7.2 Issue 1 30 Sep 2010
Table View To change the value of a setting, follow these steps: 1. Expand the levels in the table view until the setting you wish to change is visible. 2. Select the value for that setting by clicking on it. 3. Depending on the type of setting you are changing this will either give you a dropdown list to select a new value from or give you a text box to enter a value. Select or enter a value. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 23
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 4. To lock a setting so that neither end-users nor administrators of sub-departments can change it, select the Lock check-box. 5. To hide a setting so that neither end-users nor administrators of sub-departments can see it, select the Hide check-box. 6. To save your changes permanently click on Save changes. Changes won t be applied to the phones themselves until they are next rebooted. To abandon any changes you have made in this session, or since you last saved, click on Discard Changes. 4.5.4 Logging Out of Phone Profiles Close your browser window to log out of the Phone Profiles management. 24 Table of contents Version 7.2 Issue 1 30 Sep 2010
4.6 Modifying Phone Configuration as User To log into and modify the phone settings as one of your users, follow these steps: 1. Click on the Individual Line icon to the right of the phone. 2. Follow the instructions on using the Phone Configurator to manage the configuration of individual phones which are given in the Metaswitch Hosted IP PBX End User Guide. 4.7 Copying Phone Configuration To copy the configuration from one phone to another, follow these steps: 1. Modify the old phone as the user, by clicking on the Individual Line icon to the right of the phone. 2. Go to the table view, using the table view icon to the bottom right of the screen. 3. Select the Phone Profile object. 4. Select Edit->Copy. 5. Exit the Phone Configurator by closing the window. 6. Now log into the new phone as the user. 7. Go to the table view. 8. Select the Phone Profile object. 9. Select Edit->Paste. 10. Click on Save Changes. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 25
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 4.8 Installing a New Phone To install a new phone, follow these steps. 1. Ensure the phone is compatible with our service. If you have bought the phone from Metaswitch or one of our approved partners it will be compatible. 2. If you need to connect a PC to the network through the phone, connect the computer s ethernet cable into the PC jack of the phone. 3. Connect a spare telephone ethernet cable into the LAN or Network socket of the new phone and connect to you network jack. 4. The phone should now power up and retrieve its configuration from our server. 5. Once the phone has fully powered up, if there is no phone number configured on the phone you will need to assign the phone to a spare line to the phone using CommPortal. See Section 4.3 26 Table of contents Version 7.2 Issue 1 30 Sep 2010
Assigning a Line to a Phone for instructions on doing this. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 27
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 4.9 Replacing with an identical phone model To replace a phone with one of an identical model, follow these steps: 1. Using CommPortal, copy the configuration of the existing phone to the new phone by following the instructions in Section 4.7 Copying Phone Configuration.. 2. Using CommPortal, remove the existing phone from the phone line, by following the instructions in Section 4.4 Removing a Line from a Phone. 3. Using CommPortal, add the new phone to the line which was removed from the old line, by following the instructions in Section 4.3 28 Table of contents Version 7.2 Issue 1 30 Sep 2010
Assigning a Line to a Phone. Note: The new phone must be in the same department as the phone being replaced. If it isn t, you or another administrator with sufficient permissions must move the phone to the appropriate department before you can assign the line to it. Follow the instructions in Section 4.2 Moving Phones between Departments to perform this task. 4. Unplug the computer s ethernet cable from the old phone if one is plugged in. 5. Unplug the telephone ethernet cable form the old phone. 6. Plug the computer s ethernet cable into the PC socket of the new phone. 7. Plug the telephone ethernet cable into the new phone. 8. The new phone should now power up and retrieve its configuration from the server. The new phone will be configured identically to the old phone. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 29
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 4.9.1 Replacing with a different phone model To replace a phone with one of a different model, follow these steps: 1. Using CommPortal, remove the existing phone from the phone line, by following the instructions in Section 4.4 Removing a Line from a Phone. 2. Using CommPortal, add the new phone to the line which was removed from the old line, by following the instructions in Section 4.3 30 Table of contents Version 7.2 Issue 1 30 Sep 2010
Assigning a Line to a Phone. Note: The new phone must be in the same department as the phone being replaced. If it isn t, you or another administrator with sufficient permissions must move the phone to the appropriate department before you can assign the line to it. Follow the instructions in Section 4.2 Moving Phones between Departments to perform this task. 3. Unplug the computer s ethernet cable from the old phone if one is plugged in. 4. Unplug the telephone ethernet cable form the old phone. 5. Plug the computer s ethernet cable into the PC socket of the new phone. 6. Plug the telephone ethernet cable into the new phone. 7. The new phone should now power up and retrieve its configuration from the server. It will have the default configuration defined by any department profiles, and can now be configured by the phone user. For more information on department phone profiles, see Section 4.5 Phone Profiles. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 31
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 5 Managing Multiple Appearance Directory Numbers (MADNs) 5.1 Viewing MADNs The MADNs page displays all of the MADNs within your department. To view MADNs in sub-departments, select the sub-department from the drop-down list at the top of the page. 32 Table of contents Version 7.2 Issue 1 30 Sep 2010
5.2 Viewing and Modifying MADN To view more details about a MADN or change its settings click on the Groups icon to the right of the MADN number. 5.2.1 MADN Lines The MADN Lines tab displays all of the lines that will ring when the MADN is called. Adding Lines To add lines to the MADN, perform one of the following two steps: 1. If you know the number, enter it in the text box on the bottom right and click Add. 2. If you don t know the number, click on Add Lines. To select one or more lines to add, use the checkboxes to the left of the lines and click Add Selected. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 33
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL Removing Lines To remove a line from the MADN, follow these steps: 1. Select the line to remove using the checkbox to the left of it. 2. Click on the Remove Selected button. 34 Table of contents Version 7.2 Issue 1 30 Sep 2010
5.2.2 Other Settings The Other Settings tab shows you the Call Limit Algorithm in use for this MADN. 5.3 Changing MADN settings To view and change the settings for the MADN line, follow these steps: 1. Click on the Individual Line icon to the right of the MADN number. 2. This will open a new browser window and automatically log you into CommPortal for this number. Follow the instructions for configuring settings given in the Metaswitch Hosted IP PBX End User Guide. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 35
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 6 Managing Multi Line Hunt Groups (MLHGs) 6.1 Viewing MLHGs The MLHGs page displays all of the MLHGs in your department. To view MLHGs in sub-departments, select the sub-department from the drop-down list at the top of the page. 6.2 Moving MLHGs to another Department To move an MLHG between Departments, follow these steps: 1. Select the MLHG using the checkbox to the left of the MLHG. 2. Select the department you wish to move the MLHG to using the drop-down list at the bottom of the page. 3. Click on the Move button. 6.3 Viewing and Modifying MLHG To view the details of an MLHG and to modify its settings you first need to select that MLHG. Do this by selecting the Group icon to the right of the MLHG. 36 Table of contents Version 7.2 Issue 1 30 Sep 2010
This takes you to a series of tabs for that MLHG. 6.3.1 MLHG Pilots The MLHG Pilots tab displays any pilot numbers for this MLHG. A pilot number is one which when called, enters this MLHG. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 37
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 6.3.2 MLHG Lines This tab displays all of the lines which are members of this MLHG. There is an icon for each line which tells you whether each member is currently logged into this MLHG. Adding Lines To add lines to the MLHG, perform one of the following two steps: 1. If you know the number, enter it in the text box on the bottom right and click Add. 2. If you don t know the number, click on Add Lines. To select one or more lines to add, use the checkboxes to the left of the lines and click Add Selected. 38 Table of contents Version 7.2 Issue 1 30 Sep 2010
Removing Lines To remove a line from the MLHG, follow these steps: 1. Select the line to remove by using the checkbox to the left of it. 2. Click on the Remove Selected button. Changing Positions To change the positions of lines within the MLHG, follow these steps: 1. Click on the Change Positions button. 2. Move lines up and down using the icons. 3. Click on Apply. 6.3.3 Settings The Settings tab lets you view and change various settings for the MLHG. Preferences The Preferences page allows you to rename the MLHG. To rename the MLHG, follow these steps: 1. Type the new name in the text box. 2. Click on Apply. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 39
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL Hunt Settings The Hunt Settings page allows you to see the call distribution algorithm that is currently in use for this MLHG and other detailed MLHG settings. 40 Table of contents Version 7.2 Issue 1 30 Sep 2010
7 Managing Call Pickup Groups 7.1 Viewing Call Pickup Groups The Call Pickup Groups page displays all of the Call Pickup Groups in your department. To view Call Pickup Groups in sub-departments, select the sub-department from the drop-down list at the top of the page. 7.2 Moving Call Pickup Groups to another Department To move Call Pickup Groups between Departments, follow these steps: 1. Select the Call Pickup Group using the checkbox to the left of the Call Pickup Group. 2. Select the department you wish to move the Call Pickup Group to using the dropdown list at the bottom of the page. 3. Click on the Move button. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 41
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 7.3 Adding Call Pickup Groups To create a new Call Pickup Group, follow these steps: 1. Click on Add Group. 2. Enter the name of the new Call Pickup Group in the text box. 3. Click on Add. 7.4 Deleting Call Pickup Groups To delete a Call Pickup Group, follow these steps: 1. Select the Call Pickup Group using the checkbox to the left of the Call Pickup Group. 2. Click on the Remove Selected button. 7.5 Viewing and Modifying Call Pickup Groups To view the details of a Call Pickup Group and to modify its settings, follow these steps: 1. Select that Call Pickup Group by selecting the Group icon to the right of the Call Pickup Group. 2. This takes you to a series of tabs for that Call Pickup Group. 42 Table of contents Version 7.2 Issue 1 30 Sep 2010
7.5.1 Managing Call Pick Up Group Lines The Lines tab displays all the lines in this Call Pickup Group. Adding Lines To add lines to the Call Pickup Group perform one of the following two operations: 1. If you know the number, enter it in the text box on the bottom right and click Add. 2. If you don t know the number, click on Add Lines. To select one or more lines to add, use the checkboxes to the left of the lines and click Add Selected. Removing Lines To remove a line from the Call Pickup Group, follow these steps: 1. Select the line to remove by using the checkbox to the left of it. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 43
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 2. Click on the Remove Selected button. 7.5.2 Settings The Settings tab lets you view and change the name of the Call Pickup Group. To change the name, follow these steps: 1. Enter the new name in the text box. 2. Click Apply. 44 Table of contents Version 7.2 Issue 1 30 Sep 2010
8 Managing Short Codes 8.1 Viewing Short Codes The Short Codes page displays all of the Short Codes in your department. To view Short Codes in sub-departments, select the sub-department from the dropdown list at the top of the page. To view all of the Short Codes for all departments, select View All from the department drop-down list. 8.2 Moving Short Codes to another Department To move Short Codes between Departments, follow these steps: 1. Select the Short Code or Short Code range using the checkbox to the left of the Short Code or Short Code range. 2. Select the department you wish to move the Short Code or Short Code range to using the drop-down list at the bottom of the page. 3. Click on the Move button. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 45
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 8.3 Adding Short Codes To create a new Short Code, follow these steps: 1. Click on Add. 2. Enter the number of the Short Code to add. 3. Enter the telephone number or internal code the Short Code should dial. 4. Click on Add. 8.4 Adding Short Code Ranges To create a new Short Code range, follow these steps: 1. Click on Add Range. 2. Enter the first and last numbers of the Short Code range to add. 3. Enter the telephone number or internal code the first Short Code in the range should dial. Then enter the telephone number or internal code for the last Short Code in the range. 4. Click on Add. 46 Table of contents Version 7.2 Issue 1 30 Sep 2010
8.5 Deleting Short Codes and Short Code Ranges To delete Short Codes and Short Code Ranges, follow these steps: 1. Select the Short Code or Short Code range using the checkbox to the left of the Short Code or Short Code Range. 2. Click on the Remove Selected button. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 47
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 8.6 Modifying Short Codes To modify an existing Short Code, follow these steps: 1. Click on either the Short Code number or the number the Short Code dials. 2. Modify the details. 3. Click on Save. 48 Table of contents Version 7.2 Issue 1 30 Sep 2010
8.7 Modifying Short Code Ranges To modify an existing Short Code Range, follow these steps: 1. Click on either the Short Code Range numbers or the numbers the Short Code Range dials. 2. Modify the details. 3. Click on Save. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 49
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 9 Managing Extensions 9.1 Viewing Extensions The Extensions page displays all of the Extensions in your business. 9.2 Adding Extensions To create a new Extension, follow these steps: 1. Click on Add. 2. Enter the number of the Extension to add. 3. Enter the telephone number of the line in your business that this Extension should map to. 4. Click on Add. 50 Table of contents Version 7.2 Issue 1 30 Sep 2010
9.3 Adding Extension Ranges To create a new Extension range, follow these steps: 1. Click on Add Range. 2. Enter the first and last Extension numbers to add. 3. Enter the telephone number of first line in your business that this Extension range should map to. 4. Click on Add. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 51
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 9.4 Deleting Extensions and Extension Ranges To delete Extensions and Extension Ranges, follow these steps: 1. Select the Extension or Extension range using the checkbox to the left of the Extension or Extension Range. 2. Click on the Remove Selected button. 9.5 Modifying Extensions To modify an existing Extension, follow these steps: 1. Click on either the Extension number or the phone number of the Extension. 2. Modify the details. 3. Click on Save. 52 Table of contents Version 7.2 Issue 1 30 Sep 2010
9.6 Modifying Extension Ranges To modify an existing Extension Range, follow these steps: 1. Click on either the Extension Range numbers or the phone numbers the Extension Range dials. 2. Modify the details. 3. Click on Save. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 53
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 10 Managing Account Codes 10.1 Viewing and Modifying Account Code Settings The Account Codes page displays all of your business s account code settings. 54 Table of contents Version 7.2 Issue 1 30 Sep 2010
10.2 Modifying Settings 10.2.1 Modifying Call Types Requiring Account Codes Use the checkboxes to specify which types of calls will require Account Codes: International Whether account codes are required for calling international numbers. Local Whether account codes are required for local calls. Premium Rate Whether account codes are required for premium rate (1-900 number) calls. Regional Whether account codes are required for regional calls. National Whether account codes are required for long distance calls. Operator Whether account codes are required for operator calls. Directory Whether account codes are required for directory (411) calls. Carrier Dialed Whether account codes are required to make calls when dialing a carrier code (such as 1010000). Local Business Group Whether account codes are required for local calls to other numbers within your business. Normally calls within your business will be local calls, but if you have multiple sites calls between numbers may be regional or national calls. In this case you need to use the Other Business Group setting. Other Business Group Whether account codes are required for non-local calls to other numbers within your business Note: You cannot require an account code for emergency calls, toll-free calls, or calls to service access codes. Once you have selected the call types, click Apply to save your changes. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 55
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 10.2.2 Choosing Validated or Non-validated Account Codes To use Validated Account Codes, follow these steps: 1. Check Yes after User validated account codes. 2. Click Apply. To use Non-validated Account Codes, follow these steps: 1. Check No after User validated account codes. 2. Click Apply. 10.2.3 Setting Account Code Length To specify the length that should be used by your account codes, follow these steps: 1. Enter the length in the text box after Account code length:. 2. Click Apply. 10.2.4 Blocking Access after Incorrect Account Codes If you are using Validated Account Codes, a user s phone line will be blocked after an incorrect account code is entered too many times in succession. To change the number of incorrect entries the user is allowed, follow these steps: 1. Enter the value in the text box after Max incorrect attempts before account is blocked:. 2. Click Apply. 56 Table of contents Version 7.2 Issue 1 30 Sep 2010
10.2.5 Setting Individual Line Properties To specify whether various settings can also be specified for each line in your business, perform one of the following operations. To allow which types of calls require account codes to be changed for each line, check Call types may be overridden per line. To allow the length of account codes to be changed for each line, check Account code length may be overridden per line. To allow lines to view the account codes that you have defined for the whole business, check Lines may view business group account codes. Set whether each line should be able to view, or both view and change, or not view their own account codes by selecting the relevant setting from the dropdown list at the bottom of the Account Code Options section. If you want to have per line account codes, but don t want the user to be able to configure these, configure these by logging on to CommPortal as that user. This is described in Section 10.3 Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 57
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL Viewing and Modifying Account Code Settings for a Line. Once you have made your changes, click Apply to save them. 58 Table of contents Version 7.2 Issue 1 30 Sep 2010
10.2.6 Configuring Account Codes To modify the account codes, follow these steps: 1. Click on Edit List. 2. To add an account code, follow these steps: Enter the code in the Account code text box. Enter the description in the Description text box. Click on Add. 3. To remove an account code, click the trash can icon to the right of the account code. 4. To change the description of an account code, remove it and then re-add it with the new description. 5. Once you have finished making changes, click on OK. 6. To save your changes you must now click Apply. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 59
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 10.3 Viewing and Modifying Account Code Settings for a Line If you want to view or change a particular line s account code settings, follow these steps: Change the settings to allow you to do this as described in Section 10.2.5 60 Table of contents Version 7.2 Issue 1 30 Sep 2010
Setting Individual Line Properties. 7. Go to the Lines page in CommPortal and log in as the line whose settings you wish to change, as described in Section 3.3 Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 61
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL Logging into a. 8. Once you have logged in as this user, follow the instructions for modifying Account Codes in Metaswitch Hosted IP PBX End User Guide. 62 Table of contents Version 7.2 Issue 1 30 Sep 2010
10.4 Viewing Business Group Call Logs The Call Logs page enables Business Group Administrators with the appropriate permissions to access Business Group Call Logs. The Call Logs menu button is only available if the associated MetaSphere CFS has Business Group Call Logs enabled. The BG Administrator can click on the Call Logs menu button to launch a new page that allows them to export call logs for their Business Group fragment, and any departments under their control within their Business Group fragment, including. Request a report containing the logs of all calls made (up to a month at a time) to and from lines within their administration domain (whole business group or department and sub-departments) Filter call logs specifying a date range, and/or by department domain if the Business Group has them. Error messages are displayed if any of these filters are set to incorrect values. The UI will validate these filters once the Download button is clicked, and then display a dialog box while the report downloads. The BG Admin cannot access the main page or navigate to another page during this process, although they can cancel the operation. These call logs can then be imported into other programs, for example Microsoft Excel. When using Microsoft Excel, the BG Admin should use the Import Data menu option and change the data format of all telephone number columns to text to ensure that the telephone numbers in the call logs are displayed correctly. To download Call Logs follow these steps: 1. From the BG Admin page select the Call Logs link from the left of the page and the following appears Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 63
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 2. Enter the time frame (up to 30 days) and the department for the call logs that you would like to see. 3. Click the Download button. After the report is generated the following appears 4. Select the program to open the file or select save file. 64 Table of contents Version 7.2 Issue 1 30 Sep 2010
11 Viewing External Calls Settings The External Calls page lets you view the settings that are in place for calls that are external to your business. External Calls This can take one of the following values: Not Permitted Calls outside of your business are not permitted. Unlimited There is no explicit limit to the number of concurrent external calls you can have, but there may be a limit to either the number of Incoming or Outgoing Calls you can make. Limited There is a limit to the number of concurrent calls you can have to outside of your business. Maximum number of external calls If the value of External Calls is Limited, the value of this setting specifies how many concurrent external calls there may be at any time. Incoming Calls This can take one of the following values: Not Permitted Inbound calls from outside of your business are not permitted. Unlimited There is no limit to the number of concurrent incoming external calls you can have, although you are still subject to any Maximum number of external calls. Limited There is a limit to the number of concurrent calls you can have from outside of your business. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 65
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL Maximum number of simultaneous incoming calls If the value of Incoming Calls is Limited, the value of this setting specifies how many concurrent incoming external calls there may be at any time. Outgoing Calls This can take one of the following values: Not Permitted Outgoing calls to outside your business are not permitted. Unlimited There is no limit to the number of concurrent outgoing external calls you can have, although you are still subject to any Maximum number of external calls. Limited There is a limit to the number of concurrent calls you can have to outside of your business. Maximum number of simultaneous outgoing calls If the value of Outgoing Calls is Limited, the value of this setting specifies how many concurrent incoming external calls there may be at any time. Local carrier code This is a code that identifies which carrier will be used for any local calls your business makes. It is sometimes called PIC2. Long distance carrier code This is a code that identifies which carrier will be used for any long distance calls your business makes. It is sometimes called PIC1. International carrier code This is a code that identifies which carrier will be used for any international calls your business makes. It is sometimes called PIC3. 66 Table of contents Version 7.2 Issue 1 30 Sep 2010
12 Viewing Number Blocks The Number Blocks page displays all of the telephone numbers which we have assigned to your business. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 67
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 13 Auto-Attendant Easy / Premium Attendant 13.1 Overview MetaSphere provides two solutions for Auto Attendant functionality. Easy Attendant offers a very simple automated telephone menu. Callers to a business are directed to the automated TUI, providing key options to transfer to specific departments or individuals in the business, to transfer to a voicemail account directly, or to listen to a recorded announcement. You can choose to have either a single menu that plays when Easy Attendant is turned on, or two different menus for business and non-business hours that are used according to a pre-defined schedule. When Easy Attendant is turned off, you can either forward callers to another telephone number or play a message informing the caller that your business is currently closed. Premium Attendant, aimed at small and medium business subscribers, offers an increased level of service compared to Easy Attendant. In addition to all the features offered by Easy Attendant, Premium Attendant allows multiple menus with a finer scheduling control. It also includes more call handling options, such as Voicemail by Name and Voicemail by Extension, as well as greater control over the actions taken for any given key press. 68 Table of contents Version 7.2 Issue 1 30 Sep 2010
13.2 Easy Attendant This section outlines the required steps for configuring Easy Attendant. 13.2.1 Planning Your Easy Attendant Before you start to set up your Easy Attendant, it is a good idea to sketch out the operation of each menu on paper. This allows you to plan what options you need from the menu and how each one will operate. For example, the main menu for a pizza company may need to include the following options: 1. Play an announcement giving directions to the store, then return to the main menu so that the user can select another option. 2. Place an order with a server. 3. Speak to the manager. 4. Speak to another employee using dial-by-name. The sketch below shows how this menu would operate, including the key presses to access each option: In the diagram, option 1 (directions to the store) is shown with an arrow returning to the main Welcome menu so that the caller can select another option if required. This is because this option is playing a recording. The other options do not allow the return to the menu. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 69
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL For out-of-hours and holiday operation, the Auto Attendant may provide an announcement that the store is closed (without allowing the caller to select any options), or it may provide an alternative set of menu options. 13.2.2 Configuring Easy Attendant To configure your Easy Attendant log into the Auto-Attendant, following these steps: 1. From the BG Administrator portal, select "Lines" and then click the "Individual Line" icon on the far right side of the page. As an alternative, you can access the CommPortal user login screen and enter the Easy Attendant Number and Password 2. The Screen then displays the Easy Attendant portal. 70 Table of contents Version 7.2 Issue 1 30 Sep 2010
3. Begin Configuring your auto attendant by selecting either a single menu or a scheduled menu for business hours and non-business hours 4. If using a scheduled menu, begin setting up your Easy Attendant by recording the initial greeting by selecting the "listen/change" option on the lower right of the screen. 5. Now you are ready to define the specific menu items as defined in your plan to one of the following options. Play Announcement Transfer to Phone Transfer to Voicemail Dial by Extension Dial by Name 6. Repeat Steps 4 and 5 above for the Non-Business Hours menu. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 71
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 7. Next you will need to establish your working hours by selecting the Schedule tab. Once in the Schedule screen, click on the Business Hours key and then click in the calendar and while holding down the left mouse button drag the mouse across the calendar to indicate the business hours. In the example below, the Business Hours are Monday Friday from 9:00 am until 5:00 PM. Any other time are considered non-working hours. 8. Next you will need to select any non-working days such as holidays by clicking on the calendar icon in the Special Days section of the Schedule page. You can choose individual non-working days by clicking on the date in the calendar, or you can use the Choose Public Holidays option to automatically add public holidays for your region. 72 Table of contents Version 7.2 Issue 1 30 Sep 2010
9. If you will be using Dial by Name, then you will need to define which extensions will participate in dial by name and record the names of users in the extensions tab. To include or exclude and extension from dial by name, select the extensions as shown below and then click either Mark as Included or Mark as Excluded. To record the users name click on the record link for the user. 10. The final step in this process is to activate you Easy Attendant by clicking the Turn On button from the Main Tab. Your Easy Attendant is now active. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 73
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 13.3 Premium Attendant This section outlines the required steps for configuring Premium Attendant. 13.3.1 Planning Your Premium Attendant Before you start to set up your Premium Attendant, it is a good idea to sketch out the operation of each menu on paper. This allows you to plan what options you need from the menu and how each one will operate. For example, the main menu for a sales company may include the following options: 1. Have a schedule Attendant. 2. Provide a main menu for business hours that provides the companies default greeting and menu. 3. Have the ability to transfer to a sales menu that provides additional menu options 4. Transfer to speak with the Billing department. 5. Dial by name 6. Dial by extension 7. Transfer to an operator. The sketch below shows how this menu would operate, including the key presses to access each option: 74 Table of contents Version 7.2 Issue 1 30 Sep 2010
For out-of-hours and holiday operation, the Auto Attendant may provide an announcement that the store is closed (without allowing the caller to select any options), or it may provide an alternative set of menu options. 13.3.2 Logging into Premium Attendant To configure your Premium Attendant log into the Auto-Attendant, following these steps: From the BG Administrator portal, select "Lines" and then click the "Individual Line" icon on the far right side of the page. As an alternative, you can access the CommPortal user login screen and enter the Easy Attendant Number and Password. The Screen then displays the Easy Attendant portal Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 75
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 13.3.3 Configuring Premium Attendant Schedule Configure your weekly schedule by clicking on the Weekly Schedule and Holidays icon. Once in the Schedule screen, click on the Business Hours key and then click in the calendar and while holding down the left mouse button drag the mouse across the calendar to indicate the business hours. In the example below, the Business Hours are Monday Friday from 9:00 am until 5:00 PM. Any other time are considered nonworking hours. 76 Table of contents Version 7.2 Issue 1 30 Sep 2010
Next you will need to select any non-working days such as holidays by clicking on the calendar icon in the Periods section of the Schedule page. You can choose individual non-working days by clicking on the date in the calendar, or you can use the Choose Public Holidays option to automatically add public holidays for your region. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 77
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 13.3.4 Configuring Premium Attendant Announcements In order to use your Premium Attendant you will need to record the announcements that will be played as either you primary Business Hours and Non-Business Hours greeting as well as any other recorded announcements required. The example in 13.3.1 would require three announcements, one each for Business Hours, Non-Business hours and the Sales menu. Click in the Announcements tab to begin configuration. 78 Table of contents Version 7.2 Issue 1 30 Sep 2010
Click the Add New Announcement button. And follow the steps below. Enter the name and description of your announcement, then you can record the announcement. The record your announcement using a microphone or headset connected to your computer, click the Red record button. When finished recording press the stop button and click on the Add button at the bottom of the interface. To upload pre-recorded announcements click on the Upload Announcement button and browse to the location of your announcement and click upload. After you upload has completed click the Add button. To record the announcement using your telephone, create the announcement by adding a name and description and click on the Record By Phone icon. Make a note of the Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 79
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL announcement number and then click on the Add button. Next dial the main number for your Premium Attendant service provided by your service provider, enter the number for your Premium Attendant, enter the pin and enter follow the prompts to record your announcement using the announcement number noted in the previous step. 80 Table of contents Version 7.2 Issue 1 30 Sep 2010
13.3.5 Configuring Premium Attendant Menus Next you will need to set up your Premium Attendant menu options. By default there are two menus defined in Premium Attendant. These could be used as your main business hours menu and you main non-business hours menu. You can additional menus as required by clicking the Add Button Begin to configure your menu by providing a name and description and selecting the Menu announcement to be used by this menu, and then click apply Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 81
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL Next you will need to configure the action for each key pressed for your menu by selecting the Keys link and selecting an option using the dropdown menus for each key pressed in the menu. The Options available are as follows: Use Default (This option is default for all keys for new menus Transfer to Phone Transfer to Voicemail (COS Controlled) Dial by Extension (COS Controlled including whether an announcement is automatically played giving initial instructions when this key is pressed, or whether these instructions must be recorded by the subscriber in the menu announcement) Dial by NameDial by Name (CoS controlled) Voicemail by Extension (CoS controlled) Voicemail by Name (CoS controlled) Transfer to Operator (CoS controlled, and only available for Premium Attendants in a Business Group) Intercept mailbox (CoS controlled) Go to Menu Return to Previous Menu Replay Menu Announcement Return Announcement Hang up Hang up 82 Table of contents Version 7.2 Issue 1 30 Sep 2010
Next you will need to configure the Timeout behavior of your menu to address callers that do not press a key in this menu. Enter timeout duration and the timeout behavior from the dropdown list as seen below and click apply. Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 83
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 13.3.6 Configuring Premium Attendant Extensions If you plan on using dial by name or dial by extension, you will need to select the extensions and record a name for the dial by name. To start click the Extensions tab. And select the extensions you wish to be added or excluded and click either the Mark as Included or Mark as Excluded. To record names to be used for dial by name, click the listen/change icon and record the name using the recording interface shown below And click the Save button. 84 Table of contents Version 7.2 Issue 1 30 Sep 2010
13.3.7 Configuring Premium Attendant Advanced Options In order to configure the advanced setting for your Premium Attendant, click on the advanced tab and define the default handling for each key press. These actions will be available to callers in all menus unless you assign an alternative action to the key in the per menu configuration. Next Click on the Error Handling link and set the value and behavior for Timeout, Call Transfers, Unknown Input and Invalid Extensions Metaswitch Hosted IP PBX Metaswitch Proprietary and Confidential 85
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 13.3.8 Activating Premium Attendant Finally you will need to activate you Premium Attendant by going to the Main page and selecting the Turn On button. The Premium Attendant interface uses the following error messages and icons to alert you to incorrect or missing configuration. These are produced on page load, and are not updated dynamically. o o o The Main tab has a Service Status panel that states your current schedule period and the menu that callers will hear. It also reports if you have errors in any menus, or one or more announcements is missing audio. The Schedule and Menus pages use a banner line to report any errors. The following icons are used to indicate incorrect or incomplete configuration error icon warning icon If there are any errors in your configuration, you will be warned against turning on Premium Attendant, and in some cases this will be prohibited. 86 Table of contents Version 7.2 Issue 1 30 Sep 2010
14 Music on Hold 14.1 CommPortal Access 14.1.1 Logging In To log into the Music On Hold system click the Music On Hold link at the bottom of the left hand side of CommPortal. This opens up a new browser window with the Music On Hold administration system. If you are the administrator for the top-level department of your business then you will see three links at the top of the page, each taking you to a different section of the Music On Hold administration system. Security View and configure your security settings. Mappings This section allows you to configure different recordings to be played when different lines within your business put callers on hold. Resources This section allows you to upload and manage your recordings. If you are not an administrator for the top-level department of your business you will not see Resources as only administrators for the top-level department can manage recordings. Version 7.2 Issue 1 30 Sep 2010 Music on Hold 87
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 14.1.2 Viewing and Changing Your Security Settings To view your security settings, select the Security section. As well as accessing the Music On Hold system using CommPortal, you can also use your phone to access it. Using this page you can view and change the password you will need to enter to use the phone access. To change your password, follow these steps: 1. Enter the new password in the text box. 2. Click Apply. 88 Music on Hold Version 7.2 Issue 1 30 Sep 2010
14.1.3 Managing Recordings To access the recordings section, click on the Resources link. Need new screen shot Global Media List The Global Media List section specifies any recordings that we have made available for your use. Whether we make any recordings available to you depend on which service you have subscribed to. You can t add or remove recordings from the Global Media List. Your Own Recordings The second section displays any recordings that you have uploaded to the system, either using this web interface or via the phone access. Recording Limits At the bottom of this section you will see: Version 7.2 Issue 1 30 Sep 2010 Music on Hold 89
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL How many MB of storage you have used. How many MB of storage you are allowed. How many recordings you have uploaded. How many recordings you are allowed. The system will not allow you to exceed either your storage limit or the maximum number of recordings you are allowed. Recording Formats You can upload recordings to the system in either WAV or MP3 format. Adding a Recording To add your own recording, follow these steps: 1. Enter an ID for this recording in the ID text box. This ID must be between 10 and 99. 2. Enter a description for this recording in the Description text box. 3. Click on Browse and select the recording you wish to upload. This must be either a.wav or.mp3 file. 4. Click on Add. Depending on the size of the recording you are uploading this process may take a few seconds. Modifying a Recording To change the description of a recording, follow these steps: 1. Click on the Edit button to the right of the recording. 2. Edit the Description field. 3. Click Save. To change the volume at which a recording will play, follow these steps: 1. Click on the Edit button to the right of the recording. 2. Select a new Gain value from the drop-down list. Select 0 to play the recording at its original volume, Select +1, +2 or +3 to play the recording louder, with +3 being the loudest. 90 Music on Hold Version 7.2 Issue 1 30 Sep 2010
Select -1, -2 or -3 to play the recording quieter, with -3 being the quietest. 3. Click Save. Playing a Recording You can play a recording that you have uploaded by clicking on the ID or Description link for that recording. Note that this will play the recording at its original volume the Gain setting has no impact on playing a recording through this interface. If you want to check the effect of changing the volume of a recording you should log into the phone interface and play the recording from there. For more details on this, see Section Error! Reference source not found. Error! Reference source not found.. Removing a Recording To remove a recording click on Delete to the right of the recording you wish to delete. 14.1.4 Assigning Recordings to Lines You can assign recordings either to all lines in your business, or different recordings per line. To do this you need to access the mappings section. You will now see a list of mappings between the directory numbers of lines in your Business Group or department and the Music On Hold resources that each line uses. If the department you are an administrator of has one or more sub-departments, you will see links to these at the bottom of the screen. Version 7.2 Issue 1 30 Sep 2010 Music on Hold 91
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL To manage resources for a line that is in a sub-department, click on the link for that sub-department. When you have followed the link to a sub-department, an additional link appears at the top of the screen, allowing you to move back up to the parent department. There is always a Default mapping, which is used if you don t specify a mapping for a particular line. Each mapping consists of a series of fields which you can set: An Initial resource, or recording, which is played when the call is put on hold. Optionally a Follow-up resource, or recording, which may be played depending on the Action. An Action, which can be one of: Repeat The initial recording is played continually. Play Once The initial recording is played once, and then the follow-up recording is playing continually. Repeat Initial Interrupted The initial recording should be interrupted at set intervals by the follow-up recording. This could be used to interrupt music with an announcement indicating that the user is in a queue. Repeat Follow-up Interrupted The initial recording is played first. Then the follow-up recording plays continually being interrupted by the first recording. The Start point field indicates whether the recording will start at the beginning (the value Start indicates this) or whether it should start at a random point of the recording (the value Random indicates this). The Duration field which is used by the Repeat Initial Interrupted and Repeat Follow-up Interrupted actions to indicate how often the repeated recording should be interrupted. Adding a Mapping To add a mapping for a particular line, follow these steps: 1. Set the fields to the left of the Add button. 2. Click on Add. Modifying a Mapping To modify either the Default mapping, or the mapping for a line, follow these steps: 92 Music on Hold Version 7.2 Issue 1 30 Sep 2010
1. Click Edit to the right of the mapping. 2. Modify the fields. 3. Click on Save. You cannot modify the telephone number that a mapping applies to. If you need to do this, remove the mapping and add a new one. Removing a Mapping To remove a mapping click on the Delete button to the right of the mapping. You cannot delete the default mapping. 14.2 Phone Access Using this interface you can: Listen to the music or other recordings for the default mapping or the mapping you have configured for any of your lines. Listen to the Global Media Resources we have made available. Create, change or delete your own recordings. 14.2.1 Logging In To access the telephone interface for Music On Hold, dial 555-555-5555 from your phone. To log in you need to enter: 1. Your telephone number. 2. Your Music On Hold password. You can view or change this by using CommPortal as described in Section 14.1.2 Version 7.2 Issue 1 30 Sep 2010 Music on Hold 93
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 14.2.2 Using Viewing and Changing Your Security Settings. The telephone interface is menu driven with voice prompts, so listen to the prompts and then press the keys on your phone to select which option you would like. For your convenience the top-level menus provided by the telephone interface are documented here: *. Press * at any time to go back to the previous menu. 1. Listen to resource for default mapping. This will play you the recording which is played to callers on hold for extensions which do not have their own mappings. 2. Listen to resource for particular extension. This will play the recording which is played to callers on hold on a particular extension. 3. Listen to global resources. This allows you to listen to the recordings in the Global Media List, described in Section 14.1.3 94 Music on Hold Version 7.2 Issue 1 30 Sep 2010
Managing Recordings. You will need the 2 digit resource ID of the recording you want to listen to. 4. Manage existing local resources. This allows you to modify or delete recordings you have added to the Music On Hold system, including recording a new resource to replace an existing one. You will need the 2 digit resource ID of the recording you want to modify or delete. 5. Record new local resource. This allows you to record a new resource over the phone. Version 7.2 Issue 1 30 Sep 2010 Music on Hold 95
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 15 Glossary This appendix describes the important concepts used in your phone system. 15.1 CommPortal CommPortal provides a web interface to your phone system, and allows end users and Business Administrators to modify their settings. There are two CommPortal interfaces. 1. The first is for regular users to manage their business telephony settings. 2. The second is for Business Administrators to modify both global settings for the business and to modify end-users' settings. The second of these interfaces is the one which you will use to administer the phone system and is described by this document. For more details on using the first interface, please see the Metaswitch Hosted IP PBX End User Guide. 15.2 Logging Into CommPortal as Another User You may at times need to log into CommPortal on behalf of another user. This will enable you to view and modify the user s settings just as that user can by using the regular CommPortal interface. Here are some examples of when this would come in useful. If a user has forgotten their password you can log on and change the password to a new value. If the user is unable to access CommPortal but needs a setting changed urgently, such as Call Forwarding, you can log on and do it for them. There are a few differences between the regular CommPortal interface and what you will get to see when you log in as another user. The Dashboard page is not available so by default CommPortal takes you to the Call Manager page. The Voicemail page is not available for privacy reasons. 96 Glossary Version 7.2 Issue 1 30 Sep 2010
15.3 Phones The Hosted VoIP solution supports a number of different types of phone. These have different keys from each other and differ in their operation. For specific instructions on using the phones, please see the Metaswitch Hosted IP PBX End User Quick Start Guide and the Metaswitch Hosted IP PBX End User Guide. 15.4 Phone Numbers Every phone line within your business has its own DID (Direct Inward Dial) number, which is a regular 10 digit number including the area code, such as 555-555-5556. Within your business you are able to assign extension codes to these phone numbers. These are shorter numbers (typically 3 or 4 digits although they can be longer) which enable your employees to quickly call each other. Your phone system is capable of having multiple lines configured on a single phone. You could configure one line on a phone which is that employee s personal DID, and another line which is your business s main switchboard number. Calls to both numbers will make this one phone ring. Your phone system is also capable of sharing lines between phones. This means that in the example above, each phone in your business could have its own DID line, and a second line which is your business s main switchboard number. Then every phone would ring when a call came into your switchboard. We will assign your business one or more blocks of numbers which you can then assign to phones as you wish. You can then define your own extension codes which map to these numbers. Alternatively, if you have asked us to, we will have preconfigured your system so that the phone numbers and extension codes are already assigned. Version 7.2 Issue 1 30 Sep 2010 Glossary 97
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 15.5 MAC addresses Every phone has a unique identifier called a MAC address. The phone system uses this identifier to uniquely identify a phone. This MAC address is printed on a sticker on the phone, usually underneath. It consists of 6 groups of 2 letters or numbers, and will be printed in one of two forms: FE:DC:BA:12:34:56 FEDCBA123456 15.6 Departments Many smaller businesses will only have a single administrator, or a number of administrators who all manage the entire phone system. However, if you work in a larger enterprise you may have different administrators each with responsibilities for the phones of different parts of your organization. Therefore our Hosted IP PBX solution supports the concept of departments. Every phone line and phone is a member of a department. Departments are hierarchical, with some departments having sub-departments. An administrator of a department is permitted to manage all phones, lines and other resources within that department. They are also allowed to manage the sub-departments. Even the smallest business will have at least one department in the phone system, known as the top-level or root department, and where there is only one department all of the phone lines and phones will be part of this. Larger businesses will have multiple departments, and phones and lines can be moved around these departments to allow different administrators to manage them. An administrator s phone line is always part of the department he is the administrator for. Moving the administrator s line to a different department will remove his permissions for managing the department he used to be in, and give him permissions to manage his new department. 98 Glossary Version 7.2 Issue 1 30 Sep 2010
15.7 Phone Profiles A department s Phone Profiles consist of default phone configuration which will be automatically applied to all phones within that department. There is a different profile for each type of phone within the department. As an example, a department may deploy three types of phones: Aastra 53i Aastra 55i with 3 560M sidecars Aastra 57i with a 536M sidecar In this case a department can have up to three profiles one for each type of phone. A department inherits the phone profiles from any parent departments, so parent departments can specify some elements of a phone s configuration, and the subdepartment can configure others. 15.7.1 Phone Profile Graphical View You can configure the keys of the phone using the graphical view so that the phones used by people in your department will contain these settings by default. For example you can configure a key to access voicemail which will be configured on every phone in your department. 15.7.2 Phone Profile Table View The table view allows you to configure a wider range of settings than just key settings, and provides a more powerful interface. Lock settings so that neither end-users nor administrators in sub-departments can override settings. Hide settings so that neither end-users nor administrators in sub-departments can view settings. Configure ringtones. Configure the phone display. Configure the time and date format, and time zone. Note: the exact options available to you will depend on your phone model and the level of phone service you have subscribed to. In some cases there may be more advanced features available to you. Version 7.2 Issue 1 30 Sep 2010 Glossary 99
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 15.7.3 Copying Phone Configuration If you need to replace a user s phone for them, because the old one breaks, you may have to copy the configuration of the old phone to the new phone. This is described in section 4.7. Note: Copying phone settings is only supported if you are replacing the old phone with a new phone of exactly the same model. If you are upgrading the phone, you or the user will need to manually apply any settings to the new phone. 15.8 Network The phones for your Hosted IP PBX use an ethernet-based network to communicate with our systems. This is the same technology that provides computers with access to a network. These phones are also powered via ethernet so if you have a compatible ethernet switch there is no need for separate power connections to the phones. Most of the phone models can also provide network access to the computers at users desks. This means only a single network connection needs to be run to each desk. As your telephone calls travel over an IP network the quality of the network in your offices is very important. Normally we or one of our partners will either supply and install your network, or verify that your network is suitable for Hosted VoIP. However, it s very important that you only connect the right type of network device to the right network connection. If you connect the wrong type of equipment to your network then it may reduce the quality of your telephone calls, or even stop your telephone system working altogether. We will tell you when we install or verify your network which connections can be used for what. 100 Glossary Version 7.2 Issue 1 30 Sep 2010
15.9 Multiple Appearance Directory Numbers A Multiple Appearance Directory Number (MADN) is a telephone number with no phone or line associated with it. Instead the MADN is configured to have a number of MADN members, each of which is a number with a line associated with it. Whenever a call comes in to the MADN all of the lines whose directory numbers are MADN members will be rung. When any of these phones is answered the rest of the phones will stop ringing. A line may be a member of one more than one MADN. In this case it rings when a call comes in to any of the MADNs that the line is a member of. MADNs can also be configured to enable queuing. If configured, calls which come in to a MADN whose members are all busy will be queued. These queued calls will receive Music on Hold if you have subscribed to this feature. You can configure to allow calls direct to a MADN member's directory number (rather than to the MADN itself). If permitted, these calls bypass the MADN and use the called number's services. Similarly, calls made from the MADN member's phone use the line's caller ID and call services rather than those of the MADN, although you can configure the calling party number on these lines to match the MADN number if required. Version 7.2 Issue 1 30 Sep 2010 Glossary 101
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 15.10 Multi Line Hunt Groups A Multi Line Hunt Group allows sequential ringing of available phones for use in applications such as call centers. An MLHG consists of a number of lines within the business group, known as members. When a call comes into the hunt group, a hunt algorithm will decide which phone to ring. If this phone is busy or is not answered the hunt algorithm will move on to another phone. Hunt groups have a pilot number, which is a directory number associated with the MLHG. When this pilot number is called the members of the MLHG are alerted in turn. Alternatively, a hunt group can be configured to hunt if any member of the hunt group is called directly using its DID number and doesn t answer. There are various distribution algorithms available: Linear hunting starts at the first configured line and goes sequentially through the members in the list in the order they were configured. Circular hunting starts at the line which has been called, and then goes through as in the linear case. Uniform hunting starts at the first line after the line which was called the last time this MLHG was called. Most idle hunting starts at the line which has been idle for the longest period of time. After this it tries the line which has been idle the next longest period, etc. MLHGs can also be configured to enable queuing. If configured, calls which come in to an MLHG whose members are all busy will be queued. These queued calls will receive Music on Hold if this feature is configured. 102 Glossary Version 7.2 Issue 1 30 Sep 2010
15.11 Call Pickup Groups Group Call Pickup allows users to pick up calls that are ringing on other phones (in a pre-defined pickup group within the same business group by picking up their own phones and dialing an access code. (If two or more phones within the pickup group are ringing at the same time, the user cannot control which call is picked up.) You can have multiple groups in your business. A line can be in multiple call pickup groups. If a call is ringing on lines in both groups simultaneously and the user who is in both groups picks up a call, then they will pick up the call which started ringing first. Directed Call Pickup is similar, but allows the user to pick up the call that is ringing on a specific phone within the group. Users pick up their own phones, and dial an access code followed by the extension code for the line which is ringing. 15.12 Short Codes Short Codes are speed dials that are defined at the scope of your organization so everyone in your business can use these speed dials. 15.13 Extensions Extensions are the codes you can dial to reach other people in your business. Version 7.2 Issue 1 30 Sep 2010 Glossary 103
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 15.14 Account Codes Account codes Authorize employees to make outbound phone calls Associate a reference number to outgoing phone calls that your business makes. Once you have dialed a number that requires an account code you will hear a tone. This is the prompt to enter the account code. Once the account code has been correctly entered the call will be made. There are two types of account codes. 1. Validated Account Codes. When the user making a phone call enters the account code it is checked against a list of valid account codes. If the account code matches one on the list the call will continue. If the account code doesn t match any on the list then an error is played. You should use Validated Account Codes when you want to stop any unauthorized personnel from making outbound calls. 2. Unvalidated Account Codes. When the user making a phone call enters the account code this account code is marked against the call in our billing system and the call continues. The account code isn t checked for validity. You can use Unvalidated Account Codes where you want to be able to record an account code against outgoing calls that you make. If you have signed up to the service with us then when we provide you with your phone bill the account code for each call will be marked on your bill. This is useful, for example, if you are billing your clients for all of your phone calls. You can set up either type of account code either for your whole business, or select from either validated and unvalidated for each line individually. You can allow your users to manage their account codes. 104 Glossary Version 7.2 Issue 1 30 Sep 2010
15.15 Auto Attendant Easy / Premium Attendant MetaSphere provides two solutions for Auto Attendant functionality. Easy Attendant offers a very simple automated telephone menu. Callers to a business are directed to the automated TUI, providing key options to transfer to specific departments or individuals in the business, to transfer to a voicemail account directly, or to listen to a recorded announcement. You can choose to have either a single menu that plays when Easy Attendant is turned on, or two different menus for business and nonbusiness hours that are used according to a pre-defined schedule. When Easy Attendant is turned off, you can either forward callers to another telephone number or play a message informing the caller that your business is currently closed. Premium Attendant, aimed at small and medium business subscribers, offers an increased level of service compared to Easy Attendant. In addition to all the features offered by Easy Attendant, Premium Attendant allows multiple menus with a finer scheduling control. It also includes more call handling options, such as Voicemail by Name and Voicemail by Extension, as well as greater control over the actions taken for any given key press. Version 7.2 Issue 1 30 Sep 2010 Glossary 105
Metaswitch Hosted IP PBX Administrator Guide CONFIDENTIAL 15.16 Music on Hold The Music On Hold system lets you configure music and recordings to be played to your callers when you put them on hold. You can either use recordings we have made available, or upload and make your own recordings. You can access the Music On Hold system either using CommPortal, or using your telephone. The CommPortal interface is more powerful and easier to use, but you can use the telephone interface to record your own announcements to be played to callers. 15.16.1 Music on Hold Performing Rights Playing music to callers on hold may constitute public performance of the music and therefore risks infringing the copyrights of composers or artists. Therefore you may need to obtain appropriate licenses to play any material that you plan to use as Music On Hold. You can obtain these licenses from licensors such as Broadcast Music Inc (http://www.bmi.com/) and the American Society of Composers, Authors and Publishers (http://www.ascap.com/). We do not accept any legal liability arising from copyright infringements associated with your use of Music On Hold, except where you use the Global Media Resources described in Section 14.1.3 106 Glossary Version 7.2 Issue 1 30 Sep 2010
Managing Recordings. Version 7.2 Issue 1 30 Sep 2010 Glossary 107
Copyright 2010 Metaswitch Networks. All rights reserved. www.metaswitch.com