Provisioning Visitor Accounts Using Cisco IP Phone Services Unified Visitor Management amigopod Technical Note Revision 1.1 1 April 2010 United States of America +1 (888) 590-0882 Europe, Middle East & Asia +34 91 766 57 22 Australia & Pacific +61 2 8669 1140 http://www.amigopod.com Copyright 2010 amigopod. All rights reserved.
Table of Contents Introduction...3 Audience...3 Document Overview...3 About Cisco IP Phone Services...4 Visitor Account Provisioning Workflow...4 Step 1: Access the visitor provisioning service...5 Step 2: Enter visitor details...5 Step 3: Select expiration time (optional)...6 Step 4: Create visitor account...6 Step 5: Visitor account details sent by SMS...7 Customizing the Workflow...7 Configuring Cisco IP Phone Services...9 Supported Cisco IP Phone Models...9 Check Plugin Versions...9 Accessing Cisco IP Phone Services...9 Creating an IP Phone Service...10 General Properties...10 Display Properties...11 Behavioral Properties...12 Receipt Properties...14 Provisioning an IP Phone Service...14 Determine Service URL...14 Create Cisco Call Manager IP Phone Service...15 Subscribe to IP Phone Service...16 Verify IP Phone Service...17 2
Introduction Audience This technical note explains how to deploy and configure visitor account provisioning as an end-user service available on Cisco IP phones. This document is intended for network administrators and system integrators deploying an amigopod-based visitor management solution in conjunction with a Cisco IP phone system. Basic familiarity with the amigopod Visitor Management Appliance is assumed. For in-depth information about the features and functions of the amigopod appliance, refer to the amigopod Deployment Guide. Some familiarity with the Cisco Unified Communications System is assumed, including knowledge of Cisco Call Manager and the general characteristics of Cisco IP phones. Document Overview The first section of the document describes how the amigopod Visitor Management Appliance can be used to define a workflow for creating a new visitor account on a Cisco IP phone. The next section contains a detailed configuration guide for administrators intending to deploy Cisco IP phone services on the amigopod Visitor Management Appliance. Step-by-step instructions for configuring and validating a configuration are provided. 3
About Cisco IP Phone Services Cisco IP phones are sophisticated devices that provide many advanced features over and above making and receiving telephone calls. The IP phone device includes a large screen, numerous programmable softkeys and a carefully designed user interface suitable for novice and advanced users alike. Figure 1: Cisco Unified IP Phone, model 7942G. The Cisco Unified Communications Solutions architecture includes centralized management and deployment capabilities and the ability to deliver interactive services to a company-wide network of phones. Using Cisco IP Phone Services, the amigopod Visitor Management Appliance enables a convenient method of provisioning visitor accounts directly from an IP Phone. Visitor Account Provisioning Workflow The amigopod Visitor Management Appliance offers flexible and completely customizable visitor account provisioning and self-registration processes. However, these processes are unsuitable for the limited user interface provided by a Cisco IP phone; in particular, text input on the numeric keypad is slow, inefficient and error-prone. Consequently, IP phone-based visitor account provisioning must be kept simple and efficient. This is achieved by only requiring one input from the phone s operator the visitor s phone number. In this section, the workflow used to provision a visitor account from a Cisco IP phone is explained in more detail. 4
Step 1: Access the visitor provisioning service The operator first presses the Services button on the Cisco IP phone. This will display a list of services that have been provisioned to the operator s phone. The operator selects the visitor provisioning service from the list in this example, amigopod Guest Manager and presses the Select softkey to use this service. The amigopod Guest Manager splash screen is displayed briefly. This serves as a visual indicator to the operator that the visitor provisioning service has been selected. Step 2: Enter visitor details The Create Visitor Account form provides an input field where the visitor s mobile phone number may be entered. In this form, the default phone number of +44 indicates that the visitor s phone number should be entered in international format; the country code is 5
assumed to be the United Kingdom. This value may be erased using the << softkey if necessary. Step 3: Select expiration time (optional) The default expiration time for the visitor account is 2 hours. If this is unsuitable, it may be changed. The operator presses the Expire softkey. A list of available expiration times is displayed. The operator uses the navigation softkeys to select the appropriate time, and then presses the Select softkey. Step 4: Create visitor account Once the visitor s mobile phone number has been entered, and an expiration time has been selected, the operator presses the Next softkey from the Create Guest Account screen. The IP phone displays a screen indicating that the account provisioning process is underway. 6
When the visitor account has been created, a receipt screen is displayed, showing the actual expiration time of the visitor account. The operator can either repeat the process for another visitor by pressing the New softkey, or can press the Exit softkey to return to the list of services. Step 5: Visitor account details sent by SMS In step 4, a temporary visitor account is created using a randomly generated username and password. These credentials are sent to the visitor s mobile phone by SMS. An amigopod print template is used to control the precise formatting of this message. The result will appear on the visitor s phone as follows: Visitor Access Username: 54758894 Password: 07476165 Expires: 2010-01-24 18:00:00 -- powered by amigopod The visitor is then able to use these credentials to log in to the network. When the expiration time is reached, the account will be deleted and any active sessions will be terminated. Customizing the Workflow Many of the details in the workflow shown above are customizable, including: The name of the service provisioned to the IP phone 7
The application title displayed on each screen The application splash screen image The default phone number to display The available options for account expiration times The format of the SMS receipt sent to the visitor The remainder of this technical note describes how to configure these options in more detail. 8
Configuring Cisco IP Phone Services Supported Cisco IP Phone Models The following models of Cisco IP phone are supported: Model Screen Type Notes 7905, 7906, 7911, 7912, 7931 Grayscale 1 7920 Grayscale 7921, 7925 Color 7940, 7941, 7942, 7960, 7961, 7962 Grayscale 7945, 7965, 7970, 7975 Color Cisco IP Communicator Color 6921, 6941, 6961 Monochrome 2 8961 Color 9951, 9971 Color Note 1 These Cisco Unified IP Phone models do not support displaying images. Note 2 These Cisco Unified IP Phone models have a monochrome display and do not support displaying images. Check Plugin Versions Visitor account provisioning using Cisco IP phones requires the following plugin versions: amigopod Kernel 2.1.8 or later SMS Services Plugin 2.1.0 or later Guest Manager Plugin 2.1.0 or later Cisco IP Phone Services 1.0.0 or later To verify you have the correct plugin versions installed, navigate to Administrator > Plugin Manager > Manage Plugins and check the version number in the list. Use the Update Plugins link to download and install updated plugins. Accessing Cisco IP Phone Services Log in to the amigopod Visitor Management Appliance s graphical user interface as an administrator. The Cisco IP Phones command link is displayed on the home page of the application and may be used to access the Cisco IP Phone Services plugin. 9
Click the Manage IP Phone Services command link. Multiple IP phone services can be provisioned. This capability allows different phones or different users of the IP phone system to use different visitor account provisioning rules. The Cisco IP Phone Services page displays a list of IP phone services that have been created. Each service has a name and a description that you can use to identify it. From this page, you can create, edit, duplicate, delete, disable, enable and obtain provisioning details for each IP phone service. Creating an IP Phone Service General Properties Click the Create new IP phone service link to prepare a new visitor account provisioning service. The Cisco IP Phone Service form is displayed. This form consists of four sections. The General Properties are the internal name and description of the visitor account provisioning service. These properties are used to identify the service for administrative use and are not displayed to end users. A unique page name must also be specified; a page name must be a single word consisting of letters, digits, hyphen (-) and underscore (_) only. 10
Display Properties The Display Properties control the visual appearance of the IP phone service and the default values displayed to the operator. Application Title text field The Application Title is displayed to end users on each screen of the visitor account provisioning workflow. Use a descriptive name to assist your end users; the default is amigopod Guest Manager. Splash Screen drop-down list The Splash Screen is an image displayed to end users when the IP phone service is selected. Select (No splash screen) to disable the image. Select (Default splash screen) to use the default image, which is shown below: Select a PNG file from the list to display that image. PNG files may be uploaded using the Content Manager (navigate to Administrator > Content Manager) NOTE PNG images should be color and up to 298 x 168 pixels in size (or up to 498 x 289 pixels in size for Cisco Unified IP Phone models 8961, 9951 and 9971). On a Cisco IP phone with a grayscale display, the image will be downsampled to the maximum size displayable on the screen and converted to grayscale. For example, on a Cisco Unified IP Phone model 7942G, the image will be scaled to a maximum size of 298 x 144 pixels. 11
Grayscale Display Default Splash Screen Color Display The table below lists the maximum displayable image size and color depth capabilities according to the Cisco IP phone model. Model Behavioral Properties Maximum Size (width x height) Screen Type 7920 128 x 59 Grayscale 1 7921 176 x 140 Color 16 7925 176 x 220 Color 16 7940, 7960 133 x 65 Grayscale 2 7941, 7942, 7961, 7962 298 x 144 Grayscale 4 7945, 7965 298 x 156 Color 16 7970, 7971 298 x 168 Color 12 7975 298 x 168 Color 16 Cisco IP Communicator 298 x 168 Color 24 8961 498 x 289 Color 24 9951, 9971 498 x 289 Color 24 Color Depth (bits) The Behavioral Properties control how this specific IP phone service will work. 12
Sponsoring checkbox Select the Query Cisco IP phone to determine sponsor name checkbox to look up certain information from the IP phone and record this information in the sponsor_name field of the visitor account. For example, the contents of the sponsor_name field with this option selected could look like: 1000 (CP-7960 SEP003094C2D96F) The values included here are the directory number of the phone (1000), the model of the phone (CP-7960) and the device s hostname (SEP003094C2D96F). When this option is not selected, the page name of the IP phone service and the device s hostname are recorded: cisco_guest_manager (SEP003094C2D96F) User Role drop-down list The User Role specifies which role should be assigned to the visitor accounts created with this IP phone service. NOTE This role must be the same for all visitor accounts created with this IP phone service. To create visitor accounts with different roles, you must use different IP phone services. Expiration Options text field The Expiration Options specify the available options for account expiration times. Use the format time description, where the time is specified as a number of hours and the description is the option displayed to the operator. If only one option is defined, the expiration time menu is not displayed to operators and the operator cannot change the expiration time for the visitor account. A default value may be indicated by adding an asterisk (*) to the description. If no default is specified in this way, the first expiration option listed will be the default. Specific times and dates may also be specified; use the syntax at time for this. For example, the expiration option at 18:00 6 PM today will display an option 6 PM today that corresponds to the time 18:00. Other useful examples are shown in the list below: at 18:00 6 PM today at midnight tomorrow Midnight at Friday 19:30 Friday, 7:30 PM at 2010-02-28 9:00 28 February 2010, 9 AM 13
Receipt Properties The Receipt Properties control the delivery and format of the SMS receipt sent to the visitor account s mobile phone. Service Provider drop-down list SMS Receipt Select the appropriate SMS service provider from the drop-down list. SMS messages will be sent using this service. Administrators may configure SMS services by navigating to SMS Services > Configure SMS. For more details about SMS service configuration, refer to the amigopod Deployment Guide. Select a plain-text print template from the drop-down list. The SMS receipt will be generated using this print template. The (Use Default) option indicates that the print template currently selected in Guest Manager > Customization > Customize SMS Receipt should be used. To create or modify a print template used for visitor account details, navigate to Guest Manager > Print Templates. NOTE When creating a new print template for SMS purposes, be sure to select the plain text format. Provisioning an IP Phone Service After creating an IP Phone service on the amigopod, the URL of the service must then be provided to Cisco Unified Call Manager. This service can then be provisioned to a phone. Determine Service URL To determine the correct URL for the service, select the IP phone service in the list and click the Provisioning link. The Service Provisioning form is displayed, showing the URL of the IP phone service. 14
Create Cisco Call Manager IP Phone Service First, log in to the Cisco Unified CM Administration interface as an administrator. Navigate to Device > Device Settings > Phone Services. Click the Add New button to define a new IP Phone Service. 15
When defining the service, use the Service URL obtained from the Service Provisioning form. No parameters for this service are required. Click the Save button to create the IP Phone Service. Subscribe to IP Phone Service To subscribe a Cisco IP Phone to the newly created IP Phone Service, navigate to the phone s configuration screen in Cisco Call Manager. Select Subscribe/Unsubscribe Services from the Related Links drop-down list. Select the IP Phone Service from the drop-down list. 16
Click the Next button. Modify the Service Name if required this will be displayed on the Cisco IP Phone when the Services button is pressed and click the Subscribe button to add a new subscription to this IP Phone Service. Click the Save link to store the service configuration, and then close the window. Click the Apply Config link from the phone configuration screen to make the configuration changes take effect. Verify IP Phone Service On a Cisco IP phone that has subscribed to the IP phone service, press the Services button. Verify that the amigopod Guest Manager service is displayed in the list. 17
Select the service using the Select softkey. Verify that the appropriate splash screen image is displayed (if a splash screen has been selected in the IP Phone Service configuration). Continue to the Create Guest Account screen. Verify that the default phone number and default expiration time on this screen are correct. Enter a mobile phone number using the IP phone s numeric keypad. Press the Expire softkey to display a list of expiration time options. Verify that the list contains the options that were configured for the IP Phone Service. Select an expiration time using the Select softkey. Verify that the Create Guest Account form now displays the entered phone number and the new expiration time. Press the Next softkey to continue with the account provisioning process. Verify that the Creating guest account screen is displayed. The receipt screen will then be displayed. Verify that the expiration time is correct. Verify that an SMS receipt was sent. In the amigopod GUI, navigate to Guest Manager > List Accounts and verify that a visitor account has been created. Verify that the sponsor name of this visitor account includes the correct directory number of the Cisco IP phone, as well as its model number and hostname. (If the Query Cisco IP phone to determine sponsor name checkbox was not selected, verify that the sponsor name shows the page name for the IP phone service and the IP phone s hostname.) NOTE The sponsor name may be displayed in this list by clicking Choose Columns, selecting the sponsor_name field and clicking Enable Field. Using a RADIUS test client (navigate to RADIUS Services > Server Control and click the Test RADIUS Authentication command link), verify that the username and password sent by SMS are correct and result in a successful authentication. After completing these steps, you have successfully deployed and validated a Cisco IP Phone service. 18