C H A P T E R
15
Graphical User Interface
This chapter describes the Cisco Unified Communications Manager Express (Cisco Unified CME) graphical user interface (GUI) and explains how to set it up accounts for system administrators, customer administrators, and phone users.
•
Prerequisites for Enabling the GUI, page 521
•
Restrictions for Enabling the GUI, page 521
•
Information About Enabling the GUI, page 522
•
Enable the GUI, page 523
•
Configuration Examples for Enabling the GUI, page 532
•
Feature Information for Enabling the GUI, page 534
Prerequisites for Enabling the GUI
• GUI files must be copied into flash memory on the router. For more information, see
Install and Upgrade
Cisco Unified CME Software, on page 101
.
• To use a phone user account in the Cisco Unified CME GUI to configure speed dials on a phone that is enabled for Extension Mobility, Cisco Unified CME GUI 4.2.1 or a later version must be installed on the Cisco router.
Restrictions for Enabling the GUI
• Cisco Unified CME GUI files are version-specific; GUI files for one version of Cisco Unified CME are not compatible with any other version of Cisco Unified CME. If you are downgrading or upgrading your
Cisco Unified CME version, you must downgrade or upgrade your GUI files.
• The user name parameter of any authentication credential must be unique. Do not use the same value for a user name when you configure any two or more authentication credentials in Cisco Unified CME, such as the username for any Cisco United CME GUI account and the user name in a logout or user profile for Extension Mobility.
Cisco Unified Communications Manager Express System Administrator Guide
521
Graphical User Interface
Information About Enabling the GUI
• Extension Mobility options in Cisco Unified CME GUI 4.2.1 and later versions cannot be accessed from the System Administrator or Customer Administrator login screens.
• To access the GUI, you must use Microsoft Internet Explorer 5.5 or a later version. Other browsers are not supported.
• If you use an XML configuration file to create a customer administrator login, the XML file can have a maximum size of 4000 bytes.
• The password of the system administrator cannot be changed through the GUI. Only the password of a customer administrator or a phone user can be changed through the GUI.
• If more than 100 phones are configured, choosing to display all phones results in a long delay before results appear.
Information About Enabling the GUI
Cisco Unified CME GUI Support
The Cisco Unified CME GUI provides a web-based interface to manage most system-level and phone-based features. In particular, the GUI facilitates the routine additions and changes associated with employee turnover, allowing these changes to be performed by nontechnical staff. The GUI provides three levels of access to support the following user classes:
• System administrator—Able to configure all system-level and phone-based features. This person is familiar with Cisco IOS software and VoIP network configuration.
• Customer administrator—Able to perform routine phone additions and changes without having access to system-level features. This person does not have to be familiar with Cisco IOS software.
• Phone user—Able to program a small set of features on his or her own phone and search the
Cisco Unified CME directory. In Cisco Unified CME GUI 4.2.1 and later versions, phone users can use the GUI to set up personal speed dials for an Extension Mobility phone. The same credential for logging into an Extension Mobility phone can be used to log into the Cisco Unified CME GUI.
The user name parameter of any authentication credential must be unique. Do not use the same value for a user name when you configure any two or more authentication credentials in Cisco Unified CME, such as the username for any Cisco United CME GUI account and the user name in a logout or user profile for Extension
Mobility.
The Cisco Unified CME GUI uses HTTP to transfer information from the router to the PC of an administrator or phone user. The router must be configured as an HTTP server, and an initial system administrator username and password must be defined from the router command-line interface (CLI). Additional accounts for customer administrators and phone users can be added from the Cisco Unified CME router using Cisco IOS software commands or from a PC using GUI screens.
Cisco Unified CME provides support for eXtensible Markup Language (XML) cascading style sheets (files with a .css suffix) that can be used to customize the browser GUI display.
522
Cisco Unified Communications Manager Express System Administrator Guide
Graphical User Interface
AAA Authentication
AAA Authentication
The GUI supports authentication, authorization, and accounting (AAA) authentication for system administrators through a remote server when this capability is enabled with the ip http authentication command. If authentication through the server fails, the local router is searched.
Using the ip http authentication command prevents unauthorized users from accessing the Cisco Unified CME router. If this command is not used, the enable password for the router is the only requirement to authenticate user access to the GUI. Instead, we recommend you use the local or TACACS authentication options, configured as part of a global AAA framework. By explicitly using the ip http authentication command, you designate alternative authentication methods, such as by a local login account or by the method that is specified in the
AAA configuration on the Cisco Unified CME router. If you select the AAA authentication method, you must also define an authentication method in your AAA configuration.
For information on configuring AAA authentication, see "Configuring Authentication” chapter of Cisco IOS
Security Configuration Guide .
Enable the GUI
Enable the HTTP Server
To enable the HTTP server, and specify the path to files for the GUI and a method of user authentication for security, perform the following steps. The HTTP server on a router is disabled by default.
SUMMARY STEPS
1. enable
2. configure terminal
3. ip http server
4. ip http path flash:
5. ip http authentication {aaa | enable | local | tacacs}
6. exit
DETAILED STEPS
Step 1
Step 2
Command or Action enable
Example:
Router> enable
configure terminal
Example:
Router# configure terminal
Purpose
Enables privileged EXEC mode.
• Enter your password if prompted.
Enters global configuration mode.
Cisco Unified Communications Manager Express System Administrator Guide
523
Graphical User Interface
Enable GUI Access for the System Administrator
Step 3
Step 4
Step 5
Step 6
Command or Action ip http server
Purpose
Enables the HTTP server on the Cisco Unified CME router.
Example:
Router(config)# ip http server
ip http path flash:
Sets the location of the HTML files used by the HTTP web server to flash memory on the router.
Example:
Router(config)# ip http path flash:
ip http authentication {aaa | enable | local
| tacacs}
Specifies the method of authentication for the HTTP server. Default is the enable keyword.
Example:
Router(config)# ip http authentication aaa
• aaa—Indicates that the authentication method used for the AAA login service should be used for authentication. The AAA login service method is specified by the aaa authentication login command.
• enable—Uses the enable password. This is the default if this command is not used.
• local—Uses login username, password, and privilege level access combination specified in the local system configuration (by the
username command).
• tacacs—Uses TACACS (or XTACACS) server.
Returns to privileged EXEC mode.
exit
Example:
Router(config)# exit
Enable GUI Access for the System Administrator
To define an initial username and password for a system administrator to access the GUI and enable the GUI to be used to set the time and to add directory listings, perform the following steps.
524
Cisco Unified Communications Manager Express System Administrator Guide
Graphical User Interface
Enable GUI Access for the System Administrator
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. web admin system name username {password string | secret {0 | 5} string}
5. dn-webedit
6. time-webedit
7. end
DETAILED STEPS
Step 1
Step 2
Step 3
Step 4
Command or Action enable
Purpose
Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
configure terminal
Example:
Router# configure terminal
telephony-service
Enters global configuration mode.
Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
web admin system name username
{password string | secret {0 | 5} string}
Example:
Router(config-telephony)# web admin system name pwa3 secret 0 wp78pw
Defines username and password for a system administrator.
• name username—Unique alphanumeric string to identify a user for this authentication credential only. Default is Admin.
• password string—String to verify system administrator’s identity.
Default is empty string.
• secret {0 | 5} string—Digit specifies state of encryption of the string that follows:
◦0—Password that follows is not encrypted.
◦5—Password that follows is encrypted using Message Digest
5 (MD5).
Note
The secret 5 keyword pair is used in the output of show commands when encrypted passwords are displayed. It indicates that the password that follows is encrypted.
Cisco Unified Communications Manager Express System Administrator Guide
525
Graphical User Interface
Access the Cisco Unified CME GUI
Step 5
Step 6
Step 7
Command or Action dn-webedit
Example:
Router(config-telephony)# dn-webedit
Purpose
(Optional) Enables the ability to add directory numbers through the web interface.
The no form of this command disables the ability to create IP phone extension telephone numbers. That ability could disrupt the network wide management of telephone numbers.
If this command is not used, the ability to create directory numbers is disabled by default.
time-webedit
(Optional) Enables the ability to set the phone time for the
Cisco Unified CME system through the web interface.
Example:
Router(config-telephony)# time-webedit
Note
We do not recommend this method for setting network time. The router should be set up to automatically synchronize its router clock from a network-based clock source using Network Time
Protocol (NTP). In the rare case that a network NTP clock source is not available, use the time-webedit command to allow manual setting and resetting of the router clock through the GUI.
end
Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Access the Cisco Unified CME GUI
To access the Cisco Unified CME router through the GUI to make configuration changes, perform the following steps.
Note
In Cisco Unified CME GUI 4.2.1 and later versions, phone users can use the GUI to set up personal speed dials for an Extension Mobility phone. The same credential for logging on to an Extension Mobility phone can be used to log into the Cisco Unified CME GUI.
526
Cisco Unified Communications Manager Express System Administrator Guide
Graphical User Interface
Create a Customized XML File for Customer Administrator GUI
Restriction
• The Cisco Unified CME GUI requires Microsoft Internet Explorer 5.5 or a later version. Other browsers are not supported.
• Extension Mobility options in Cisco Unified CME GUI 4.2.1 and later versions cannot be accessed from the System Administrator or Customer Administrator login screens.
Step 1
Step 2
Go to the following URL: http://
router_ipaddress
/ccme.html
where router_ipaddress is the IP address of your Cisco Unified CME router. For example, if the IP address of your
Cisco Unified CME router is 10.10.10.176, enter the following: http://10.10.10.176/ccme.html
Enter your username and password at the login screen.
The Cisco Unified CME system evaluates your privilege level and presents the appropriate window. Note that users with
Cisco IOS software privilege level 15 also have system-administrator-level privileges in the Cisco Unified CME GUI after being authenticated locally or remotely through AAA. The ip http authentication command that is configured on the Cisco Unified CME router determines where authentication occurs.
After you login and are authenticated, the system displays one of the following home pages, based on your user level:
• System administrator home page.
• Customer administrator sees a reduced version of the options available on the system administrator page, according to the XML configuration file that the system administrator created.
• Phone user home page.
After you log in successfully, access online help from the Help menu.
Create a Customized XML File for Customer Administrator GUI
The XML configuration file specifies the parameters and features that are available to customer administrators and the parameters and features that are restricted. The file follows a template named xml.template, which conforms to the Cisco XML Document Type Definition (DTD), as documented in the Cisco IP Phone Services
Application Development Notes . This template is one of the first Cisco Unified CME files that is downloaded during installation.
Cisco Unified Communications Manager Express System Administrator Guide
527
Graphical User Interface
GUI Access for Customer Administrators
To edit and load the XML configuration file, perform the following steps.
Step 1
Step 2
Step 3
Step 4
Step 5
Copy the XML template and open it in any text editor (see
Example for Configuring XML Configuration File Template,
on page 532 ). Name the file something that is meaningful to you and use “xml” as its suffix. For example, you could name the file "custadm.xml".
Edit the XML template. Within the template, each line that starts with a title enclosed in angle brackets describes an
XML object and matches an entity name in the Cisco CME GUI. For example, “<AddExtension>” refers to the Add
Extension capability, and “<Type>” refers to the Type field on the Add Extension window. For each object in the template, you have a choice of actions. Your choices appear within brackets; for example, “[Hide | Show]” indicates that you have a choice between whether this object is hidden or visible when a customer administrator logs in to the GUI. Delete the action that you do not want and the vertical bar and brackets around the actions.
Example:
For example, to hide the Sequence Number field, change the following text in the template file:
<SequenceNumber> [Hide | Show] </SequenceNumber> to the following text in your configuration file:
<SequenceNumber> Hide </SequenceNumber>
Edit every line in the template until you have changed each choice in brackets to a single action and you have removed the vertical bars and brackets. A sample XML file is shown in the
Example for Configuring XML Configuration File,
on page 533 .
Copy the file to a TFTP or FTP server that can be accessed by the Cisco Unified CME router.
Copy your file to flash memory on the Cisco Unified CME router.
Example:
Router#
copy tftp flash
Load the XML file from router flash memory.
Example:
Router(config)#
telephony-service
Router(config-telephony)#
Router(config-telephony)#
web customize load filename
exit
GUI Access for Customer Administrators
Prerequisites for Enabling GUI Access to Customer Administrators
• Enable a system administrator account for GUI access. See
Enable GUI Access for the System
Administrator, on page 524
.
528
Cisco Unified Communications Manager Express System Administrator Guide
Graphical User Interface
GUI Access for Customer Administrators
• Create the XML configuration file for the customer administrator GUI. See
Create a Customized XML
File for Customer Administrator GUI, on page 527
.
• Reload the XML file using the web customize load command if you have made changes to the customer administrator GUI.
Define a Customer Administrator Account Using GUI
Step 1
Step 2
Step 3
Step 4
From the Configure System Parameters menu, choose Administrator’s Login Account.
Complete the Admin User Name (username) and Admin User Type (Customer) fields. The username must be a unique alphanumeric string to identify a user for this authentication credential only.
Complete the New Password field for the user that you are defining as a customer administrator. Type the password again to confirm it.
Click Change for your changes to become effective.
Define a Customer Administrator Account Using Cisco IOS Software Commands
To allow the system administrator to create a customer administrator account by using the Cisco IOS software command line interface, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. web admin customer name username password string
5. end
DETAILED STEPS
Step 1
Step 2
Command or Action enable
Example:
Router> enable
configure terminal
Example:
Router# configure terminal
Purpose
Enables privileged EXEC mode.
• Enter your password if prompted.
Enters global configuration mode.
Cisco Unified Communications Manager Express System Administrator Guide
529
Graphical User Interface
GUI Access for Phone Users
Step 3
Step 4
Step 5
Command or Action telephony-service
Purpose
Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
web admin customer name username password
string
Example:
Router(config-telephony)# web admin customer name user44 password pw10293847
Defines a username and password for a customer administrator.
• name username—Unique alphanumeric string to identify a user for this authentication credential only. Default is
Customer.
• password string—String to verify customer administrator identity.
Returns to privileged EXEC mode.
end
Example:
Router(config-telephony)# end
GUI Access for Phone Users
Prerequisites for Enabling GUI Access for Phone Users
• Enable a system administrator account for GUI access. See
Enable GUI Access for the System
Administrator, on page 524
.
Define a Phone User Account Using GUI
To create a phone user account by using the Cisco Unified CME GUI, perform the following steps.
Step 1
Step 2
Step 3
From the Configure Phones menu, choose Add Phone to add GUI access for a user with a new phone or Change Phone to add GUI access for a user with an existing phone. The Add Phone screen or the Change Phone screen appears.
Enter a username and password in the Login Account area of the screen. The username must be a unique alphanumeric string to identify a user for this authentication credential only. If you are adding a new phone, complete the other fields as appropriate.
Click Change for your edits to become effective.
530
Cisco Unified Communications Manager Express System Administrator Guide
Graphical User Interface
GUI Access for Phone Users
Define a Phone User Account Using Cisco IOS Software Commands
To use commands in the ephone configuration mode to create credentials for phone users to log into the
Cisco Unified CME GUI, perform the following steps for each phone user/phone combination.
Note
You can also create phone user credentials for accessing the Cisco Unified CME GUI by using the user command in the voice user-profile configuration mode and the voice logout-profile mode. For configuration information, see
Extension Mobility, on page 723
.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. username username password password
5. end
DETAILED STEPS
Step 1
Step 2
Step 3
Step 4
Command or Action enable
Example:
Router> enable
configure terminal
Example:
Router# configure terminal
ephone phone-tag
Example:
Router(config)# ephone 2
username username password password
Example:
Router(config-ephone)# username prx password pk59wq
Purpose
Enables privileged EXEC mode.
• Enter your password if prompted.
Enters global configuration mode.
Enters ephone configuration mode.
Assigns a phone user login account name and password.
• This allows the phone user to log in to the
Cisco Unified CME GUI to change a limited number of personal settings.
• username—Unique alphanumeric string to identify a user for this authentication credential only.
Cisco Unified Communications Manager Express System Administrator Guide
531
Graphical User Interface
Troubleshooting the GUI
Step 5
Command or Action end
Example:
Router(config-ephone)# end
Purpose
Returns to privileged EXEC mode.
Troubleshooting the GUI
If you are having trouble starting the Cisco Unified CME GUI, try the following actions:
Step 1
Step 2
Step 3
Verify you are using Microsoft Internet Explorer 5.5 or a later version. No other browser is supported.
Clear your browser cache or history.
Verify that the GUI files in router flash memory are the correct version for the version of Cisco Unified CME that you have. Compare the filenames in flash memory with the list in the Cisco Unified CME software archive that you downloaded. Compare the sizes of files in flash memory with the sizes of the files in the tar archive for the Cisco Unified
CME GUI to ensure that you have the most recent files installed in flash memory. If necessary, download the latest version from the Software Download website at http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp .
Configuration Examples for Enabling the GUI
Example for Configuring HTTP Server and System Administrator Account
The following example sets up the HTTP server and creates a system administrator account for pwa3, a customer administrator account for user44, and a user account for prx.
ip http server ip http path flash: ip http authentication aaa telephony-service web admin system name pwa3 secret 0 wp78pw web admin customer name user44 password pw10293847 dn-webedit time-webedit ephone 25 username prx password pswd
Example for Configuring XML Configuration File Template
<Presentation>
532
Cisco Unified Communications Manager Express System Administrator Guide
Graphical User Interface
Example for Configuring XML Configuration File
<MainMenu>
<!-- Take Higher Precedence over CLI "dn-web-edit" -->
<AddExtension> [Hide | Show] </AddExtension>
<DeleteExtension> [Hide | Show] </DeleteExtension>
<AddPhone> [Hide | Show] </AddPhone>
<DeletePhone> [Hide | Show] </DeletePhone>
</MainMenu>
<Extension>
<!-- Control both view and change, and possible add or delete -->
<SequenceNumber> [Hide | Show] </SequenceNumber>
<Type> [Hide | Show] </Type>
<Huntstop> [Hide | Show] </Huntstop>
<Preference> [Hide | Show] </Preference>
<HoldAlert> [Hide | Show] </HoldAlert>
<TranslationRules> [Hide | Show] </TranslationRules>
<Paging> [Hide | Show] </Paging>
<Intercom> [Hide | Show] </Intercom>
<MWI> [Hide | Show] </MWI>
<MoH> [Hide | Show] </MoH>
<LBDN> [Hide | Show] </LBDN>
<DualLine> [Hide | Show] </DualLine>
<Reg> [Hide | Show] </Reg>
<PGroup> [Hide | Show] </PGroup>
</Extension>
<Phone>
<!-- control both view and change, and possible add and delete --->
<SequenceNumber> [Hide | Show] </SequenceNumber>
</Phone>
<System>
<!-- Control View Only -->
<PhoneURL> [Hide | Show] </PhoneURL>
<PhoneLoad> [Hide | Show]</PhoneLoad>
<CallHistory> [Hide | Show] </CallHistory>
<MWIServer> [Hide | Show] </MWIServer>
<!-- Control Either View and Change or Change Only -->
<TransferPattern attr=[Both | Change]> [Hide | Show] </TransferPattern>
<VoiceMailNumber attr=[Both | Change]> [Hide | Show] </VoiceMailNumber>
<MaxNumberPhone attr=[Both | Change]> [Hide | Show] </MaxNumberPhone>
<DialplanPattern attr=[Both | Change]> [Hide | Show] </DialplanPattern>
<SecDialTone attr=[Both | Change]> [Hide | Show] </SecDialTone>
<Timeouts attr=[Both | Change]> [Hide | Show] </Timeouts>
<CIDBlock attr=[Both | Change]> [Hide | Show] </CIDBlock>
<HuntGroup attr=[Both | Change]> [Hide | Show] </HuntGroup>
<NightSerBell attr=[Both | Change]> [Hide | Show] </NightSerBell>
<!-- Control Change Only -->
<!-- Take Higher Precedence over CLI "time-web-edit" -->
<Time> [Hide | Show] </Time>
</System>
<Function>
<AddLineToPhone> [No | Yes] </AddLineToPhone>
<DeleteLineFromPhone> [No | Yes] </DeleteLineFromPhone>
<NewDnDpCheck> [No | Yes] </NewDnDpCheck>
<MaxLinePerPhone> [1-6] </MaxLinePerPhone>
</Function>
</Presentation>
Example for Configuring XML Configuration File
sample.xml
<Presentation>
<MainMenu>
<AddExtension> Hide </AddExtension>
<DeleteExtension> Hide </DeleteExtension>
<AddPhone> Hide </AddPhone>
<DeletePhone> Hide </DeletePhone>
Cisco Unified Communications Manager Express System Administrator Guide
533
Graphical User Interface
Feature Information for Enabling the GUI
</MainMenu>
<Extension>
<SequenceNumber> Hide </SequenceNumber>
<Type> Hide </Type>
<Huntstop> Hide </Huntstop>
<Preference> Hide </Preference>
<HoldAlert> Hide </HoldAlert>
<TranslationRule> Hide </TranslationRule>
<Paging> Show </Paging>
<Intercom> Hide </Intercom>
<MWI> Hide </MWI>
<MoH> Hide </MoH>
<LBDN> Hide </LBDN>
<DualLine> Hide </DualLine>
<Reg> Hide </Reg>
<PGroup> Show </PGroup>
</Extension>
<Phone>
<SequenceNumber> Hide </SequenceNumber>
</Phone>
<System>
<PhoneURL> Hide </PhoneURL>
<PhoneLoad> Hide </PhoneLoad>
<CallHistory> Hide </CallHistory>
<MWIServer> Hide </MWIServer>
<TransferPattern attr=Both> Hide </TransferPattern>
<VoiceMailNumber attr=Both> Hide </VoiceMailNumber>
<MaxNumberPhone attr=Both> Hide </MaxNumberPhone>
<DialplanPattern attr=Change> Hide </DialplanPattern>
<SecDialTone attr=Both> Hide </SecDialTone>
<Timeouts attr=Both> Hide </Timeouts>
<CIDBlock attr=Both> Hide </CIDBlock>
<HuntGroup attr=Change> Hide </HuntGroup>
<NightSerBell attr=Change> Hide </NightSerBell>
<Time> Hide </Time>
</System>
<Function>
<AddLineToPhone> No </AddLineToPhone>
<DeleteLineFromPhone> No </DeleteLineFromPhone>
<MaxLinePerPhone> 4 </MaxLinePerPhone>
</Function>
</Presentation>
Feature Information for Enabling the GUI
The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature.
Use Cisco Feature Navigator to find information about platform support and Cisco software image support.
To access Cisco Feature Navigator, go to www.cisco.com/go/cfn . An account on Cisco.com is not required.
534
Cisco Unified Communications Manager Express System Administrator Guide
Graphical User Interface
Feature Information for Enabling the GUI
Table 37: Feature Information for Enabling the GUI
Feature Name Cisco Unified CME Version
Support for Extension Mobility
Phone Users in Cisco Unified CME
GUI
4.2(1)
Cisco Unified CME GUI 2.0
Feature Information
Allows a phone user to use a name and password from an Extension
Mobility profile to log into the
Cisco Unified CME GUI for configuring personal speed dials on an Extension Mobility phone.
The Cisco Unified CME GUI was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
535
Feature Information for Enabling the GUI
Graphical User Interface
536
Cisco Unified Communications Manager Express System Administrator Guide
