Table Of Contents
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.
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
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
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
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:
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:
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.
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.
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:
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
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)
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.
This section includes these topics:
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:
•Cisco.com user ID and password
To use the Software Bug Toolkit, follow these steps:
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.
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 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.
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:
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.
This document is to be used in conjunction with the documents listed in the "Related Documentation" section.
CCDE, CCENT, Cisco Eos, Cisco HealthPresence, the Cisco logo, Cisco Lumin, Cisco Nexus, Cisco StadiumVision, Cisco TelePresence, Cisco WebEx, DCE, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn and Cisco Store are service marks; and Access Registrar, Aironet, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, EtherFast, EtherSwitch, Event Center, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, iQuick Study, IronPort, the IronPort logo, LightStream, Linksys, MediaTone, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, Network Registrar, PCNow, PIX, PowerPanels, ProConnect, ScriptShare, SenderBase, SMARTnet, Spectrum Expert, StackWise, The Fastest Way to Increase Your Internet Quotient, TransPath, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0812R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.
©2009 Cisco Systems, Inc. All rights reserved.