1. Sametime
Version 8.5.2
From Zero to Hero
ShoreTel Communicator for IBM Sametime
Installing and configuring a Social Communications solution
From Zero to Hero: ShoreTel Communicator for IBM Sametime 1
3. Contents
Edition Notice.......................................................................................................................2
Contents...............................................................................................................................3
Introduction and purpose of this guide.................................................................................4
What is IBM Sametime?.......................................................................................................4
What is ShoreTel?................................................................................................................4
How does ShoreTel telephony integrate with IBM Sametime?.............................................5
Solution architecture.............................................................................................................5
Machines used in the deployment scenario.........................................................................8
Installing and configuring IBM Sametime.............................................................................8
Installing IBM Sametime Community Server..................................................................10
Configuring IBM Sametime Community Server..............................................................26
Installing IBM Sametime Connect..................................................................................30
IBM Sametime – more than instant messaging and presence.......................................35
Installing and configuring ShoreTel telephony....................................................................37
Installing and configuring ShoreTel Communicator for IBM Sametime...............................38
Installing and configuring CSTA and Sametime Integration Services.............................38
Installing and configuring client components..................................................................43
From Zero to Hero: ShoreTel Communicator for IBM Sametime 3
4. Introduction and purpose of this guide
The IBM Social Communications vision describes an integrated approach of easily finding,
reaching, and collaborating with others through a unified user experience. Social Communications
sets „traditional“ communication such as e-mail and telephony in context of a social business,
enabling organisations to become more integrated and social in how they communicate, innovate
and make decisions.
This vision is implemented by a set of IBM and partner solutions.
The present guide describes installation and configuration of ShoreTel Communicator for IBM
Sametime, a solution that connects Sametime instant messaging and presence with telephony
provided by ShoreTel. The solution plug-in enables advanced communications and provides
features commonly available from an enterprise VoIP deskphone as part of unified messaging
capabilities within the IBM Sametime or IBM Lotus Notes client.
This document is intended for use as a template for implementing a demo or pilot environment with
the option to extend. Sales, PoC or IT staff can consult this step-by-step guide to realize, for
example, an integrated customer showcase.
Please notice: The information provided is general in nature. The described scenario will require
modifications / extensions for implementation in a production environment.
What is IBM Sametime?
IBM Sametime is a product family that enables unified communications and collaboration via an
unified user experience. It delivers services such as presence awareness, IM, Web conferencing,
VoIP, video, persistent group chat, broadcast tools, instant screen sharing and location-based
awareness.
The Sametime platform consists of client and server applications, but also provides an open plug-in
model for adding third-party services. It can be integrated with applications your workforce uses
every day for easy access to enterprise instant messaging, online meetings, telephony and video
conferencing.
What is ShoreTel?
ShoreTel provides an unique set of unified business communications solutions that consistently
leads the industry in customer satisfaction and lowest total cost of ownership. In addition to an
premise-based IP phone system with unified communications and contact center capabilities,
ShoreTel also offers cloud-based communications.
The ShoreTel approach of a distributed architecture is incorporated into a unique appliance-based
platform. This platform has no single point of failure: each switch and site functions as an
independent call processor. In the event of wide area network (WAN) failure, the phone system
continues to place and receive calls on the Public Switched Telephone Network (PSTN).
A ShoreTel VoIP phone system can scale and grow across as many sites, as needed. The whole
system could be managed from a single browser-based interface.
Because of its open system approach, ShoreTel integrates with popular business applications such
as IBM Sametime, enabling users with VoIP phones, mobile phones, or any phone connected to the
public phone network to communicate and work together in a brilliantly simple new way.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 4
5. How does ShoreTel telephony integrate with IBM Sametime?
ShoreTel Communicator for IBM Sametime delivers the best of both worlds for ShoreTel and
IBM Sametime users: a reliable, single-image, easy-to-manage and feature-rich unified
communication solution. It allows users to call, transfer, conference, hold, or hang up their
softphone. Call logs remain available for historical reference and ShoreTel telephony presence
becomes visible to all IBM Sametime contacts – all within the familiar IBM Sametime and IBM
Lotus Notes interfaces users are accustomed too. ShoreTel Communicator for IBM Sametime
provides easy access to voice messages and the ability to listen and reply to, create, and manage
voice mails with full ShoreTel visual voicemail implementation – straight from your Sametime or
Notes desktop. Users can also click to dial from business cards within IBM Sametime contacts.
Extension assignment and softphone settings are readily available for edit via simple setting control
within IBM Sametime.
Full integration with your IBM Lotus Notes calendar is included as well - supporting automatic call
handling mode control. So, if your calendar reflects you as “in a meeting” your telephony status
will automatically change to “in a meeting.”
Solution architecture
Both IBM Sametime and ShoreTel telephony solutions could be deployed in either a single-site or
multi-site scenario.
Note: The Sametime Wiki describes in detail how to implement a high availability and high-
performance enterprise-scale deployment of Sametime as well as the ShoreTel Planning and
Installation Guide does for the telephony infrastructure.
IBM Sametime is much more than just chat and presence while these are the functions that ShoreTel
Communicator for IBM Sametime currently supports and extends. Sametime also provides web
conferencing and integrated voice, data and video within a social communications offering. For our
current ShoreTel Communicator for IBM Sametime deployment scenario, only Sametime
Community Server is needed. Other Sametime services such as Web Meetings, audio/video
integration or mobile device access will require additional server components.
If your plan to setup a multi-service Sametime environment, IBM strongly recommends to
install the IBM Sametime System Console as your focal point for administering and
configuring all Sametime servers.
The following picture describes a single-site deployment of IBM Sametime and ShoreTel. For this
scenario, ShoreTel's Headquarter (HQ) server hosts the voice applications platform and the
management web site, as well as the integrated voice applications. ShoreTel Communicator for
IBM Sametime brings Instant Messaging and Sametime presence together with voice mail,
telephony presence, call control and other features provided by ShoreTel.
Note: IBM Lotus Domino is an optional component in this scenario. If you use or plan to use
Domino-based e-mail and calendaring, the ShoreTel Communicator for IBM Sametime could
seamlessly integrate with your Domino calendar to manage your call handling mode.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 5
6. Single-site environment of ShoreTel Communicator for IBM Sametime
This scenario requires you to provide/install the following components/machines:
• Active Directory or LDAP
• IBM Sametime Community Server
• ShoreTel (HQ) server
The ShoreTel server provides features such as Distributed Application Platform (TAPI access via
ShoreTel Telephony Management Service) and Single System Management (ShoreWare Director).
It also hosts the ShoreTel Communicator for IBM Sametime.
To reduce WAN bandwidth, increase system scale and reliability, the ShoreTel system also supports
Distributed Voice Servers (DVS) to allow distributing voicemail and other applications. Currently, a
total number of 21 servers (1 HQ, 20 DVS) is certified by ShoreTel.
In the scenario below, „local“ users at SITE 2 connect to their local ShoreTel server with DVS
installed while SITE 3 users connect directly to the HQ server. For the purpose of simplification,
the scenario assumes that Sametime, Directory Services and (optional) Domino are hosted centrally.
ShoreTel Communicator for IBM Sametime could be installed on both HQ and DVS servers.
During the setup process, it detects whether the base server is running HQ or DVS services and
installs appropriately.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 6
7. Multiple-site environment of ShoreTel Communicator for IBM Sametime
The installation steps described below focus on the single-site deployment of ShoreTel, IBM
Sametime and the ShoreTel Communicator for IBM Sametime.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 7
8. Machines used in the deployment scenario
Within the next steps, we will either access or setup the following server components:
Server 1 (decide which option fits better to your requirements)
ldap.<yourdomain>: Domino 8.5 LDAP
or
ad2008.<yourdomain>: Active Directory 2008
Server 2
stshoretel.<yourdomain>: Sametime 8.5.2 Community Server:
Server 3
shoretelhq.<yourdomain>: ShoreWare HQ Server
Client 1
no specific host name: Sametime Connect 8.5.2 and/or Lotus Notes 8.5.3
For this manual, we will use the domain pscbln.de.ibm.com.
Installing and configuring IBM Sametime
IBM Sametime Community Server runs on top of an IBM Lotus Domino run-time environment. To
setup a Sametime 8.5.2 Community Server, you will need the following installation packages that
could be downloaded from IBM Passport Advantage:
Windows
• IBM Lotus Domino 8.5.2 32 bit for Windows English (CZIP9EN)
• IBM Sametime Standard Community Server V8.5.2 Windows Multilingual (CZYD7ML)
AIX / Linux / Solaris
• IBM Lotus Domino 8.5.2 for AIX 32 bit English (CZJ99EN) or
• IBM Lotus Domino 8.5.2 32 bit Linux for xSeries English (CZIQ2EN) or
• IBM Lotus Domino 8.5.2 32 bit Solaris English (CZIQ4EN)
• IBM Sametime Standard Community Server V8.5.2 AIX Linux Solaris Multilingual
(CZYD8ML)
IBM i
• IBM Lotus Domino 8.5.2 for IBM i English (CZIQ5EN)
• IBM Sametime Standard Community Server V8.5.2 IBM i Multilingual (CZYD9ML)
Note: To install a localized version of Sametime, you will have to download and install the
appropriate Domino Language Pack too.
If your plan to setup a multi-service Sametime environment, IBM recommends you to install an
additional server as the first step: The IBM Sametime System Console acts as your focal point for
administering and configuring all Sametime servers. Because it is not required for our ShoreTel /
Sametime deployment, installation and configuration of the System Console server is not
From Zero to Hero: ShoreTel Communicator for IBM Sametime 8
9. documented within this manual.
You can find further details about the installation in the IBM Sametime wiki at:
http://www-10.lotus.com/ldd/stwiki.nsf
To setup a Sametime 8.5.2 System Console Server, you will need the following installation
packages that could be downloaded from IBM Passport Advantage:
Windows
• IBM Sametime Standard System Console Server V8.5.2 Windows Multilingual (CZYF2ML)
AIX / Linux / Solaris
• IBM Sametime Standard System Console Server V8.5.2 AIX Multilingual (CZYF3ML) or
• IBM Sametime Standard System Console Server V8.5.2 Linux on x86 Multilingual
(CZYF4ML) or
• IBM Sametime Standard System Console Server V8.5.2 Solaris Multilingual (CZYF5ML)
IBM i
• IBM Sametime Standard System Console Server V8.5.2 IBM i Multilingual (CZYF6ML)
Directory Services: We need an existing LDAP or Active Directory for installation, so make sure
that this service is accessible from your machine via DNS or /etc/hosts.
IBM Sametime Connect is an Eclipse-based client for presence / instant messaging, web
conferencing and audio / video. It bases on an open, extensible platform architecture that enables
users or organizations to deploy and use a taylor-made set of features depending on their needs,
environment and policies.
To setup an IBM Sametime Connect client, you will need to download the following installation
packages from IBM Passport Advantage:
Windows, Linux and Mac
• IBM Sametime Standard Connect Clients and Network Installer V8.5.2 Multiplatform
Multilingual (CZYF7ML)
While IBM Sametime Connect is a stand-alone application, IBM also provides an embedded
version of its feature set that seamlessly integrates with Lotus Notes, IBM's integrated collaboration
client.
Note: Because of the variety of deployment scenarios for a Notes / Domino environment, this
manual will focus on how to extend an existing Lotus Notes client by integrating the ShoreTel
Communicator for IBM Sametime there, but will not describe the setup of a Notes / Domino
environment for messaging and / or applications. For details about how to plan and deploy a
Notes/Domino infrastructure, please have a look at the wiki:
http://www-10.lotus.com/ldd/dominowiki.nsf
From Zero to Hero: ShoreTel Communicator for IBM Sametime 9
10. Installing IBM Sametime Community Server
The following steps describe installation of a single Sametime Community Server 8.5.2 in a
Windows environment.
Preparation: Provide your server with a fully qualified hostname, e.g. stshoretel.<yourdomain>.
Also note that, if you use Windows 2008 as Operating System, you will need to start all installations
and configurations in administrative mode.
1. Extract the Domino installation package and start the installation process. The following dialog
is getting displayed:
2. Click Next >. The server we are about to install is our first Domino server within the domain,
so select the first option and click Next >.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 10
11. 3. We name the Domino server stshoretel, derived from the server's host name. Provide some title
here, then click Next >.
4. Provide an organization's name. Based on that, the installer will create your organization's
certifyer. Make sure to remember its password - it is required for administrative tasks such as
registering new organizational units, servers and users.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 11
12. 5. Provide a Domino domain name, then click Next >.
6. Insert a name for your Domino Administrator and assign a password to that user.
Click Next >.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 12
13. 7. We don't need any additional Domino-based services to support our deployment scenario, so
disable the LDAP service, then click Next >.
8. From the Domino network settings dialog, navigate to the port settings and disable NetBIOS
over TCP/IP.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 13
14. 9. On the next screen, keep the default settings, then click Next >.
10. Please review the configuration details on the next screen, then click Setup to start the
installation.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 14
15. 11. If setup is done, please click Finish to close the installation dialog.
Note: If you plan to deploy a non-English Sametime server, this would be the right time to
install the appropriate Domino Language Pack.
12. Extract the Sametime installation package to a temporary location. Navigate to the
SametimeStandardServerserver directory there, and run the setupwin32.exe.
13. Select your language of choice:
From Zero to Hero: ShoreTel Communicator for IBM Sametime 15
16. 14. The installation dialog comes up. Click Next > to proceed.
15. Accept the license agreement, then click Next>.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 16
17. 16. If you have already installed a Sametime System Console server and created a deployment plan
for your new Sametime Community Server, select Yes here and specify your System Console
server.
In our scenario, we do not use the System Console, therefore we select No here.
Click Next > then.
17. Accept the default and click Next >, in our scenario we won't deploy web conferencing with
slide conversion.
Notice: The following steps describe how to connect your Sametime Community Server to either an
LDAP or an Active Directory.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 17
18. LDAP only: Step 18 - 22
18. If you would like to connect to an existing LDAP, point the Sametime server to your LDAP
service.
Advanced LDAP Configuration might not be neccessary for this scenario, but will provide
you with some more detailed configuration options, e.g., in case a bind user is needed to access
your LDAP.
Click Next >.
19. If required, enter your LDAP bind user's credentials. Select the first option for anonymous
access.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 18
19. 20. Click Test Connection to make sure that Sametime could access the LDAP.
21. If everything is OK, click Next >.
22. For LDAP configuration steps 2/6 - 6/6, keep the defaults. Always click Next >.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 19
20. Active Directory only: Step 23 - 30
23. If you would like to connect to an existing Active Directory, point the Sametime server to your
service. Notice the different port number.
Check Advanced LDAP Configuration, then click Next >.
24. Enter your AD's bind user's credentials.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 20
21. 25. For Active Directory, change the search filter to the following:
(&(objectclass=organizationalPerson)(|(cn=%s)(sn=%s)(sAMAccountName=%s)(mail=%s)))
26. Click Next >.
27. For Active Directory, specify the following search filter:
(&(objectclass=organizationalPerson)(|(cn=%s*)(sn=%s*)(sAMAccountName=%s*)(mail=
%s*)))
The base object depends on your Active Directory structure. Click Next > if you have specified
the appropriate settings.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 21
22. 28. Keep the default settings and click Next >.
29. To access your Active Directory, add the appropriate base object here, then click Next >.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 22
23. 30. Just keep the defaults here, then click Next >.
31. After having configured access to eiter LDAP or Active Directory, the next screen provides the
option to enable HTTP tunneling to access your Sametime server.
Keep the default, then click Next > here, because we won't make use of HTTP tunneling in our
scenario.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 23
24. 32. Read the summary to validate your specified settings, then click Install.
33. The installation starts. It could take a couple of minutes to finish.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 24
25. 34. After the installation has been finished, you should see a Lotus Domino Server icon on your
desktop. Clicking on it will automatically start the newly created Sametime Community Server.
35. After server startup, navigate to the Windows services management. It might take a couple of
minutes, but then all Sametime (ST<xxx>) services should be started.
Known issue with Active Directory:
If your Sametime Community Server is connected to an Active Directory, some users might notice
the effect that online awareness does not work for them or, that a user's name appears multiple times
in the same contact list. This issue could be fixed by modifying the LDAP configuration settings
document that is created during installation.
The steps to fix the issue are described here:
http://www-01.ibm.com/support/docview.wss?rs=203&uid=swg21161658
From Zero to Hero: ShoreTel Communicator for IBM Sametime 25
26. Configuring IBM Sametime Community Server
Before we proceed with installation of the ShoreTel Communicator for IBM Sametime, we need
to modify a couple of parameters that impact both the server connectivity and the set of features that
is available to the clients.
Administration of IBM Sametime requires only a browser. There are two different scenarios for
managing and configuring the Sametime platform:
• Using the Sametime System Console: This is a recommended approach for an environment
with more than instant messaging and awareness. In this scenario, a centralized administration
is provided by the Integrated Solutions Console, a dedicated application running on IBM's
WebSphere Application Server. It provides a central point for managing and monitoring all
Sametime services as well as for providing the desired functionality to your users and groups.
• Using the stand-alone management and administration capabilities of Sametime Community
Server: Our server could be managed via an administrative web front-end, enabling the
administrator to modify all the settings that impact the services provided by the Community
Server. We'll follow this scenario which requires you to install a Java Run-time Environment
before you proceed with the next steps.
Before we could deploy the ShoreTel Communicator for IBM Sametime feature to our Sametime
users, we need to enable them to install additional plug-ins on their clients. By default, this option is
disabled by policy. To enable it, run the following steps:
1. Navigate your browser to your Sametime server, e.g. http://stshoretel.pscbln.de.ibm.com.
2. You should see the following screen:
From Zero to Hero: ShoreTel Communicator for IBM Sametime 26
27. 3. Log in with your Domino Administrator account which you had specified during installation of
the Domino server.
4. When logged in, scroll down until you see an Administer the server link on the right-hand
side.
5. Click on that link. The Administration screen should come up, allowing you to configure the
server.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 27
28. 6. From the outline, navigate to Policies, and open the Sametime Default Policy.
7. Scroll down to the Instant Messaging section, and enable the Allow plug-ins installation
option.
Optional: If you plan to provide the full IBM Sametime feature set (including ShoreTel
integration) embedded in IBM Lotus Notes to your users, enable the Allow all Sametime
Connect features to be used with integrated clients option.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 28
29. 8. Click OK on the page bottom to save your changes.
ShoreTel Communicator for IBM Sametime, which we will install later, requires connectivity
between its server base platform, the ShoreTel HQ server, and the IBM Sametime Community
Server. Therefore, we will have to add the ShoreTel machine to the list of IP addresses trusted by
Sametime.
To accomplish that, follow the steps below:
1. Shutdown your Sametime Community Server – the console command for that is quit.
2. If the server is down, navigate to the data directory of your Domino server, by default this is
C:IBMLotusDomino.
3. Find the sametime.ini file and add the following line there, establishing a trusted connection
between your ShoreWare HQ server and the Sametime machine:
VPS_TRUSTED_IPS=<Your_ShoreTel_Server_IP>
4. Save and close the sametime.ini file.
5. Start the Sametime server.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 29
30. Installing IBM Sametime Connect
The following steps describe an IBM Sametime Connect client setup on Windows. Installation on
Mac and Linux is also supported.
1. Extract the installation package to a temporary location. Navigate to the extracted folder and
find the SametimeStandardClientsametimeclient.standalone subdirectory within.
2. From the Windows directory, start the sametime-connect.exe.
3. Select the first option to start the setup immediately after extraction of the required file set, then
click Next >.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 30
31. 4. After a couple of minutes, the setup dialog comes up. Select your language of choice, then click
OK.
5. When a system check has been completed, you should see the following screen. Click Next >
there to continue.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 31
32. 6. Accept the license agreement, then click Next >.
7. Accept the installation location by clicking Next >.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 32
33. 8. Click Install to start the installation.
9. After a couple of minutes, you should see the following screen:
10. Click Finish to start the newly installed client.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 33
34. 11. Log in with an existing user id from your LDAP or Active Directory.
12. If Sametime connectivity to your directory has been configured properly, you should see the
following screen now:
From Zero to Hero: ShoreTel Communicator for IBM Sametime 34
35. IBM Sametime – more than instant messaging and presence
Beyond awareness and chat, IBM Sametime provides a set of client and server components that
enables users to collaborate over an intranet or the Internet. This includes features and activities
such as screen sharing and real-time audio / video capabilities to work together. Integration is key to
a Social Communications vision where members of the community can chat through instant
messaging sessions or start meetings that include chat, screen-sharing, polls, the ability to send web
pages to other users, and audio / video capabilities. Sametime also includes location awareness of
the user, and an extensible resource area at the bottom of the left pane that can be customized to
reflect different locations.
Outside instant messaging providers such as AOL's AIM, Microsoft Office Communications Server,
and Google Talk communities could be integrated through IBM's Sametime Gateway, enabling
users to share presence information and to participate.
There are three primary Sametime client applications available: the Sametime Connect client, the
embedded Sametime Connect client as part of IBM Lotus Notes, and the Sametime Meeting Room
client. There is also a comprehensive set of mobile apps available for different plattforms and
devices.
The following picture displays the general architecture of a Sametime solution:
IBM Sametime: General architecture
From Zero to Hero: ShoreTel Communicator for IBM Sametime 35
36. Note: Most of the features and components shown here (except IBM Connections, Sametime
Unified Telephony / SUT, Email, and the Sametime Gateway) are covered by the Sametime
Standard license, therefore a customer that plans to deploy the ShoreTel Communicator for IBM
Sametime solution is entitled to deploy and use features such as Web Meetings and access from
mobile devices without additional charge.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 36
37. Installing and configuring ShoreTel telephony
The ShoreTel server software is shipped on a DVD or can be downloaded directly from the
ShoreTel web site.
Installing a ShoreTel HQ or DVS server is not described within this manual because it is embedded
into a setup process for the whole telephony infrastructure, including voice switches, IP phones and
network.
Planning and implementation of a ShoreTel system is described by the ShoreTel Planning and
Installation Guide that is available at
http://support.shoretel.com
Within the setup process, you create your set of ShoreTel users and assign them the appropriate
phones and extensions. These data will be replicated to the Sametime Integration Services later and
linked to the Sametime user data set.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 37
38. Installing and configuring ShoreTel Communicator for IBM Sametime
ShoreTel Communicator for IBM Sametime is implemented as a set of server and client
components. On server side, the Sametime Integration Services hook into the ShoreTel HQ server
capabilities. On client side, a set of plug-in modules delivered via ShoreTel server extends the
modular platforms of IBM Sametime Connect and IBM Lotus Notes.
Installing and configuring CSTA and Sametime Integration Services
The installer package is delivered as a single MSI package for both 32 and 64 bit Windows
operating systems. It will install the CSTA Services as well as the Sametime Integration Services
and will also create an Eclipse Update Site containing the Sametime client plug-ins.
The installer package could be installed on either the ShoreWare HQ or on a ShoreWare DVS
server. During the setup process, it automatically detects the server configuration and will provide
the appropriate steps to install the required set of components.
The installer package will set up the following Windows services:
• ShoreTel CSIS Connector
• ShoreTel CSTA Connector
• ShoreTel CSTA Gateway
• ShoreTel CSTA TSP 32 (on 32 bit systems), ShoreTel CSTA TSP 64 (on 64 bit systems)
• ShoreTel IBM Sametime Integration
These services will be automatically started during installation.
Note: The following steps describe the installation process on the ShoreWare HQ server.
1. Start the installation, e.g., by clicking on the install package link from your desktop.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 38
39. 2. Accept the license agreement, then click Install.
3. The installation wizard now asks for your Domino and Sametime server. If you have an
existing Domino server for calendaring & scheduling, ShoreTel Communicator for IBM
Sametime integrates with your Domino calendar. This means that, call handling occurs based
on your calendar information.
Notes: ShoreTel Communicator for IBM Sametime uses IIOP calls for accessing your calendar,
therefore, this feature required enablement of the DIIOP server task on Domino side.
If you don't have Domino calendaring & scheduling in place or don't want to integrate with,
leave the Domino server field empty.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 39
40. Note: You could either user the server's IP address(es) or host names.
Click Next then.
4. Enter either your LDAP's or Active Directory's server name or IP address here. Specify the
distinguished name of your bind user (if required) and the search base for your environment.
Click Next.
5. Enter the user field name – for Domino LDAP this would be cn. In case of an Active Directory,
use distinguishedName here.
Also, enter the field names used in your directory for phone number and mobile number, then
click Next.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 40
41. 6. The installation starts. This could take a minute or two.
7. You should see the following screen, indicating that installation has been finished.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 41
42. To validate, if ShoreTel Communicator for IBM Sametime could access the ShoreTel data set, do
the following:
1. Navigate to C: Program FilesShoreline CommunicationsShoreWare ServerIBMlicense.
2. Find and open the license-info.xml file. It should contain all the ShoreTel users you have
previously created.
Finally, the installer package will provide a Sametime client plugin update site at the following
URL (“hq_server” stands for your HQ server):
http://hq_server:8080/IBM/client/updatesite/site.xml
as well as at this file system path:
C:Program FilesShoreline Communications
ShoreWare ServerIBMclientupdatesite
Please note that the URL will not be available before a couple of minutes after the ShoreTel IBM
Sametime Integration service has started.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 42
43. Installing and configuring client components
ShoreTel Communicator for IBM Sametime provides a set of client components that interate with
either IBM Sametime Connect or IBM Lotus Notes. Both clients base on the modular and
extensible Eclipse platform. To add additional components, an Eclipse-based client could be
connected to an Update Site to download and install plug-in modules. The Sametime Integration
Services hosted on the ShoreTel HQ server provide an Update Site that could be accessed via HTTP
from the clients.
IBM Sametime Connect client: Installing ShoreTel Communicator for IBM Sametime
The following steps describe an installation of the appropriate set of plug-inst into a Sametime
Connect Client.
1. Open your Sametime Connect client.
2. From the Tools menu, navigate to Plug-ins > Install Plug-ins...
Note: If this option is greyed out, check the Sametime policy configuration steps described in
the previous chapter.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 43
44. 3. Select the second option because we would like to install a new feature set. Click Next >.
4. Click Add Remote Location and point the wizard to the following URL:
http://<Your_ShoreTel_Server>:8080/IBM/client/updatesite/site.xml
From Zero to Hero: ShoreTel Communicator for IBM Sametime 44
45. 5. Click OK.
6. Click Finish to proceed.
7. Make sure that all features have been selected for installation, then click Next >.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 45
46. 8. Accept the terms of the license agreement, then click Next >.
9. Click Finish.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 46
47. 10. You may receive a certificate warning – Please trust the signer by selecting the third option,
then click OK.
11. If the installation has been finished, a dialog comes up, requesting you to restart your Sametime
Connect client.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 47
48. 12. After restart, your Sametime Connect client should now contain the ShoreTel Communicator
components such as VoiceMail and telephony presence.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 48
49. IBM Lotus Notes client: Installing ShoreTel Communicator for IBM Sametime
Because of the variety of deployment scenarios for the Notes client, our scenario will start with an
already existing Lotus Notes installation. To find out how to deploy the ShoreTel Communicator
for Sametime client plug-in as part of the initial Notes client installation, refer to:
http://publib.boulder.ibm.com/infocenter/domhelp/v8r0/topic/com.ibm.help.domino.admin85.
doc/H_ENABLING_AND_USING_THIRD_PARTY_FEATURE_INSTALL_AND_UPDATE_
1925_OVER.html
Preparation: There are two ways to deploy the required set of plug-ins into your Lotus Notes
client. If user-initiated provisioning of plug-ins has not been disabled for your Lotus Notes client,
you can start the installation from the File menu, by clicking the Application > Install option.
The plug-in installation process is very similar to provisioning for a Sametime client, so please
follow the steps described in Installing ShoreTel Communicator for IBM Sametime: IBM
Sametime Connect client.
If you plan to deploy the ShoreTel Communicator for Sametime client plug-in for multiple clients
or prevent your Notes users from running the manual setup described above, it is best practice to
provide a centralized entry point for installation. A Widget Catalog is similar to an App Store and
enables the end user to deploy additional components to the Lotus Notes client via drag and drop.
From an administrator's perspective, the catalog also facilitates the management of complexity if
different extensions and extension sets should be provided to different users and groups.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 49
50. 1. From your Domino Administrator's Lotus Notes client, create a Widget Catalog on your
Domino server by selecting File > Application > New.
2. Name the new server application Widget Catalog with file name widgets.nsf, based on the
(advanced) template Widget Catalog (8.5) from your Domino server.
3. Click OK.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 50
51. 4. From the newly created application, navigate to File > Application > Access Control.
5. Assign the WidgetAuthor role to those users that should be able to add Widgets to the catalog.
6. Click OK.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 51
52. 7. Close the catalog.
8. Navigate to your Notes client's Preferences page.
9. Navigate to the Widgets section and enable the Show Widget Toolbar and the My Widgets
Sidebar panel option.
10. Add your Domino server that hosts the catalog. Enter the name of the catalog, then click Apply.
This creates a local replica of the catalog on your machine.
11. Save and close the Preferences page by clicking OK.
12. Expand your new Widgets sidebar component.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 52
53. 13. From the drop-down menu of this component, select Configure a Widget from... > Features
and Plugins on an Update Site.
14. Point the wizard to your ShoreWare HQ server's update site for the plug-ins, then click Load:
15. Select both components. Click Next >.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 53
54. 16. Enter a title for this Widget, then click Next >.
17. Click Next > again.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 54
55. 18. Click Next.
19. Click Finish.
20. You may receive a certificate warning – Please trust the signer by selecting the third option,
then click OK.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 55
56. 21. If update has been finished successfully, you should see the following dialog. Click Yes to
restart Notes.
22. If Notes comes up again, you should have all the ShoreTel Communicator for IBM
Sametime features available from the sidebar.
IBM Lotus Notes client: Provisioning ShoreTel Communicator for IBM Sametime
If you have the client components running within your administrator's Notes application, you can
now publish the newly created Widget to the Widget Catalog. This enables other users that are
allowed to access and install from that catalog to setup the ShoreTel Communicator for IBM
Sametime with just a simple drag & drop action.
Note: You need to finish the installation steps described in IBM Lotus Notes client: Installing
ShoreTel Communicator for IBM Sametime before you proceed.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 56
57. 1. From your administrator's client, navigate to the My Widgets sidebar component. Right-click
on the ShoreTel Communicator for IBM Sametime Widget and select Publish to Catalog.
2. The form that opens now could be used to provide your users with some details about the plug-
ins, e.g., functional description, screen shots, ...
3. Click Save & Close to save the Widget.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 57
58. 4. To install the Widget on a different Notes client, start Notes on that machine.
5. Configure the Widget Catalog as described in Step 8-11 from the Installing ShoreTel
Communicator for IBM Sametime: IBM Lotus Notes client (Single-user deployment)
section.
6. Navigate to the My Widgets sidebar and click on the Browse the Widget Catalog icon.
7. You should see the new widget that we have created before.
8. From the Widget Catalog, drag and drop the Widget to the My Widgets sidebar. This initiates
the deployment process.
9. Restart your Notes client. If Notes comes up again, you should have all the ShoreTel
Communicator for IBM Sametime features available from the sidebar.
From Zero to Hero: ShoreTel Communicator for IBM Sametime 58