Administration Guide for the Cisco Unified Application Environment (2.4)
Configuring the Cisco Unified Application Server
Downloads: This chapterpdf (PDF - 875.0KB) The complete bookPDF (PDF - 1.64MB) | Feedback

Configuring the Cisco Unified Application Server

Table Of Contents

Configuring the Cisco Unified Application Server

Configuring Components

Applications

Installing an Application

Enabling an Application

Disabling an Application

Modifying an Application

Uninstalling an Application

Updating an Application

Creating Partitions

Media Engines

Overview

Adding Media Engines

Editing Media Engine Parameters

Enabling or Disabling a Media Engine

Removing a Media Engine from the System

Adding a Media Resource Group

Editing a Media Resource Group

Removing a Media Engine from the Group

Providers

Viewing the List of Providers

Modifying a Provider

Disabling a Provider

Installing a Provider

Media Engine Provider

Presence Provider

SCCP Provider

SIP Provider

Timer Provider

Telephony Servers

Overview

Configuring SIP

Creating H.323 Call Route Groups and Gateways

Creating CTI Telephony Devices

Configuring JTAPI-Monitored Devices

Configuring SCCP Devices

Configuring System Parameters

Service Control

License Management

Overview

Uploading the Cisco Unified Application Environment License

Viewing License Statistics

Viewing License Details

Deleting a License

SSL Management

Redundancy Setup

Configuring Local Environment Parameters

User Accounts

Adding a User

Changing a User Password

Removing a User

Core Components

Log Server

Alarms

Viewing Current Alarms

Setting Alarms to Ignored

Adding New Alarm Destinations

Downloading a MIB File


Configuring the Cisco Unified Application Server


This chapter describes how to use the Cisco Unified Application Environment management console to manage application servers and includes these sections:

Configuring Components

Configuring System Parameters

Configuring Local Environment Parameters

Configuring Components

The Cisco Unified Application Environment management console provides access to the system components used to manage IP telephony applications. The Components group, on the main control panel, contains links to these configuration pages:

Applications—Install and uninstall applications

Media Engines—Enable the Cisco Unified Application Environment to act as a media endpoint

Providers—Display the list of providers, which open network ports and allow the runtime environment to communicate with devices

Telephony Servers—Configure interactions with IP telephony devices

Applications

To install and uninstall applications you must first log in to the Cisco Unified Application Environment management console. In the Main Control Panel, under Components, open the Applications page (Figure 3-1).

When you open the Applications page, the page displays the application name (displayed as a link), status, and version number. An application typically includes configuration items that are unique to your deployment and which you must configure after the application is installed.

This section includes these topics:

Installing an Application

Enabling an Application

Disabling an Application

Modifying an Application

Uninstalling an Application

Updating an Application

Creating Partitions


Note All application configuration occurs at the partition level. See the Creating Partitions for information about partitions.


Figure 3-1 Applications Page

Installing an Application

To install an application, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Applications.

Step 3 Click Browse...

Step 4 Highlight the file, then click Open.

Step 5 Click Upload File.

The Application Manager processes the file, installs the application, and updates the Applications page listing the application. The application is immediately enabled.


Enabling an Application

To enable an application, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Applications.

Step 3 Click the application name.

Step 4 Click Enable Application.

The application is enabled and the scripts defined within it can be initiated. If you return to the Applications page, the Status column indicates that the application is enabled.


Disabling an Application

To disable an application, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Applications.

Step 3 Click the application name.

Step 4 Click Disable Application.

The scripts defined by the application can no longer be initiated. If you return to the Applications page, the Status column shows that the application is Disabled.


Modifying an Application

To modify application settings, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Applications.

Step 3 Click the application name.

Step 4 Make changes as needed.

Step 5 Click Apply.


Uninstalling an Application

To uninstall an application, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Applications.

Step 3 Click the application name.

Step 4 If the application is enabled, click Disable Application.

Step 5 Click Uninstall Application.

Step 6 Click Yes to confirm.

The application is removed, and all running scripts are stopped.


Updating an Application

To update an application, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Applications.

Step 3 Click the application name.

Step 4 Under Update Application, browse for the application, highlight it, and click Upload File.


Creating Partitions

All application configuration occurs at the partition level. A partition is a configuration profile for an application. Applications can support multiple partitions, enabling you to create and execute multiple versions of the same application on a single Cisco Unified Application server.

This section includes these topics:

Overview

Creating a New Partition

Defining Trigger Parameters

Event Types and Trigger Parameters

Overview

Partitions are flexible and can be useful in a variety of situations. For example, if an application is intended to serve end-users located on distinct Cisco Unified Communications Manager clusters, it is often desirable for all call control and media streams to terminate to the network and telephony resources contained within each cluster. At the same time, it may be desirable to have another configurable protocol on the application, such as LDAP, which makes reference to the same central location, regardless of the partition.

Each partition is associated with a call route group and media resource group. By defining unique call route groups and media resource groups, you can identify the partitions that use individual media engines. For each partition, you can also determine which Cisco Unified Communications Manager cluster is used for making calls by specifying a call route group that corresponds to the particular telephony protocol and group.

Each application is also associated with scripts, which are partitioned along with the application. Because multiple scripts can execute actions through the same protocol, you must specify the conditions under which a partitioned script should initiate action.

For example, assume that an application has one script and three partitions and activates on an IncomingCall trigger. The default partition has no triggering parameters and can act as a catch-all for events which do not match other partitions.

The application server determines the best match handler for a given event. Other partitions take effect if their trigger parameters are activated. For example, if Partition 2 specifies to=2000, then when a call comes in for extension 2000, partition 2 will activate. If no trigger matches, the default partition will be active.

A partition is similar to a configuration template for a script and applies these rules:

The application developer sets the event that triggers a script. The event applies to all partitions and cannot be changed.

All installed script partitions across all applications are treated as equal.

If any two partitions have identical triggering criteria, either one may trigger; therefore, it is important that all partitions have unique triggering criteria.

The router will match the handler that best fits the events. For example, if partition A specifies to=2000 and partition B specifies to=2000 and from=1000, then a call from 1000 to 2000 triggers B.

Creating a New Partition

To create a new partition, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Applications.

Step 3 Click the application name. A page similar to the following opens to display available settings (Figure 3-2).

Figure 3-2 Application Manager Page - Example

Step 4 Click Create Partition. A Creating Partition page for the selected application appears.


Note Depending on the application, additional fields are displayed which are unique to the application.


Step 5 Configure settings as described in Table 3-1, then click Create Partition.


Note Parameter values are inherited from the default partition, and all unchanged parameters in the new partition remain linked to parameters in the default partition. These parameter values will be updated in the new partition to match any changes made to them in the default partition.


Table 3-1 Partition Parameters

Field
Description

Name

Name of application

Description

Description of application

Enabled

Partition is active

Reserve Media Early

Reserve media ports early to reduce setup time

Locale

Default locale for this partition

Preferred Codec

Preferred media resource codec

Call Route Group

Used by an application only when making outbound calls

The protocol of the inbound call is determined by the configuration of the Cisco Unified Communications Manager. Specifically, its configuration determines which protocol is used when routing the call to the Cisco Unified Application Server device appearance.

Media Resource Group

Media engine group closest to the IP endpoints using this application


Step 6 Under Scripts, click Edit Trigger Parameters.

Step 7 Enter at least one trigger parameter name and value.

Trigger requirements are dictated by the needs of the application and are beyond the scope of this document. See Defining Trigger Parameters, and Event Types and Trigger Parameters for examples.

Step 8 Click Done, and return to the application page.


Defining Trigger Parameters

Define triggers in any of the following ways:

Single value—Figure 3-3 shows an example trigger that activates when extension 2000 receives a call.

Value List —Figure 3-4 shows an example trigger that activates when a call is received from extension 2000, 2001, or 2003.

Single Regular Expression—Figure 3-5 shows an example trigger that activates when a call is received on any of the extensions 2000-2999 (regex:2[0-9][0-9][0-9]).

