IBM Lotus Sametime Proxy: A Collaborative Recipe for Success

1. (AD306)
IBM Lotus Sametime Proxy:
A Collaborative Recipe for Success
© 2011 IBM Corporation
William Holmes
Software Engineer @ IBM

2. Disclaimer
● Information regarding potential future products is intended to outline our
© 2011 IBM Corporation
general
● product direction and it should not be relied on in making a purchasing
decision.
● The information mentioned regarding potential future products is not a
● commitment, promise, or legal obligation to deliver any material, code or
● functionality.
● Information about potential future products may not be
● incorporated into any contract. The development, release, and timing of any
● future features or functionality described for our products remains at our sole
● discretion.

3. © 2011 IBM Corporation 3
Agenda
●IBM Lotus® Sametime® Proxy Server * Overview
─ The Product
─ JavaScriptTM API
●New Offerings in Sametime Proxy
─ OpenAjax Hub
─ Framework update
●How IBM products collaborate with the Sametime Web client.
─ Sametime Meetings
─ Lotus Sametime Advanced
─ More ...
●Integrating the SDK into Current and New Applications
─ Shallow, Simple or Full Integration
●Application Integration
●
●* This presentation may refer to the associated product as “Sametime Web client” and/or “Sametime Proxy Web client”.

4. Introduction
● Sametime Proxy Server
● The IBM Lotus Sametime Proxy Server runs on WebSphere® Application
© 2011 IBM Corporation 4
Server.
●
● It requires a Lotus Sametime Community Server.
●
● It can also communicate with ...
─ Lotus Sametime Meeting server
─ Lotus Sametime Connections Server
─ Lotus Sametime Unified Telephony Server
─ TCSPI-enabled server
─
●

5. Introduction
● Applications can utilize the underlining data and UI widgets documented in the
© 2011 IBM Corporation 5
associate SDK provided with the product.
●
● The Sametime WebClient comes with a feature rich SDK.
●
● The SDK provides access to both low level data models and a variety of UI
widgets.
●
●
●
●

6. © 2011 IBM Corporation 6
Introduction
● Sametime Proxy WebClient Overview
● Extends the traditional Sametime Solution to provide a web based application.
●
●

7. UI Widgets
● sametime.WebClient ● sametime.Awareness
© 2011 IBM Corporation 7

8. UI Widgets
● sametime.QuickFind ● sametime.LiveName
© 2011 IBM Corporation 8
●
●
●
●
●
●

9. UI Widgets
● sametime.Chat ● sametime.GroupChat
© 2011 IBM Corporation 9

10. UI Widgets
● sametime.UserInfo ● sametime.BusinessCard
© 2011 IBM Corporation 10

11. © 2011 IBM Corporation 11
JavaScript APIs Overview
●
● Base Component Architecture
1
2
●
1
Sametime
Proxy Server
REST
GET
POST
PUT
DELETE
HTTP REQUESTS
APIs RTC4WEB
(Long Poll)
COMMUNICATION
LAYER
HUB
Sametime
Community Server
Client

12. © 2011 IBM Corporation 12
JavaScript APIs Overview
1 Login / Logout are Synchronous HTTP requests
2
3 RTC4WEB Long Poll
1 Asynchronous HTTP request
2 Publish/Subscribe
3 30 Seconds Request Channel (Comet )
4 Continues polling for Data
4
5 JavaScript APIs use callback functions allowing integrating
application(s) to handle returned data including successful and
unsuccessful requests.
1

13. Model Model
© 2011 IBM Corporation 13
JavaScript APIs Overview
● sametime.LiveName
1 Based on a LiveName Model
2 Each Model distributes updates to each LiveName for that model
3
4
5
6
7
8
9
10Model is JavaScript Framework Independent
1 Create a model
1 var myModel = stproxy.getLiveNameModel(<userId>);
2 Use an event subscription to connect for updates
3 myModel.onUpdate(update);
4 Overriding the function is NOT recommended.
5 dojo.connect(myModel,”onUpdate”, myHanlder)
6
11
1
STATUS UPDATE

