16 Managing the Instant Messaging and Presence Service

16.2.2.2.3 Building Application Provisioner

This section lists the steps Microsoft provides for provisioning other IIS servers to access OCS.

1. Install Visual Studio 2008 on any developer box (not necessarily IIS/OCS).

2. Install UCMA version 2.0 on the same box following the steps in Section 16.2.2.2.6, "Installing UCMA v2.0." The Application Provisioner application comes with the UCMA SDK.

3. Go to the directory Sample Applications\Collaboration\ApplicationProvisioner under the location where you installed UCMA Core (for example, C:\Program Files\Microsoft Office Communications Server 2007 R2\UCMA SDK 2.0\UCMACore\Sample Applications\Collaboration\ApplicationProvisioner).

4. The directory contains the Application Provisioner application. Build the application using Visual Studio 2008. This generates the ApplicationProvisioner.exe file.

5. Copy the executable file to the OCS box.

16.2.2.2.4 Provisioning WebCenter Portal's Proxy Application on OCS Server

1. Install UCMA v2.0 core libraries on the OCS box. Follow the same steps in Section 16.2.2.2.6, "Installing UCMA v2.0," except that after installing Visual C++ 2008 Redistributable, run OCSCore.msi. This installs the WMI classes required to provision an application.

2. Run the ApplicationProvisioner.exe file, generated in the previous section. This launches the Application Provisioner dialog.

3. In the Application Provisioner dialog, enter WebCenterProxyApplication as the name of your application for the Application name, and then click Find or Create.

4. In the Create Application Pool dialog, select the Office Communications Server pool for your application in the OCS Pool Fqdn list. For Listening port, enter the listening port for your application (for example, 6001). For Application server Fqdn, enter the fully qualified domain name (FQDN) of the computer on which the application is deployed. (This is the IIS box.)

   If the application is deployed on two or more computers, then select the Load balanced application check box, and for Load balancer Fqdn, enter the FQDN of the load balancer.

5. The application pool now appears in the Application Provisioner dialog. Double-click the server entry. The View Server dialog appears. Note the information shown there; that is, Server FQDN, port, and GRUU.

6. Create a certificate on the OCS server with the subject name as the Server FQDN noted in the previous step using the Office Communications Server Certificate Wizard. This certificate is used to authorize the requests coming from the IIS server.

7. After the certificate is created, view the certificate. On the Details tab click Copy to File. This launches the Certificate Export Wizard. Export the certificate with the private key to a file. This creates a .pfx (Personal Information Exchange) file with the certificate name.

16.2.2.2.5 IIS Server Configuration

Because the IIS server hosts WebCenter Portal's Proxy application in the remote deployment scenario, use the information from the previous section to make it a trusted authority.

1. Install the certificate issued by the OCS server with the private key: Copy the .pfx file generated in step 7 under section "Provisioning WebCenter Portal's Proxy Application on OCS Server" to the IIS box, and double-click it. This launches the Certificate Import wizard. Import the certificate in Personal Folder under LOCAL_MACHINE.