Combined Method—Figure 3-6 shows an example trigger that includes a single value trigger that activates when the extension 2000 is called and a regular expression trigger that activates when a call is received from any of the extensions 2000-2999 (regex:2[0-9][0-9][0-9]).


Note A regular expression is indicated by adding regex: before the expression. You cannot mix literal values and regular expressions in a list. Only a single regular expression can be used as a trigger parameter for a given partition. The syntax [0-9] in a regular expression is equivalent to the Cisco Unified Communications Manager X notation used in route patterns and CTI Route point line numbers.


Figure 3-3 Single Value Trigger Parameter Configuration - Example

Figure 3-4 Value List Trigger Parameter Configuration - Example

Figure 3-5 Single Regular Expression Trigger Parameter Configuration - Example

Figure 3-6 Combined Method Trigger Parameter Configuration - Example

Event Types and Trigger Parameters

This section lists examples of trigger parameters for the following event types:

Metreos.CallControl.IncomingCall—Table 3-2

Metreos.Providers.Http.GotRequest—Table 3-3

Metreos.Providers.JTapi.JTapiIncomingCall—Table 3-4

Metreos.Providers.JTapi.JTapiCallInitiated—Table 3-5

Metreos.Providers.TimerFacility.TimerFire—Table 3-6

Table 3-2 Metreos.CallControl.IncomingCall 

Trigger Parameter
Description

To

Called party, or last redirected number if redirected

From

Number of the calling party

OriginalTo

Original called party, even if redirected

DisplayName

Textual display name associated with the calling part


Table 3-3 Metreos.Providers.Http.GotRequest 

Trigger Parameter
Description

URI

Path portion of the requested URI. Must begin with a front slash (/).

Hostname

Host portion of the requested URI. Does not contain port information.

Host

Host portion of the requested URI. Might contain port information.

Port

Port portion of the requested URI

Body

Content of the request

Method

Request method— either GET or POST

Query

Query string portion of the requested URI

RemoteHost

IP address and port of the remote client

RemoteIPAddress

IP address of the remote client


Table 3-4 Metreos.Providers.JTapi.JTapiIncomingCall 

Trigger Parameter
Description

To

Called party, or last redirected number if redirected

From

Number of the calling party

OriginalTo

Original called party, even if redirected

DeviceName

Name of the device that the call came in on


Table 3-5 Metreos.Providers.JTapi.JTapiCallInitiated 

Trigger Parameter
Description

To

Called party

From

Number of the calling party

DeviceName

Name of the device from which the call was initiated


Table 3-6 Metreos.Providers.TimerFacility.TimerFire 

Trigger Parameter
Description

TimerUserData

Opaque token used to allow distinguishable events to be raised.

Note You must obtain this value from the person who developed the application which uses the TimerFire script.


Media Engines

For the Cisco Unified Application Environment to act as a media endpoint, a Cisco Unified Media Engine must be present and the Cisco Unified Application Environment must be configured to use the engine. The decision to use a media engine depends on the needs of the application. Applications that place or answer calls typically require a media engine.


Note Some applications do not require media engines; for example, telephony applications that use peer-to-peer media negotiation.


This section includes these topics:

Overview

Adding Media Engines

Editing Media Engine Parameters

Enabling or Disabling a Media Engine

Removing a Media Engine from the System

Adding a Media Resource Group

Editing a Media Resource Group

Removing a Media Engine from the Group

Overview

To be available for use by applications, each media engine must be placed in a media resource group, which is assigned within the application partition. A media resource group is a container for a collection of media engines. All media engines are placed automatically into the Default media resource group, and all application partitions can use the default group. It is not necessary to create custom media resource groups.

Creating custom media resource groups is recommended in the following cases:

Diverse geography—If a single Cisco Unified Application Environment provides call control for calls that originate and terminate in different countries, it is desirable to use media engines that are physically located in each country to service the calls directed to that country. For example, a push-to-talk application may reside on the Cisco Unified Application Server in New York but be triggered by a user in India to call another phone number in India. If all media engines in India are assigned to a custom media resource group, the application can be instructed to use the servers in the India media resource group to process calls that originate and terminate in India.

Resource guarantees—Some applications, such as scheduled conferencing, are sensitive to resource utilization and may not recover well from unexpected loss of media resources due to the demands of other applications. To reserve the needed resources, you can assign specific media engines to a custom media resource group. The application then reserves the resources of the custom media resource group.

The Media Engines page (Figure 3-7) includes following sections:

Media Engines—To add, edit, enable or disable, and remove media engines.

Media Resource Groups—To create and edit a media resource group.

Figure 3-7 Media Engines Page

Adding Media Engines

To add a media engine to the system, follow these steps:


Note By adding a media engine, you are not enabling media engine services for this particular server. This procedure enables the application server to communicate with the specified media engine.


Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Media Engines.

Step 3 Click Add a Media Engine.

Step 4 Enter values as described in Table 3-7.

Table 3-7 Media Engine Parameters

Field
Description

Name

Name (your choice) for the media engine.

Address

IP address of media engine

Password

Password for access to media engine

Add to Group

Group to which media engine is assigned


Step 5 Click Add.


Editing Media Engine Parameters

To edit parameters for an existing media engine, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Media Engines.

Step 3 Click the Edit next to the engine whose parameters you want to modify.

Step 4 Enter values as described in Table 3-8.

Table 3-8 Media Engine Parameters-Editing

Field
Description

Name

Name (your choice) for the media engine

Address

IP address of the media engine

Note This value cannot be changed.

Password

Click Change Password. A new page appears where you can enter this information:

1. Enter the new password

2. Reenter the new password

3. Click Apply


Step 5 Click Apply.


Enabling or Disabling a Media Engine

To enable or disable a media engine, follow these steps:


Note Disabling a media engine does not remove it from the system. It remains configured and accessible through the management console, however the services for the application server are disabled.


Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Media Engines.

Step 3 Click the Enable or Disable next to the engine you want to enable or disable.


Removing a Media Engine from the System

To remove a media engine from the system, follow these steps:


Note This procedure removes a media engine from the system. It is no longer configured and accessible through the management console, and cannot communicate with the application server.


Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Media Engines.

Step 3 Click Remove to the right of the Media Engine you want to delete.

The media engine is deleted from the system, and the name is removed from the list on Media Engines page.


Adding a Media Resource Group

To add a media resource group, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Media Engines.

Step 3 Under Media Resource Groups, click Create New Group.

Step 4 Enter values as described in Table 3-9.

Table 3-9 Media Resource Group Properties

Field
Description

Name

Name (your choice) for the group

Type

Type of group

Note This value cannot be changed.

Description

Description of group

Failover Group

Name of the failover group


Step 5 Click Create Group.


Editing a Media Resource Group

To edit an existing media resource group, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Media Engines.

Step 3 Under Media Resource Groups, click Edit Group.

Step 4 Enter values as described in Table 3-10.

Table 3-10 Media Resource Group Properties-Editing

Field
Description

Name

Name (your choice) of the group

Type

Type of group

Note This value cannot be changed.

Description

Description of group

Failover Group

Name of the failover group


Step 5 To remove a member from the group, select the name from the Members list, then click Remove.

Step 6 Click Apply.

Step 7 Click Done to return to the Media Engines page.


Removing a Media Engine from the Group

To remove a media engine from the group without removing it from the system, follow these steps:


Caution A media engine cannot be used unless it is associated with a group. If you remove it from a group, you must add it to another group before an application can access it. If you do not add the media engine to a group, it will not be used.

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Media Engines.

Step 3 In the Media Resource Groups area, select the group from the list, then click Edit Group.

Step 4 Click Delete Group.

Step 5 Click OK to confirm.

The group is removed from the list on the Media Engines page.


Providers

Providers are application server plug-in modules that open network ports and allow the runtime environment to communicate with devices on the network.

Use the Providers page (Figure 3-8) to display the list of providers shipped with the Cisco Unified Application Server, the status of each provider (Enabled, Running, or Disabled), and the version number. Click the provider name to launch the configuration page for that provider.

Figure 3-8 Providers Page

This section includes these topics:

Viewing the List of Providers

Modifying a Provider

Disabling a Provider

Installing a Provider

Viewing the List of Providers