14. © 2011 IBM Corporation 14
JavaScript APIs Overview
● Creating a Livename
●Option1: <div dojo.type=”sametime.LiveName” userId=”<userId>”/>
●Option2: new sametime.LiveName({“userId”:<userId>},<myDivElement>);
●
● sametime.Chat / sametime.GroupChat
1Start a Chat
1stproxy.openChat(<userId>,/*isIncoming*/ true);
2Create a Chat model
1var myChatModel = stproxy.getChatModel(<userId>);
3Create a GroupChat model
1var myGroupChatModel = stproxy.getGroupChatModel(<placeId>)
4
5Each Chat/GroupChat model provides a set of event handlers.
1

15. © 2011 IBM Corporation 15
JavaScript APIs Overview
● UI plugin extension points
● LiveName
1 Status Icons
2 Custom Attribute Icons
3 Text Plugins (CSS)
4
● (Right Click) Context Menus
1 LiveName
2 Groups
3
● Toolbars
1Main Menu
2Chat Menu
●
●

16. New Offerings in Lotus Sametime Proxy Server
● Open AJAX Hub v.2.0
© 2011 IBM Corporation 16
●
● Defined by the Open Ajax Alliance
●
● The hub provides JavaScript functionality which addresses our XHR Cross
Domain (same origin) requirements.
●
● Why start using the Hub?
● Not necessary to lower the document domain for your application.
● No requirement to use alternative AJAX proxies.
●
● IBM continue to have an active roll in the development of the hub.
●
●
1

17. New Offerings in Lotus Sametime Proxy Server
1 Configuration Changes
●The hosting application must set the tunnelURI in the global stproxyConfig
JavaScript Object.
●
●
●
© 2011 IBM Corporation 17
1
2 Example tunnel.html source
3
4
●
●
●
●
●
●

18. New Offerings in Lotus Sametime Proxy Server
3 Optional Configuration Changes
●If your application already uses/loads the AJAX Hub...
●Loading of the hub from the Sametime Proxy Server can be disabled
© 2011 IBM Corporation 18
●
●
●
●baseComps.js?oah=false
●
● Benefit
● Reduce redundancy
● Increase page load speeds.
●
●
●
●
●

19. New Offerings in Lotus Sametime Proxy Server
© 2011 IBM Corporation 19
● JavaScript Framework update
1 Dojo Toolkit
1 Now supporting Dojo v.1.5
2 Still backward compatible to Dojo v.1.4.3
3 We intend to follow the versions to ensure as broad compatibility as possible
2
3 Additional Portal AJAX proxy support
1 Encoding cookie security
2
4 Double Byte character Searching
1

20. © 2011 IBM Corporation 20
Integrated IBM Products
1 Lotus Sametime Meetings
2

21. © 2011 IBM Corporation 21
Integrated IBM Products
1 Lotus Sametime Meetings
2

22. © 2011 IBM Corporation 22
Integrated IBM Products
2 Lotus Sametime Advanced
2

23. © 2011 IBM Corporation 23
Integrated IBM Products
2 Lotus Sametime Advanced
2

24. © 2011 IBM Corporation 24
Integrated IBM Products
3 Lotus Connections
2

25. © 2011 IBM Corporation 25
Integrated IBM Products
3 Lotus Connections
2

26. © 2011 IBM Corporation 26
Integrated IBM Products
● iNotes
● Lets watch a short video

27. © 2011 IBM Corporation 27
Integrated IBM Products
5 Portal 7.x
1 Theme Support (non-dojo integration)
2 Sametime Proxy Contact List Portlet
3
4
5
6
7
8
9
10
11
12
13

28. © 2011 IBM Corporation 28
Integrated IBM Products
3 Portal Awareness support
● Regular vcard
●
● <span class="vcard X-person-profile-inplace">
● ...
● </span>
●
●
●
● Adding awareness to current vcard tags
●
● <span class="vcard X-person-profile-inplace X-sametime-resolve">
● ...
● </span>
1
2 Its that simple !
1
3
4

