This documentation is archived and is not being maintained.

Unified Communications Managed API 2.0 Speech SDK Documentation

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

A Unified Communications Managed API (UCMA) application is an application designed to run in an Office Communications Server (OCS) environment. A UCMA application can access various OCS features, such as collaboration, speech, or the communications workflow.

The application is installed on the hosting server and accessed by various clients.

The application will interact with OCS to carry out various tasks, such as registering itself as a service, attaching to a communication stream, routing communications, and responding to input and events.

A bootstrapper is a setup application that defines a set of zero or more prerequisites and a single target product to install. The user runs the setup application to install the product. The bootstrapper first performs a prerequisite check and allows the user to install any of the needed prerequisites, and then installs the target product. When the user uninstalls the target application, the setup application uninstalls the target product, but does not uninstall any of the prerequisites.

Visual Studio and the Windows Platform SDK ship with the setup.exe bootstrapper. For information about creating a setup application, see How to: Create or Add a Setup Project ( or Msistuff.exe (

The setup.exe bootstrapper is designed to install products that are configured as a Windows Installer package, or .msi file. You can create an installation package using Visual Studio, or by using other tools, such as WiX. For more information about creating installation packages, see Windows Installer Deployment (, or Windows Installer XML (WiX) toolset (

A prerequisite of a target product is a product that must be installed prior to installing the target product. The bootstrapper for the target application is usually designed to prompt the user to install the prerequisite if the prerequisite is not currently installed. These are typically delivered as executables or installation packages. The .NET framework (dotnetfx.exe in the Windows Platform SDK) as well as other files in the [PlatformSDKInstallLocation]\Bootstrapper\Packages\ folder are often prerequisites for other products.

When users install your OCS application, they will also need to install one or more UCMA prerequisites which are included in this SDK. The UCMA redistributable installer is UcmaRedist.msi, the speech redistributable installer is UcmaSpeechRedist.msi, and the workflow redistributable is UcmaWorkflowRedist.msi. Your installer, whether it is created by Visual Studio or another bootstrapping tool, will need to install these prerequisites. you will also need to deploy these installers. If you are only using basic UCMA functionality or basic speech functionality, you just need to include the appropriate installer. However, if you are using workflow functionality, you will need to include all three installers.

To create a bootstrapper using Visual Studio, follow the instructions at Adding Custom Prerequisites ( This will show you how to add packages into the redistributable list so that they will appear in the prerequisites dialog in Visual Studio, allowing you to incorporate them into the bootstrapper.

The target computer must be running one of the following environments:

  • Microsoft Windows Server 2003 64-Bit Edition, with .NET Framework Version 3.5 SP1

  • Microsoft Windows Server 2008 64-Bit Edition, with .NET Framework 3.5

Every UCMA application has the following prerequisites:

  • Microsoft Office Communications Server 2007 R2

  • VC++ 2008

  • microsoft.rtc.collaboration.dll