This documentation is archived and is not being maintained.

Run Time Requirements

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.

The supported run-time environment for the deployment of a Unified Communications Managed API 2.0 Core SDK application is one of the following:

  • Microsoft Windows Server 2003 with Service Pack 2 or higher service pack version

  • Microsoft Windows Server 2008 with Service Pack 2 or higher service pack version

  • Microsoft Windows Server 2008 R2 (with any service pack, including no service pack)

  • Microsoft Windows Vista (64-Bit Editions) with Service Pack 1 or higher service pack version

  • Microsoft Windows 7 (64-Bit Editions)

The following table summarizes the components needed at run time by an application built on the UCMA 2.0 Core SDK. The sections that follow the table provide more information about each component.

Required component

Comments

OCSCore.msi

An application based on the UCMA 2.0 Core SDK must be provisioned by Microsoft Office Communications Server 2007 R2. The administrator for the computer on which the application is deployed must ensure that Microsoft Office Communications Server 2007 R2, Core Components (OCSCore.msi) is present for successful provisioning before deploying the application, and must ensure that Office Communications Server 2007 Administrative Tools (AdminTools.msi) is installed on the deployment computer.

OCSCore.msi does not have a redistribution license and can be installed only when the Office Communications Server 2007 R2 Administrative Tools are installed.

If you install OCSCore.msi through the Office Communications Server deployment user interface, all of the prerequisites for the Office Communications Server 2007 R2 Administrative Tools (VC++ 2008 Redist, .NET 3.5 SP1, MSXML, SQL Native Client, and OCSCore.msi) are installed automatically.

.NET Framework 3.5 Service Pack 1

Microsoft Unified Communications Managed API 2.0 Core Redistributable (UcmaRedist.msi) is built on .NET Framework 3.5 Service Pack 1 and Microsoft Visual C++ 2008 Redistributable Package (x86)

.NET Framework 3.5 Service Pack 1 is installed when the Office Communications Server Admin Tools are installed.

Visual C++ 2008 Redistributable Package

Microsoft Unified Communications Managed API 2.0 Core Redistributable (UcmaRedist.msi) is built on .NET Framework 3.5 Service Pack 1 and Visual C++ 2008 Redistributable Package (x86).

Visual C++ 2008 Redistributable Package (x86) is installed when the Office Communications Server Admin Tools are installed.

Microsoft Unified Communications Managed API 2.0 Core Redistributable (UcmaRedist.msi)

By default, the Microsoft Unified Communications Managed API 2.0 SDK setup application (SetupUCMASDK.exe) copies the UCMA 2.0 Core SDK to the %Program Files%\Microsoft Office Communications Server 2007 R2\UCMA SDK 2.0\UCMACore\Redist directory. The UCMA 2.0 Core SDK will be installed in a \Redist directory at a different location if an alternate location is specified.

Optional: Windows Media Format Runtime

If you use the UCMA 2.0 Core SDK to develop applications that play or record media, the Windows Media Format Runtime must be installed.

For more information, see “Windows Media Format Runtime” later in this topic and Using WMA Format with Player and Recorder.

The administrator of the computer on which the UCMA 2.0 Core SDK-based application is to be deployed should install the previously listed components. The application bootstrapper should include code that detects the presence of these components, and should fail if they are not detected.

For more information about writing an application bootstrapper, see Authoring a Custom Bootstrapper Package for Visual Studio 2005 and Adding Custom Prerequisites.

OCSCore.msi

OCSCore.msi does not have a redistribution license and must be installed only by installing the Admin Tools available on the Microsoft Office Communications Server 2007 R2 DVD.

For detection, the application bootstrapper should make use of the upgrade code and MinVersion value of OCSCore.msi. If appropriate values of upgrade code and MinVersion are not detected, the application bootstrapper should fail and should suggest that the administrator install OCSCore.msi using Office Communications Server 2007 R2 Admin Tools.

OCSCore upgrade code = E69B354B-B22C-4595-BA36-BF390CF37711

Microsoft Unified Communications Managed API 2.0 Core Redistributable (UcmaRedist.msi)

When you run the Microsoft Unified Communications Managed API 2.0 SDK setup application (SetupUCMASDK.exe) to install the UCMA 2.0 Core SDK, and do not specify a different location, a directory named %Program Files%\Microsoft Office Communications Server 2007 R2\UCMA SDK 2.0\UCMACore\Redist\ is created.The following files are in this directory.

  • UcmaRedist.msi

  • WmaCheck.wxi

  • wmfdist64.exe

