Guest

Cisco Unified Application Environment

Cisco Unified Application Environment Release Notes, Release 2.5(1) SR1

  • Viewing Options

  • PDF (177.4 KB)
  • Feedback
Cisco Unified Application Environment Release Notes, Release 2.5(1) SR1

Table Of Contents

Cisco Unified Application Environment
Release Notes, Release 2.5(1) SR1

Contents

Related Documentation

New and Changed Information

New Messaging Plugin

Improved Event Notifications

Notification of Provider or Plugin Status Changes

Notification of Application Script End

SIP Failover

cuae package Ignore Files List

Core Addendum and Prerequisite Upgrade

Installation and Upgrade Notes

Upgrading from Release 2.3 or 2.4 to Release 2.5(1) SR1

Upgrading From Release 2.5(1) to Release 2.5(1) SR1

Installing Cisco Unified Application Environment Developer Tools

Installing the Cisco Unified Application Environment Messaging Plugin

Caveats

Using Bug Toolkit

Open Caveats

Resolved Caveats

Obtaining Documentation and Submitting a Service Request


Cisco Unified Application Environment
Release Notes, Release 2.5(1) SR1


Revised: January 2009, OL-18440-01

These release notes describe the new features and caveats for the Cisco Unified Application Environment, Release 2.5(1) SR1.

Contents

Related Documentation

New and Changed Information

Installation and Upgrade Notes

Caveats

Obtaining Documentation and Submitting a Service Request

Related Documentation

There are two types of related documentation: product and developer.

Table 1 provides links to product documentation.

For developer documentation, go to: http://developer.cisco.com/web/cuae

Table 1 Product Documentation 

Related Information
URL

Cisco Unified Application Environment Administration Guide, Release 2.5.1

http://www.cisco.com/en/US/products/ps7058/prod_maintenance_guides_list.html

Cisco Unified Application Environment Installation Guide, Release 2.5.1

http://www.cisco.com/en/US/products/ps7058/prod_installation_guides_list.html

Cisco Unified Application Environment Messaging Plugin Installation Guide, Release 2.5.1 SR1

http://www.cisco.com/en/US/products/ps7058/prod_installation_guides_list.html

Cisco Unified Application Environment Upgrade Guide, Release 2.5.1

http://www.cisco.com/en/US/products/ps7058/prod_installation_guides_list.html

Cisco Unified Application Environment Hardware Compatibility Matrix, Release 2.5.1

http://www.cisco.com/en/US/products/ps7058/products_device_support_tables_list.html

Cisco Unified Application Environment Software Compatibility Matrix, Release 2.5.1

Open Source License Notices for the Cisco Unified Application Environment

http://www.cisco.com/en/US/docs/voice_ip_comm/cuae/openssl_license/cuae_ssllic.html

Cisco Unified Communications Manager Documentation

http://www.cisco.com/en/US/products/sw/voicesw/ps556/tsd_products_support_series_home.html


New and Changed Information

This section contains the following topics that describe new features and changes that are pertinent to the Cisco Unified Application Environment:

New Messaging Plugin

Improved Event Notifications

SIP Failover

cuae package Ignore Files List

Core Addendum and Prerequisite Upgrade

New Messaging Plugin

The new Messaging Plugin enables developers to build applications that interact with Cisco Unity and Cisco Unity Connection, Release 7.0. It consists of the following components:

Messaging Plugin—Enables communication between the Cisco Unified Application Environment and the Cisco Unity Server or Cisco Unity Connection Server to allow developers to programmatically read, create, and send voicemail

Messaging Plugin Developer Tools—API reference documentation and the Messaging Plugin Etch IDL.

To install the Messaging Plugin or the Messaging Plugin Developer Tools, see the Cisco Unified Application Environment Messaging Plugin Installation Guide listed in the Related Documentation.

Improved Event Notifications

This section describes the following new event handlers:

Notification of Provider or Plugin Status Changes

Notification of Application Script End

Notification of Provider or Plugin Status Changes

This new event handler sends an event to an application when the status of a provider or plugin the application uses has changed.

The event includes three parameters:

pluginName—Name of the plugin or provider.

nameSpace—Full namespace of the plugin or provider.