29. © 2011 IBM Corporation 29
Integrated IBM Products
● Portal Awareness support
● Sametime Livename with vCard Support
1
1
2
●

30. © 2011 IBM Corporation 30
Integrating the SDK:
Shallow integration
● Simple connection to Sametime
─ Launch the client externally using an on-page button
●

31. © 2011 IBM Corporation 31
Integrating the SDK:
Simple integration
● Standard set of steps
─ Load the CSS file for styling
─ Set the configuration values
─ Load Dojo
─ Load the Base Components library
─ Load the UI widgets – all widgets or only those needed

32. © 2011 IBM Corporation 32
Integrating the SDK:
Full integration
● Consider your usage
─ Do you need Sametime support on all pages?
– Requires delivery of basic information to all pages
– These will require Dojo if you use the UI Widgets
─
─ Which widgets will you use?
– Should you include widgetsall.js or simply livename.js?
– Common widgets are:
● Status – you should be able to change your status
● BuddyList – show your contact list
● LiveName – presence awareness

33. © 2011 IBM Corporation 33
Example Demo
● Company Agent
● Logged into Sametime WebClient
●
Company Agent
●
● Policy Holder
● Logged into your Application
●
●Customer Login

34. Offerings
● How will you use Sametime Proxy ?
●
● Full Web Client
● UI Widgets (using Dojo)
● Model Frameworks (using another JavaScript Framework)
● Custom UI using the Base Component JavaScript APIs
● Or
● Using the REST services provided by the Sametime Proxy Server
●
●
●
© 2011 IBM Corporation 34

35. © 2011 IBM Corporation 35
Summary
1
● Model Architecture is not dependent on a JavaScript framework
●
● Widget/Plugin Extension Points allowing customization of functionality and L&F
●
● Integrate as much or as little as you require
●
● Sametime WebClient does not require browser plugins
●
● Integration should be easy, don't try and make it complicated.
●
● Read the SDK document … Please
●
●
●
●
●
●

36. Question Time
© 2011 IBM Corporation 36

37. © 2011 IBM Corporation 37
Legal Disclaimer
● © IBM Corporation 2011. All Rights Reserved.
●The information contained in this publication is provided for informational purposes only. While efforts were made to verify the completeness and accuracy of the information contained in this publication, it is provided AS IS without warranty of any kind, express or
implied. In addition, this information is based on IBM’s current product plans and strategy, which are subject to change by IBM without notice. IBM shall not be responsible for any damages arising out of the use of, or otherwise related to, this publication or any other
materials. Nothing contained in this publication is intended to, nor shall have the effect of, creating any warranties or representations from IBM or its suppliers or licensors, or altering the terms and conditions of the applicable license agreement governing the use of
IBM software.
●References in this presentation to IBM products, programs, or services do not imply that they will be available in all countries in which IBM operates. Product release dates and/or capabilities referenced in this presentation may change at any time at IBM’s sole
discretion based on market opportunities or other factors, and are not intended to be a commitment to future product or feature availability in any way. Nothing contained in these materials is intended to, nor shall have the effect of, stating or implying that any activities
undertaken by you will result in any specific sales, revenue growth or other results.
●Performance is based on measurements and projections using standard IBM benchmarks in a controlled environment. The actual throughput or performance that any user will experience will vary depending upon many factors,
including considerations such as the amount of multiprogramming in the user's job stream, the I/O configuration, the storage configuration, and the workload processed. Therefore, no assurance can be given that an individual user will
achieve results similar to those stated here.
●All customer examples described are presented as illustrations of how those customers have used IBM products and the results they may have achieved. Actual environmental costs and performance characteristics may vary by
customer.
●IBM, the IBM logo, Lotus, Lotus Notes, Notes, Domino, Quickr, Sametime, WebSphere, UC2, PartnerWorld and Lotusphere are trademarks of International Business Machines Corporation in the United States, other countries, or
both. Unyte is a trademark of WebDialogs, Inc., in the United States, other countries, or both.
●Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both.