To view the list of providers that are shipped with the Cisco Unified Application Server software, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Providers.

The list of providers appears.


Modifying a Provider

To modify a provider, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Providers.

Step 3 Click one of these providers to select it:

Cisco DeviceListX Provider

H.323 Provider

HTTP Provider

JTAPI Provider

Media Engine Provider

Presence Provider

SCCP Provider

SIP Provider

Timer Provider

Step 4 Make changes as needed, then click Update.

Step 5 Click Done to return to the Providers page.


Disabling a Provider

To disable a provider, follow these steps:


Note When you disable a provider, it becomes unavailable. After restarting the application server, the provider remains disabled until you manually enable it.


Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Providers.

Step 3 Select one of the following providers by clicking on it.

Step 4 Click Disable Provider.


Installing a Provider

To install a provider, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Providers.

Step 3 Under Install a Provider, browse to locate the provider assembly (.dll file) or provider package (.mcp file), highlight it, then click Upload File.

The provider is added to the list of providers.


Cisco DeviceListX Provider

The Cisco DeviceListX Provider communicates with Cisco Unified Communications Manager to retrieve and cache real-time device information for application use. The Cisco DeviceListX (3.X, 4.X) Provider and SNMP (5.X, 6X) protocols are used to gather this information. The Cisco Unified Communications Managers with which the Cisco Unified Application Server communicates are specified in the Telephony Servers pages.

The Cisco DeviceListX Provider supports the following extensions, which you can invoke on the Cisco DeviceListX Provider page:

Metreos.Providers.CiscoDeviceListX.Refresh—Forces the application server to reinitialize the real-time cache. This is recommended if phone device IP addresses have been changed during high usage of an application that uses the Cisco DeviceListX Provider.

Figure 3-9 shows the Cisco DeviceListX Provider page, and Table 3-11 lists the provider parameters.

Figure 3-9 Cisco DeviceListX Provider Page

Table 3-11 Cisco DeviceListX Provider Parameters

Field
Description

Log Level

Type and amount of information system writes to the log for each component

Poll Interval

Interval in minutes between requests sent to Cisco Unified Communications Manager to refresh device information (cache refresh)


H.323 Provider

The H.323 provider can make and receive H.323 phone calls with call processing nodes within a Cisco Unified Communications Manager cluster. The H.323 provider has an H.323 gateway device appearance within the Cisco Unified Communications Manager, and Cisco Unified Communications Manager nodes have an H.323 gateway device appearance under Telephony Servers.


Note The H.323 provider is defined and configured under Main Control Panel > Telephony Servers.


Figure 3-10 shows the H.323 Provider page, and Table 3-12 lists the provider parameters.

Figure 3-10 H.323 Provider Page

Table 3-12 H.232 Provider Parameters 

Field
Description

Log Level

Filters all debug output below the specified level

Listen Port

Number of the port on which the stack should listen for incoming H.225 requests

Valid Range: 1024 - 32767

Max Pending Calls

Maximum number of pending calls allowed before the stack starts auto-rejecting calls

Valid Range: 100 - 1000

H.245 Range (min)

Minimum port number for H.245

Valid Range: 1024 - 32767

H.245 Range (max)

Maximum port number for H.245

Valid Range: 1024 - 32767

Enable Stack Debugging

Tool that writes logs to a file for H.323 diagnostics

Stack Debugging Log Level

Log level specifying detail of logs written by the StackDebugger

Valid Range: 0 - 5 (where 0=Errors-only and 5=Verbose)

Stack Debugging Log File

Name of log file for the Stack Debugging Log function

TCP Connect Timeout

Number of seconds that an attempt is made to contact a gateway before giving up. A lower number ensures faster failover.

Valid Range: 1 - 10

H323 Service Log Level

Detail level of service log messages