status—Status of the provider or plugin after the change. The following are valid statuses:

Disabled

Disabled_Error

Enabled_Running

Enabled_Stopped

The event handler differs slightly if the application was created using Cisco Unified Application Designer or etch tools:

Designer Application: Developers can use the OnPluginStatusUpdate event handler, which is implemented under the Metreos.ApplicationControl namespace.

In the following example, the H323 provider was disabled and then enabled. The output shows the events messages sent when the H323 provider is first disabled, then enabled.

2008:12:02::16:55:11(60): Info: script1-1 ****Using Function 'OnPluginStatusUpdate'********************

2008:12:02::16:55:11(62): Info: script1-1 Plugin: H323Provider is Disabled

2008:12:02::16:55:57(32): Info: script1-1 ****Using Function 'OnPluginStatusUpdate'********************

2008:12:02::16:55:57(32): Info: script1-1 Plugin: H323Provider is Enabled_Running

Etch-based Application: Developers can override the pluginStatusUpdate event handler from the EtchBridge.etch interface.

The following is a Java example of the event handler:

@Override

public void pluginStatusUpdate( String pluginName, String nameSpace, PluginStatus status )

{

System.out.println("Plugin Name: " + pluginName + " with NameSpace: " + nameSpace + " status: " + status);

}

The following sample shows the output from the Java Console window, which was produced when the MediaControl provider was disabled and then re-enabled.

pluginName: MediaControlProvider with nameSpace: Metreos.MediaControl status: Disabled

pluginName: MediaControlProvider with nameSpace: Metreos.MediaControl status: Enabled_Running

Notification of Application Script End

This new event handler sends an event when an application script ends to legacy providers or etch-based plugins used by the application. The event includes only one parameter, which is the routing GUID and session ID of the application script that ended.

The event handler differs slightly if the application was created using Cisco Unified Application Designer or etch tools:

Designer Application: When an application script ends, legacy providers receive an event that contains the routingGuid/sessionId parameter. Developers of these legacy providers can override the OnScriptEnded event from the Metreos.ProviderFramework.ProviderBase abstract class to implement any script ending handlers they need.

Etch-based Plugin: Developers can override the sessionEndNotify event handler from the EtchBridge.etch interface.

In the following example, this function is activated when a script is ended. The only parameter to the function is the session ID of the script that ended.

@Override

public void sessionEndNotify(String SessionId)

{

System.out.println("SessionID : " + SessionId);

}

The following sample shows the output from the Java Console window, which was produced by the event handler to display the session ID of a script that ended.

SessionID: 94ac22ff-bc98-407d-9e14-0989240252b5

SIP Failover

This release includes enhanced SIP failover support for Cisco Unified Communications Manager clusters with two nodes (one publisher and one subscriber).

With this release, failover is accomplished by automatically registering each SIP virtual device on both the publisher and subscriber, thus creating a primary connection and a secondary connection for each SIP virtual device. If the primary connection fails, Cisco Unified Application Server automatically switches to the secondary connection. This helps prevent an outage period during the failover process. When the primary connection returns, it automatically takes over from the secondary.

cuae package Ignore Files List

The CUAE command-line tool cuae package command compresses all of the files in the cuae-resources directory and bundles them with metadata about an application or plugin in the .mca or .mcp package file, respectively. When the application or plugin is installed, the files from the cuae-resources directory are decompressed and installed on the application server.

With this release, developers can specify files to exclude from the package for situations when developers do not need or want to keep all of the files in the cuae-resources directory on the application server.

Developers create the Ignore Files list using wild card filters in the project.yaml file—one of the standard files created when the developer first builds a Cisco Unified Application Environment application or plugin.

The following is a the default code from the project.yaml file:

#package:
# Both "*" and "?" are special characters in Yaml syntax, so the  
# whole value string needs to be double quoted. 
#exclude-directories: ".svn" 
#exclude-files: "*.htm .* afile?x.txt" 

To create an Ignore Files list, the developer should follow these steps:

Procedure


Step 1 Uncomment the package line.

Step 2 Uncomment the exclude-directories and/or exclude-files lines.

Step 3 Modify the values on the exclude-directories and/or exclude-files lines as necessary.

