Application Note

ST-10063
March 24, 2009

Microsoft OCS Requirements for ShoreWare Call Manager Instant Messaging Feature
Product: ShoreWare Call Manager, ShoreTel 8.1 and 9

Overview OCS implementation guidelines

ShoreWare® Call Manager in ShoreTel 8 and above offers the OCS server software comes in three configurations: Stan-
ability to interface with third party Instant Messaging (IM) dard Edition, Enterprise Edition and Enterprise Expanded
servers compliant with the SIP/SIMPLE protocols. ShoreWare Edition.
Call Manager supports the Microsoft Office Communication
All editions require Windows 2003 or later and Windows
Server 2007 (OCS) and the Live Communications Server
Active Directory. The Standard Edition is generally for small
2005 (LCS) in ShoreTel 8 and 8.1. It only supports Microsoft
business while the Enterprise and Enterprise Expanded
OCS 2007 and ShoreTel Converged Conferencing 7.1 in
Edition are for larger organizations.
ShoreTel 9.
ShoreTel strongly recommends deploying the OCS 2007
This document describes the license and configuration
Standard Edition for a user population with less than 5,000
required on the OCS side to allow Call Manager to use
users. This edition is more cost-effective, easier to install and
Instant Messaging and IM presence. The ShoreTel® system
maintain than the Enterprise Edition when the intended
and Call Manager configuration for IM is addressed in the
feature is Instant Messaging only.
ShoreTel 8 Administration Guide.

This document does not describe how to integrate the OCS license requirement
ShoreTel system with the Microsoft OCS for remote call
control or unified messaging. It does not describe how to One (1) standard CAL is required on OCS per IM user to
set-up OCS by itself. Please refer to Microsoft documentation enable Instant Messaging and IM presence.
to learn how to perform the basic set-up.
OCS server configuration
Instant Messaging and IM Presence features
TCP transport
Instant Messaging and PC presence are available in the The server is to be configured with TCP transport with the
following ShoreWare Call Manager applications: following steps.
• ShoreWare Professional Call Manager 1. Right-click on the server as shown, then select Properties
• ShoreWare Operator Call Manager or Front End Properties.
• ShoreWare Workgroup Supervisor
• ShoreWare Workgroup Agent

Instant Messaging is an optional functionality that the

administrator can activate on a per-user basis in ShoreWare
Director.

Instant Messaging features include:

• Point-to-point and multiparty conversations

• Contact Viewer
• Combined telephony and PC presence
• Conversation history
• IM presence change alert

Microsoft OCS Requirements for ShoreWare Call Manager Instant Messaging Feature Application Note—Page 1
2. In the General Tab, you will see that MTLS is enabled by Choose “Client Version Filter”. Change RTC to “Allow”.
default.

Basic connectivity testing

3. Click the Add button, select the TCP Transport and,
click OK. OCS user account and profile
The user login should be of the format tom@acme.com. This
format will need to be authenticated with the domain controller.

The screenshots below illustrate how the user login in the

Domain Controller needs to match the user login in the
OCS server.

Security settings
The TLS transport is currently only supported in ShoreTel 9.

Note: TLS transport is enabled by default on the OCS 2007

server.

Client Version Filtering

In OCS 2007, you will need to make sure that the RTC client
type is allowed in the Client Version Filtering setting to
connect the Call Manager to the Microsoft server. This
setting is not required with LCS 2005. To find out more on
the Client Version Filter setting, refer to the OCS 2007
Administration guide, page 197.

You will bring up the Microsoft Office Communications-

Server 2007 configuration application. Right click on
yourserver name.

Microsoft OCS Requirements for ShoreWare Call Manager Instant Messaging Feature Application Note—Page 2
The IM password used by Call Manager is the OCS password Any of these errors indicate an authentication failure.
which is also the user’s NT password since the user is defined ShoreWare Call Manager may not authenticate with the
through LDAP for OCS. correct domain. By default, ShoreWare Call Manager will
authenticate against a domain, but for certain environments,
ShoreTel recommends testing connectivity to the server
it may need to be authenticated against a specific sub-do-
by having two users log in using Office Communicator,
main. In this case, a fully qualified domain name, such as
and then sending an IM message to each other and
username@sub.domain.com must be configured in each
exchanging presence information.
Call Manager.

Still having issues logging into Microsoft OCS? Other considerations

1. If OCS is configured with TLS, go to ShoreWare Director
and check the following: • Microsoft OCS is not necessary to enable video on the
Call Manager.
a. Administration | IM Servers
• Edge Proxy is not currently supported. With Call Manager,
b. Select IM server and make sure it is enabled for TLS and
remote clients require a VPN connection.
not TCP
• Exchange of IM presence between the Call Manager and
2. Verify the user IM information is setup correctly in
Microsoft Office Communicator is supported with OCS 2007.
ShoreWare Director:
• Support for LCS 2005 is discontinued in ShoreTel 9.
a. Administration | Users | Individual users
• Microsoft OCS Federation is only supported by ShoreWare
b. On users page | Instant Messaging Settings:
Call Manager in ShoreTel 9.
c. Verify the correct server with TLS enabled
• Running ShoreWare Professional Call Manager concurrently
d. Verify the sign-in and user name are correct with the Microsoft Office Communicator on the same PC is
3. Verify client type is correct. Must be Professional Call not supported.
Manager or higher:
4. Turn on IM tracing on the client Call Manager: Additional documentation
a. Bring up ShoreWare Call Manager
You can find information on OCS at Office Communicator
b. In the QuickDialer area, hit Ctrl-F12 2007 Resource Center at:
c. Support and Debugging | Call Manager logging | Enable
http://office.microsoft.com/en-us/help/HA102373941033.aspx
check box for Instant Messaging.
d. Exit out and relaunch the Call Manager Record of Change
You may find the following type of error messages in the
This application note is subject to change. Updates and
PCM log:
corrections are always welcome. Please submit any updates or
2009/02/20 13:01:13.390 PST P/TID 0x174/0x26c corrections to info@shoretel.com.
IMManager: OnError: AUTHENTICATION_FAILED

2009/02/20 13:01:13.390 PST P/TID 0x174/0x100 Issue Author Reason for Change Date
PCMDockingArea.m_imMgr_IMEventsEvent: Error 1.2 L. Dinard OCS 2007 added July 28, 2008

2009/02/20 13:01:13.561 PST P/TID 0x174/0x100 1.3 L. Dinard Added details on removing PKI January 07, 2009
certificates, reference to
PCMDockingArea.ProcessError: AUTHENTICATION_FAILED Converged Conferencing
2009/02/20 13:01:13.651 PST P/TID 0x174/0x26c
1.4 L. Dinard Added discontinued support of April 7, 2009
[UCCAdapter] OnEnable Error- Logon Error code:- LCS 2005 in ShoreTel 9; more
2131820143 :: 0x80EF0191 UCC_E_SIP_STATUS_CLIENT_ details on troubleshooting steps
UNAUTHORIZED

960 Stewart Drive Sunnyvale, CA 94085 USA Phone +1.408.331.3300 +1.877.80SHORE Fax +1.408.331.3333 www.shoretel.com
Copyright © 2008 ShoreTel. All rights reserved. ShoreTel, the ShoreTel Logo, ShoreCare, ShoreGear, ShoreWare, ShorePhone, ControlPoint and Office Anywhere are trademarks or registered trademarks of ShoreTel, Inc.
All other marks are the property of their respective owners. Specifications are subject to change without notice. ST-10010_10.07