Valid Range 0 - 4 (where 0=Off, 1=Error, 2=Warning, 3=Info, 4=Verbose.


HTTP Provider

The HTTP provider receives HTTP requests over port 8000. These requests are then routed to the appropriate application for processing.

Figure 3-11 shows the HTTP Provider page, and Table 3-13 lists the provider parameters.

Figure 3-11 HTTP Provider Page

Table 3-13 HTTP Provider Parameters

Field
Description

Log Level

Filters all debug output below the specified level

Session Expiration Minutes

Number of minutes before HTTP sessions expire

Valid Range: 1 - 3600


JTAPI Provider

The Java Telephony API(JTAPI) provider uses the CTI protocol to create, receive, and control IP telephony calls. The JTAPI provider registers as a CTI route point and CTI port in Cisco Unified Communications Manager can use JTAPI to monitor phone devices.


Note CTI route points, ports, and monitored devices are defined and configured under Main Control Panel > Telephony Servers.


Figure 3-12 shows the JTAPI Provider page, and Table 3-14 lists the provider parameters.

Figure 3-12 JTAPI Provider Page

Table 3-14 JTAPI Provider Parameters 

Field
Description

Log Level

Filters all debug output below the specified level

Max Calls per Device

Maximum number of calls allowed on any first-party CTI Port device (this value must match the equivalent value in Cisco Unified Communications Manager)

Valid Range: 1 - 200

Advertise Low-bitrate Codecs

Indicates whether devices should be registered with G.723.1 and G.729a support


Media Engine Provider

The Media Engine provider manages media engines to provide media capabilities to applications. It supports these extensions:


Note You should invoke these extensions only under the direction of a Cisco technical support engineer.


Metreos.MediaControl.RefreshMediaServers—Forces the application server to reinitialize control of the media engines.

Metreos.MediaControl.ClearMRGCache—Forces the application server to reinitialize the media engine's internal storage.

Metreos.MediaControl.PrintServerTable—Forces the application server to write a summary of all configured media engines to the application server log.

Metreos.MediaControl.PrintDiags—Forces the application server to write diagnostic information about currently connected media engines to the application server log.

Figure 3-13 shows an excerpt of the Media Engine Provider page, and Table 3-15 lists the provider parameters.

Figure 3-13 Media Engine Provider Page

Table 3-15 Media Engine Provider Parameters 

Field
Description

Log Level

Filters all debug output below the specified level

Connect Timeout

Interval in milliseconds before a connection is deemed unsuccessful and the system attempts to retry

Valid Range: 1000 - 60000

Heartbeat Interval

Interval, in seconds, between heartbeat signals to a media engine

Valid Range:1 - 60

Heartbeat Skew

Interval, in seconds, that the Media Engine provider waits for a response to the heartbeat signal

Valid Range:1 - 60

Log Inbound Connect Messages

All inbound connect messages written to the Log Server

Log Outbound Connect Messages

All outbound connect messages written to the Log Server

Log Outbound Disconnect Messages

All outbound disconnect messages written to the Log Server

Log Outbound Command Messages

All outbound command messages written to the Log Server

Log Inbound Response Messages

All inbound responses written to the Log Server

Log Real-Time Resource Info

Heartbeat signal information written to the Log Server

Log Media Server Selection

All selection process details written to the Log Server

Log Transaction Metrics

All log transaction metrics written to the Log Server


Presence Provider

The Presence provider uses SIP and SIMPLE (SIP for Instant Messaging and Presence Leveraging Extensions) to communicate with outside systems that support these protocols. This allows applications to receive notification of presence changes in real-time for a user or a group of users.


Note While the Presence provider should be able to interface with any SIP- or SIMPLE-capable application, the provider has only been tested and supported with Cisco Unified Presence, Release 6.0.


Figure 3-14 shows the Presence Provider page, and Table 3-15 lists the provider parameters.

Figure 3-14 Presence Provider Page

Table 3-16 Presence Provider Parameters

Field
Description

Log Level

Filter for all debug output (below the specified level)

ServiceLogLevel

Presence service log level.

Valid Range: 0 - 4 (where 0=Off, 1=Error, 2=Warning, 3=Info, 4=Verbose)

ServiceTimeout

Time (in seconds) provider waits for Presence service to respond. It should be a positive number.

Valid Range: 0 - 2147483647

SubscribeExpires

Expiration time (in seconds) for each subscription

When it expires, presence service automatically resubscribes to the presence server for notification. The value must fall between the configured minimum and maximum expires time on Cisco Unified Presence

Valid Range: 1 - 2147483647

LogTimingStat

Timing statistics (enabled when set to yes)


SCCP Provider

The SCCP provider uses the SCCP protocol to create, receive, and control IP telephony calls. The SCCP provider registers as an SCCP 7960 device in Cisco Unified Communications Manager.


Note SCCP devices are defined and configured under Main Control Panel > Telephony Servers.


Figure 3-15 shows an excerpt of the SCCP Provider page. Table 3-17 lists only the basic SCCP parameters; the advanced parameters on the Provider page have default values that do not need to be modified.

Figure 3-15 SCCP Provider Page


Note The table below does not list the advanced parameters. They should be allowed to default.


Table 3-17 SCCP Provider Parameters 

Field
Description

Log Level

Filter for all debug output (below the specified level)

MaxBurst

Maximum registration messages per burst (5)

Valid Range: 1 - 2147483647

InterBurstDelayMs

Milliseconds between bursts (1000)

Valid Range: 0 - 2147483647

CommunicationsManagerPort

Port on which Cisco Unified Communications Managers listen for registrations (2000)

Valid Range: 1024 - 32767

AdvertiseLowBitRateCodecs

Devices registered with G.729a support (No)

MusicOnHoldOption

Music-On-Hold enabled (Yes)

LogCallVerbose

Verbose logging for call enabled (Yes)

LogCommunicationsManagerVerbose

Verbose logging for Communications Manager (No)

LogConnectionVerbose

Verbose logging for connection (No)

LogDiscoveryVerbose

Verbose logging for discovery (No)

LogRegistrationVerbose

Verbose logging for registration (Yes)

LogSystemVerbose

Verbose logging for system (No)


SIP Provider

The SIP provider uses the SIP protocol to create, receive, and control IP telephony calls between Cisco Unified Communications Manager nodes. The SIP provider either behaves as a SIP trunk or registers as SIP 7961G-GE devices in Cisco Unified Communications Manager.


Note SIP trunks and SIP devices are defined and configured under Main Control Panel > Telephony Servers.


Figure 3-16 shows the SIP Provider page, and Table 3-18 lists the provider parameters.

Figure 3-16 SIP Provider Page

Table 3-18 SIP Provider Parameters 

Field
Description

Log Level

Filter for all debug output (below the specified level)

DefaultOutboundFromNumber

Default From number for outbound call.

SIPTrunkIP

SIP Trunk IP address for outbound call (should match the IP used for SIP Trunk in Communications Manager)

SIPTrunkPort

SIP Trunk port for outbound call (should match the port used for SIP Trunk in Communications Manager)

MinRegistrationPort

Minimum TCP port number to use for registration with SIP server

Valid Range:1024 - 65535

MaxRegistrationPort

Maximum TCP port number to use for registration with SIP server

Valid Range: 1024 - 65535

ServiceLogLevel

SIP service log level

Valid Range: 0 - 4 (where 0=Off, 1=Error, 2=Warning, 3=Info, 4=Verbose)

LogTimingStat

Timing statistics (enabled when set to true)


Timer Provider

The Timer provider makes timers available for use by applications. It does not communicate with any other system.

Click the Timer provider link to configure the Timer provider. Figure 3-17 shows the Timer Provider page, and Table 3-19 lists the provider parameters.

Figure 3-17 Timer Provider Page

Table 3-19 Timer Provider Parameters 

Field
Description

Log Level

Filters all debug output below the specified level

Enable Minute Events

Enable minute by minute timer events (enabled when set to Yes)

Enable Hourly Events

Enable hourly timer events (enabled when set to Yes)

Enable Daily Events

Enable daily timer events will be generated (enabled when set to No)


Telephony Servers

Every IP telephony system must contain at least one telephony server. The management console provides a telephony server configuration page for adding and configuring telephony servers and devices on those servers. When adding a telephony server, however, its devices must be associated with one or more call route groups.

This section includes these topics:

Overview

Configuring SIP

Creating H.323 Call Route Groups and Gateways

Creating CTI Telephony Devices

Configuring JTAPI-Monitored Devices

Configuring SCCP Devices

Overview

Just as a media resource group functions as a container for media engines, a call route group functions as a container for telephony devices. Each telephony device must belong to one or more call route groups.


Note Creating a call route group is optional; the system provides a default call route group to be used if multiple groups are not needed.


From the main Main Control Panel, click Telephony Servers to open the Telephony Servers page (Figure 3-18).

Figure 3-18 Telephony Servers Page

The application server currently supports these call control protocols:

SIP

H.323

CTI

SCCP

It also supports these types of telephony servers:

Cisco SIP Domain—Defines a SIP interface into Cisco Unified Communications Manager. By creating a Cisco SIP domain, you can use SIP trunks and SIP devices that the Cisco Unified Application Server creates in Cisco Unified Communications Manager.

H.323 Gateway—Telephony servers, which are used exclusively with H.323.

Unified Communications Manager—Multipurpose telephony server devices supporting SCCP and CTI in the Cisco Unified system.

IETF SIP Domain—Defines a telephony server that supports Internet Engineering Task Force (IETF)-specific SIP.

Configuring SIP

The Cisco Unified Application Server can simultaneously behave as both an SIP trunk and one or more SIP phones. However, to behave as both device types simultaneously, you have to configure the Cisco Unified Application Server with two IP addresses. This is because the Cisco Unified Communications Manager does not allow SIP trunk devices and SIP phone devices to have the same IP address at the same time. To support both SIP trunk and SIP phone functionality with the Cisco Unified Application Server, one of the two IP addresses must be configured using the SIP Provider > SIPTrunkIP field.

The SIP Provider will automatically support only SIP trunk calling if it detects that the application server has only one IP address. In that case, there is no need to configure the SIP Provider > SIPTrunkIP field—it will simply default to the one IP address of the Application Server.


Note When you use the SIP protocol, the outbound leg is handled by the SIP trunk assigned to the Cisco SIP Domain for the Cisco Unified Application Server.


This section includes these topics:

Configuring IP Addresses on the NIC

Configuring SIP Trunks

Configuring SIP Devices

Configuring IP Addresses on the NIC

To configure IP addresses on the Cisco MCS server's NIC, follow these steps:

Procedure


Step 1 In Windows Explorer, select Start > Control Panel > Network Connections > Local Area Connection.

The Local Area Connection dialog appears.

Step 2 Click Properties.

Step 3 Highlight Internet Protocol (TCP/IP), then click Properties.

The Internet Protocol (TCP/IP) Properties dialog appears.

Step 4 Select Use the following IP address, and enter a static IP address and other information related to your network setup.

Step 5 Click Advanced...

The TCP/IP dialog appears.

Step 6 Enter the second IP address, then click Add.


Configuring SIP Trunks

You can use SIP trunks for two purposes:

First-party calling mechanism for applications between the Cisco Unified Communications Manager and the Cisco Unified Application Server—See First-Party Calling Integration with Cisco Unified Communications Manager.

Integrate to Cisco Unified Presence—See Presence Integration with Cisco Unified Presence.

Whether you use SIP trunks is dependent on the requirements of the applications installed on the Cisco Unified Application Server. In other words, if one or more applications needs an SIP trunk to perform first-party calling, or if one or more applications needs presence information, then create SIP trunks.

First-Party Calling Integration with Cisco Unified Communications Manager

If an application is performing peer-to-peer dialing with SIP trunks or phones, and the outbound call leg is potentially routed to the PSTN, then two service parameters must be altered to prevent the outbound from call from prematurely terminating while it is still in a ringing state. Both of the parameters are set in the Cisco Unified Communications Manager administration web interface under System > Service Parameters > Select Any Server > Service = Cisco CallManager > Clusterwide Parameters (Service). Change the values for each to 30 to allow the outbound call to ring for 30 second instead of terminating prematurely:

Media Exchange Interface Capability Timer: 30

Media Exchange Timer: 30

When you configure the Cisco Unified Communications Manager side of the SIP trunk integration, select the SIP Information > Destination Address* field.

If the Cisco Unified Application Server has one IP address, enter the IP address configured on the server's operating system.

If the Cisco Unified Application Server has two IP addresses, enter the server's IP address configured in the SIP provider on the management console.

To integrate first-party calling with Cisco Unified Communications Manager, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Select Cisco SIP Domain from the Add Server list.

Step 4 Click Add Server.

Step 5 Configure settings as described in Table 3-20.

Table 3-20 Add Server Parameters for Cisco Unified Communications Manager

Field
Description

Domain Name

IP address of a Cisco Unified Communications Manager

Primary Registrar

IP address of a Cisco Unified Communications Manager

Secondary Registrar

IP address of a Cisco Unified Communications Manager

Outbound Proxy

Address of the outbound proxy


Step 6 Click Create SIP Domain to create the domain.

By creating the domain, an SIP trunk is automatically created and inserted into the Default SIP Call Route Group.


Presence Integration with Cisco Unified Presence

To integrate with Cisco Unified Presence, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Select IETF SIP Domain from the Add Server list.

Step 4 Click Add Server.

Step 5 Configure settings as described in Table 3-21.

Table 3-21 Add Server Parameters for Cisco Unified Presence

Field
Description

Domain Name

Name resolvable SIP domain name

Primary Registrar

Address of the primary registrar

Secondary Registrar

Address of the secondary registrar

Outbound Proxy

Address of the outbound proxy


Step 6 Click Create SIP Domain to create the domain.

Unlike creating a Cisco SIP domain, a SIP trunk is not automatically created and inserted into the Default SIP Call Route Group.


Configuring SIP Devices

Use SIP devices to allow a first-party calling mechanism between the Cisco Unified Communications Manager and the Cisco Unified Application Server. Whether you use SIP devices is dependent on the requirements of the applications installed on the Cisco Unified Application Server. In other words, if one or more applications need one ore more SIP devices to perform first-party calling, then create SIP device(s).

To integrate first-party calling with Cisco Unified Communications Manager, follow these steps:

1. Create a SIP Domain—See Creating a SIP Domain

2. Create a SIP Device Pool—See Creating a SIP Device Pool

3. Add Devices from the SIP Pool—See Adding Devices from the SIP Pool

Creating a SIP Domain

To create a SIP domain, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Select Cisco SIP Domain from the Add Server list.

Step 4 Click Add Server.

Step 5 Configure settings as described in Table 3-22.

Table 3-22 Add Server Parameters for Cisco Unified Communications Manager

Field
Description

Domain Name

IP address of Cisco Unified Communications Manager

Primary Registrar

IP address of Cisco Unified Communications Manager

Secondary Registrar

IP address of Cisco Unified Communications Manager

Outbound Proxy

Address of outbound proxy


Step 6 Click Create SIP Domain to create the domain.

By creating the domain, a SIP Trunk is automatically created and inserted into the Default SIP Call Route Group.


Creating a SIP Device Pool

To create a Cisco SIP device pool, follow these steps:

Procedure


Step 1 Click Create Cisco SIP Device Pool on the SIP domain edit page.

Configure settings as described in Table 3-23.

Table 3-23 Cisco SIP Device Pool Parameters

Field
Description

Name

Display name (your choice) for the SIP device pool.

Username

User configured in Cisco Unified Communications Manager that has the rights to control the SIP device(s) that will be registered by the Cisco Unified Communications Manager

Password

Password of configured user

Outbound Proxy

If an outbound proxy was configured on the domain, it is optional to apply it to SIP traffic generated for the registration of the devices

Add to Group

Group to which the SIP device(s) are assigned


Step 2 Click Create SIP Device Pool.


Adding Devices from the SIP Pool

After the device pool has been created, SIP devices can be added and removed from the pool. Note that it assumed that the devices already exist in Cisco Unified Communications Manager as the Cisco Unified IP Phone 7961G-GE.

There are two ways to add devices to the device pool as configured: one at a time or in bulk.

To add a single device to the device pool, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Select Cisco SIP Domain from the Add Server list.

Step 4 Select Manage for a device pool.

Step 5 Under Add Single Device, enter the MAC address for the SIP phone as configured in the Cisco Unified Communications Manager.

Step 6 Click Add to add the device.


To add a range of devices to the device pool, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Select Cisco SIP Domain from the Add Server list.

Step 4 Select Manage for a device pool.

Step 5 Under Add Several Devices, add the Starting MAC Address, and the number of Devices to Register to add to this device pool. The Starting MAC address is used to compute the MAC address used for each n * Devices to Register devices in a sequential manner.

Step 6 Click Add to add the devices.


Creating H.323 Call Route Groups and Gateways

This section describes how to create and configure H.323 call route groups and gateways. If a call route group other than the default is required, you can create a new H.323 call route group using this procedure.

This section includes these topics:

Creating a New Call Route Group

Creating an H.323 Gateway

Creating a New Call Route Group

To add a new call route group, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Select H.323 Group from the Create New Group list under Call Route Groups.

Step 4 Click Create New Group to open the Create Group page (Figure 3-19).

Figure 3-19 Configuring a New H.323 Telephony Group

Step 5 Enter the name of the group.

Step 6 Enter a description.

Step 7 Select Create Group.

Step 8 To add members, select one from the list, then click Add Member.


Creating an H.323 Gateway

Before you can add an H.323 telephony server to a group, you must create an H.323 gateway. Because H.323 does not require static configuration of devices, the gateway is added to a call route group. All logical devices created during runtime will automatically be part of that same group.

To create an H.323 gateway, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Select H.323 Gateway from the Add a Telephony Server list.

Step 4 Click Add Server.

Step 5 Configure settings as described in Table 3-24.

Table 3-24 H.323 Gateway Parameters 

Field
Description

Name

Name (your choice) for the gateway

Description

Information to identify the gateway

Address

IP address of gateway

Add to Group

Group to which gateway is assigned


Step 6 Click Add H.323 Gateway to create the gateway.


Creating CTI Telephony Devices

Computer Telephony Integration (CTI), unlike H.323, is an IP telephony protocol based on line-oriented telephony devices. This section describes how to set up and administer CTI ports and route points that are configured on a CTI Manager. These properties apply to CTI devices:

A CTI route point is a group unto itself.

CTI ports are grouped into device pools.

CTI ports and route points must each have at least one CTI manager associated with them.

Call route groups should contain exactly one route point or one device pool. The application server does not allow a call route group containing a combination of route points and device pools.

CTI route points and device pools are contained within a CTI Manager and are associated with CTI Groups.

This section includes these topics:

Creating a CTI Route Group

Adding a Cisco Unified Communications Manager Cluster

Creating a CTI Manager

Editing a CTI Manager

Deleting a CTI Manager

Creating a CTI Device Pool

Viewing a CTI Device Pool Settings

Deleting CTI Device Pool Settings

Managing CTI Device Pool Settings

Creating a Monitored CTI Device Pool

Creating a CTI Route Point

Creating a CTI Route Group

To create a CTI route group, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Select CTI Server Group from the Create New Group list.

Step 4 Click Create New Group.

Step 5 Enter the name of the group in the Name field.

Step 6 Enter a description in the Description field.

Step 7 Click Create Group.


Adding a Cisco Unified Communications Manager Cluster

Cisco Unified CTI clusters are known as Cisco Unified Communications Manager clusters. You can create a Cisco Unified Communications Manager cluster and associate it with the new CTI group.

To add a Cisco Unified Communications Manager cluster, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Select Unified Communications Manager from the Add a Telephony Server list.

Step 4 Click Add Server.

Step 5 Configure settings as described in Table 3-25.

Table 3-25 Cisco Unified Communications Manager Parameters 

Field
Description

Name

Name to identify the server

Version

Cisco Unified Communications Manager version

Publisher Address

IP address of the publisher of the Cisco Unified Communications Manager cluster

Publisher Admin Username

Administrator user name for the publisher

Publisher Admin Password

Password for the publisher

Retype Publisher Admin Password

Password verification for the publisher

SNMP Community

SNMP community string for the publisher

Description

Text to describe the publisher


Step 6 Click Create Unified Communications Manager Cluster.


Creating a CTI Manager

To create a CTI manager, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Click the name of the server to open the server configuration page.

Step 4 Scroll down and click Add CTI Manager.

Step 5 Enter the manager name.

Step 6 Enter the address.

Step 7 Click Add CTI Manager. You can now create devices.


Editing a CTI Manager

To edit a CTI manager, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Click the name of the server to open the server configuration page.

Step 4 Click Edit next to the CTI manager you want to modify.

Step 5 Make the changes, then click Apply CTI Manager.

Step 6 Click Done to return to the previous page.


Deleting a CTI Manager

To delete a CTI manager, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Click the name of the server to open the server configuration page.

Step 4 Click Edit next to the CTI manager you want to modify.

Step 5 Click Delete CTI Manager.


Creating a CTI Device Pool

To create a CTI device pool, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Click the name of the server to open the server configuration page.

Step 4 Scroll down and click Create CTI Device Pool.

Step 5 Configure values as described in Table 3-26.

Table 3-26 CTI Device Pool Parameters 

Field
Description

Name

Name of the pool

Primary CTI Manager

Primary CTI Manager for CTI device pool

Secondary CTI Manager

Secondary CTI Manager for CTI device pool

Username

Username to allow monitoring of CTI device pool

Password

Password for monitoring the CTI device pool (must reenter to verify)

Add To Group

Call route group selected for this device pool


Step 6 Click Create CTI Device Pool.


Viewing a CTI Device Pool Settings

To view a CTI device pool settings, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Click the name of the server to open the server configuration page.

Step 4 Scroll down and under Monitored Device Pools, click View Settings.

A page appears with the settings for the device pool.


Deleting CTI Device Pool Settings

To delete a CTI monitored device pool, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Click the name of the server to open the server configuration page.

Step 4 Scroll down and under Monitored Device Pools, click View Settings.

A page appears with the settings for the device pool.

Step 5 Click Delete Monitored CTI Device Pool.


Managing CTI Device Pool Settings

To add, search for, or manage a device in a CTI monitored device pool, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Click the name of the server to open the server configuration page.

Step 4 Scroll down and under Monitored Device Pools, click Manage Devices.

Step 5 A page appears from which you can:

Add a device—Enter the device name and click Add.

Search for a device—Enter the search criteria, then click Search.

Delete a device—Select one or more devices from the list, then click Delete Devices.


Creating a CTI Route Point

To create a CTI route point, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Click the name of the server to open the server configuration page.

Step 4 Scroll down and Create CTI Route Point.

Step 5 Configure values as described in Table 3-27.

Table 3-27 CTI Route Point Parameters 

Field
Description

Name

Name of the pool

Device Name

Device name of the CTI route point as created in Cisco Unified Communications Manager (name is case-sensitive)

Primary CTI Manager

Primary CTI Manager for CTI device pool

Secondary CTI Manager

Secondary CTI Manager for CTI device pool

Username

Username to allow monitoring of CTI device pool

Password

Password for monitoring CTI device pool (must reenter to verify)

Add To Group

Call route group selected for this device pool


Step 6 Click Create CTI Route Point.


Configuring JTAPI-Monitored Devices

JTAPI allows third parties to monitor a device state in real time. To allow an application built with the Cisco Unified Application Environment to use JTAPI in this way, you must create a monitored CTI device pool.


Note A monitored CTI device pool is contained within a CTI manager.


This section includes these topics:

Creating a Monitored CTI Device Pool

Adding Devices to the Monitored CTI Device Pool

Creating a Monitored CTI Device Pool

To create a monitored CTI device pool, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Click the name of the server to open the server configuration page.

Step 4 Scroll down and click Create Monitored CTI Device Pool.

Step 5 Configure values as described in Table 3-26.

Table 3-28 CTI Device Pool Parameters 

Field
Description

Name

Name of pool

Primary CTI Manager

Primary CTI Manager for the monitored CTI device pool

Secondary CTI Manager

Secondary CTI Manager for the monitored CTI device pool

Username

Username to allow monitoring of all devices configured in the device pool

Password

Password to allow monitoring of all the devices in the device pool (must reenter to verify)

Add To Group

Call route group selected for this device pool


Step 6 Click Create CTI Device Pool.

After the device pool has been created, devices can be added and removed from the pool one at a time. See Adding Devices to the Monitored CTI Device Pool.


Adding Devices to the Monitored CTI Device Pool

To add a single device to the device pool, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Select Unified Communications Manager from the Add Server list.

Step 4 Select Manage Devices for a monitored device pool.

Step 5 Under Add Device, enter the device name address for the phone as configured in Cisco Unified Communications Manager.

Step 6 Click Add.

After a minute, click Refresh on the Manage Device page, then check the Status field.

If the Status shows Enabled Running, and a directory number is showing, then the device is being monitored.

If no number shows after a minute, and the status does not update, make sure the Application Server service is running and that the corresponding JTAPI service is running.

If both services are running, check the AppServer log for errors by selecting Main Control Panel > Server Logs > AppServer.


Configuring SCCP Devices

For applications requiring SCCP devices, there must be at least one SCCP device pool configured to contain SCCP devices.

This section includes these topics:

Adding a Subscriber to the Cisco Unified Communications Manager

Creating a Device Pool

Adding a Subscriber to the Cisco Unified Communications Manager

To add a subscriber to Cisco Unified Communications Manager, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Click the name of the telephony server to be added as an SCCP subscriber.

Step 4 Click Add Subscriber.

Step 5 Enter the subscriber name.

Step 6 Enter the subscriber IP address.

Step 7 Click Add Subscriber.


Creating a Device Pool

To create a device pool on the subscriber created to contain SCCP devices, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Components, click Telephony Servers.

Step 3 Click the name of the telephony server.

Step 4 Click Create SCCP Device Pool in the SCCP Device Pools section.

Step 5 Configure settings as described in Table 3-29.

Table 3-29 Device Pool Parameters 

Field
Description

Name

Name of the pool

Primary Subscriber

Primary subscriber for the SCCP Device Pool

Secondary Subscriber

Secondary subscriber for the SCCP Device Pool

Tertiary Subscriber

Tertiary subscriber for the SCCP Device Pool

Quaternary Subscriber

Quaternary subscriber for the SCCP Device Pool

SRST

Subscriber assigned as SRST for the SCCP Device Pool

Add To Group

Call route group for this device pool


Step 6 Click Create Device Pool.


Configuring System Parameters

The System group contains links to these Cisco Unified Application Environment configuration pages:

Service Control—Service Control

License Management—License Management

Statistics— Viewing Statistics

SSL Management—SSL Management

Redundancy Setup—Redundancy Setup

Service Control

The Service Control page (Figure 3-20) is used to enable, disable, stop, restart, or kill services that run on the application server. Under normal circumstances, it should not be necessary to perform these functions; these functions are required only in these instances:

You have modified configuration parameters using the management console, and a message has indicated that you must restart a particular service for the configuration change to take effect.

A service is not functioning properly.

A Cisco support representative has asked you to restart a service to help debug an issue.


Note Services require differing amounts of time to restart. The media engine and application server can take approximately one minute to start or stop.


Figure 3-20 Service Control Page

Procedure

To see the services that are currently running and to enable, disable, start, restart, or stop the services, follow these steps:


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under System, click Service Control.

Table 3-30 describes the information that is provided for each service.

Table 3-30 Service Control Page 

Field
Description

Service Name

Name of service

Description

Explanation of service

Enabled

Indicates whether service is active

An enabled service automatically starts when the system is rebooted; a disabled service does not. When a service is disabled, the system automatically stops it.

Status

Running—Service is available

Stop Pending—Service is shutting down

Stopped—Service is unavailable

Start Pending—Service is starting up

Unknown—Status is unknown

Actions

Disable—Make service unavailable (disallows automatic start at reboot)

Restart—Stop and restart the service

Stop—Make service unavailable

Kill—Stop the service

Enable—Allow automatic start at reboot

Start — Make service available

To perform an action on a service, click the button to the right of the action.



License Management

The license management page (Figure 3-21) is used to apply licenses to the Cisco Unified Application Environment server.

When you place an order for the Cisco Unified Application Environment, Cisco ships you a Claim Certificate with a Product Authorization Key (PAK). The Claim Certificate provides directions for registering the PAK to obtain the license. You must:

1. Register the PAK that you received using the License Registration web tool that is provided on Cisco.com at the following URL: https://tools.cisco.com/SWIFT/Licensing/PrivateRegistrationServlet.

2. Enter the MAC address of the server for which you are requesting the licenses, and a valid e-mail address.

A license file is generated per the license configuration you purchased, and sent to you using the e-mail address you provided.

3. Upload the license file to the server. (See the Uploading the Cisco Unified Application Environment License).

Figure 3-21 License Management Page

This section includes these topics:

Overview

Uploading the Cisco Unified Application Environment License

Viewing License Statistics

Viewing License Details

Deleting a License

Overview

By applying the appropriate licenses, you enable either the Cisco Unified Application Server software on the server or the Cisco Unified Media Engine software, or both. In addition, you can incrementally increase the capabilities for the Cisco Unified Application Server or for the Media Engine with supplementary licenses. There are dedicated licenses files for:

Mode (Premium, Standard, or Basic)

The mode of the Cisco Unified Application Server or Cisco Unified Media Engine, which defines the upper limit of script instances.

Application Instance Licenses

Licenses can be applied to the Cisco Unified Application Server to increase the number of application instances allowed to concurrently execute on the application server. Note that while an incremental license will increase the number of application instances, the total number of such instances cannot exceed the upper limit dictated by the mode of the Cisco Unified Application Server license. If the number of licensed application instances exceeds this mode limit, the total allowed instances will cap at the mode limit.

Media Resource Instance Licenses

Licenses can be applied to the Cisco Unified Media Engine mode license to increase the number of media resources instances allowed to concurrently execute on the media engine. Note that while an incremental license will increase the overall amount of media resources instances, the total amount of media resources instances cannot exceed the upper limit dictated by the mode of the Cisco Unified Media Engine license. If the number of licensed application instances exceeds this mode limit, the total allowed instances will cap at the mode limit.

If no licenses are applied to the server, then the server will operate in software developer kit (SDK) mode. This mode may not be used for commercial purposes. It is intended to enable development, demos, and trials. In this mode, the server will auto-license itself to:

6 script instances

6 RTP (G.711)

0 ERTP (Low-bit rate: G.723 & G.729)

6 Voice (Media operations such as Play, Record, and GatherDigits)

6 Conference

0 Speech Recognition (also known as continuous speech processing (CSP)

1 text-to-speech port

Licenses are node locked to the MAC address of the server. If you upload a licence that does not have the same MAC address as the server, the features specified by the licence will not be enabled.

Uploading the Cisco Unified Application Environment License

To upload the Cisco Unified Application Environment license, follow these steps:


Note Uploading a license restarts the server.


Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under System, click License Management.

Step 3 Under Unified Application Environment License, click Browse... and highlight the license mode, then click Open to make the file available for uploading.

Step 4 Click Upload.


Viewing License Statistics

To view statistics for the Unified Application Environment licenses, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under System, click License Management.

.Table 3-31 describes the information that is provided for each license type.

Table 3-31 License Statistics 

Field
Description

Resource

Name of the resource.

Max

Maximum number of resource units that can be licensed with the current license mode.

To increase this number, you must obtain a higher-mode licenses.

Licensed

Number of licensed resource units.

To increase this number you must purchase additional, incremental licenses. However, this number cannot be larger than the one shown in the Max field.

Active

Currently-used number of license units.

Stats

Click View Graphs.



Viewing License Details

To view license details, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under System, click License Management.

Step 3 Under License File Management, click View Details next to the license name.


Deleting a License

To delete a license, follow these steps:


Note Deleting a license restarts the server.


Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under System, click License Management.

Step 3 Under License File Management, click Delete next to the license name you want to delete.


SSL Management

The management console web server does not have an SSL certificate or SSL key. If you need to use HTTPS (HTTP-over-SSL) instead of HTTP for management console access, then you must supply a security certificate and key. Open the SSL Management page (Figure 3-22) to manage SSL certificates and keys.


Note If you already have your own SSL certificate and key, they are verified upon upload to make sure that they are compatible. You must upload them at the same time.


This section includes these topics:

Uploading an SSL Certificate and Key

Generating a New SSL Certificate and Key

Figure 3-22 SSL Management Page

Uploading an SSL Certificate and Key

To upload an SSL certificate and key, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under System, click SSL Management.

Step 3 Under Upload SSL Certificate/Key, click Browse... and highlight the certificate file, then click Open to make the file available for uploading. Then do the same for the key.

Step 4 Click Upload to copy the certificate and key to the server.


Generating a New SSL Certificate and Key

To generate a new SSL certificate and key, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under System, click SSL Management.

Step 3 Under Generate SSL Certificate/Key, enter the values as described in Table 3-32.

Table 3-32 SSL Certificate Parameters 

Field
Description

Passphrase

Code used to encrypt the private key

Organization Name

Name of organization submitting certificate request

Organizational Unit

Type of organization submitting certificate request

Country

Standard two-letter country code

State/Province

Full name of state or province where server is located

City/Locality

City or other local jurisdiction where server is located

Domain/Common Name

Host and domain name (for example, cisco.com)

E-mail Address

Contact email address

Years Until Expire

Number of years SSL certificate should be valid


Step 4 Click Generate Certificate/Key.


Redundancy Setup

The Cisco Unified Application Environment supports redundant configurations for certain protocols, including Session Initiation Protocol (SIP), Skinny Client Control Protocol (SCCP), and computer telephony integration (CTI). Specifically, when these protocols are configured in station (phone) device appearances in Cisco Unified Communications Manager, such as a CTI Route Point, CTI Port, SCCP phone, or SIP phone, the steps outlined here allow add redundancy.

You can configure a master and stand-by application server. The stand-by server attempts to contact the master server every few seconds. If the specified number of attempts fails, the stand-by server takes over.

Use the Redundancy Setup page (Figure 3-23) to assign a unique ID number for each of the application servers and to configure the master and stand-by servers.

Creating a master/stand-by configuration is not always necessary to achieve redundancy. If the device appearance of the Cisco Unified Application Server in the Cisco Unified Communications Manager is a gateway or trunk, then the Cisco Unified Communications Manager Route Lists and Route Groups can be used to define groups of Cisco Unified Application Servers. Route groups defined in the Cisco Unified Communication Manager inherently support failover and/or load balancing. For example, if a call is placed to a gateway or trunk in a route group, and the receiving gateway or trunk is not responding, then Cisco Unified Communications Manager will try the next device in the group, essentially providing redundancy.

A pair of servers can be both a master and stand-by servers to each other. This configuration allows you to place half of the devices to be registered on one server and the other half on the second server. When both servers are up, neither server is fully loaded. Only when a server is down is the other fully loaded. This allows minimum system resource usage during up times thereby creating optimum performance.

Figure 3-23 Redundancy Setup Page

To set up redundant operations, follow these steps:


Note When you make changes that involve the Server ID or address of the master or stand-by appliance, you must shut down and restart the application server and database.


Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under System, click Redundancy Setup.

Step 3 Enter a unique server ID to identify this server.

Step 4 Enter settings in the As Master fields as described in Table 3-33.

Table 3-33 Master Server Parameters 

Field
Description

Address of Standby

IP address of standby appliance

Database Username

User name for standby appliance access

Database Password

Password for standby appliance access

Verify Password

Reenter password

Startup Synchronization Timeout

Number of seconds after which master appliance is considered unavailable


Step 5 Enter settings in the As Stand-by fields as described in Table 3-34.

Table 3-34 Stand-by Server Parameters 

Field
Description

Address of Master

IP address of master appliance

Database Username

User name for standby appliance access

Database Password

Password for standby appliance access

Verify Password

Reenter password

Heartbeat Interval

Number of seconds standby appliance waits between attempts to contact the master appliance

Max Missed Heartbeats

Number of attempts after which master appliance is considered unavailable


Step 6 Click Apply Settings.

Step 7 Click Done to return to the Main Control Panel.


Configuring Local Environment Parameters

The Local Environment group contains links these Cisco Unified Application Environment configuration pages:

User Management—User Accounts

Core Component Configuration—Core Components

Media Engine Configuration—Configuring the Cisco Unified Media Engine

Log Server Configuration—Log Server

Speech Recognition Configuration—Configuring Speech Recognition Parameters

Alarm Management—Alarms

User Accounts

A user account is required for each user who will access the system. By creating a different account for each user, you can ensure that audit logs will accurately record each user's interactions with the system. From the Main Control Panel, open the Users page (Figure 3-24) to add users and to list existing users and their access levels.


Note From the Users page, you can list all users or click a letter to select the users whose names begin with that letter. Click the asterisk (*) next to the A in the alphabet string to return to the default view (all users).


This section includes these topics:

Adding a User

Changing a User Password

Removing a User

Figure 3-24 Users Page

Adding a User

To add a user, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Local Environment, click User Management.

Step 3 Click Add a User.

The Add User page opens.

Step 4 Enter settings in the Add User fields as described in Table 3-33.

Table 3-35 Add User Parameters 

Field
Description

Username

Username for the new user.

Password

Password for the user

Verify Password

Reenter password for verification

Access Level

Permission level for the user.

Administrator—Users assigned the Administrator role are allowed full access to the management console.

Normal User—Users assigned to the Normal User role may manage only the following system components:

Core Component Configuration

Applications

Media Engines

Providers

Telephony Servers


Step 5 Click Add User.

Step 6 Click Go Back to return to the Users page.


Changing a User Password

To change a user password, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Local Environment, click User Management.

Step 3 Click * to list all users, or click the first letter of the user name.

Step 4 Scroll to find the user name, then click Edit User.

The Edit User page opens.

Step 5 Enter a new password, then reenter it to verify.

Step 6 Click Apply.

Step 7 Click Go Back to return to the Users page.


Removing a User

To remove a user, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Local Environment, click User Management.

Step 3 Click * to list all users, or click the first letter of the user name.

Step 4 Scroll to find the user name, then click the associated Delete User button.

Step 5 Click Yes to confirm.

The user record is deleted.

Step 6 Click Go Back to return to the Users page.


Core Components

From the Main Control Panel, open the Core Components page (Figure 3-25) to configure Cisco Unified Application Environment core components.

Figure 3-25 Core Component Page

To configure core components, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Local Environment, click Core Component Configuration.

Step 3 Click the name of the component you want to configure.

Step 4 Enter and select values as described in these tables:

Application Environment, Table 3-36

Application Server, Table 3-37

Application Manager, Table 3-38

Cluster Interface, Table 3-39

License Manager, Table 3-40

Logger, Table 3-41

Management Interface, Table 3-42

Provider Manager, Table 3-43

Router, Table 3-44

Telephony Manager, Table 3-45

Step 5 Click Apply.

Step 6 Click Done to return to the Core Components page.


You can also invoke extensions from some of the core components pages that provide additional services.

Table 3-36 Application Environment Parameters

Field
Description

Log Level

Filters all debug output below the specified level

Shutdown Timeout

Interval in seconds to wait for applications to shut down

Max Threads

Size of thread pool used for concurrent execution of actions


Table 3-37 Application Server Parameters

Field
Description

Log Level

Filters all debug output below the specified level

Server Name

Identifier for application server


Table 3-38 Application Manager Parameters

Field
Description

Log Level

Filters all debug output below the specified level

Debug Listen Port

Number of port on which the debugger listens for debug commands

Default Locale

Locale applied to all newly-installed applications by default


Table 3-39 Cluster Interface Parameter

Field
Description

Log Level

Filters all debug output below the specified level


Table 3-40 License Manager Parameter

Field
Description

Log Level

Filters all debug output below the specified level


Table 3-41 Logger Parameters

Field
Description

TCP Logger Level

Filter for remote console debug output (below specified level)

TCP Logger Port

Number of port on which the TCP remote console logger remote server listens for connections

Log Server Sink Logger Level

Filter for log server debug output (below specified level)

Enable Logger Queue Diagnostics

If enabled, the queue size and object generation are provided as log messages


Table 3-42 Management Interface Parameters

Field
Description

Log Level

Filters remote console debug output below specified level

Management Port

Port on which the application server listens for commands from the management console and the Cisco Unified Application Designer


Table 3-43 Provider Manager Parameter

Field
Description

Log Level

Filters remote console debug output below specified level

Shutdown Timeout

Length of time in milliseconds the system waits before forcing a shutdown

Startup Timeout

Length of time in milliseconds the system waits before considering a provider unloadable


Table 3-44 Router Parameters

Field
Description

Log Level

Filters remote console debug output below specified level

Default Action Timeout

Interval in milliseconds the system waits for a provider to respond to an action


Table 3-45 Telephony Manager Parameters

Field
Description

Log Level

Filters remote console debug output below specified level

Enable Call/Connection Sandboxing

Indication of whether or not sandboxing is enabled (when enabled, the system clears any remaining calls and media connections while the controlling script exits)

Enable Periodic Diagnostics

If enabled, the Telephony Manager provides periodic diagnostics about calls and performance


Log Server

From the Main Control Panel, open the Log Server Configuration page (Figure 3-26) to specify the maximum size and number of log files.

Figure 3-26 Log Server Configuration Page

To configure the log server, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Local Environment, click Log Server Configuration.

Step 3 Enter or select values as described Table 3-46.

Table 3-46 Log Server Parameters

Field
Description

Max File Log Lines

Maximum number of lines written to the log file before starting a new file

Valid Range: 100 - 1000000

Max Files

Maximum number of files to store in an individual log folder; when this limit is surpassed, older files are deleted to keep the total within the maximum


Step 4 Click Apply.

Step 5 Click Done to return to the Main Control Panel.


Alarms

Real-time alarm messages warn of critical system events, such as a server failing to start. Use the Alarms page to define which SMTP or SNMP manager receives the alarm messages.

From the Main Control Panel, open the Alarms page (Figure 3-27) to list current alarms and specify the destinations to receive alarm messages.

You can also use this page to download a MIB file. This MIB file can be loaded into network management software to monitor the Cisco Unified Application Server and the Cisco Unified Media Engine. The MIB defines a number of traps and real-time statistics which are useful for SNMP monitoring systems.

Figure 3-27 Alarms Page

This section includes these topics:

Viewing Current Alarms

Adding New Alarm Destinations

Downloading a MIB File

Viewing Current Alarms

To add view current alarms, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Local Environment, click Alarm Management.

The Alarm Management page displays active alarms.


Setting Alarms to Ignored

To set alarms to ignored so that they do not continue to be active, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Local Environment, click Alarm Management.

The Alarm Management page displays active alarms.

Step 3 Select the alarms you want ignored, then click Set Ignored Alarms.


Adding New Alarm Destinations

To add new alarm destinations, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Local Environment, click Alarm Management.

Step 3 Choose SMTP Manager or SNMP Manager, then click Create.

Step 4 Configure settings for the selected option:

SMTP Manager—Enter values as described in Table 3-47, then click Add SMTP Manager.

SNMP Manager—Enter values as described in Table 3-48, then click Add SNMP Manager.

Table 3-47 SMTP Alarm Manager Parameters

Field
Description

Description

Description of alarm manager

Recipient

Email address to which to send alarm message

Sender

Email address from which to send alarm message

Server

IP address of SMTP server

Username

(Optional) User name for outbound SMTP authentication

Password

(Optional) Password for outbound SMTP authentication

Server Port

SMTP server port (default is 25)

Trigger Level

Event level that triggers alarm


Table 3-48 SNMP Alarm Manager Parameters

Field
Description

SNMP Manager

IP address of SNMP manager

Trigger Level

Event level that triggers alarm



Downloading a MIB File

To download a MIB file, follow these steps:

Procedure


Step 1 Log in to the Cisco Unified Application Environment management console.

Step 2 From the Main Control Panel, under Local Environment, click Alarm Management.

Step 3 Click Download MIB File.