Step 4 Save and close the file.

Step 5 Rebuild the application or plugin prior to packaging and installing it.


Core Addendum and Prerequisite Upgrade

With this release, the core addendum includes an updated version of Dialogic HMP 3.0 SU 225.

Production installations are automatically updated to version SU 225 when you run the Core Addendum Installer. For more information, see the "Upgrading From Release 2.5(1) to Release 2.5(1) SR1" section.

You must manually upgrade SDK installations to SU 225. For more information, see the Cisco Unified Application Environment wiki, Downloads page: http://developer.cisco.com/web/cuae/downloads.


Note For best results, do not use a version older than HMP 3.0 SU 225.


Installation and Upgrade Notes

The following sections describe the upgrade procedures:

Upgrading from Release 2.3 or 2.4 to Release 2.5(1) SR1

Upgrading From Release 2.5(1) to Release 2.5(1) SR1

Installing Cisco Unified Application Environment Developer Tools

Installing the Cisco Unified Application Environment Messaging Plugin

Upgrading from Release 2.3 or 2.4 to Release 2.5(1) SR1

To upgrade from Release 2.3 or 2.4 to Release 2.5(1) SR1, you must first update to Release 2.5(1). For more information, see the Upgrade Guide for the Cisco Unified Application Environment, Release 2.5, listed in the Related Documentation.

After you upgrade to Release 2.5(1), see the instructions in the "Upgrading From Release 2.5(1) to Release 2.5(1) SR1" section.

Upgrading From Release 2.5(1) to Release 2.5(1) SR1

To upgrade from Release 2.5(1) to Release 2.5(1) SR1, you will install the following components:

1. Cisco Unified Core Addendum

2. Cisco Unified Platform Services

3. Cisco Unified Application Server

4. Cisco Unified Media Engine


Note You are not required to uninstall the previous version of the Cisco Unified Application Environment before installing this version.


Before You Begin

1. Locate the following executable files on the Release 2.5(1) SR1 DVD or download them from the Cisco Unified Application Environment wiki Downloads page http://developer.cisco.com/web/cuae/downloads:

CUAE-coreadd-2.5.x.exe (Cisco Unified Core Addendum)

CUAE-platsvc-2.5.x.exe (Cisco Unified Platform Services)

CUAE-appserver-2.5.x.exe (Cisco Unified Application Server)

CUAE-mediaengine-2.5.x.exe (Cisco Unified Media Engine)

Procedure


Step 1 Install the following Cisco Unified Application Environment components. Refer to the procedures in the Installation Guide for the Cisco Unified Application Environment, Release 2.5(1). See Related Documentation.

1. CUAE-coreadd-2.5.x.exe (Cisco Unified Core Addendum).

2. CUAE-platsvc-2.5.x.exe (Cisco Unified Platform Services)

3. CUAE-appserver-2.5.x.exe (Cisco Unified Application Server)

4. CUAE-mediaengine-2.5.x.exe (Cisco Unified Media Engine)

Step 2 After installing the components and rebooting the server, log into the Cisco Unified Application Environment Administration to verify that the installation has completed.

Installing Cisco Unified Application Environment Developer Tools

Developers download the CUAE-devtools-2.5.1.x.exe executable file and installation instructions on the Cisco Unified Application Environment wiki: http://developer.cisco.com/web/cuae/downloads.

Installing the Cisco Unified Application Environment Messaging Plugin

To install the new Messaging Plugin, Messaging Plugin Service or Messaging Plugin Developer Tools, refer to the procedures in the Installation Guide for the Cisco Unified Application Environment Messaging Plugin, Release 2.5(1) SR1. See Related Documentation.

Caveats

This section includes these topics:

Using Bug Toolkit

Open Caveats

Resolved Caveats

Using Bug Toolkit

Known problems (bugs) are graded according to severity level. These release notes contain descriptions of:

All severity level 1 or 2 bugs.

Significant severity level 3 bugs.

You can search for problems by using the Cisco Software Bug Toolkit. To access Bug Toolkit, you need the following items:

Internet connection

Web browser

Cisco.com user ID and password

To use the Software Bug Toolkit, follow these steps:

