Proper Procedures for Polite Presence Protocol and Perfect Propriety

From Mr. Presence

Dear Mr. Presence,

Microsoft Office Communicator provides me fantastic ways to connect with other people!  I can call them, send them an instant message, send files or even see them on video.  The problem is, with all these easy ways to connect with people, I find my colleagues are interrupting me at inopportune times.  How can I keep my private time private?

-Overly Interrupted

Dear Overly Interrupted,

Communicator does provide a dizzying number of mechanisms to connect with people!  Fortunately, it also provides ways to protect yourself from being interrupted when you don’t want to be.

The Presence system in Communicator is what powers the “Availability Jellybean.”  This Jellybean is the signal you send to others that tells them how Willing and Able you are to communicate.  When you are very busy, and need some private time, you can set this signal to indicate exactly that!

Do Not Disturb on the Presence Menu

Setting yourself to “Do Not Disturb” (or DnD for short) is a polite way to inform others that you are extremely busy.  While you are in DnD, phone calls automatically go to voicemail, and IM conversations are rejected.

Your colleagues could still choose to interrupt you face-to-face, but they should respect your DnD state and only choose to do this in dire circumstances.

-Mr. Presence

Dear Mr. Presence,

I have noticed I can set my Presence Availability state to “Away” from the Presence menu.

Be Right Back and Away on the Presence Menu

Doesn’t Communicator automatically set this state when I stop using my computer?  And what about the “Be Right Back” state I also see?  When should I use that?

-Away but Present

Dear Away but Present,

In general, the Yellow or Away Availability level in Communicator’s Presence model indicates that you are not able to communicate because you are no longer present at a communications device (i.e. you are “away”).

This state is automatically set for you when Communicator can detect you are away.  Today, Communicator does this based on activity on the device.  Each device has its own mechanism for sensing activity.  For a PC, activity on the keyboard, mouse or other input device keeps Communicator from setting the “Away” state.

You can set the Away state manually as well.  There are two reasons you may want to do this:

1.    You are stepping away from your computer, and you want this indicated immediately (by default, Communicator only sets Away after 20 minutes or if you lock your machine)

2.    You do not want to be interrupted by your colleagues, but you do not want to utilize the Do Not Disturb (DnD) state.

In the first case, it is best to use the “Be Right Back” state.  This state, once set, is automatically unset when you return to your computer.

In the second case, it is best to use the “Away” state.  This state persists until you unset it, either by choosing a new state, or by choosing “Reset Status” (which removes any manually set state).

Reset Status Option on the Presence Menu

Your colleagues will see you as “Away” even while you are using your machine.  This can be helpful if you want to be able to place calls and send IMs, but do not want all of your colleagues to know you are active on Communicator.

-Mr. Presence

Dear Mr. Presence,

I would really like to be logged into Communicator, so I can make and receive phone calls and instant messages, but I don’t want everyone to know I am logged in.  How can log in “invisibly” or “appear invisible” to others?

-Hiding Out

Dear Hiding Out,

There are two primary ways you can “lurk” using Communciator’s presence system today.  You can set yourself to “Away” (as I have discussed previously) or you can set yourself to “Appear Offline.”

Appear Offline on the Presence Menu

The “Appear Offline” option, when selected, will cause all of your colleagues to view you as “Offline.”  They will not even be aware that you are logged into Communicator.  However, you can still send and receive any and all communications (voice/phone, instant messages etc.).  When you no longer want to be seen as Offline, you can select “reset status” or another state.

The “Appear Offline” option will only appear if the Group Policy Option has been enabled by your Office Communications Server administrator (Software\Policies\Microsoft\Communicator\EnableAppearOffline).

It is important to use the Appear Offline option judiciously.  If everyone were to lurk Offline all the time, there would be no presence system at all.  However, there are times when it is very important to be able to be logged in, but not allow others to know you are logged in.

One example would be a middle of the night conference call.  You need to log in to conduct your conference call, but you do not want anyone else disturbing you during your twilight talk.

Further, you do not even want your colleagues to be aware you are logged in.  You want to conduct your call, and then go to sleep without reading email.  If a colleague saw your state as “Do Not Disturb”, for example, they might choose to send you a message.  By appearing offline, no one would expect an immediate response from their midnight memo.

