CUAE - Unity Messaging Plugin - Wiki
CUAE Wiki
Wiki
-
Wiki Home - Recent Changes
- All Pages
- Orphan Pages
- Draft Pages
CUAE - Unity Messaging Plugin
About#
This article contains instructions for installing the Cisco Unified Application Environment Messaging Plugin, which has the following components:
- Messaging Plugin Service - The service that communicates with a Cisco Unity Connection server or cluster of servers and allows you to retrieve messages.
- Mesasging Plugin SDK and Documentation - The IDL required for developing applications that utilize the Messaging Plugin Service and the API reference materials.
Note: The Messaging Plugin Service must be installed on a machine running the Cisco Unified Application Environment Application Server software. The Messaging Plugin SDK must be installed on a machine running the Cisco Unified Application Developer Tools. For information about downloading and installing the most recent version of the Cisco Unified Application Environment and Development Tools, see the Installation article.
Installation Instructions#
Before You Begin#
1. Determine which connection protocol to use.
The installer connects to the Management Service using either TCP or Transport Layer Security (TLS) depending on the installation options you select. You must select the protocol used by the Management Service in your deployment. TLS is enabled on the Management Service by default, but can be disabled by the administrator. Therefore, you should contact your administrator to find out whether to use TCP or TLS.
2. If you choose to use TLS for the installation, you must import the Management Service TLS certificate to a truststore using keytool before running the Messaging Plugin installer.
For more information and instructions for using keytool, see the Secured transport to Management Service how-to article.
Installing the Messaging Plugin Service#
To install the Messaging Plugin, follow these steps:
1. Download the Messaging Plugin installer from the Cisco Unified Application Environment Downloads page to the target system for your version of CUAE. The Messaging Plugin installer is named messaging-plugin-<version>.exe
CUAE-msgplgn-xxx.exe.
2. Execute the installer.
3. The Cisco Unified Application Environment Messaging Plugin installation Wizard appears. Click Next.
4. The Choose Components dialog appears. Select the Service and Plugin check boxes and leave other check boxes unselected. Click Next.
5. The Choose Install Location dialog appears. Accept the default or click Browse to locate a new destination for the Plugin service files.
6. The Choose Start Menu Folder dialog appears. Accept the default or create a new Start menu shortcut path for the Messaging Plugin service. Click Next.
7. The Cisco Unified Application Environment Setup dialog appears. Enter the following information:
| Field Name | Value | |
|---|---|---|
| Domain Name/IP Address | Domain Name/IP Address of the Cisco Unified Application Server. | |
| TLS | Select this check box if you are using TLS for installation. | |
| Force Overwrite | Select this check box if you want to overwrite previous installations. | |
| Management Service Port | The port on the Cisco Unified Application Server used for the Management Service listener. | |
| Username/Password | Cisco Unified Application Environment Administration interface user name and password. | |
| TrustStore | Path to the TrustStore where you have imported the Management Service TLS certificate. |
8. Click Next.
9. The Messaging Plugin Information dialog appears. Enter the following information:
| Field Name | Value | |
|---|---|---|
| Domain Name | The FQDN or IP address of the Cisco Unified Application Server | |
| Port | The listening port for the Messaging Plugin. (Note: Specify a port that is not in use by any other application service.) | |
| CUAE Directory | The directory on Cisco Unified Application Server where you have installed the Cisco Unified Application Environment. |
10. Click Next.
11. The Unity (Connection) Server Setup dialog appears. Enter the following information:
| Field Name | Value | |
|---|---|---|
| Messaging Server | Select UnityConnection | |
| Unity Domain | Enter UnityConnection | |
| Unity Domain Name/IP Address | Enter the host name or IP address of the Unity Connection server. | |
| Port and Root Port | Accept the defaults, or if you have a custom port configuration for communication over IMAP on the Unity Connection server, enter the custom port numbers. | |
| Max Connections | The maximum number of concurrent connections the messaging plugin can attempt to make to the Unity Connection server. | |
| Timeout(s) | The number of seconds the plugin service will wait for a response from the Unity Connection server before attempting to reconnect. | |
| SMTP Server/IP Address | Enter the host name or IP address of the Unity Connection server. |
12. The Installation dialog window indicates progress as the installation proceeds. Once installation completes, you must then start the plugin service.
Starting the Plugin Service#
There are two ways to start the Messaging Plugin service:
- From the Start Menu:
- Choose Start > Cisco Systems > Messaging Plugin > Start.
- From the Windows Services console:
- Choose Start > Control Panel > Administrative Tools > Services.
- Click the CUAE Messaging Plugin service.
- On the Action menu, click Start.
Installing the Messaging Plugin Developer Tools#
To install the Messaging Plugin Developer Tools, follow these steps:
- Download the Messaging Plugin installer from the Cisco Unified Application Environment Downloads page to the target system. The Messaging Plugin installer is named messaging-plugin-<version>.exe.
- Execute the installer.
- The Cisco Unified Application Environment Messaging Plugin installation Wizard appears. Click Next.
- The Choose Components dialog appears. Select the API and Documentation check boxes and leave other check boxes unselected. Click Next.
- The Choose Install Location dialog appears. Accept the default or click Browse to locate a new destination for the Developer Tools.
- The Choose Start Menu Folder dialog appears. Accept the default or create a new Start menu shortcut path for the Messaging Plugin Developer Tools. Click Next.
- The Installation dialog window indicates progress as the installation proceeds.
Verifying the Installation#
To verify that the plugin service was properly installed, follow these steps:
- Log in to the Cisco Unified Application Environment Administration interface.
- Choose Plugins.
- Note that the messaging plugin appears in the list of installed plugins.
Working with the Messaging Plugin #
Developers can download the new Messaging plugin to build applications that interact with Cisco Unity Connection, Release 7.0. The Messaging API supports the reading and sending of voicemail. See the Messaging Plugin Example Application for a demonstration on how to use the Messaging Plugin methods.
Tip: Please visit http://www.cisco.com/en/US/products/ps6509/tsd_products_support_series_home.html for all product documents related with Cisco Unity Connection.