Procedure


Step 1 To access the Bug Toolkit, go to http://tools.cisco.com/Support/BugToolKit/action.do?hdnAction=searchBugs.

Step 2 Log in with your Cisco.com user ID and password.

Step 3 To look for information about a specific problem, enter the bug ID number in the "Search for Bug ID" field, then click Go.


Open Caveats

Table 2 lists the open caveats. For information about an individual bug, click the Identifier to access the online record, including workarounds.


Note Because defect status continually changes, be aware that Table 2 reflects a snapshot of the defects that were open at the time the release notes were compiled. For an updated view of open defects, access Bug Toolkit and follow the instructions as described in the "Using Bug Toolkit" section.


.

Table 2 Open Caveats for the Cisco Unified Application Environment, Release 2.5(1) SR1

Identifier
Headline

CSCsr40650

An intermittent issues occurs that causes the Bridge action to fail with JTAPI - CTIERR_HOLDFAILED error.

CSCsu03054

P2P Bridged Inbound CTI Route Point - CTIERR_TIMEOUT after 15 seconds and 1-way audio from call recipient to caller. When a CTI port is used, the issue is not seen and the connectivity is not affected.

CSCzb50741

MakeCall_Complete: To not correct under forwarded conditions w/ H.323.

CSCzb50990

MakeCall_Complete: OriginalTo not populated by SCCP and H.323.

CSCzb50991

MakeCall_Complete: To not correct under forwarded conditions w/ H.323.

CSCzb51019

SCCP provider fails to handle conference call flow.

CSCsv97343

No two-way media using ICT after Hold and Resume with SIP.

CSCsw17052

Call Control State goes from TALKING state to DROPPED state.

CSCsw52764

The JTapi provider reports the error "E JTP Call encountered an error (CallIdUnknown): <no description>".

This error message is caused due to a harmless race condition.

CSCsw31182

Cisco Unified Application Designer does not support the Messaging Plugin.

CSCsx05179

An intermittent issue occurs during uninstallation of the Messaging Plugin. When the uninstaller alerts the user that the connection to the CUAE server has timed out, the uninstaller proceeds to continue uninstallation of the plugin from the machine, but it is unclear to the user that the uninstallation was successful.

CSCsx04874

When uninstalling a plugin package, the CUAE command-line tool is calling the Management Service API. When the server-side API takes too long to respond, the client-side etch API throws a timeout exception before the server completes the processing and returns.

CSCsx05616

An intermittent issue occurs when the Cisco Unified Application Environment Messaging Plugin connects to the Unity Server. It appears that Login attempts to the AUTH web service of VMWS time out and no SOAP response is sent to the client.

CSCsx17101

Clicking the Cancel button on the Welcome screen or Choose Start Menu screen in the Messaging Plugin installer does not cancel the installation and returns an invalid error message.

CSCsx18881

When adding, editing, or deleting an application trigger using the Cisco Unified Application Environment Administration interface, an error message is written to the application server log file and the changes do not propagate to the Application Server. Use the mceadmin interface to avoid this issue.

CSCsx19837

The Messaging Plugin Developer Tools uninstaller does not return an error message when it cannot find the component that has been selected for removal.


Resolved Caveats

Table 3 lists Severity 1, 2 and 3 defects that are resolved since the last release of the Cisco Unified Application Environment.

For more information about an individual defect, you can access the online record for the defect by clicking the Identifier or going to the URL shown. You must be a registered Cisco.com user to access this online information.

Because defect status continually changes, be aware that Table 4 reflects a snapshot of the defects that were resolved at the time this report was compiled.

For an updated view of resolved defects, access Bug Toolkit as described in the "Using Bug Toolkit" section on page 5.

.

Table 3 Resolved Caveats for the Cisco Unified Application Environment 

Identifier
Heading

CSCsj94121

No audio heard from MakeCall app on CUAE to CUME via H323.

CSCsr46998

SIP GatherDigits Request Fails due to HMP RFC2833 event handling.

CSCsr69066

SIP P2P Pstn to IP - 1 - way Media.

CSCsr87016

SIP Virtual Device Status Enabled Stop On SIP Domain Failover.


Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0.