-Mr. Presence

The Red Bang (Exclamation Mark) that appears in the Office Communicator Notifications region (top right corner) can indicate one of several different underlying problems.

Communicator uses the Red Bang to notify you that something needs your attention.  Clicking on that button opens a menu listing errors or other notifications.  Common causes of the red bang are missed calls/instant messages, Outlook integration errors, and address book synchronization (ABS) errors.  In this post, I will focus on the Outlook integration and ABS errors.

1.       Outlook Integration Error

As the error suggests, Communicator is unable to connect to Outlook.  Side effects of this include being unable to search for Outlook contacts in communicator, reverse number lookup failing for Outlook contacts when making a phone call in Communicator,  presence not lighting up in Outlook,  and others.   There are a couple of things to try that might fix the problem:

a.       Make sure Outlook is running.  If you didn’t start Outlook on your machine, Communicator will display this error.  If you already have Outlook running, try restarting Communicator (i.e. “exit” instead of just signing out).  It’s possible that Communicator failed to detect you have Outlook running, and restarting Communicator ensures that the Outlook detection code path (which gets executed during start up) is run. 

b.      Verify that the Outlook account and Communicator sign in profiles match.  By default Communicator signs in using the Windows account.  If the Outlook and Communicator profiles do not match, Communicator will be unable to connect to Outlook (and you will see the integration error).  For instance, in Outlook if I’m using cindykwan@msn.com and my Communicator account is cindykwan@microsoft.com, then I will see the integration error.  Please make sure the two emails are identical.  If, for some reason, you don’t want the Outlook and Communicator profiles to match, you can disable the profile/email comparison check.  Instructions on how to do that can be found here.

c.       Install the June 2007 hotfix package for Outlook 2007.   If none of the above solutions work, try installing the hotfix. A number of Office fixes related to presence and IM integration are part of this hotfix package.  Here’s a KB article that describes the updates, and includes a download link.

2.       Address book synchronization Error

If you have no idea what ABS is, then it’s probably a good thing because you’ve likely never encountered this error.  For those who have seen the error, it’s probably extremely frustrating because its error description will tell you to contact your system administrator.  Let’s first try to understand what ABS is and why it’s needed – this way, you’ll have more context about the issue if you ever have to troubleshoot the error.

On Office Communications Server (OCS), there is an address book service (ABS).  The ABS performs 2 main operations:  replicating the Active Directory (AD) (which is the central store of the enterprise’s global address list (GAL)) and computing and storing copies and deltas of the GAL on the server.  Unified Communication (UC) endpoints like Office Communicator connect to the ABS, and download and store the GAL locally (Communicator downloads the GAL from the address book server and not the AD directly because of performance issues).  The local GAL file is needed for displaying contact data on the contact card, phone numbers in the click to call menu (in addition to other minor features) and, most importantly, for Communicator search.  Communicator’s fast search capabilities (i.e. word wheeling – instant search results) are possible because Communicator indexes the local GAL so it can return instant search results as the user types in the search box.

When an ABS error occurs, contact details you see in the contact card or search results may be out of date.  There are several causes for this error:

a.       Internet Explorer (IE) settings are incorrect.  Communicator uses standard IE APIs to perform URL authorization, so the problem probably lies with either your Security or Proxy settings within IE.

i.                     Proxy Settings:  Try selecting “automatically detect settings” in Internet Explorer under Tools->Internet options->Connections->LAN settings.  Then sign-out and sign-in to Communicator.  If this setting causes other problems with your Internet connection you may need to change your settings back

ii.                   Security Settings:  If you are an internal user (i.e. within an enterprise network), make sure you are using your intranet URL for the AB download.  If you are using an internet URL in this case, then you must manually configure the internet URL as an intranet URL in the IE security settings.  You can determine the AB URL by opening the Communicator logs under %userprofile%\tracing\*.uccapilog (Note: you will need to have logging enabled in Communicator via tools menu->options->general tab) and search for “URLDownloadToFile”.  In that log entry, there should be an URL.  You must enter this URL into the list of “Local Intranet” sites in IE (Tools->Internet Options->Security – see the below screenshot).