2. Give permission to IIS_WPG user for reading the certificate. This is required so that the IIS server has appropriate read access on the certificate. This could be done using a utility provided by Microsoft called Windows HTTP Services Certificate Configuration Tool (http://www.microsoft.com/downloads/details.aspx?familyid=c42e27ac-3409-40e9-8667-c748e422833f&displaylang=en). Download the utility and install it. This creates an executable called winhttpcertcfg.exe. Go to the install location and run the following command to grant permission:

   winhttpcertcfg.exe -g -c LOCAL_MACHINE\MY -s "<certificate-name>" -a "IIS_WPG"
   

3. Make an entry in C:/WINDOWS/system32/drivers/etc/hosts for the pool name of the OCS server as follows:

   <ip-address-of-ocs-box> <poolname-of-ocs-box>
   

   For example:

   10.177.252.146 pool01.example.com
   

4. Because the IIS server hosts WebCenter Portal's Proxy application, install Microsoft UCMA v2.0 on it.

   For detailed information, see Section 16.2.2.2.6, "Installing UCMA v2.0."

5. After UCMA is installed, deploy the proxy application on the IIS server. WebCenter Portal's Proxy application provides web services for interacting with OCS server and sending/receiving information. WebCenter Portal talks to these web services and presents the data.

   For detailed information, see Section 16.2.2.2.7, "Installing WebCenter Portal's Proxy Application."

6. Go to the location where WebCenter Portal's Proxy application was extracted. Open Web.config and edit the appSettings XML node to add the values noted in Step 7 in previous section. Ensure to set value for RemoteDeployment to true.

   For example, the appsettings XML node should look somewhat like this.

   <appSettings>
     <add key="ApplicationName" value="WebCenterProxyApplication"/>
     <add key="RemoteDeployment" value="true"/>
     <add key="ApplicationFQDN" value="iis.server.com"/>
     <add key="ApplicationGRUU" value="sip:[email protected];gruu;opaque=srvr:WebCenterProxyApplication:7mhSo94PlUK-5Q2bKPLyMAAA"/>
     <add key="ApplicationPort" value="6001"/>
   </appSettings> 
   

The trust is established, and WebCenter Portal's Proxy application can talk to OCS.

16.2.2.2.6 Installing UCMA v2.0

Microsoft Unified Communications Managed API v2.0 (UCMA) is an endpoint API that allows advanced developers to build server applications that can interact with the OCS environment.

In a simple deployment, the UCMA is installed on the same box as OCS. In a remote deployment, the OCS core libraries are installed on the OCS box, and the UCMA is installed on the IIS (proxy) box.

1. Download UCMA v2.0 from the following location:

   • For OCS2007 R1 installation (32 bit): http://www.microsoft.com/downloads/details.aspx?FamilyID=768efa33-6606-4b2b-809a-6c69274621d3&displaylang=en

     Download and run the UcmaSDKWebDownload.msi file. This extracts set up files to the folder C:\Microsoft Unified Communications Managed API 2.0 SDK Installer package\i386.

   • For OCS2007 R2 installation (64 bit): http://www.microsoft.com/downloads/details.aspx?FamilyID=b20967b1-6cf5-4a4b-b7ae-622653ac929f&displaylang=en

     Download and run the UcmaSDKWebDownload.msi file. This extracts set up files to the folder C:\Microsoft Unified Communications Managed API 2.0 SDK Installer package\amd64.

2. Go to the directory (where the files from the previous step were extracted) and run vcredist_x86.exe. This installs run-time components of Visual C++ Libraries required for UCMA APIs. Go to directory called Setup and run UcmaRedist.msi. This installs the UCMA 2.0 assemblies in the GAC.

16.2.2.2.7 Installing WebCenter Portal's Proxy Application

1. Extract owc_ocs2007.zip from the companion CD. This creates a directory named OCSWebServices.

2. Open the Internet Information Services (IIS) Manager.

3. Expand the server node and then Web Sites in the Internet Information Services (IIS) Manager.

4. Right-click Default Web Site, select New, and then select Virtual Directory to create a site for the Oracle RTC Web service. The Virtual Directory Creation Wizard displays. Click Next.

5. Enter an alias for the virtual directory in the Alias field, for example RTC.

6. Enter the path to the directory extracted from owc_ocs2007.zip file. If you had extracted the zip file in C:\, then the path supplied should be C:\OCSWebServices. Alternatively, use the Browse button to navigate to that directory. Click Next.

7. Ensure that the virtual directory has the Read, Execute, and Browse privileges. Click Next.

8. Click Finish. The newly created virtual directory appears under Default Web Site in the Internet Information Services (IIS) Manager window.

9. Right-click the newly created virtual directory for the Oracle RTC Web service, and then select Properties to open the Properties dialog.

10. In the Virtual Directory tab, under Application settings, click Create. Notice that the button label changes to Remove, and the name of your newly created virtual directory appears in the Application name field.

11. Select Scripts and Executables from the Execute permissions dropdown list.

12. Under the ASP.NET tab, select the ASP.NET version as 2.0 or higher from the ASP.NET version dropdown list. IIS should be configured to consume ASP.NET 2.0 applications. Click OK.

13. Test the Web service by accessing the Web site from the following URL format: http://localhost/default_website/OCSWebService.asmx.

    where default_website is the virtual directory you created for the Oracle RTC Web service

    For example:

    http://localhost/RTC/OCSWebService.asmx

16.2.3.2.3 Building Application Provisioner

This section lists the steps Microsoft provides for provisioning other IIS servers to access Lync.

1. Install Visual Studio 2008 on any developer box (not necessarily IIS/Lync).

2. Install UCMA version 2.0 on the same box following the steps in Section 16.2.3.2.8, "Installing UCMA v2.0." The Application Provisioner application comes with the UCMA SDK.

3. Go to the directory Sample Applications\Collaboration\ApplicationProvisioner under the location where you installed UCMA Core (for example, C:\Program Files\Microsoft Lync 2010 R2\UCMA SDK 2.0\UCMACore\Sample Applications\Collaboration\ApplicationProvisioner).

4. Open the application in Visual Studio 2008 and edit the Application.cs file as per http://msdn.microsoft.com/en-us/library/gg448038.aspx.

5. Build the application using Visual Studio 2008. This generates the ApplicationProvisioner.exe file.

6. Copy the executable file to the Lync box.

16.2.3.2.4 Provisioning WebCenter Portal's Proxy Application on Lync Server

1. Run the OCSWMIBC.msi file that comes with the Lync setup package.

2. When a UCMA 2.0 application is deployed directly against Lync Server 2010, the SIP domains used in the Lync Server 2010 environment must be added to the Office Communications Server 2007 R2 SIP domain list before you run the Merge-CsLegacyTopology cmdlet. The application is deployed as if it were being deployed against OCS 2007 R2, then migrated to run against Lync Server 2010. To add the domains, see Section 16.2.3.2.5, "Adding AllowedDomains Using WBemTest."

3. Run the ApplicationProvisioner.exe file, generated in the previous section. This launches the Application Provisioner dialog.

4. In the Application Provisioner dialog, enter WebCenterProxyApplication as the name of your application for the Application name, and then click Find or Create.

5. In the Create Application Pool dialog, select the pool for your application in the Lync Pool Fqdn list. For Listening port, enter the listening port for your application (for example, 6001). For Application server Fqdn, enter the fully qualified domain name (FQDN) of the computer on which the application is deployed. (This is the IIS box.)

   If the application is deployed on two or more computers, then select the Load balanced application check box, and for Load balancer Fqdn, enter the FQDN of the load balancer.

6. The application pool now appears in the Application Provisioner dialog. Double-click the server entry. The View Server dialog appears. Note the information shown there; that is, Server FQDN, port, and GRUU.

7. The newly-created trusted entry must be migrated to Lync Server 2010. See Section 16.2.3.2.6, "Migrating Trusted Service Entries Using Topology Builder or PowerShell Cmdlets."

8. Create a certificate on the Lync server with the subject name as the Server FQDN noted in the previous step using the Lync Certificate Wizard. This certificate is used to authorize the requests coming from the IIS server.

9. After the certificate is created, view the certificate. On the Details tab click Copy to File. This launches the Certificate Export Wizard. Export the certificate with the private key to a file. This creates a .pfx (Personal Information Exchange) file with the certificate name.

16.2.3.2.5 Adding AllowedDomains Using WBemTest

1. To start WBemTest.exe, type WBemTest in a command prompt and click the Enter button.

2. In the Windows Management Instrumentation Tester dialog box, click Connect.

3. In the Connect dialog box, click Connect.

4. In the Windows Management Instrumentation Tester dialog box, click Enum Classes.

5. In the Superclass Info dialog box, click OK.

6. In the Query Result dialog box, scroll down to MSFT_SIPDomainData(), and double-click this entry.

7. In the Object editor for MSFT_SIPDomainData dialog box, click Instances. This causes the Query Result dialog box to open, displaying the InstanceIDs for any instances of the MSFT_SIPDomainData WMI class. These entries are the AllowedDomain entries.

8. To add AllowedDomain entries, click Add.

9. In the Instance of MSFT_SIPDomainData dialog box, in the Properties listbox, double-click Address.

10. In the Property Editor dialog box, select the Not NULL radio button.

11. In the Value text input pane, enter the Lync server domain; for example, contoso.com. Click Save Property.

12. In the Instance of MSFT_SIPDomainData dialog box, in the Properties listbox, double-click Authoritative. The Authoritative property should not be Null and should be set to False. Click Save Property.

13. In the Instance of MSFT_SIPDomainData dialog box, in the Properties listbox, double-click Default Domain. The Default Domain property should not be Null and should be set to True. Click Save Property.

14. In the Instance of MSFT_SIPDomainData dialog box, click Save Object.

16.2.3.2.6 Migrating Trusted Service Entries Using Topology Builder or PowerShell Cmdlets

To migrate trusted service entries using Microsoft Lync Server 2010 Topology Builder:

1. Launch Microsoft Lync Server 2010, Topology Builder.

2. After the existing topology is loaded, under Action, select Merge 2007 or 2007 R2 Topology. This launches a wizard.

3. Go through the wizard, keeping the default options. After the wizard has finished, check that it completed successfully. There should be no errors in the user interface.

4. Select Publish Topology and complete the wizard, as in the previous step.

To migrate trusted service entries using Microsoft Lync Server 2010 PowerShell Cmdlets:

1. From the Start menu, in the Microsoft Lync Server 2010 program group, open Lync Server Management Shell.

2. Run the following PowerShell cmdlet:

   Merge-CsLegacyTopology -TopologyXmlFileName D:\output.xml
   

3. Run the following PowerShell cmdlet:

   Publish-CsTopology -FileName D:\output.xml
   

16.2.3.2.7 IIS Server Configuration

Because the IIS server hosts WebCenter Portal's Proxy application in the remote deployment scenario, use the information from the previous section to make it a trusted authority.

1. Install the certificate issued by the Lync server with the private key: Copy the .pfx file generated in step 7 under section "Provisioning WebCenter Portal's Proxy Application on Lync Server" to the IIS box, and double-click it. This launches the Certificate Import wizard. Import the certificate in Personal Folder under LOCAL_MACHINE.

2. Make an entry in C:/WINDOWS/system32/drivers/etc/hosts for the pool name of the Lync server as follows:

   <ip-address-of-lync-box> <poolname-of-lync-box>
   

   For example:

   10.177.252.146 pool01.example.com
   

3. Because the IIS server hosts WebCenter Portal's Proxy application, install Microsoft UCMA v2.0 on it.

   For detailed information, see Section 16.2.3.2.8, "Installing UCMA v2.0."

4. After UCMA is installed, deploy this proxy application on the IIS server. WebCenter Portal's Proxy application provides web services for interacting with Lync and sending/receiving information. WebCenter Portal talks to these web services and presents the data.

   For detailed information, see Section 16.2.3.2.9, "Installing WebCenter Portal's Proxy Application."

5. Go to the location where WebCenter Portal's Proxy application was extracted. Open Web.config and edit the appSettings XML node to add the values noted in Step 7 in previous section. Ensure to set value for RemoteDeployment to true.

   For example, the appsettings XML node should look somewhat like this.

   <appSettings>
     <add key="ApplicationName" value="WebCenterProxyApplication"/>
     <add key="RemoteDeployment" value="true"/>
     <add key="ApplicationFQDN" value="iis.server.com"/>
     <add key="ApplicationGRUU" value="sip:[email protected];gruu;opaque=srvr:WebCenterProxyApplication:7mhSo94PlUK-5Q2bKPLyMAAA"/>
     <add key="ApplicationPort" value="6001"/>
   </appSettings> 
   

ErrorCode = -2146893039
FailureReason = NoAuthenticatingAuthority
e.Message = "Unable to perform authentication of credentials."
base {Microsoft.Rtc.Signaling.FailureResponseException} = {"Unable to perform authentication of credentials."}
InnerException = {"NegotiateSecurityAssociation failed, error: \-2146893039"}

<identity impersonate="true" userName="Administrator" password="MyPassword1*"/>

The trust is established, and WebCenter Portal's Proxy application can talk to the Lync server.

16.2.3.2.8 Installing UCMA v2.0

Microsoft Unified Communications Managed API v2.0 (UCMA) is an endpoint API that allows advanced developers to build server applications that can interact with the Lync environment.

In a simple deployment, the UCMA is installed on the same box as Lync. In a remote deployment, the Lync core libraries are installed on the Lync box, and the UCMA is installed on the IIS (proxy) box.

1. Download UCMA v2.0 for OCS 2010 R2 installation from the following location: http://www.microsoft.com/downloads/details.aspx?FamilyID=b20967b1-6cf5-4a4b-b7ae-622653ac929f&displaylang=en

   Download and run the UcmaSDKWebDownload.msi file. This extracts set up files to the folder C:\Microsoft Unified Communications Managed API 2.0 SDK Installer package\amd64.

2. Go to the directory (where the files from the previous step were extracted) and run vcredist_x86.exe. This installs run-time components of Visual C++ Libraries required for UCMA APIs. Go to directory called Setup and run UcmaRedist.msi. This installs the UCMA 2.0 assemblies in the GAC.

16.2.3.2.9 Installing WebCenter Portal's Proxy Application

1. Extract owc_ocs2007.zip from the companion CD. This creates a directory named OCSWebServices.

2. Open the Internet Information Services (IIS) Manager.

3. Expand the server node and then Sites in the IIS Manager.

4. Right-click Default Web Site, and then select Add Application. The Add Application wizard displays.

5. Enter an alias for the virtual directory in the Alias field, for example RTC.

6. Enter the path to the directory extracted from the owc_ocs2007.zip file. For example, if you extracted the zip file in C:\, then enter C:\OCSWebServices. Alternatively, use the Browse button to navigate to that directory. Click OK.

7. Right-click the newly created application and select Edit Permissions to open the Properties dialog.

8. In the Security tab, edit permissions to grant user Everyone read permission.

9. Test the Web service by accessing the Web site from the following URL format: http://localhost/default_website/OCSWebService.asmx.

   where default_website is the virtual directory you created for the Oracle RTC Web service.

   For example:

   http://localhost/RTC/OCSWebService.asmx