Register a managed application on Lync Server 2013

Lync 2013

There are several required steps when you install a managed application on Microsoft Lync Server 2013. This article describes those steps and the errors Lync Server 2013 may return when the installation is not done correctly.

  • Lync Server 2013

  • A managed code application that references the Lync Server API.

  • Membership in the local computer RTC Server Applications group on the computer where the application is installed.

Core concepts to know for registering a managed application

Registering an application requires use of the management shell, and PowerShell cmdlets. Also, it is useful to be familiar with the Lync Server API, and the tools for managing Lync Server.

Table 1. Core concepts for registering a managed application

Article title


Get started with Lync Server 2013 SDK

Familiarity with the Lync Server API.

Lync Server Administrative Tools

Familiarity with Lync Server administrative tools.

Lync Server Management Shell

Use of the Lync Server Management Shell.

Use the Lync Server SDK to create server applications that extend and customize Lync Server features. For example, features to add might include forwarding messages to different targets, managing message content, or modifying message headers.

There are two types of server applications created with the Lync Server SDK: script applications and managed code applications. Server applications are often deployed on an application server. In simple topologies server applications can be deployed to the Lync Front End server. To run a managed or script application on Lync Server you must register it, which includes configuring and deploying the application on a computer in the Lync Server domain.

For typical coding patterns in Lync Server applications, see the samples listed in Lync developer sample applications.

The tasks listed here are required to register a managed server application.

To register a managed code server application

  1. Compile the application and the application manifest, configured as a 64-bit application.

  2. Copy the application executable and manifest files to the server.

  3. Log in to the server as a member of the local computer RTC Server Applications group.

  4. Use the cmdlet New-CsServerApplication to create the server application.

  5. Ensure that the URI in the manifest file is identical to the URI used in the New-CsServerApplication cmdlet.

  6. Start the application executable. Using administrator privileges to start the executable is recommended.

The following list contains some common errors seen when registering an application and the steps commonly used to fix the error.

Error text

Try this

Is not a valid Win32 application

Rebuild the application, and ensure the build is configured for a 64-bit application.

Registration time-out

Use the cmdlet Get-CsServerApplication to verify that the application exists on the server. Verify that the URI listed on the server application is identical to the URI in the manifest.

Queue could not be opened

Make sure you are logged on as a member of the local computer RTC Server Applications group. Then, log off, log back in, and try again.

Server application failed to start

Make sure that the URI listed on the server application is identical to the URI in the manifest.