b.      File to download cannot be found.  This is an issue on OCS, and the OCS system administrator will need to fix this problem on server end.  The issue may be a result of the web site hosting the address book not having valid Secure Sockets Layer (SSL) certificates.  If you’re interested in more details, refer to this KB article.

I hope you’ve never encountered any Outlook Integration or ABS errors and will never have to worry about troubleshooting the notification messages hidden behind the red bang.  If you have, please try the tips I’ve mentioned above. Fingers crossed – let’s hope the red bang goes away!

Cindy Kwan 
Program Manager

Update for Communicator 2007 Phone Edition - July 2008 (KB952693) has been released to the Microsoft download center. http://www.microsoft.com/downloads/details.aspx?FamilyID=eeb1b339-df7e-486f-a47a-23d7ed8be6fd&DisplayLang=en

Description of the Communicator 2007 Phone Edition update: July 2008 http://support.microsoft.com/?kbid=952693

Note:  Released for English as well as all the other localized languages (Dutch, French, German, Italian, Japanese, Korean and Spanish)

I have been working on a multi-part article for Technet magazine that explains how Communicator works with OCS and other components to provide various voice, conferencing and presence features. The first of these series of articles was published in February edition that explained how presence works. The next one in the July edition explains how voice works. These articles also shed light on the important role that client endpoints play in the OCS system and provide an end to end perspective. This particular article highlights the role client endpoints play in setting up voice calls, what happens when numbers are dialed and how they are processed in the system, how calls are forked, what inbound and outbound routing functions are etc. The article also provides a map of the events that take place from the point that a call is initiated to the point that the call is answered and then terminated.

http://technet.microsoft.com/en-us/magazine/cc645016(TechNet.10).aspx

Enjoy reading!

Rajesh Ramanathan

Conferencing was a large investment for OCS and OC in the 2007 release. We define conferencing as a conversation having three or more participants in it. This can be IM, Audio, Audio/Video, data (Live Meeting), or any combination of those items. For Communicator, we worked hard to keep the fact that it is a "conference" fairly transparent in our user experience. In this article I will explain how easy it is to take advantage of conferencing assuming that you have a conference supported version of OC/OCS 2007.

Turn Two Party call into a Conference
Let’s take a simple example. You are having an audio call with someone and you realize that you should bring another person into the conversation to help answer a question. There are two ways to do this:
1. Press Invite and select them from a contact picker.
(Note the presence letting you know the likelihood of them being able to join.)

2. Find them in your contact list and drag them into the conversation

Either operation will cause a conference to be created seamlessly. On your side the main difference will be an additional person in the conversation.

Start Ad-hoc Conference
In addition to turning an existing conversation into a conference, it is also just as easy to start a conference from the very beginning. Below are three common methods to begin a conference.

Start with existing contact group
Use the groups you’ve created in your contact list as a starting point, especially for IM conferences. This will send an IM to everyone in the ‘Project A’ group (below).

Before starting your conference you may want to first provide a subject, so those that are invited will see that as part of the toast they receive to join. You can set the subject by selecting the menu drop-down on the far right of the conversation window.

Start with specific contacts
Another option is to select the people you want by pressing CTRL+ selecting each contact and then right-click to bring up the context menu. From there you can pick what modality you’d like.

Or you could start an audio/video call with those participants right away.

Start from an email in Outlook
Another really powerful scenario involves the integration of Communicator into Outlook. You can start a group IM directly in Outlook after you notice that everyone’s presence is indicating they are available. Ginger describes this in one of her posts.

Schedule a Conference Call from Outlook
Given the ad-hoc nature of Communicator it is assumed that it would do well with the scenarios I described above. However, scheduled conference calls are a very common scenario for many people today. When you install the Conferencing Add-In for Microsoft Outlook, you will be able to schedule a Live Meeting or Communicator Conference Call. See Cameron’s recent post on how to schedule and join OC conference calls.

Join from alternate device
Imagine you need to step away from your desk, but still want to join the conference call on your cell. You can do this by selecting the Join From button and then selecting the number you want to be called at. The conferencing server will automatically call you at that number so you can join.

TIP: To configure devices to show up you must provide phone information in the Phone tab in the Tools|Options dialog, as shown in a previous post.
Additionally, you don’t need to worry about how to invite others. All OC users will receive a familiar toast and have the option to accept it and join with OC or join from an alternate number also.

Invite a phone number
Just because you are having an OC conference, doesn’t mean that everyone has to be using Communicator. At any point you can always invite someone by typing their phone number and OCS will dial-out to them automatically. Doing this is very similar to what was shown earlier. You select Invite and then type the number you want to dial and press OK.

Multimodal Communication
During a conference, like two party conversations, you can always add audio, audio/video, and even Live Meeting. Each participant will be notified and they have the option to join the new modes of communication.

Conference Commands
There are additional features that become available to Leaders when you are in a conference that can be accessed by right-click on a conference participant. This will bring up a context menu with extra commands enabled.

1. Make Leader – this will make the selected person a Leader also
2. Mute – the leader can mute themselves or anyone else using a conference mute
a. Note: the other participants can always un-mute themselves
3. Remove from Conference – this will remove the contact immediately

Hopefully, this post has made it clear how easy and familiar the conference experience is in Office Communicator.

Brandon Taylor 
Program Manager

The Office Communicator 2007 PE equipped Tanjay will use its "quick dial" feature as soon as it has been enabled through the use of "off hook" mode. If the Tanjay is using fixed number of digits normalization rules that overlap then the Tanjay could dial a number before it is completely entered. This will cause the user not be able to complete their call or they could possibly dial the wrong extension or phone number. These types of issues can occur when businesses add the Tanjay VOIP phones to their Office Communications Server 2007 network after they have designed a functional set of normalization rules that meet the needs of their VOIP phone network’s dial plan. If these pre-existing dial plans include different normalization rules that use a fixed number of digits, then the Tanjay in "quick dial" mode will be forced to dial the numbers that are entered an soon as the requirements for a static number of digits normalization rule are met. So for instance if you have 3 normalization rules designed for phone extensions throughout your Office Communications Server 2007 Enterprise Voice infrastructure e. g. 4 digits, 5 digits, and 6 digits. If a Tanjay user is trying to dial a known 6 digit extension using "quick dial" mode as they enter the fourth digit of that six digit extension the Tanjay device will begin to dial the four digits that have been entered as per the four digit normalization rule. So, either the Tanjay user will be connected with a wrong number or the will receive a "call cannot be completed" message from the Tanjay’s display. The first step in resolving this issue will be to redesign the Office Communications Server 2007 Enterprise Voice fixed digit normalization rules that overlap by using regular expression syntax to add a prefix to the fixed digit normalization rule that will be dropped.

Here's a couple of screenshots of the RouteHelper Number Normalization Rule dialog using a variable number of digits rule that will not accept the "no quick dial" feature:

With the Office Communicator and the Conferencing Add-in for Outlook, you can schedule a VoIP conference call well in advance, and join the call using Microsoft Office Communicator.

First things first, there’s some one-time prep work:

· You’ll need Office Communicator (of course), and it’s a good idea to have it running and signed in so you can avoid signing in at the time of the call.

·You’ll need the Conferencing Add-in for Microsoft Outlook, which you can get here: http://office.microsoft.com/en-us/help/HA102368901033.aspx
Just click the "Accept Terms and Install Add-in" link at the bottom of the page to kick off the download and install the Add-in.

· Close and restart Outlook so it is aware of the Add-in.

· You’ll notice you now have a Conferencing menu in Outlook. On that menu, click "User Accounts":



· Now enter your sign-in name in the dialog, and click the Test Connection button, which should tell you the connection succeeded after a few seconds. If not, you may need to use the Advanced button to enter your sign-in information:



NOTE: You can ignore the Live Meeting Service information in the User Accounts dialog if you don’t have an account.
· Click OK to close the User Accounts dialog. That’s it for the prep work!

Now it’s time to schedule your first Conference Call:

1.On the Conferencing menu in Outlook, select Schedule a Conference Call. Or, on the Outlook toolbar, select Schedule a Conference Call.

 

2. This will bring up a Conferencing Request window (the one shown below is from Outlook 2007):


3. On the Appointment tab, on the Subject line, type a description for your conference call.

4. To add people to the invitation, do one of the following:

· On the Appointment tab, in the To box, type the full e-mail addresses of the people you want to invite, separating each address by a semi-colon.

· On the Appointment tab, click To, and then select the invitees from your address book.

5. To designate which invitees are to be leaders depending on which version of Microsoft Office Outlook you are running, in the Conferencing request, on the Live Meeting toolbar (or in the Outlook 2007 ribbon) click, Participants/Leader or Leaders. In the Participants list, click the appropriate names and e-mail addresses. Click Add to move the selected names to the Leaders list, and then click OK.

 

· Choose Open Authenticated to only allow participants with a user account on the same Office Communications Server to join the meeting.

· Choose Closed Authenticated to allow only invited participants to join the meeting.

8. You can also type a message that all recipients will receive. On the Appointment tab, type your message above the dotted line in the box provided.

9. When the meeting invitation is as you want it, on the Standard toolbar, click Send.
You’ve now scheduled your Conference Call – note that you’ll often be able to skip many of the steps above. For instance, if you’re going to be the only Leader, you can skip step 5, and you’ll likely want to leave the Access control at Open Authenticated for most cases. The rest of the steps you’ll do for any meeting you schedule.

Microsoft Office Communicator provides several call forwarding options that allows you to manage your incoming calls in the way you want. For example, you can set up a simple rule in Communicator such that all your calls get routed to your cell phone while you are travelling on business. Or, you can set up a more complex rule such that your cell phone also rings if someone calls you at work during work hours on a weekday so that you don’t miss the important call from your client that you have been waiting for, even if you step outside your office for a few minutes. Or, you can automatically forward your calls to voicemail without first ringing you by setting yourself to "Do Not Disturb".

If you are enabled for enterprise voice, you will notice quick call forwarding options from the button at the top right corner of your Office Communicator main window as shown in Figure 1. You can quickly select to route the incoming calls to one of your personal numbers or to a contact from the flyout menu. For example, I often set my incoming calls to be routed to my mobile phone when I’m travelling as shown in Figure 1 below. You might find it convenient to first enter your personal numbers (mobile, home etc) in Tools > Options > Phones dialog as shown in Figure 2 so that these phone numbers appear in the call forwarding flyout menus automatically. (Note: You can choose to keep your phone numbers private by opting to not publish them.) Note: This call forwarding button will be missing if your administrator has configured you as a Standard CAL (client access license) user.

Once you set a rule, you will notice that the call forwarding button turns green. Hovering over the button or clicking on it will show you the exact rule you have set. For example, see Figure 3 below that shows that I’m forwarding my calls to my mobile phone.

From the call forwarding flyout menu, you can also select to simultaneously ring another phone number when you get an incoming call (see Figure 4 below). I find this option really cool and generally keep it turned on to ring my cell phone in addition to my desk phone for any incoming calls. It is particularly useful when I’m expecting an important call that I do not want to miss if I step outside the office for a few minutes. When I’m at my desk, I usually pick up the incoming calls on Communicator within a few seconds. If I happen to be outside my office getting a cup of coffee or chatting with a co-worker down the corridor or getting lunch in the cafetaria or travelling to another building for a meeting, I can always pick up that important call on my cell phone.

When you use this option, here are a couple of tips to keep in mind for better experience. There’s usually a few seconds latency in cell phone networks, so your Communicator will ring a few seconds before your cell phone. You may want to adjust the ring duration (I talked about this later) appropriately so that your cell phone rings at least a few times before the call goes to voicemail. Also, you might want to adjust the ring duration to ensure that the caller gets voicemail on your work number (and not your cell phone). A setting of 18 – 25 seconds has worked for me wonderfully.

To set more advanced call handling rules such as how to manage your unanswered calls and how to use the rules during work hours that you have specified in Microsoft Outlook Calendar, select Call-Forwarding Settings from the dropdown or from the Tools menu as shown in Figure 5 and Figure 6 below.

On the Call-Forwarding Settings dialog below, you can select more advanced options like time-based forwarding. For example, when I’m working from home, I often select the incoming calls to be routed to my home number during business hours as shown in Figure 7 below. This feature is really neat because it provides a unified experience with working hours in your Microsoft Outlook calendar. To view or update the business hours configured in Microsoft Outlook, go to Tools > Options > Calendar Options > Calendar Work Week as shown in Figure 8.

You can also send your un-answered calls to a phone number or to another person.That way, if you are not around to answer your calls, you can redirect them to someone or some phone number. For example, my project partner has selected to redirect his unanswered calls to me after ringing him first for 20 seconds in Figure 9 below. If an incoming call is not answered by my project partner and me (or my voicemail) within 60 seconds, it will be routed to my project partner’s voicemail instead.

Communicator 2007 also supports basic presence-based call routing. If you set your presence level to Do Not Disturb (aka DND), your incoming calls will be immediately routed to your voicemail without first ringing you. This is somewhat like the silent feature on your cell phone that you might already be familiar with. I find this immensely useful when I’m working on an important task or when I’m giving a presentation in front of clients and do not want to be disturbed by incoming calls. Note that contacts in your team access level can breakthrough DND to reach you if they have a pressing need to interrupt you. Also note that the call forwarding rules you have set previously do not apply while you are in DND.

You can also set all the call forwarding settings that I have described above when you use Microsoft Office Communicator Web Access 2007 as shown in Figure 10. This can come in really handy when you are at an airport kiosk, and want to change your call forwarding rules. If you happen to have an IP phone powered by Microsoft Office Communicator 2007 Phone Edition (e.g. Tanjay), you will notice a subset of call-handling options (including forwarding calls to a phone number, to a contact or to your voicemail) on your phone also as shown in Figure 11 below. The call forwarding settings roam and persist from one endpoint to another. So, if you set a call forwarding rule in Communicator client, you can later update it in Communicator Web Access and then turn it off in Office Communicator Phone Edition.

If you are not enabled for enterprise voice (e.g. if you are configured for remote call control), you will notice that you do not have the richer call forwarding settings that I have described above. Instead, you will notice a dialog as shown in Figure 12 that simply allows you to forward your incoming calls to a phone number or to your voicemail.

I hope you find these Call Forwarding Settings (and my tips) useful, and I look forward to hearing any feedback/comments based on your experience!

Ankit Tandon

Program Manager

Recently, there have been some server changes made by two of our Public IM Connectivity partners Yahoo! Inc. and MSN (Windows Live). These changes will affect only those Microsoft Office Communications Server 2007 and Microsoft Office Live Communications Server 2005 customers whose external firewalls accept traffic on TCP port 5061 only from known IP addresses.

On May 22, 2008, Yahoo! Inc. moved their servers that provide instant messaging (IM) federation with Microsoft Office Communications Server 2007 and with Microsoft Office Live Communications Server 2005. As a result, The fully qualified domain names (FQDNs) and IP addresses for the Yahoo! gateway servers have changed. However, Yahoo! will not change the name of the service provider for instant messaging, which is configured in Microsoft Office Live Communications Server 2005 Access Proxy and Microsoft Office Communications Server 2007 Access Edge Server. This name will remain lcsap.msg.yahoo.com.

Meanwhile, MSN (Windows Live) has also changed the IP address for its LCS and OCS gateway. The name of the service provider for instant messaging will also remain the same, which is federation.messenger.msn.com.

As documented in the documentation for Live Communications Server 2005 SP1 and for Office Communications Server 2007, the recommended firewall configuration when federating with public IM providers is to allow any IP address to connect to port 5061 on the Access Proxy. However, certain enterprises prefer to enforce stricter firewall rules and restrict incoming connections to specific IP addresses. For those customers, the IP addresses that are used by the public IM networks need to be specifically allowed on the enterprise firewall. The following lists contain the new IP addresses that are currently used by each service provider:

IP address that is used by MSN (Windows Live)
• 65.54.227.249

IP addresses that are used by Yahoo!
• 76.13.22.8
 
• 76.13.22.9
 
• 76.13.22.10
 
• 76.13.22.11
 
• 98.136.47.8
 
• 98.136.47.9
 
• 98.136.47.10
 
• 98.136.47.11
 
IP addresses that are used by AOL (unchanged)
• 64.12.162.248
 
• 205.188.153.55
 
For further information about the Yahoo! Change, please refer to the following Microsoft KB article:

http://support.microsoft.com/kb/952209

For other Known issues that occur with public IM connectivity, please refer to the following Microsoft KB article:

http://support.microsoft.com/kb/897567

Hao Yan
Sr. Program Manager

With this post, we would like to provide you an overview of how one could write a simple .NET based application to perform point-to-point Instant Messaging session (IM) using the Unified Client Communications API (UCC API) which can be downloaded from here.

The UCC SDK enables one to add features like Presence, Instant Messaging as well as Voice, Video and others offered by the Unified Communications Client Platform to applications (managed or unmanaged).

For an SDK overview and how to use the API in general, please refer to the MSDN library focused on UCC 1.0 SDK section within the Communications Server 2007 of the Office System.

A brief architecture overview follows.

The diagram above shows some of the various components involved within the UCC API SDK. The UCC SDK includes various communication modalities, conferencing capabilities, a presence infrastructure built on top of a signaling stack and a media stack. The signaling and media stack combined supports various different protocols including (but not limited to) the following: SIP, RTP, RTCP, STUN/TURN/ICE (for NAT/FW traversal), SRTP (for encryption), CCCP (for conferencing) and ECMA-based CSTA for Remote Call Control.

As before mentioned, this blog entry will primarily focus on the instant messaging APIs. Future posts may focus on other aspects of the API based on demand (please drop a comment if you would like us to focus on other areas in the future).

With that, let us dive into what one needs to do to integrate UCC API into their product to offer basic point-to-point Instant Messaging (IM) capabilities.

First, one will have to ensure that a manifest is included in the application that contains UCCAPI as a dependency (see sample below).

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">

    <assemblyIdentity

        version="1.1.0.0"

        processorArchitecture="x86"

        name="IMVoIPSample.exe"

        type="win32"

    />

    <dependency>

        <dependentAssembly>

                   <assemblyIdentity

                           version="2.0.0.0"

                           processorArchitecture="x86"

                           name="UCCAPI"

                             type="win32"

                    />

        </dependentAssembly>

    </dependency>

</assembly>

Next, the inter-op COM dependency needs to be added as a reference to the application: Microsoft.Office.Interop.UccApi.dll. The following DLLs are also needed to run the application: UccApi.dll and RTMPLTFM.dll.

The following will give an overview of what an application needs to prior to initiating an IM session.

An application should first initialize the platform as shown below. The following piece of code performs the following functions:

-          Initializes the platform

-          Connects to the SIP outbound proxy (specified as the server address below) using TLS

-          Sets NTLM as the authentication scheme with specified username and password (credentials)

-          Enables the endpoint: at which point the application sends out a SIP REGISTER request to the outbound proxy which then routes the SIP REGISTER request (RFC 3261, RFC 3327 and a few others) to the SIP registrar within OCS (Office Communications Server 2007). The UCCP stack internally handles SIP 401/407 SIP challenge responses with the supplied credentials.

-          In the event that a challenge response fails again, an event is raised to the events interface as will be later shown.

NOTE: What is not shown is the setting the application up to receive the events as shown in the comments below.

//Create the singleton platform object

IUccPlatform platform = new UccPlatform();

//Advise for platform events

//Initialize the platform with application name

platform.Initialize(“SampleApp", null);

//Advise for platform events

//Create an endpoint object from the platform object

IUccEndpoint endpoint = platform.CreateEndpoint(userURI, null, null);

//Advise for endpoint objects

//QI server IUccServerSignalingSettings interface from the endpoint

IUccServerSignalingSettings serverSignalingSettings = (IUccServerSignalingSettings)endpoint;

//Set servername, transport, authentication mode and login credentials

serverSignalingSettings.Server = serverAddress;

serverSignalingSettings.TransportMode = UCC_TRANSPORT_MODE.UCCTM_TLS;

serverSignalingSettings.AllowedAuthenticationModes = (int)UCC_AUTHENTICATION_MODES.UCCAM_NTLM;

IUccCredential credential = serverSignalingSettings.CredentialCache.CreateCredential(username, passwd, domain);

serverSignalingSettings.CredentialCache.SetCredential("*", credential);

//Enable the endpoint in order to register with server 

endpoint.Enable();

Next, handle the sign-in completion events as follows.

void _IUccEndpointEvents.OnEnable(IUccEndpoint pEventSource,IUccOperationProgressEvent pEventData){

  if (pEventData.IsComplete) {

    if (pEventData.Stat