If you run the Microsoft Unified Communications Managed API 2.0 SDK setup application (SetupUCMASDK.exe) to install the UCMA 2.0 Core SDK on a 32-bit development environment, the 32-bit version of Microsoft Unified Communications Managed API 2.0 Core Redistributable (UcmaRedist.msi) is installed, but this version is not supported. Application development using Microsoft Unified Communications Managed API 2.0 SDK on 32-bit client platforms along with 64-bit client/server platforms is supported.

When Microsoft Unified Communications Managed API 2.0 Core Redist (UcmaRedist.msi) is installed, it determines whether Microsoft .NET Framework Version 3.5 SP1 Redistributable Package and Microsoft Visual C++ 2008 Redistributable Package are already installed. If not, UcmaRedist.msi displays a warning message.

Whenever you deploy an application that is built on the UCMA 2.0 Core SDK, Microsoft Unified Communications Managed API 2.0 Core Redistributable (UcmaRedist.msi) must be present as a prerequisite on the server computer on which it is deployed. The recommendation is that your application bootstrapper should check for the presence of UcmaRedist.msi and the installation should fail if it is not present.

The upgrade code and minimum version code for the Microsoft Unified Communications Managed API 2.0 Core Redistributable (UcmaRedist.msi) for a 64-bit deployment platform are as follows.

UcmaRedist.msi upgrade code = 7CA5F91F-26AA-42f9-AB67-B85371B1D5E0

For detection, the application bootstrapper should use the upgrade code and MinimumVersion values of UcmaRedist.msi. If the appropriate values of the upgrade code and MinimumVersion are not detected, the application bootstrapper should fail and should suggest that the administrator install UcmaRedist.msi.

Windows Media Format Runtime

If you use Microsoft Unified Communications Managed API 2.0 Core SDK to develop applications such as notification applications, IVR systems, and Automated Call Distributor systems that will play or record media, your application must have the Windows Media Format Runtime.

If you use WiX to build your application installer, you can use WmaCheck.wxi in the Redist directory to detect Windows Media Format Runtime by including WmaCheck.wxi in your installer, as follows: “<? include WmaCheck.wxi?>”. When you run the application installer on a system that does not have Windows Media Format Runtime, one of the following error messages is displayed.

Operating system

Error message

Windows Server 2003, 64-Bit Editions

The redistributable package for the Windows Media Format Runtime must be installed before you can deploy Office Communications Server on this computer. Install the package, and then try your deployment again. The package is available as part of Office Communications Server installation media. For details, see the Office Communications Server deployment documentation.

Windows Server 2008, 64-Bit Editions, and Windows Server 2008 R2

The Windows Media Format Runtime must be installed before you can deploy Office Communications Server on this computer. Install the package, and then try your deployment again. You can install the package by using the Package Manager. For more information, see the Office Communications Server deployment documentation.

If an error occurs and you have the Microsoft Office Communications Server 2007 R2 CD, follow the instructions from there to install Windows Media Format Runtime. Alternatively, you can install Windows Media Format Runtime as described in the following table.

Operating system

Installation

Windows Server 2003, 64-Bit Editions

Run wmfdist64.exe included from the Redist folder of the UCMA 2.0 Core SDK installation.

Windows Server 2008, 64-Bit Editions

pkgmgr.exe /ip /m:"%windir%\servicing\Packages\Microsoft-Windows-Media-Format-Package~31bf3856ad364e35~amd64~~6.0.6001.18000.mum"

Windows Server 2008 R2

dism.exe /online /norestart /add-package /packagepath: "%windir%\servicing\Packages\Microsoft-Windows-Media-Format-Package~31bf3856ad364e35~amd64~~6.1.7600.16385.mum" /ignorecheck

Windows Server 2008 R2, Service Pack 1

dism.exe /online /norestart /add-package /packagepath: “%windir%\servicing\Packages\Microsoft-Windows-Media-Format-Package~31bf3856ad364e35~amd64~~6.1.7601.17514.mum “ /ignorecheck

If you do not use WiX to write your application installer, an installer running on either Windows Server 2003 or on Windows Server 2008 can detect the presence of Windows Media Format Runtime by verifying that wmvcore.dll is in the %windir%\system32 directory and that its version is greater than or equal to 9.5. If your installer detects that Windows Media Format Runtime is missing, use the previously described steps to install it.

When a customer application is uninstalled, the application uninstall procedure MUST not automatically uninstall any of the required components (OCSCore.msi, .NET Framework 3.5 Service Pack 1, Visual C++ 2008 Redistributable Package, and UcmaRedist.msi), because other applications might require them.

Additional information about the following topics can be found in the Unified Communications Managed API v1.0 SDK documentation.

  • Patching for UCMARedist

  • Storing the Managed Code and Other DLLs

  • Registration of Signaling Performance Counters

  • Installing the Logging Utilities

  • Terms of Redistribution

Show: