IP Telephony
IP Telephony
Jose Faisca
Mike Gordon
Kim Greene
Rob Haviland
Debbie Landon
Markus Neuhold
Jairo Reyes
ibm.com/redbooks
International Technical Support Organization
April 2008
SG24-7412-00
Note: Before using this information and the product it supports, read the information in “Notices” on
page vii.
This edition applies to 3Com System i IP Telephony Release 7.2.5c and 3Com System i IP Conferencing
Release 7.2.49 running on i5/OS Version 5 Release 3 or Version 5 Release 4.
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
The team that wrote this book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Become a published author . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Comments welcome. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Contents v
vi IBM System i IP Telephony and Integrated Collaboration
Notices
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in other countries. Consult
your local IBM representative for information on the products and services currently available in your area.
Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product, program, or service that does
not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to
evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this document. The
furnishing of this document does not give you any license to these patents. You can send license inquiries, in
writing, to:
IBM Director of Licensing, IBM Corporation, North Castle Drive, Armonk, NY 10504-1785 U.S.A.
The following paragraph does not apply to the United Kingdom or any other country where such
provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION
PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of
express or implied warranties in certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are periodically made
to the information herein; these changes will be incorporated in new editions of the publication. IBM may make
improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time
without notice.
Any references in this information to non-IBM Web sites are provided for convenience only and do not in any
manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the
materials for this IBM product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it believes appropriate without
incurring any obligation to you.
Information concerning non-IBM products was obtained from the suppliers of those products, their published
announcements or other publicly available sources. IBM has not tested those products and cannot confirm the
accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the
capabilities of non-IBM products should be addressed to the suppliers of those products.
This information contains examples of data and reports used in daily business operations. To illustrate them
as completely as possible, the examples include the names of individuals, companies, brands, and products.
All of these names are fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which illustrate programming
techniques on various operating platforms. You may copy, modify, and distribute these sample programs in
any form without payment to IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating platform for which the sample
programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore,
cannot guarantee or imply reliability, serviceability, or function of these programs.
mySAP, and SAP logos are trademarks or registered trademarks of SAP AG in Germany and in several other
countries.
Oracle, JD Edwards, PeopleSoft, Siebel, and TopLink are registered trademarks of Oracle Corporation and/or
its affiliates.
Java, JDBC, JRE, and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United
States, other countries, or both.
Excel, Microsoft, Windows Media, Windows, and the Windows logo are trademarks of Microsoft Corporation in
the United States, other countries, or both.
Linux is a trademark of Linus Torvalds in the United States, other countries, or both.
Other company, product, or service names may be trademarks or service marks of others.
Companies that use IBM® Lotus® Sametime® and Lotus Domino® already have a
comprehensive solution for presence awareness, e-mail, instant messaging, and Web
conferencing. Now, with the 3Com System i™ IP Telephony and Integrated Collaboration
solution, Sametime users can make phone calls by using their IP desk phone and simply
clicking a contact within their Sametime contact list. Alternatively, they can receive voice mail,
faxes, and e-mail in a single unified inbox as part of the 3Com IP Telephony Messaging for
System i application integrated with Domino.
Voice messages are received as attachments that can be opened and played on a computer
by using standard multimedia applications. Faxes are displayed as a graphics attachment.
Systems integrators, independent software vendors (ISVs), and application developers can
integrate telephony into their business and collaboration applications by using the application
programming interfaces (APIs) that are available with the 3Com IP Telephony Integration
Software Development Kit (SDK) or SDK Toolkit for System i.
This IBM Redbooks® publication is intended for system administrators and field technicians
to help you understand and integrate telephony into your collaborative environment.
Specifically it shows how to configure the Domino server to directly receive voice mail and
faxes into the Domino inbox. This book includes information about enabling telephony into
your Sametime Connect clients. In addition, it explains how to synchronize your Domino
Directory with the IP Telephony VCX directory.
Jon Rush
ISV Business Strategy and Enablement, Technical Enablement Specialist
Fant Steele
IBM Sales & Distribution, Advanced Technology Support (ATS) - Americas
Helen Olson-Williams
IBM Performance Analyst System i Benchmark Center
Thomas Gray
Joanna Pohl-Misczyk
Craig Schmitz
Jenifer Servais
ITSO, Rochester Center
Your efforts will help increase product acceptance and customer satisfaction. As a bonus, you
will develop a network of contacts in IBM development labs, and increase your productivity
and marketability.
Find out more about the residency program, browse the residency index, and apply online at:
ibm.com/redbooks/residencies.html
Preface xi
Comments welcome
Your comments are important to us!
We want our books to be as helpful as possible. Send us your comments about this book or
other IBM Redbooks publications in one of the following ways:
Use the online Contact us review Redbooks form found at:
ibm.com/redbooks
Send your comments in an e-mail to:
[email protected]
Mail your comments to:
IBM Corporation, International Technical Support Organization
Dept. HYTD Mail Station P099
2455 South Road
Poughkeepsie, NY 12601-5400
More information: For detailed information about how to configure your System i machine
to support IP Telephony, refer to IBM System i IP Telephony Configuring the System i
Infrastructure, SG24-7382.
More information: For details about configuring partitions on a System i machine for IP
Telephony, refer to IBM System i IP Telephony Configuring the System i Infrastructure,
SG24-7382.
For details about sizing your System i machine, refer to 2.9, “Capacity planning,” in IBM
System i IP Telephony Configuring the System i Infrastructure, SG24-7382, which provides
information about using the following tools:
Workload Estimator
VoIP Designer tool
System Planning Guide
Important: These tools do not replace the advice of an IBM representative or Business
Partner who is experienced with IP telephony requirements. Make sure to obtain expert
assistance before you select a final System i configuration.
To run IBM System i IP Telephony and Integrated Collaboration, you must have the following
additional hardware requirements at a minimum:
Processor unit: 670 commercial processing workloads (CPWs)
Memory: 1.5 GB
Disk storage: 25 GB
Network interface: One virtual Ethernet adapter for virtual I/O or dedicated for direct I/O
System i Sizing Crib Sheet: At the time of writing this book, these requirements were the
minimum additional requirements to run one System i IP Telephony and Messaging
partition including Lotus Domino and Sametime integration. For the most current values,
see the System i Sizing Crib Sheet on the 3Com IP Telephony for IBM System i
documentation Web page:
http://csoweb4.3com.com/iseries/vcx_doc.cfm
Table 1-1 Sizing guidelines for IP Telephony and Integrated Collaboration scenarios (part 1)
Server resources Incremental resources for i5/OS System i IP Telephony and System i IP
per hosted LPAR Messaging Conferencing
Scenario 1: 38 voice or fax messages going to the Domino server per hour, less than 2000 click-to calls per hour,
100 Sametime presence users with less than 50 buddies in a buddy list
Scenario 2: 75 voice or fax messages going to the Domino server per hour, 2001 - 5000 click-to calls per hour,
500 Sametime presence users with less than 50 buddies in a buddy list
Processor unit 15 CPW 100 CPW 750 CPW 100 / 610 CPW
Scenario 3: 600 voice or fax messages going to the Domino server per hour, 5001 - 10,000 click-to calls per hour,
2500 Sametime presence users with less than 50 buddies in a buddy list
Processor unit 120 CPW 300 CPW 1100 CPW 200 / 2610 CPW
For example, let us review the second scenario in Table 1-1 and Table 1-2. In this scenario,
we assume that you plan to use 100 phone users (using either hard or soft phones), 50
people parallel in one or more conferences, and 75 voice or fax messages forwarded to the
Domino server per hour in a business day. In addition to this, you plan to have between 2001
and 5000 click-to calls from Sametime per hour and about 500 Sametime presence users
with less than 50 buddies in their buddy list.
To set up this environment, you must first have a Domino server configured and running on
your System i machine. Then you activate the Lightweight Directory Access Protocol (LDAP)
service in your Domino server and install the Domino IP Telephony integration code. Next you
install and set up the System i IP Telephony and Messaging partition, including the LDAP
synchronization and the System i IP Conferencing partition for extended conferencing
services.
In this example, 44 GB of disk storage is required. The i5/OS partition requires all the
additional space. The most common way to set up an System i IP Telephony environment is
to use hosted Linux partitions that receive their storage from the hosting i5/OS partition. The
two partitions require 32 GB of disk storage. We assume that the Domino server runs on the
same i5/OS partition and requires an additional 12 GB of storage.
IBM i5/OS V5R3M0 or System i partition operating system i5/OS and related software Install,
later, including: level, including PASE, which is Option upgrade, or delete i5/OS and related
Option 33 for Portable 33 of 5722-SS1 software, SC41-5120
Application Solution
Environment (PASE)
Latest Cumulative
PTF Package
3Com System i IP System i IP Telephony and Messaging 3Com VCX IP Telephony and Messaging
Telephony Release code running in a Linux partition or DVD
7.2.5c or later partitions IBM System i IP Telephony Configuring the
System i Infrastructure, SG24-7382
3Com IP Telephony for IBM System i:
http://csoweb4.3com.com/iseries/
vcx_doc.cfm
3Com System i IP System i IP Conferencing code running 3Com VCX IP Conferencing DVD
Conferencing Release in a Linux partition IBM System i IP Telephony Configuring the
7.2.49 or later (optional) System i Infrastructure, SG24-7382
Whether you must run a separate 3Com IP Telephony for IBM System i:
conferencing partition depends on the http://csoweb4.3com.com/iseries/
required conferencing ports. If you do vcx_doc.cfm
not need more than five times six people Section 3.1, “IP Telephony collaboration
in a conference, you do not need a functions in Sametime” on page 56
separate IP Conferencing server. The IP
Messaging product includes 30 ports for
adhoc conferencing.
Either of the following Domino server code running on i5/OS is IBM Lotus Domino 6 for iSeries
Domino versions: required to use the LDAP Implementation, SG24-6592
For Domino synchronization or to integrate with the Implementing IBM Lotus Domino 7 for
integration or LDAP Domino server. i5/OS, SG24-7311
synchronization,
Domino 6.5.6 or later If you want to integrate IP Telephony
on System i with Sametime, a higher level of Domino
For Sametime code is required, which provides the
integration, Domino features needed to implement the
7.0.2 or later on integration.
System i
For Sametime integration, Sametime server code running on i5/OS Installing and Managing Sametime 7.5.1
Sametime 7.5.1 Server for i5/OS, SC23-5978, on the Web at:
on System i http://www-128.ibm.com/developerworks/
lotus/documentation/sametime/
Click the 7.5.x tab and scroll down.
IBM Integrated Domino Integrated Fax server to run fax on i5/OS IBM Integrated Domino Fax for i5/OS:
Fax for i5/OS V4R4 or http://www.ibm.com/iseries/domino/
later (optional) With this software, you can send related/fxd/
outbound faxes directly from your Notes Chapter 4, “Domino integration” on
clients. With the Print-to-Fax driver, page 111
Notes users can send faxes directly
from a Microsoft Windows® application,
such as Microsoft Word or Excel®.
In this book, we describe how to install and set up both Domino and Sametime integration.
Table 1-4 provides a quick reference on where to find the installation code for IBM System i IP
Telephony and Integrated Collaboration. Refer to the referenced sections in Table 1-4 for
detailed installation and setup steps.
IPTelephonySPI-version.tar Sametime integration code to be 3Com VCX IP Telephony and Messaging DVD
version 7.2.74.1 or later executed in the i5/OS PASE
environment using Qshell Refer to 3.2, “Installing and setting up IP Telephony
integration with Sametime” on page 58.
IPTelephonyPlugin.jar 3Com IP Telephony Line Status This file is on your VCX server after installing IP
Feature code Telephony SPI in http://IPTelserver/linestatus.
Alternatively to run the installation from a different
This Sametime connect client server, you can find the IPTelephonyPlugin.jar file in
plug-in shows the System i IP /opt/3com/VCX/ipwservice/vcx-html/linestatus.
Telephony line status. With this
plug-in, you can work with Refer to 3.2, “Installing and setting up IP Telephony
telephony preferences under integration with Sametime” on page 58.
File → Preferences.
ipmmail_i5.tar Domino integration code to be 3Com VCX IP Telephony and Messaging DVD
executed in the i5/OS PASE
environment by using Qshell Refer to “Installing the integration package in the
i5/OS partition” on page 115.
Check the System i IP Telephony and Messaging Required Table 1-3 on page 5
server version.
Check the System i IP Conferencing server version Optional Table 1-3 on page 5
if installed.
Enable LDAP services on the Domino Required 2.2, “Enabling LDAP services for
server. the Domino server” on page 28
Modify the Domino LDAP configuration Required 2.2.2, “Modifying the Domino
to add the telephoneNumber Attribute LDAP configuration” on page 33
Type to the LDAP schema.
Enable full text indexing of the Domino Optional 2.2.3, “Full text indexing of the
Directory to provide adequate LDAP Domino Directory” on page 35
services performance.
Update the fire wall on the primary Optional 4.2.1, “Planning” on page 113
and secondary System i IP
Messaging partition.
Prepare the DVD that contains the Required Table 1-4 on page 6.
ipmmail_i5.tar file.
Copy and extract the ipmmail_i5.tar Required “Installing the integration package in
file that contains the installation the i5/OS partition” on page 115
script for IPMADDIN to i5/OS.
Enable Simple Mail Transfer Protocol Required 4.3.2, “Enabling Domino for SMTP
(SMTP) and Internet Message and IMAP” on page 130
Access Protocol (IMAP) services on
the Domino server.
On the Domino server, specify the Required 4.3.3, “Configuring the Domino
Internet password and Internet environment” on page 132
address (e-mail address) on each
Person document. This is required
for users to receive e-mail from the
System i IP Messaging server.
In the System i IP Messaging Voice Required 4.3.4, “Adding Domino and SMTP to
mail Administration GUI, add the the System i IP Telephony
Domino server to the system configuration” on page 134
configuration.
Configure the SMTP Server Required 4.3.4, “Adding Domino and SMTP to
parameters in the System the System i IP Telephony
configuration of the Voice mail configuration” on page 134
Administrative GUI.
For most environments in which you might want to use virtual IP, you will want to provide
multiple paths between the local gateway and the System i machine. For example, you might
want load balancing and fault tolerance. In this context, each path implies an additional
interface and an additional, nonvirtual IP address on the system. These multiple interfaces
should be visible only on the local network. You do not want the remote clients to be aware of
the multiple IP addresses for the system. They detect and connect to your system with a
single IP address. By using virtual IP, the routing of the inbound packets through the gateway,
over the local network, and to the system is invisible to a remote client. Because remote
clients detect only the virtual IP address, you can stop communication to a bounded
application by taking down this interface. Therefore, you do not have to stop the nonvirtual
address or the physical Ethernet line.
Figure 1-1 shows an example of how to apply fault tolerance for one Domino server called
DEMODOM, which is installed on a system called RCHAS10. DEMODOM uses a virtual IP
interface of 9.5.92.26 that is bound to two nonvirtual IP interfaces, 9.5.92.16 and 9.5.92.18.
Refer to 1.4.2, “Setting up fault tolerance by using a virtual IP interface” on page 11, for the
steps to configure this example.
RCHAS10
R1
Domino server: 9.5.92.16
DEMODOM IP addresses: 9.5.92.x
9.5.92.18 Internet
Subnet mask: 255.255.255.0
*Virtual IP:
IP address: 9.5.92.26
Subnet mask: 255.255.255.255 R2
Proxy ARP: enabled
DNS Entry for DEMODOM:
9.5.92.26
The virtual IP address of 9.5.92.26 acts as the server for remote clients that appear as a
single host. The virtual IP address must be on a different subnet than the physical interfaces.
Therefore, the subnet mask for the virtual IP interface is usually set to 255.255.255.255.
Alternative: You can also use the following i5/OS Add TCP/IP Interface (ADDTCPIFC)
CL command to create a new virtual IP interface:
a. In iSeries Navigator, start the New IPv4 Interface wizard. Expand Network → TCP/IP
Configuration → IPv4. Select Interfaces, right-click, and select New Interface →
Virtual IP (Figure 1-2).
b. On the virtual IP interface Properties window (Figure 1-8), click the Advanced tab.
Starting the virtual IP interface from a 5250: Although you are unable to change the
Proxy ARP settings from a 5250 emulation session, you can start the virtual IP interface
from there. Use the following command to start the virtual IP interface:
STRTCPIFC ALIASNAME(DEMODOM)
Figure 1-11 shows our new active virtual IP interface, 9.5.92.26, with the subnet mask of
255.255.255.255. The current associated local IP interface is 9.5.92.16, and the proxy ARP is
enabled.
Sametime Connect
Notes client Domino Web Access Sametime
Client plug-in Web client
Sametime protocol
NRPC HTTP over TCP/IP HTTP
IPMADDIN TCSPI
SIP
The Domino address book is the master directory that sends the changes to the Domino
LDAP directory and forwards them to the System i IP Telephony user directory. The person
document in the Domino server address book must have their phone number assigned to the
office phone field in order to be synchronized. To exclude users from being synchronized, you
must add a pre-configured string into the comments field of those users.
You can set up LDAP synchronization at the initial System i IP Telephony configuration or any
time after that. See Chapter 2, “LDAP synchronization” on page 25, for details.
The System i IP Telephony internal adhoc conferencing function can accommodate five
conferences up to six people. If you need more simultaneous conferences or more people in
the same conference, you must install a System i IP Conferencing server. In addition to the
functions that are enabled by the TCSPI, you can install a Sametime Connect client plug-in to
display the status of phone users. You can see if a user has a phone assigned and if the
phone is in use. Details are provided in Chapter 3, “Sametime integration” on page 55.
For details about the server configuration of the primary and secondary IBM System i IP
Telephony servers that we used to test IBM System i IP Telephony and Integrated
Collaboration, see Appendix B, “System i IP Telephony and Messaging server settings” on
page 191.
We cover all three integration models. Therefore, we installed and configured a Domino
server with the LDAP server enabled and a Sametime server.
Because Session Initiation Protocol (SIP) devices are needed for testing, we installed seven
3Com phones and one analog gateway. One fax device was attached to the gateway to
simulate incoming faxes. On the clients, we ran Lotus Notes and Sametime Connect clients.
Domino on i5/OS
DEMODOM
9.5.92.26
Sametime on i5/OS
DEMOST
IP Telephony IP Telephony IP
9.5.92.50
IP Messaging IP Messaging Conferencing
i5/OS
Par ID 2 Par ID 3 Par ID 4
Par ID 1
RCHAS10 DEMOPRI DEMOSEC DEMOCONF
9.5.92.66 9.5.92.67 9.5.92.68
3Com phones 9.5.92.16
analog gateway
9.5.92. 200 - 9.5.92.207 9.5.92.18
VRTETH01
(CMN21)
Subnet Mask
255.255.255.0
Virtual LAN 1
The hosted Linux partitions that hold the System i IP Telephony, Messaging, and
Conferencing code use virtual Ethernet ports as described in IBM System i IP Telephony
Configuring the System i Infrastructure, SG24-7382. Since we have only a few SIP devices
configured, we decided to assign fixed IP addresses to them. However, the phones can obtain
their IP address from a DHCP server.
Since we enabled LDAP synchronization in our test environment, the users and phone
numbers are populated from the Domino Directory to the System i IP Telephony server
directory. The LDAP sync column in Table 1-10 indicates whether the user is populated to the
System i IP Telephony server directory. See Chapter 2, “LDAP synchronization” on page 25,
for details about why some users are not synchronized. By having this configuration, the
users and the phone numbers are common within the three applications.
Table 1-10 Domino users and phone numbers in our test environment
Domino user name Phone Internet (e-mail) address LDAP sync
number
No PhoneNumber - [email protected] No
Note: These settings are done within the Web-based system management of the primary
System i IP Telephony server. Check the corresponding documentation on 3Com IP
Telephony for IBM System i documentation Web site for details:
http://csoweb4.3com.com/iseries/vcx_doc.cfm
With bulk loading of the VCX directory, users in the Domino LDAP directory can quickly be
imported into the VCX user database. When this bulk import happens, users and associated
voice mailboxes for the users are automatically created in the VCX directory.
After the initial bulk loading of the VCX directory, changes that are made to users in the
Domino LDAP directory are reflected in the VCX directory. New users who are registered in
Domino automatically have a user account and voice mailbox created for them in the VCX
directory. The account and mailbox are created as long as the new user has a phone number
specified in their Domino Person document and they are not specified as a non-VCX user.
In addition, any changes to users on the Domino Directory (names.nsf) side, such as name
changes, are synchronized in the VCX directory. These LDAPSync add, modify, and delete
requests are sent to the VCX data server through a Java™ Database Connectivity (JDBC™)
interface. After the updates are performed in the VCX database, the VCX database triggers
notify the LDAPSync application that the updates have been performed. This way the
LDAPSync knows that it has completed synchronization to the VCX database.
Domino VCX DB
LDAP
Important: Changes in the VCX directory are not synchronized back to the Domino LDAP
directory.
The default synchronization time interval is every 1800 seconds (30 minutes). The minimum
synchronization time allowed is 60 seconds. We recommend that you leave the default
synchronization interval of 1800 seconds.
Table 2-1 Domino LDAP attributes that get synchronized to the VCX directory
Domino LDAP attribute VCX directory attribute
The phone number field is pulled from the office phone attribute in the Domino Directory,
which is located on the Work tab of the Person document as shown in Figure 2-2. This
attribute is not enabled by default in the Domino LDAP directory. We show how to enable this
LDAP attribute in 2.2.2, “Modifying the Domino LDAP configuration” on page 33.
The non-VCX user identifier is used in the Domino Directory in the Comments field of a
Person document. When this field is set to the non-VCX user identifier, the user is not added
to the VCX directory. If a user has already been added to the VCX directory, the user is
removed from the VCX directory when the non-VCX user identifier is specified in their Person
document.
See 2.5, “Working with the non-VCX user identifier” on page 43, for details about how to use
the non-VCX user identifier.
Logout of end points: The user must be logged out of all end points (hard phones,
soft phones, wi-fi phones, and so on) before they can be removed from the VCX
directory.
Updates to any Domino LDAP attributes listed in Table 2-1 on page 27 cause the
associated field in the VCX directory entry to be updated for that user.
Deletion of the user’s phone number in the Domino LDAP directory causes the user to be
removed from the VCX directory.
Figure 2-3 Enabling the LDAP port for the Domino server
Tip: Press the F4 key to prompt the CHGDOMSVR command to see the parameters
as shown in Figure 2-4 on page 30.
More...
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More keys
Figure 2-4 Change Domino Server (CHGDOMSVR) command to add the LDAP task
d. Start the Domino server by entering the following Start Domino Server (STRDOMSVR)
CL command:
STRDOMSVR DominoServerName
Here DominoServerName represents your Domino server name.
If LDAP task does not start: If the LDAP task does not start after you make these
changes, make sure the line DisableLDAPOnAdmin=1 does not exist in the Domino
server’s notes.ini file. If you see this entry, remove it and restart the Domino server.
To edit the notes.ini file, use the Work with Domino Server (WRKDOMSVR) CL
command and type option 13 (Edit Notes.ini) next to your Domino server.
2.2.1 Running the Domino LDAP and i5/OS LDAP servers on the same system
Both the i5/OS LDAP server and Domino LDAP server must bind to a specific TCP/IP
address if they are to run on the system at the same time. By default, the i5/OS LDAP server
listens on all IP interfaces, which creates a port conflict with the Domino LDAP server. To
avoid this situation, you can choose one of the following options:
“Binding the i5/OS LDAP server to a specific IP interface” on page 31
“Disabling the i5/OS Directory server” on page 32 (if the directory server is not being used)
Figure 2-7 Disabling the i5/OS LDAP server from automatically starting
The Global Configuration document for the Domino LDAP server must include the LDAP
attribute types. To add the attribute types:
1. Open the Domino Administration client.
2. Click the Configuration tab.
3. In the left navigation frame, click Server → Configurations.
LDAP tab: The LDAP tab is not available until you select the Use these settings as the
default settings for all servers option on the Basics tab.
Important: The telephoneNumber LDAP attribute maps to the work phone number
field in the Person document. If this attribute type is not added to the Domino LDAP
directory, LDAPSync will not function properly.
Tip: Our testing has shown that reloading the LDAP schema is not always sufficient. To
be safe, stop and restart the Domino server for the LDAP schema change to take effect.
Tip: Our testing has shown that reloading the LDAP schema is not always sufficient. To
be safe, stop and restart the Domino server to ensure that full text indexing is enabled.
Important: Before you install the System i IP Messaging software, you must have your
Domino LDAP server configured properly. The required Domino server configuration and
Domino LDAP configuration changes are explained in 2.2, “Enabling LDAP services for the
Domino server” on page 28.
In this section, we explain how to set up LDAP synchronization during the initial setup of the
System i IP Telephony and Messaging primary server. If you plan to change the setting later,
then follow the information in 2.4, “Reconfiguring LDAP synchronization” on page 41.
LDAP synchronization setup is done on the primary System i IP Telephony and Messaging
server only.
Make sure you know the following information before you start:
Current password for user cworks on the primary System i IP Telephony server
Host name or TCP/IP address and port number of your Domino LDAP server
User ID and password to connect to the Domino LDAP server
The base distinguished name (DN) for retrieving users from the Domino LDAP server
Landscape design: Discuss the design of your System i IP Telephony system landscape
with a 3Com System i IP Telephony authorized Business Partner before you run the initial
setup.
Perform the following steps to configure LDAP synchronization at the initial setup of your
primary System i IP Telephony and Messaging server. You must run Version 7.2.5.c or later of
this software to see the LDAP synchronization parameter. See 1.2, “Software prerequisites”
Figure 2-11 Opening a terminal window to the primary System i IP Telephony and Messaging partition
2. Log on as root and use the default password of pvadmin as shown in Figure 2-12.
-bash-3.00#
Figure 2-12 Logging on to the System i IP Telephony and Messaging server
-bash-3.00# setup
Warning: Host IP address '192.168.1.100' not found in /etc/hosts.
---------------------------------------------------------------------------
------------- Welcome to the VCX Network Configuration Wizard -------------
---------------------------------------------------------------------------
Tip: If you do not see the Enable LDAP Synchronization parameter, check whether you
are on the secondary System i IP Telephony server. You can also run the
vcx-showversion command on your System i IP Telephony partition to check the
installed version.
------- Configuring additional parameters for Auth & Dir Service --------
At a branch office, the password for access to the regional office system's
'cworks' account is required. At a regional office or on a standalone
system, specify the 'cworks' password for access to *this* system.
VCX Authentication & Directory Services can provide support for System Speed
Dials. This feature must be enabled only for a single Site ID, and if
replication is in use, the setting must be the same on the primary and
secondary servers for that Site ID. Note: this setting cannot be changed
once initial setup is complete, so be certain it is set correctly.
LDAP Synchronization requires the host name or IP address of the LDAP Server
with which to synchronize.
What port number is used by the LDAP service on the LDAP Server? Note that
the default will be correct in most cases.
What is the password for the LDAP server username provided previously?
Input the Base Distinguished Name (DN) for retrieving users from the LDAP
server.
The Non-VCX User Identifier is used to identify users which should not be
automatically added to the VCX IP Telephony system.
Do you wish to change any of the Auth & Dir Service parameters? [N] : N
Figure 2-15 Configuring LDAP synchronization continued
Then enter the following command on your Linux partition by using the root user to
browse the output file:
vi services.txt
The LDAPSync interval specifies how frequently changes from the Domino LDAP directory
are synchronized to the VCX directory. The LDAPSync interval is configured through the
Linux root access to the primary System i IP Telephony and Messaging partition. To set the
LDAPSync interval:
1. Log into the System i IP Telephony and Messaging partition with Linux root access by
using either of the following methods:
– Hardware Management Console
– Virtual terminal emulator of your choice (for example, PuTTY) by connecting with
Telnet to your i5/OS partition TCP/IP address and port 2301
Important: The tool that you use for Linux root access must be enabled to use SSH.
2. Log in by providing the appropriate user name and password. The default user name and
password for the Linux root access are root and pvadmin respectively.
3. Change to the directory where the configLdapSync script resides:
cd /opt/3com/VCX/vcxdata/vcx-bin
Tip: The directory is case sensitive. Therefore, VCX must be typed in uppercase.
Tip: Replace version with the version of the LDAPSync software that is running on the
System i IP Telephony and Messaging server. If you do not know the software version
that is on the server, press the Tab key after you type vcxdata, and the appropriate
version number is automatically retrieved for you.
Important: The tool that you use for Linux root access must be enabled to use SSH.
2. Log in by providing the appropriate user name and password. The default user name and
password for the Linux root access are root and pvadmin respectively.
Note: The directory is case sensitive. Therefore, VCX must be typed in uppercase.
Figure 2-19 Adding the non-VCX user identifier to the Comments field of a Person document
We used a tool called WinSCP, which is a secure FTP client, to access the messages log file
on our System i IP Telephony and Messaging server. A benefit of using a secure FTP client,
such as WinSCP, is the ability to view the log file and to send the file by using FTP to your
desktop to distribute to others as necessary for proper debugging.
2. Navigate to the /var/logs directory and locate the messages file as shown in Figure 2-21.
You can open the log file or send it by using FTP to your local client as necessary.
Figure 2-21 Locating the LDAPSync messages file in the /var/logs directory
Important: The tool that you use for Linux root access must be enabled to use SSH.
2. Log in by providing the appropriate user name and password. The default user name and
password for the Linux root access are root and pvadmin respectively.
Note: The directory is case sensitive. Therefore, VCX must be typed in uppercase.
-bash-3.00# ./configLdapSync
1) Set LDAPEnableStatus
2) Get LDAPEnableStatus
3) Set LDAPServer
4) Get LDAPServer
5) Set LDAPBaseDN
6) Get LDAPBaseDN
7) Set LDAPUsername
8) Get LDAPUsername
9) Set LDAPPassword
a) Get LDAPPassword
b) Set LDAPSyncInterval
c) Get LDAPSyncInterval
d) Set LDAPNonVCXUserID
e) Get LDAPNonVCXUserID
f) Set LDAPPortNumber
g) Get LDAPPortNumber
q) Exit
Important: The tool that you use for Linux root access must be enabled to use SSH.
2. Log in by providing the appropriate user name and password. The default user name and
password for the Linux root access are root and pvadmin respectively.
3. Change to the directory where the configLdapSync script resides:
cd /opt/3com/VCX/vcxdata/vcx-bin
Note: The directory is case sensitive. Therefore, VCX must be typed in uppercase.
Figure 2-26 Changing the user’s phone number in the Person document of the Domino Directory
The Domino LDAP user should be properly synchronized into the VCX directory now that the
phone number conflict has been removed.
To unassign a phone from a user and assign a new phone to the user in the VCX directory:
1. Make sure the user is logged out of the phone that is currently assigned to them.
2. Log into the Central Manager Console for the System i IP Telephony and Messaging
partition. The default user ID and password are admin and besgroup respectively.
Figure 2-27 Selecting the Site Name link in the Central Manager Global Directory
Figure 2-28 Selecting the Phones link under the Phones column for the user
5. Select the user you for whom want to change the phone number and click the Unassign
Selected button as shown in Figure 2-29.
6. In the window that prompts you to confirm the action to unassign the phone for the user,
click OK.
Figure 3-1 illustrates the functions that Lotus Domino and Sametime integration with System i
Telephony Solution provides to the user.
Click-to-dial feature: The click-to-dial feature from the Lotus Notes client is available with
Domino 8, which includes Sametime version 7.5.1.
The integration of Sametime and System i IP Telephony offers the following features:
Telephony presence
Telephony presence allows a Sametime user to know in real time the contact status of a
person they want to reach. Specifically, it indicates whether a person is currently on the
phone. This information is collected by the Sametime Connect client user interface from
the System i IP Telephony solution. A user does not have to be logged into Sametime for
their telephone presence to be available.
Click-to-dial feature
The click-to-dial feature allows Sametime users to call a phone number simply by clicking
it. This feature is pervasive across the Sametime Connect client and is available within a
chat window. It helps Sametime users to avoid the following actions:
– Searching a contact’s phone number, because it is looked up automatically
– Dialing the number from the desktop hard phone
Sametime users can start (dial) the call from the Sametime Connect client and then use
their desktop telephone to talk to and finish the conversation.
Important: For correct operation of these functions with the System i IP Telephony
solution and the integration with Sametime, you are required to use 3Com telephones.
Instant meeting
or
Attend a meeting
Click Click
to to
dial dial Ext:
7777
Click
Clickto
to
IP Telephony Messaging conference
conference Port
Port ==5092
5092
Conference
ConferenceAttendant
Attendant
Click
Clickto
tocall
call Click
Clickto
toconference
conference- -
Adhoc
Adhoc
For more information regarding TCSPI, see IBM Lotus Sametime 8.0 Telephony
Conferencing Service Provider Interface (TCSPI) Implementer Guide, SC23-8704.
3.2.1 Planning
There are several environmental characteristics and resources that you should have
available, as explained in this section, in order to install and configure the IP Telephony
collaboration services. In addition, you must have all of the prerequisites that are discussed in
1.2, “Software prerequisites” on page 5.
Assumptions
In planning for the integration, we assume that you have the following components and
configurations:
You have already installed and configured the following products:
– Domino 7.0 or later in an i5/OS partition
– Sametime 7.5.1 or later in an i5/OS partition
– System i IP Telephony software in its own Linux partition on the System i machine
Required information
You must provide the following information for the TCSPI software installation and
configuration scripts:
IP address for the primary System i IP Telephony logical partition (LPAR)
IP address for the secondary System i IP Telephony LPAR
Conference bridge number
IP address and host name for the Domino LDAP server
IP address and host name for the System i IP Conferencing LPAR
Password for the Domino Administrator user in the Sametime server
Network configuration
If the Domino server and any System i IP Messaging LPARs reside on the same System i
machine, the Domino server might encounter a problem trying to access the System i IP
Messaging partition. The problem may occur if the System i IP Messaging partition is using
virtual networking and the i5/OS partition in which the Domino server is running performs
proxy Address Resolution Protocol (ARP) for the virtual network.
Tip: See 4.3.4, “Adding Domino and SMTP to the System i IP Telephony configuration”
on page 134, for information about how to install Cygwin and start an SSH session to a
System i IP Messaging partition.
Installing TCSPI
To install the TCSPI software:
1. Load the 3Com VCX IP Telephony and Messaging DVD into the System i DVD player.
Alternatively, mount the proper image volume in the image catalog of your System i
machine where the Sametime server is already installed and configured.
ISO image: You can create an ISO image for this DVD and mount it to a virtual optical
device in i5/OS. For more information regarding this i5/OS feature, see Appendix A,
“Virtual CD library” in Implementing POWER Linux on IBM System i Platform,
SG24-6388.
IPTelephonySPI file: Be aware that the IPTelephonySPI file name depends on the
software version. In this case, we use version 7.2.74.1.
3. Start an i5/OS 5250 emulation session and sign on with a user profile that has *ALLOBJ
authority.
4. Create a directory in the i5/OS integrated file system. For our example, we created a
directory called /iptcollab by using the following Create Directory (CRTDIR) CL command:
CRTDIR DIR(iptcollab)
6. Start an i5/OS Qshell command entry by typing the STRQSH CL command and pressing
Enter.
Attention: If your QCCSID system value is different from 37 (USA), you must change it
for your current job by using the following Change Job (CHGJOB) CL command:
CHGJOB CNTRYID(US) CCSID(37)
> cd /iptcollab
$
> ls
IPTelephonySPI-7.2.74.1.tar
$
After the pax command ends, you see messages like those that are shown in Figure 3-7.
Tip: You can check the unpacked files by using iSeries Navigator or NetServer™
services and displaying the contents of the directory.
config.sh
install.sh
lib/IPTelephonyClient.jar
lib/IPTelephonySPI.jar
lib/WSSecurity.jar
lib/XmlSchema.jar
lib/axiom.jar
lib/axis.jar
lib/backport-util-concurrent.jar
lib/commons.jar
lib/stax-api.jar
lib/wstx-asl.jar
lib/xercesImpl.jar
lib/xml-apis.jar
pax: 001-2298 For archive file IPTelephonySPI-7.2.74.1.tar and volume 1, 19
files were processed with 0 bytes read and 4188160 bytes written.
$
===>
i5/OS CL command alternative: You can also stop the Sametime server from a 5250
emulation session by using the following End Domino Server (ENDDOMSVR) CL
command:
ENDDOMSVR SERVER(demost) OPTION(*CNTRLD)
Important: You must repeat this procedure for each Sametime server that you want to
connect to the System i IP Telephony solution.
1. Start an i5/OS Qshell command entry by typing the STRQSH CL command and pressing
Enter.
2. In the QSH Command Entry display, change to the directory where you unpacked the
TCSPI software, which is /iptcollab in our example, and call the install.sh script as shown
in Figure 3-9.
Attention: You must run this install procedure only once because the install.sh script
copies several Java archive (JAR) files into the /QIBM/ProdData/LOTUS/Sametime/
telephony_ext directory.
In addition, the install.sh script uses the default SDK Toolkit Web services user ID
(wsuser) and password (wspwd). Therefore, if you change the default SDK Toolkit Web
services user and password, you must first follow the instructions in this section. Then
follow the steps in 3.2.3, “(Optional) Reconfiguring and enabling the Sametime server”
on page 70. Finally complete the steps in “Enabling TCSPI on the Sametime server” on
page 68.
config.sh
install.sh
lib/IPTelephonyClient.jar
lib/IPTelephonySPI.jar
lib/WSSecurity.jar
lib/XmlSchema.jar
lib/axiom.jar
lib/axis.jar
lib/backport-util-concurrent.jar
lib/commons.jar
lib/stax-api.jar
lib/wstx-asl.jar
lib/xercesImpl.jar
lib/xml-apis.jar
pax: 001-2298 For archive file IPTelephonySPI-7.2.74.1.tar and volume 1, 19
files were processed with 0 bytes read and 4188160 bytes written.
===> ./install.sh
DNS host name versus IP address: If you use DNS host names instead of IP
addresses, the integration between Sametime and System i IP Telephony depends
on the reliability and availability of the DNS server.
Figure 3-12 shows an example of the install.sh script answers based on our test
environment.
lib/xercesImpl.jar
lib/xml-apis.jar
pax: 001-2298 For archive file IPTelephonySPI-7.2.74.1.tar and volume 1, 19
files were processed with 0 bytes read and 4188160 by
tes written.
$
> ./install.sh
Copying files to ProdData ...
===>
F3=Exit F6=Print F9=Retrieve F12=Disconnect
F13=Clear F17=Top F18=Bottom F21=CL command entry
Figure 3-12 Installing and configuring TCSPI
4. With this input data, the install.sh script creates the IPTelephonyProperties.xml file. You
can see this file and verify the information by using the Display File (DSPF) CL command:
DSPF STMF('/Domino/demost/IPTelephonyProperties.xml')
If the data values in this file are correct, continue to next section. If not, and you must
change any value or change the default SDK Toolkit Web services user ID and password,
go to 3.2.3, “(Optional) Reconfiguring and enabling the Sametime server” on page 70.
i5/OS CL command alternative: You can also start the Sametime server by entering
the following Start Domino Server (STRDOMSVR) CL command:
STRDOMSVR SERVER(demost)
2. From a Web browser, enter the Sametime Center URL, for example:
http://demost.iptdemo.com/stcenter.nsf
3. In the left pane of the Welcome page (Figure 3-13), click Administer the server and sign
in with the Domino Administrator user ID and password.
6. Scroll down to the bottom of the page and click the Update button (Figure 3-15).
If you reach this point successfully, the Sametime server and System i IP Telephony have
been configured and enabled to collaborate. Continue with 3.3, “Installing the IP Telephony
presence plug-in in the Sametime Connect client” on page 72.
> cd /iptcollab
$
===> ./config.sh
Important: The admin user name and password must match the SDK Toolkit Web
services user name and password.
5. With the input data, the config.sh script updates the IPTelephonyProperties.xml file. You
can display this file and verify the information by entering the following Display File (DSPF)
CL command:
DSPF STMF('/Domino/demost/IPTelephonyProperties.xml')
If the data values in this file are not correct, run the config.sh script again with the proper
input data.
If the data values are correct, but you are installing and configuring the Sametime server
for the first time and you are doing this step because you are using a different user or
password for the SDK Toolkit Web services, return to “Enabling TCSPI on the Sametime
server” on page 68.
The Sametime LineStatus Plugin for 3Com System i IP Telephony is packaged as an Eclipse
plug-in that allows administrators to choose the way they want to deliver this software to
users. Users do not need to do any special configuration for access to the IP Telephony
presence and collaboration features. They download the plug-in directly from the System i IP
Telephony and Messaging server by using the Sametime plug-in management tools.
Administrators also have the option to deploy the Sametime presence plug-in on a separate
update server. This option is useful to customers who maintain setup policies that force or
restrict the download of the plug-in to any or all members of their Sametime community. They
do this by using centralized update servers for all their custom and third-party Eclipse or
Sametime updates.
Important: If the Web services user name (wsuser) and password (wspsw) settings are
modified with the axis2cfg script, those changes are reflected in the Sametime presence
plug-in package on the server. Clients that have already received and downloaded the
plug-in must remove it and reinstall it, so that they can pick up the new configuration
parameters. Meanwhile, IP Telephony status for their Sametime contacts is displayed as
unknown, because the plug-in is unable to authenticate with the System i IP Telephony and
Messaging server.
IPTelephonyPlugin.jar file: You might not want the plug-in to be downloadable from one
of the System i IP Telephony and Messaging servers, but would rather have it be made
available from a different server. In this case, you can obtain the IPTelephonyPlugin.jar file
from the System i IP Telephony and Messaging server in the /opt/3com/VCX/ipwservice
/vcx-html/linestatus directory. You can extract the file into a directory on a different update
server by using the jar tool. To use this option, administrators must be familiar with setting
up update sites.
Important: The contents of update site must be updated if there is a new version of the
plug-in or its initialization parameters are changed on the System i IP Telephony and
Messaging server. The initialization parameters include the System i IP Telephony address
or the SDK Toolkit Web services user or password.
Figure 3-20 Selecting the server where the Sametime presence plug-in is located
9. In the Install/Update window (Figure 3-25), you are prompted to restart your Sametime
client. Click Yes.
You need to add yourself to your contact list to see your line status being updated. The line
status is only updated for contacts who have a reachable phone number. As you can see in
Figure 3-26, the line status is visible regardless of the Sametime status (logged in, logged
out, or busy). Three states are available for IP Telephony line status:
Line Free Green telephone icon next to the Sametime status icon.
Line Busy Green telephony icon with a stop sign through it next to the Sametime status
icon.
Line Status Unknown
A telephone icon next to the Sametime status icon that is unavailable.
Figure 3-28 Notification preferences in the Sametime Connect client, one-on-one conference options
Figure 3-29 Notification preferences in the Sametime Connect client, multi-party conference options
You are now ready to use the new IP Telephony presence, click-to-dial, click-to-call, and
click-to-conference integration features that are enabled by the integration of Sametime and
the System i IP Telephony solution.
In this section, we show you how to take advantage of these new capabilities in your
Sametime Connect client.
You also can change the telephone number where you will attend the call. For example, you
might be in an office in your home, on your mobile, or in a meeting room and need to originate
the call there. In this case, use the Call me at option and provide the other telephone number.
This phone number must fulfill the dialing plan that is defined in the System i IP Telephony
solution. For example, in the System i IP Telephony solution, if you configured that your users
must first dial the number 9 before they dial an external number, then here you must enter a 9
and the external phone number where you want to be reached.
In this example, a window (Figure 3-33) opens for Rob Haviland at extension 1704 that
prompts him to accept a call from Jairo Reyes, who was the originator of the call. Rob clicks
the Join Call button to answer the phone call.
Tip: You can avoid this message if you choose the Ring phone parameter in the
Notification preferences as shown in Figure 3-28 on page 82.
Again, the first option for the phone number in the Number at which I will join the call field is
the number that your partner has defined for the Geographic Location preference. See
“Geographic location preferences” on page 84 for more information.
Figure 3-34 Adding a different phone number from which to join a call
When the call is accepted, both hard phones ring and are ready to start the call. During the
call progress, you see a status, such as Connected, as shown in Figure 3-35.
While the call is in progress, as the call originator or moderator, you can add new users to the
call (creating a conference), disconnect participants, or end the call from this window.
Moderator: As the moderator, if you close your conference status window during the call,
the call ends and all the participants are disconnected.
After the call ends, the Line status icons return to the Line free status (green telephone).
Conferencing modes
The System i IP Telephony solution supports the following types of conferencing modes:
Conferences that consist of no more than three participants
In this case, the conferencing and audio mixing is done on the 3Com phones, and no IP
Telephony conferencing server is used. By using this option, you can have unlimited
conferences of up to three participants. In addition, you can create networks of
conferences where the telephones connect groups of up to three participants in order to
create bigger conferences. Figure 3-39 illustrates this mode.
Unlimited Conference #2
3-telephones Conference #3
conference Conference #4
Conference #n
and/or
...
Moderator
3Com
3Com 3Com
Conference #1
..
and/or ..
.
One conference with
unlimited telephones
Conference #2 Conference #3
Conference #4
Conference #5 Conference #6
..
..
..
. ..
.
In the window that opens, you can choose to invite more Sametime community members.
When they accept the invitation, you see the status in the window status like the example in
Figure 3-35 on page 87.
Moderator: As the moderator, if you close your conference status window during the call,
the call ends, and all the participants become disconnected.
IP Telephony presence rules apply as shown in Figure 3-43. In this example, we cannot
connect with Markus Neuhold because he is using the phone. However, he is available for a
text chat, so that we can reach him by a normal Sametime text chat session.
Important: As the moderator, you cannot connect more than six phones in this way
because you are using the ad hoc function of System i IP Telephony solution. If you try to
connect a seventh phone, the moderator telephone (if it has a display) shows the following
message:
No more users allowed.
Then in the Sametime status window, the seventh user has a status of Connecting as
shown for Markus Neuhold in Figure 3-44.
All of the people who are selected in the contact list receive an invitation window like the one
that is shown in Figure 3-33 on page 86. As long as your invitees accept or decline the
invitation, you and your participants should see the conference status window as shown in
Figure 3-46 on page 96. Only you as the call originator have Moderator options to disconnect
a participant or to completely finish the call.
Moderator: As the moderator, if you close your conference status window during the call,
the call ends, and all the participants become disconnected.
After each invitee accepts to attend the call, the hard phone rings, which the invitee must
answer in order to join the telephone conference.
Conference number: In the Topic message, include the conference number, which is
7130 in our example, to inform participants of which number to dial when the Assistant
conference message prompts them.
After you send the invitation, each invitee receives a Meeting Invitation window like the
one shown in Figure 3-50 prompting them to join the meeting in a virtual telephone
conference room (7130 in this example).
Conference extension: You have the option to configure the Conference Bridge
Number (see 3.2.3, “(Optional) Reconfiguring and enabling the Sametime server” on
page 70) with a conference extension (in our example between 7100 and 7199). This
way, your participants can go directly to the telephone conference without hearing the
assistant message.
8. Each conference member must follow the instructions on the welcome message of the
virtual telephone conference room to join the telephone conference.
During the conference, the participants can use all the resources that the Sametime
Meeting Room provides plus the options that the System i IP Telephony solution provides.
If any participant, even the moderator, closes their Web browser, they continue to be
connected to the telephone conference, but not to the Sametime meeting. Additional
people who dial directly to the conference extension (in this example 7130) can connect to
the telephone conference.
All participants must hang up their hard phone in order to close the entire telephone
conference.
If your invitees use the Sametime Connect client to access and attend the meeting, they must
perform the following steps. However, if you sent the invitation by adding the meeting Web
link, your invitees can click the link and go to step 3:
1. Start a Sametime Connect client session.
2. From the Sametime Connect client, select Tools → Meetings → Attend Meeting
(Figure 3-55).
Figure 3-55 Attending a scheduled meeting from the Sametime Connect client
For additional information regarding log files and problem determination, refer to Appendix C,
“Location of log files” on page 205.
> cd iptcollab
> install.sh
Copying files to ProdData ...
===>
Problem: The following message is displayed during the installation and configuration
procedure when running the install.sh or config.sh scripts:
The installing user profile needs *ALLOBJ authority.
– Description: The current i5/OS user profile does not have enough authority.
– Solution: Sign off and change your i5/OS user profile to one that has *ALLOBJ
authority.
Problem: The following message is displayed during installation when running the
install.sh script:
Sametime is not at a compatible version. Check the product prerequisites.
– Description: Your version of Sametime is invalid or the i5/OS integrate file system
directory of /QIBM/ProdData/LOTUS/Sametime/telephony_ext was deleted.
– Solution: Update the Sametime server to a supported version or create the missing
directory.
– Comments: If your directory was deleted, verify the integrity of your Sametime
product. You can run the following Check Product Option (CHKPRDOPT) CL command
to do an initial verification:
CHKPRDOPT PRDID(5724J23) RLS(*ALL) OPTION(*ALL) DETAIL(*FULL)
Problem: In an incoming phone call window as shown Figure 3-34 on page 87, you
cannot edit the current phone number.
– Description: The Sametime Connect client uses the Geographic Location preference
to accept a call.
– Solution: Set up the primary phone number in your Geographic Location preference.
See Figure 3-30 on page 84.
– Comments: Ensure that this phone number satisfies the dialing plan that is defined in
the System i IP Telephony solution.
Problem: When creating a conference from a Sametime contact list, some people do not
connect.
– Description: After selecting several people in the Sametime contact list and then
selecting the Start a Call option, some people do not appear in the status window.
– Solution: Be sure that you are not inviting more than five participants to the meeting.
Remember that the call originator counts as one person in the limit of six people in an
ad hoc conference call.
– Comments: Use the Instant meeting option to invite more than six people to the
meeting. If you do not have the System i IP Conferencing module configured to create
an Instant meeting, ask the current participants in the conference to connect more
participants through their hard phones.
More information: For detailed information about how to install and configure Domino on
i5/OS, refer to IBM Lotus Domino 6 for iSeries Implementation, SG24-6592, or
Implementing IBM Lotus Domino 7 for i5/OS, SG24-7311.
With this integrated solution, the user uses Domino mail and automatically receives new voice
mail and fax messages as they are deposited by callers. By using Domino mail, users can
listen to voice messages as WAV files and view fax messages as TIF files. The Domino user
can forward voice mail and fax messages that are received from System i IP Telephony back
to other System i IP Telephony mailbox users or to other e-mail destinations that are
supported by the Domino server. Domino users have the option to use the Lotus Notes client
or Domino Web Access as a client. Figure 4-1 illustrates this unified inbox solution.
HTTP or NRPC
System i – RCHAS10
IP Messaging Domino
Events
demopri.iptdemo.com demodom.iptdemo.com
System i IP Telephony
SIP
Voice or Fax message
Extension 1703
Figure 4-1 Unified inbox solution with Domino and System i IP Telephony
A typical message between the System i IP Messaging server and a Domino server follows
this sequence of actions:
1. The System i IP Messaging server receives a voice mail or fax and activates the MWI.
2. The System i IP Messaging server sends a message to the Domino server via SMTP.
3. The Domino server sends an event (InboxAdd) to the System i IP Messaging server.
4. The System i IP Messaging server initiates an IMAP poll that retrieves the IMAP unique
identifier (UID) of the message and stores it on the System i IP Messaging server.
5. The user opens the message on the Domino server.
6. The Domino server sends an event (MarkRead) to the System i IP Messaging server.
7. The System i IP Messaging server updates the message status and MWI.
8. The user deletes the message on the Domino server.
9. The Domino server sends an event (Delete) to the System i IP Messaging server.
10.The System i IP Messaging server deletes the message and updates the MWI.
For more information about how this integrated solution works between the System i IP
Messaging server and the Domino server, see “IMAP” on page 212.
4.2.1 Planning
You should have available the environmental characteristics and resources that are presented
in the following sections, so that you can install and configure the unified inbox solution.
Assumptions
In planning for the installation, we assume that you have the following components and
configurations:
You already installed and configured the following products:
– Domino 6.5.6 or later in an i5/OS partition
Important: Make sure that e-mail accounts exist on the Domino server.
– System i IP Telephony software on its own Linux partition on the System i machine
You have configured and activated Lightweight Directory Access Protocol (LDAP)
synchronization between the System i IP Telephony solution and the Domino server. See
Required information
You must provide the following information for the installation script:
IP address of the primary System i IP Telephony logical partition (LPAR)
IP address of the Domino server that is running on the i5/OS partition
Network configuration
Consider a situation where the Domino server and any System i IP Messaging LPAR reside
on the same System i machine. In addition, the System i IP Messaging partition is using
virtual networking, and the i5/OS partition in which the Domino server is running performs
proxy Address Resolution Protocol (ARP) for the virtual network. In this situation, the Domino
server might encounter a problem when it tries to access the System i IP Messaging partition.
To prevent this problem, perform the following steps:
1. Start an SSH session and log in as root (with a default password of pvadmin) to each
System i IP Messaging partition that is configured for virtual networking and resides on the
same System i machine as the Domino server.
Tip: See 4.3.4, “Adding Domino and SMTP to the System i IP Telephony configuration”
on page 134, for information about how to install Cygwin and start an SSH session to a
System i IP Messaging partition.
2. On the Linux command line of the SSH session, modify the firewall ipm_table_sock as
shown in Figure 4-2 by entering the following command:
modfw -p ipm_table_sock allow i5/OS_virtual_LAN_IP_address
In our example, 9.5.92.65 is the i5/OS virtual LAN IP address:
modfw -p ipm_table_sock allow 9.5.92.65
You install the integration package into the i5/OS partition from the 3Com software media by
using a Qshell command prompt. You can use these instructions when you install the
System i IP Messaging software for the first time or for an already installed system.
ISO image: You can create an ISO image for this DVD and mount it to a virtual optical
device in i5/OS. For more information regarding this i5/OS feature, see Appendix A,
“Virtual CD library” in Implementing POWER Linux on IBM System i Platform,
SG24-6388.
3. Start an i5/OS 5250 emulation session and sign on with a user profile that has *ALLOBJ
authority.
4. Create a directory in the i5/OS integrated file system. For our example, we created a
directory called /iptcollab by using the following Create Directory (CRTDIR) CL command:
CRTDIR DIR(iptcollab)
i5/OS Cl command alternative: You can also copy the ipmmail_i5.tar file from an
i5/OS 5250 emulation session by using the following Copy (CPY) CL command:
CPY OBJ('/QOPT/VCXINSTALLER-7.2.5C/I5OS/ipmmail_i5.tar') TODIR('/iptcollab')
6. Start an i5/OS Qshell command entry by typing the STRQSH command and pressing Enter.
Attention: If your QCCSID system value is different from 37 (USA), you must change it
for your current job by using the following Change Job (CHGJOB) CL command:
CHGJOB CNTRYID(US) CCSID(37)
Important: You must use the -C parameter with code 819 regardless of the language
that you are using on your system.
$
> cd /iptcollab
$
> ls
ipmmail_i5.tar
$
> pax -rv -C 819 -f ipmmail_i5.tar
ipmmail_i5.qsh
ipmmail_i5.readme
ipmmail_i5_install.qsh
COMSIPM.SAVF
pax: 001-2298 For archive file ipmmail_i5.tar and volume 1, 4 files were
processed with 0 bytes read and 675840 bytes written.
$
===>
i5/OS CL command alternative: You can also stop the Domino server from a 5250
emulation session using the following End Domino Server (ENDDOMSVR) CL
command:
ENDDOMSVR SERVER(demodom) OPTION(*CNTRLD)
> cd /iptcollab
$
> ./ipmmail_i5_install.qsh
creating COMSSAVF library
CPC2102: Library COMSSAVF created.
creating COMSSAVF/COMSIPM
CPC7301: File COMSIPM created in library COMSSAVF.
Updating comssavf/comsipm ...
Restoring COMSIPM ...
CPC3703: 4 objects restored from COMSIPM to COMSIPM.
creating ipmaddin link
creating ipmmail link
Tip: When the operation is successful, you receive the following message:
1 servers updated
===>
Restarting the Domino server and activating the IPMADDIN server task
Restart the Domino server to activate the newly installed IPMADDIN server task. From
iSeries Navigator, in the left navigation pane, click Network → Servers → Domino to retrieve
a list of Domino servers configured on your system. In the right pane, right-click the Domino
server and select Start.
i5/OS CL command alternative: You can also start the Domino server by entering the
following Start Domino Server (STRDOMSVR) CL command:
STRDOMSVR SERVER(demodom)
Browse : /domino/demodom/NOTES.INI
Record : 1 of 84 by 14 Column : 1 106 by 79
Control :
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
[Notes]
Directory=/domino/demodom
KitType=2
NPN=1
UNICODE_DISPLAY=1
FaultRecovery_Build=Release 7.0.2FP1
SHARED_MAIL=0
DisableLDAPOnAdmin=0
Passthru_LogLevel=0
Console_LogLevel=2
DefaultMailTemplate=mail7.ntf
Preferences=32
ServerTasks=IMAP,COLSRV400,Update,HTTP,LDAP,Replica,Router,SMTP,ipmaddin
ServerTasksAt1=Catalog,Design
ServerTasksAt2=UpdAll
Browse : /domino/demodom/NOTES.INI
Record : 71 of 84 by 14 Column : 1 59 by 79
Control :
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....
CLEANUP_EVENTS4_STATS_VIEW=0
EventSetup=700200
DELETE_DUPLICATE_PUID_NOTES=0
DDMSetup=700200
WebAdminSetup=710
DominoConfigLevel=1
CATALOG_UPDATED_BY_BUILD=510
ADMINP_LAST_SAVED_POLICY_TIME=08/31/2007 13:28:40
ADMINP_LAST_SAVED_USER_TIME=09/05/2007 11:25:16
ADMINP_LAST_SAVED_DIRECTORY_TIME=09/05/2007 11:26:12
EXTMGR_ADDINS=IPMMAIL
IPMServer=9.5.92.66,9.5.92.67:2298
DominoControllerCurrentLog=dcntrlr200709050000.log
JrnlEnbld=0
************End of Data********************
3. Start a Domino server console session by entering the following Work with Domino
Console (WRKDOMCSL) CL command:
WRKDOMCSL dominoserver
In our example, demodom is the name of the Domino server:
WRKDOMCSL demodom
Tip: You can press F5 to refresh the display. In addition, you can press the Page Up
and Page Down keys to scroll through the display.
Binding the Domino SMTP and i5/OS SMTP on the same system
The i5/OS SMTP server and Domino SMTP server must bind to a specific TCP/IP address.
After you configure this, the Domino SMTP server can send and receive mail with the i5/OS
SMTP server, as though they were communicating over the Internet. Figure 4-13 illustrates
this configuration.
Users Users
i5/OS SMTP
9.5.92.16
i5/OS TCP/IP
Internet
Figure 4-13 Configuring multiple SMTP instances on the same i5/OS partition
To configure multiple instances of SMTP, you must ensure that Domino partitioning is
enabled, and each instance must bind to a specific TCP/IP address. To bind your servers to
specific TCP/IP addresses for configuring multiple SMTP servers on the same system:
Complex network environment: The following steps do not explain how to set up a
complex network environment. You must understand your network and plan your
environment accordingly. For help with setting up a complex network environment, see the
Networking section of the IBM Systems Information Center:
http://www.ibm.com/eserver/iseries/infocenter
1. Obtain all of the necessary TCP/IP addresses that are required for the configuration. One
address is required for the Domino SMTP server, and one is required for the i5/OS SMTP
server.
2. Start a 5250 emulation session and sign on with a user profile that has *ALLOBJ authority.
3. Type the Configure TCP/IP (CFGTCP) CL command and press Enter.
Selection or command
===> 10
5. On the Work with TCP/IP Host Table Entries display (Figure 4-15), change the host table
entries for System i TCP/IP according to your configuration. In Figure 4-15, we show that
our Domino server (DEMODOM) is added to the System i host table.
Internet Host
Opt Address Name
9.5.92.16 RCHAS10.RCHLAND.IBM.COM
RCHAS10
9.5.92.26 DEMODOM.IPTDEMO.COM
DEMODOM
9.5.92.39 DEMODOM8.IPTDEMO.COM
DEMODOM8
More...
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
Figure 4-16 Change TCP/IP Domain display
7. Edit the notes.ini file for the Domino server by using the following Edit File (EDTF) CL
command:
EDTF STMF('/domino_directory/domino_data_directory/NOTES.INI')
In our example, we enter the following command:
EDTF STMF('/domino/demodom/NOTES.INI')
CMD
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+
ServerKeyFileName=server.id
Domain=ITSO
Admin=CN=Domino Administrator/O=ITSO
Timezone=6
DST=1
FaultRecovery=1
TemplateSetup=700200
Setup=700200
ServerSetup=700100
TCPIP_TcpIpAddress=0,9.5.92.26
ServerName=DEMODOM/ITSO
PhoneLog=2
Log=log.nsf, 1, 0, 7, 40000
CleanSetup=1
DB2_DBS_PER_SCHEMA=10
9. Bind the i5/OS SMTP server to a specific IP address by using the Add SMTP List Entry
(ADDSMTPLE) CL command. Enter the following two commands in which you substitute
your TCP/IP address for the one that is used in your configuration:
ADDSMTPLE TYPE(*SVRBIND) INTNETADR('9.5.92.16')
ADDSMTPLE TYPE(*CLTBIND) INTNETADR('9.5.92.16')
In our example, 9.5.92.16 is the IP address of the i5/OS SMTP server.
More...
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More keys
Figure 4-18 Changing the autostart parameter of the i5/OS SMTP attributes
More...
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
Figure 4-19 Enabling the SMTP and IMAP tasks on the i5/OS Domino server
3. Start the Domino server console by entering the following Work with Domino Console
(WRKDOMCSL) CL command:
WRKDOMCSL dominoserver
In our example, demodom is the name of the Domino server:
WRKDOMCSL demodom
4. Start the Domino SMTP task on the Domino server console:
load smtp
5. Start the Domino IMAP task on the Domino server console:
load imap
5. Back in the Person document, specify the Internet e-mail address by changing the Internet
address field (Figure 4-23).
6. Click the Save & Close button to save the changes to the Person document.
To have GUI administration access to the System i IP Telephony server, you must use a
terminal emulator for the X Window System (xterm). In the Windows environment, you can
have xterm by using the Cygwin software. Cygwin is a Linux-like environment. It provides a
dynamic link library (DLL) that acts as a Linux application programming interface (API)
emulation layer on a collection of tools that provide a Linux look and feel. You can download a
copy of the Cygwin software from the Cygwin Web site at the following address:
http://www.cygwin.com
xterm software: You can use other xterm software to access System i IP Telephony. The
xterm software must support the SSH protocol.
Perform the following steps to configure and use GUI administration access to the System i IP
Telephony server by using the Cygwin software. Then define the Domino server and the
SMTP service to the System i IP Telephony Messaging server:
Files in cygwin.zip: In the following steps, we assume that the files in cygwin.zip are
extracted to the C:\cygwin_installation directory and the Cygwin application is installed in
the C:\cygwin directory.
5. On the Cygwin Setup - Choose Installation Type window (Figure 4-25), select the Install
from Local Directory option and click Next.
Default Text File Type: Do not change the Default Text File Type option of Unix.
7. On the Cygwin Setup - Select Local Package Directory window (Figure 4-27), in the Local
Package Directory field, type C:\cygwin_installation and click Next.
9. The installation process begins. During the Cygwin installation process, you see the
installation progress on the Cygwin Setup window (Figure 4-29).
11.Start the Cygwin program (cygwin.bat). Either click the icon that was created on the
desktop, or from the Windows Start menu, select Start → All Programs → Cygwin →
Cygwin Bash Shell.
12.Type startx in the Cygwin window to start the X Windows System (Figure 4-31).
SSH session: You must start the SSH session on the primary System i IP Telephony
server. In our configuration, 9.5.92.66 is the System i IP Messaging primary server.
14.After you receive information about the RSA key fingerprint, type yes in response to the
question: “Are you sure you want to continue connecting (yes/no)?” (Figure 4-33).
15.When prompted for the app user password, enter the correct value and press Enter. The
default password is nice.
17.Start the System i IP Telephony GUI by entering the following command (Figure 4-35):
xattach app
18.To access to the main menu, select Utilities → VM Admin as shown in Figure 4-36.
Tip: After you enter the Login information, press Enter to access the Password field.
After you type the password, press Enter again.
20.From the Main Menu (Figure 4-38), click System Configuration to access the System i IP
Telephony Messaging system configuration.
22.As shown in Figure 4-40, for Type, select Domino to define the Domino server. Select the
corresponding TCP/IP address of your Domino server, accept the default port of 2281,
and use the TCP/IP address of the i5/OS VLAN. Click Save to save the changes.
Figure 4-40 Defining the Domino server to the System i IP Telephony Messaging server
Figure 4-41 Defining the SMTP server to the System i IP Telephony Messaging server
To access to the System i IP Messaging Web interface and edit a user mailbox to create a
new external e-mail session and password:
1. From a Web browser, enter the following URL to access the System i IP Messaging Web
interface:
http://primary_server_IP_address
Primary System i IP Telephony Messaging server: You must have access to the
primary System i IP Telephony Messaging server. In our example, 9.5.92.66 is the
primary System i IP Telephony Messaging server.
3. On the Welcome page (Figure 4-43), enter the correct values for user name and
password. The default User Name or Phone Number is sockroot, and the default
Password is secret. Then click Submit.
5. On the Edit Mailbox page (Figure 4-45), to configure an System i IP Messaging mailbox,
enter the user’s mailbox number and click Submit.
Passwords: User passwords are not populated during LDAP synchronization. You
must use the same password that is used in the Domino Directory Internet Password
field of the Person document as explained in 4.3.3, “Configuring the Domino
environment” on page 132. If you change the Internet password in the Domino
Directory, you must change the External Email password again.
10.On the External Email page (Figure 4-50), ensure that the Account Validated field is set to
YES.
Account Validated field: The Account Validated field is set to NO if you did not enter
the same password that is used in the Domino Directory Internet Password field of the
Person document. In this case, you must retype the password.
2. The e-mail message contains an attached WAV file with the name of message.wav as
shown in Figure 4-52. To listen to the message, double-click the attachment icon and
select Open.
3. The PC workstation operating system shows the image file by starting the default
application that is associated with TIF files. As shown in Figure 4-58, the Windows system
is using the Windows Picture and Fax Viewer program to show the image.tif file.
The Integrated Domino Fax software enables Lotus Notes users to send and receive faxes
directly from their Notes client by using their current telephone system and Domino
infrastructure. Upon specifying the intended recipients in the Fax To field, it is possible to fax
Notes messages that contain rich text and graphics or fax files that are attached to a Lotus
Notes e-mail.
Notes users can also send faxes directly from most Windows-based applications by using the
Print-to-Fax driver. With the Print-to-Fax driver, users can address outgoing faxes by using
their Personal Address Books or the Domino Directory. As an alternative to sending a fax,
Notes users can also use Domino Web Access.
Windows workstation,
manages a Domino Fax server
LAN
FAX Windows
Services system
When a user specifies that a Notes e-mail should be sent to one or more recipients as a fax,
the message is routed to the Domino Fax server for processing. When a fax is received on a
System i fax device that has been configured for use with Domino Fax, the Domino Fax server
receives the fax. The Domino Fax configuration determines where and how the fax server
delivers the incoming faxes.
Similarly, when the Domino Fax server receives a fax, the fax must first be routed to the Fax
Windows Services system for conversion to an appropriate format. The message is sent back
to the Domino Fax server for final delivery.
The Fax Windows Services system is normally a stand-alone Windows workstation or server.
If you prefer, you can use an Integrated xSeries® Server (IXS) instead.
See the IBM Integrated Domino Fax for i5/OS Web site for more information:
http://www.ibm.com/servers/eserver/iseries/domino/related/fxd/
More information: See 4.3.4, “Adding Domino and SMTP to the System i IP Telephony
configuration” on page 134, for information about how to install and configure Cygwin.
2. On the Cygwin window, start an SSH session to the System i IP Telephony Messaging
server as user root:
ssh root@System i IP Messaging address
3. When prompted for the root user password, enter the correct value and press Enter. The
default password is pvadmin.
5. To quit the Linux vi editor, type :q as shown in Figure 4-66 and press Enter.
Web services are the basis of distributed computing across the Internet. They provide a
standard method of communicating between diverse software applications running on
different platforms. The VCX Web Services API provides a platform-neutral and programming
language-independent approach to application integration. Developers can interact with the
IP Telephony system from any programming language that can initiate Web services requests
by using the provided 3CW open standard WSDL document.
With the VCX Web Services API, you have high-level access to a set of communications
functions such as phone status, call control, and phone configuration, which enable business
and telephony applications to work together to deliver business process improvements. For
example, a Lotus Notes agent can be initiated from within an existing business application by
using telephone contact information that stored in a Domino database.
All requests to the interface require client applications to present their authentication
credentials in a valid security header. The applications do this by using the Web services
security standard to ensure that only authorized applications can invoke telephony features.
The System i IP Telephony software is installed and runs on a dedicated System i Linux
partition, allowing remote applications to use the Web Services API. The request types
supported by this API fall into three categories:
Call control
– Initiate a phone call
– Transfer a call
– Conference call
– Hold call
– End call
Phone configuration
– Enable hands free operation
– Mute phone
– Enable/disable do not disturb (DND)
– Enable/disable forward of voice mail
Phone status
– Get phone state
– Get DND state
– Get voice mail state
On the 3Com Open Network Web site, you must register in order to log in. After you log in,
click the Developer ToolKit link in the left navigation frame and then click the VCX IP
Telephony Web Services SDK for IBM System i link in the right pane (Figure 5-1).
Figure 5-1 Obtaining the SDK toolkit from the 3Com Open Network Web site
Download the SDK .zip file to a directory that is accessible to your workstation and extract the
file. The SDK toolkit includes the following contents:
/lib folder with the Web Services API Java archive (JAR) files
/samples folder with the source files and the class files of the sample application and its
corresponding build files
/docs folder with the PDF of the user guide and a wsdldoc.zip file that contains the
applicable reference documentation for the WSDL
/resources folder with the WSDL files
/RunSample.bat file that runs the Java sample application
By using the SDK toolkit, a programmer can access the specific capabilities that are exposed
such as controlling the calls. These capabilities are exposed externally through the WSDL
Web services definition language XML file. By using this documentation, the programmer can
determine the parameters that are required for any of the Web service endpoints that are
provided by the IP Telephony Web service.
http://www.soapui.org/
c. In the New WSDL Project window (Figure 5-9), select the Create sample requests for
all operations option and click OK.
7. On the project Request Properties details tab (Figure 5-11), enter the Web Services user
name and password. The default for Username is wsuser, and the default for Password is
wspwd. Select PasswordText as the WSS-Password Type.
9. In the CallControlRequest - Request 1 window, on the SOAP Request tab, change the
SOAP message by changing the content of the actionType, originNumber,
destinationNumber, and serviceValidator fields as shown in Figure 5-13.
In this example, we invoke a call control request (makeCall). We tested the originator
number 1703 by calling destination number 1705.
Originator number: The originator number password is optional. If you do not use it,
you must remove any space or character from the field.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ipt="http://ws.coms.com/iptelephony/">
<soapenv:Header/>
<soapenv:Body>
<ipt:callControlRequest>
<ipt:actionType>makeCall</ipt:actionType>
<ipt:credentials>
<ipt:originNumber>1703</ipt:originNumber>
<!--Optional:-->
<ipt:password></ipt:password>
</ipt:credentials>
<!--Optional:-->
<ipt:destinationNumber>1705</ipt:destinationNumber>
<ipt:serviceValidator APIVersion="?">V1</ipt:serviceValidator>
</ipt:callControlRequest>
</soapenv:Body>
</soapenv:Envelope>
Figure 5-13 soapUI - SOAP request message
11.A call is established between the originator number and the destination number. You see
Success on the SOAP Response tab as shown in Figure 5-15.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body>
<ns646:callControlResponse
xmlns:ns646="http://ws.coms.com/iptelephony/">Success</ns646:callControlRespons
e>
</soapenv:Body>
</soapenv:Envelope>
Figure 5-15 soapUI - SOAP response message
Domino version 7.0 introduced the Web Service design element, so that you can write a Web
service and host it on your Domino server in order for it to be called from other computers.
Domino version 8.0 introduced Web service consumers, so that you can call Web services that
are hosted elsewhere. A Web service consumer does not use a Web Service design element,
Web service consumers: In Domino version 7.0 and earlier versions, you can write your
own Web service consumers in Java, but Domino Designer does not assist you in doing so.
A Web service consumer uses standard Web protocols, such as XML, SOAP, and HTTP, to
connect to a Web service provider and invoke the functionality that it provides. The ability to
define a Web service consumer enables application developers to use and reuse common
Web service-based components in their applications. This can help speed the time to develop
applications and eliminate duplication of code that provides identical functionality.
A Lotus Notes agent client (Web service consumer) sends service requests to the server of
the System i IP Telephony Web service. An example of a request is to make a call. To make a
request, the Notes agent calls a method, such as makeCall, on the client-side service stub
that was generated by the SOAP toolkit. The client-side SOAP framework then sends a SOAP
request to the service. Each request is processed by the service. After the request is
completed, the service sends either a response (with a “success” or any other message
returned) or a SOAP fault.
Each service request is acknowledged with a service response. The results of the request are
reported in the service response. In some cases, response to a request may result in an error.
Theses errors are indicated through SOAPs faults. Service responses are returned in the
form of objects by the service request method on the client-side stubs that are generated by
your SOAP framework.
Unique library name: Each library in a database must have a unique name.
5. Click the WSDL button, which is available in both Web service-enabled script libraries and
the newly created script libraries. After you Web enable a script library, you cannot
unenable it.
6. Select Import WSDL and click OK to overwrite the script library.
8. Select File → Save, and then select File → Close to save and close the library.
After the WSDL file is imported into a script library, you can use it in a Lotus Notes application
as shown in the Java code example in Figure 5-17 on page 179.
More information: See 5.3.2, “Creating a Web service consumer using Web Services API
JAR files” on page 179, to learn how to create a Java agent and incorporate the Java script
library.
The Import WSDL operation creates the Java code that represents the service that is
described in the WSDL document. The code that is generated, including the names of
classes, fields, their types, and functions or substitutes are all derived from the WSDL
document. The Import WSDL operation generates one or more PortType classes and can
generate any number of Value type classes.
In the IP Telephony scenario, the Web service provider has methods to interact with the
telephony system. Note that the script library contains only back-end classes. The Web
service messages have no UI implementation. Therefore, the script library can be used with
the Lotus Notes 8 client and the Domino 8 server. Also the Web service location may be part
of the WSDL that you imported as in our example.
You need to see the contents of the IPTelephonyService_Port.java file in the Java script
library that is generated by the WSDL for methods that you can call.
import lotus.domino.*;
import lotus.domino.types.PortTypeBase;
import com.coms.ws.iptelephony.*;
import com.coms.ws.wssecurity.*;
try {
Session session = getSession();
AgentContext agentContext = session.getAgentContext();
} catch(Exception e) {
e.printStackTrace();
}
}
}
Figure 5-17 Lotus Notes agent Java code example using a generated WSDL Java script library
5.3.2 Creating a Web service consumer using Web Services API JAR files
As an alternative to creating the Java script library with the WSDL, you have the option to
create the Java script library by using the Web Services API JAR files and program a Web
service consumer from there. In this section, we present the following tasks:
“Creating a Java script library” on page 180
“Creating a Java agent” on page 181
“Incorporating the Java script library into the Java agent” on page 184
“Compiling and saving the Java agent” on page 185
“Running the Java agent” on page 186
6. Select File → Save and then select File → Close to save and close the library.
3. In the Agent Properties window, click the Security tab (Figure 5-20). For Set runtime
security level, select option 2. Allow restricted options. Close the Agent properties
window.
import lotus.domino.*;
import lotus.domino.types.PortTypeBase;
import com.coms.ws.iptelephony.*;
import com.coms.ws.iptelephony.IPTelephonyServiceStub;
import com.coms.ws.iptelephony.IPTelephonyServiceStub.*;
import com.coms.ws.wssecurity.*;
import org.apache.axis2.client.ServiceClient;
try {
Session session = getSession();
AgentContext agentContext = session.getAgentContext();
// * Variables * //
Database db = agentContext.getCurrentDatabase();
DateTime dt = session.createDateTime("Today");
String u = session.getUserName();
String ipAddress = "http://9.5.92.66/axis2/services/IPTelephonyService/";
String username = "wsuser";
String appPasswd = "wspwd";
String origination = "1703";
String phonePasswd = null;
String destination = "1705";
// * Send the Call Control request * //
// build request body
ActionCredentials cred = new ActionCredentials();
cred.setOriginNumber(origination);
cred.setPassword(phonePasswd);
ServiceType ver = new ServiceType();
ver.setString("Version");
ver.setAPIVersion("V1");
CallControlRequest req = new CallControlRequest();
req.setActionType(CallControlActionType.makeCall);
req.setCredentials(cred);
req.setDestinationNumber(destination);
req.setServiceValidator(ver);
// init the client
IPTelephonyServiceStub stub = new IPTelephonyServiceStub (ipAddress);
ServiceClient serviceClient = stub._getServiceClient();
// build security header
SecurityType sec = new SecurityType(username, appPasswd);
serviceClient.addHeader(sec.toElement());
// execute the request
CallControlResponse response = stub.callControlRequest(req);
ActionResultType resultType = response.getCallControlResponse();
//* print *//
Figure 5-21 Notes agent Java code example using the SDK JAR files library (part 1 of 2)
} catch(Exception e) {
e.printStackTrace();
}
}
}
Figure 5-22 Notes agent Java code example using the SDK JAR files library (part 2 of 2)
3. In the Java Console window (Figure 5-26), you see the messages of the Java agent. Click
Close after you read the messages.
The Web service consumer sends a request to the Web service provider. The request is a
SOAP message that is transported through HTTP and includes the variables. The System i IP
Telephony Web service performs its operations and provides the response to the Web service
consumer as a SOAP message that contains the return value of the operation. The return
value is that of the method in the script library.
In our example we invoke the makeCall method. This method attempts to place a call from an
origination phone to a destination phone (extension 1703 calling extension 1705). The origin
phone (the invoker) must be a supported 3Com handset connected to a System i IP
Telephony system. The destination phone can be any telephony (IP/PSTN) endpoint.
Tip: In a production environment, always change the default passwords. The best time to
do this is at the initial setup of your servers and services.
Table A-1 Default passwords for System i IP Telephony, Messaging, and Conferencing users
User name Default Description
password
root (VM admin) secret System i IP Messaging Voice Mail administration (Xterminal interface) access
To display your configuration, log on to your primary System i IP Telephony and Messaging
partition by using the root user. Use the following commands to prompt the settings and
display the output file:
vcx-config-services -show >services.txt
vi services.txt
Common parameters
Hidden lines: Lines 6 to 22 are for trusted addresses and are not displayed as shown in
Figure B-5.
Firewall parameters
Figure B-9 IP Telephony Web services parameters on the primary System i IP Telephony server
System accounts
To display your configuration, log on to your secondary System i IP Telephony and Messaging
partition by using the root user. Use the following commands to prompt the settings and
display the output file:
vcx-config-services -show >services.txt
vi services.txt
Hidden lines: Lines 6 to 22 are for trusted addresses and are not displayed as shown in
Figure B-18.
Firewall parameters
System accounts
You can read the LDAPSync log file by using secure FTP WinSCP. To locate the messages
log file by using the WinSCP tool:
1. Open the WinSCP tool and log into the Linux partition that is hosting the System i IP
Telephony software with root access. Click Login to log into the Linux partition
(Figure C-1).
Figure C-1 Logging into the System i IP Telephony Linux partition with WinSCP
3. Open the log file or send it by using FTP to your local client as necessary. You also see
several more files with the name messages.number.gz. These files are old versions of the
message file that stores the history of the log file.
Inside this directory, several other log files give specific information regarding the IP
Telephony solution activities:
– Boot.log file
– cron file
– maillog file
– secure
– vcxSetup.log
– install-upgrade-7.2.5c.log
You can find debug log and error log files in there as well. You can find these files with the
WinSCP tool logged into the System i IP Conferencing Linux partition.
Appendix D. Performance
In this appendix, we provide performance information related to the Internet Message Access
Protocol (IMAP) and the IPMADDIN task of the Lotus Domino server to synchronize with the
message waiting indicator (MWI) on your phone and full text indexing of the Domino LDAP
directory.
The IPMADDIN task performs synchronization based on the poll interval that has been set in
the System i IP Messaging server. The default setting for the poll interval is 30 minutes. See
“Synchronization interval” on page 217 for the steps to determine the IMAP synchronization
poll interval for a specific Domino user’s mail file.
The IPMADDIN task converts each document in the inbox to MIME format. These
conversions are noted with the “Begin MIME to CD Conversion” messages that are displayed
on the Domino server console. Figure D-1 on page 213 shows an example.
Any messages in the Domino inbox that have been received from the System i IP Messaging
message store are already in MIME format. Therefore, they are not converted. All other
documents, such as e-mail messages and calendar invitations, are converted.
More on conversion: All documents in the Domino inbox that have not already been
converted to MIME message format are converted when the IPMADDIN task runs.
Documents in other folders will not be converted.
Now that we understand how the IPMADDIN task works with the System i IP Messaging
message store, let us recap how the Domino mail file is impacted:
1. When the first phone mail message or fax is received into a Domino user’s mail file, the
mail file is IMAP enabled.
2. At this point, all non-IMAP enabled documents in the inbox are converted to the MIME
format.
3. As new documents are received into the inbox, they are converted to the MIME format
when one of the following actions occurs:
– A new voice e-mail message is delivered to the Domino user’s mail file from the
System i IP Messaging message store.
– A new fax message is delivered to the Domino user’s mail file from the System i IP
Messaging message store.
– The IPMADDIN task executes at its defined polling interval.
Setting RouterAppendIMAPItems
The notes.ini variable, RouterAppendIMAPItems=1, can be used to perform a partial Notes
Rich Text (RTF) to MIME conversion for all Domino mail that is delivered to an IMAP-enabled
database. When this conversion occurs, IMAP header information for the message is
calculated and permanently stored with the document in the user’s Domino mail database as
the message is delivered to the mail file.
Important: While this notes.ini variable prevents the CD-to-MIME conversions from taking
place, it also increases the size of the messages in the user’s Domino mail file. This can be
a concern for users who have quotas on their mail files.
Adding this variable to the Domino server’s notes.ini file prevents the need for the
CD-to-MIME conversion. Implementation of this notes.ini variable is a trade-off between
preventing the conversion versus increasing the size of each message delivered to the user’s
inbox.
Figure D-2 on page 216 shows the conversion process for newly delivered mail messages. It
also shows that the IPMADDIN task is also continuing to convert the messages. The
messages on the console show the IMAP header being inserted into the e-mail message
permanently as the router task delivers the e-mail to the user’s Domino mail file.
The IPMADDIN task continues to convert these new messages the first time it encounters
them, although they already contain IMAP headers. Additionally, the behavior of the
IPMADDIN task that continues to convert the most recent non-VCX message in the user’s
inbox is shown, even though the e-mail message contains IMAP headers.
Figure D-3 Document properties showing the document ID and IMAP header fields
Synchronization interval
The IPMADDIN task performs its synchronization based on the poll interval that has been set
in the System i IP Messaging server. The default setting for the poll interval is 30 minutes. To
determine the setting of the IMAP synchronization poll interval for a specific Domino user’s
mail file:
1. Access the System i IP Messaging Web interface by entering the following URL in a Web
browser:
http://primary_server_IP_address
Primary messaging server: You must access the primary System i IP Messaging
server. The primary messaging server in our configuration has an IP address of
9.5.92.66.
3. Log in to the IP Messaging Web Provisioning for the System i IP Telephony partition. The
default user ID and password are sockroot and secret respectively.
4. On the Welcome to 3Com IP Messaging page (Figure D-5), click Edit a Mailbox in the left
navigation area.
6. On the Mailbox Preferences page (Figure D-7), click the External Email link in the left
navigation area.
Figure D-7 Selecting the External Email link for the mailbox being edited
Figure D-8 Clicking the View/Edit button to edit the external e-mail information for the mailbox
8. On the External Email page (Figure D-9), locate the poll interval for the user’s mailbox that
is being edited. In our example, the poll interval is the default setting of 30 minutes. If you
need to change the polling interval, change the value in the Poll interval field and click
Save. Changes to this parameter take effect immediately.
Figure D-9 Locating the polling interval for the user’s mailbox
Performance of lookups within nested groups is particularly impacted if there is no full text
index for the Domino Directory. See 2.2.3, “Full text indexing of the Domino Directory” on
page 35, for detailed steps to enable full text indexing for the Domino Directory.
The publications listed in this section are considered particularly suitable for a more detailed
discussion of the topics covered in this book.
IBM Redbooks
For information about ordering these publications, see “How to get Redbooks” on page 224.
Note that some of the documents referenced here may be available in softcopy only.
IBM Lotus Domino 6 for iSeries Implementation, SG24-6592
IBM System i IP Telephony Configuring the System i Infrastructure, SG24-7382
Implementing IBM Lotus Domino 7 for i5/OS, SG24-7311
Implementing POWER Linux on IBM System i Platform, SG24-6388
Other publications
These publications are also relevant as further information sources:
i5/OS and related software Install, upgrade, or delete i5/OS and related software,
SC41-5120
IBM Lotus Sametime 8.0 Telephony Conferencing Service Provider Interface (TCSPI)
Implementer Guide, SC23-8704
Installing and Managing Sametime 7.5.1 for i5/OS, SC23-5978
IP Conferencing Module Administration Guide
http://support.3com.com/infodeli/tools/vcx/71/IPCM_7.1_Admin_Guide.pdf
Online resources
These Web sites are also relevant as further information sources:
3Com IP Telephony for IBM System i documentation
http://csoweb4.3com.com/iseries/vcx_doc.cfm
IBM Integrated Domino Fax for i5/OS
http://www.ibm.com/systems/i/software/domino/related/fxd/
Cygwin
http://www.cygwin.com
IBM Integrated Domino Fax for i5/OS
http://www.ibm.com/servers/eserver/iseries/domino/related/fxd/
3Com Open Network
http://open.3com.com
Index 227
SDK User’s Guide 164 unique identifier (UID) 156
service-oriented architecture (SOA) 171
setup checklists 7
sizing guidelines 2 V
SMTP services 124 VCX directory 26
SMTP session log file 160 change to phone extension 51
SOA (service-oriented architecture) 171 VCX IP Telephony Web Services SDK for IBM System i
soapUI program 171 164
software requirements 5 documentation 166
Start Domino Server (STRDOMSVR) command 30, 120 Domino Designer 176
synchronization of e-mail 112, 214 planning 166
System i IP Conferencing 5, 92 sample Java program 170
default passwords 189 soapUI program 171
instant meeting conference 96 testing 170
log files 208 VCX Web Services API 164
Sametime meeting invitation 101 verification
System i IP Messaging click to conference 92
log files 160 Domino integration 155
mailbox configuration 143 Domino integration installation 121
System i IP Telephony 5 Sametime integration with System i IP Telephony 84
adding Domino and SMTP 134 virtual Ethernet 10
default passwords 189 virtual IP interface 10
System i IP Telephony and Messaging server 207 configuration 11
configuration of LDAP synchronization 36 voice mail message 150
default passwords 189 VoIP Designer tool 2
Domino integration 112 voipadmin.log file 208
Sametime integration 56 voipuser.log file 208
System Planning Guide 2
W
T Web service 164
TCP/IP port conflicts 124 consumer 176
TCPIP_TcpIpAddress 128 Web Services API JAR files 179
TCSPI (Telephony Service Provider Interface) 58 definition language XML file 169
configuration 65 design element 176
enablement on the Sametime server 68 Web Service Definition Language (WSDL) 164
reconfiguration 70 Web service-enabled Java script library with WSDL 177
telephony presence 56, 85 WinSCP tool 45, 207
Telephony Service Provider Interface (TCSPI) 58 Work with Domino Console (WRKDOMCSL) command
configuration 65 122, 130
enablement on the Sametime server 68 Work with Domino Server (WRKDOMSVR) command 30
installation 60 Workload Estimator 2
reconfiguration 70 WSDL (Web Service Definition Language) 164
terminal emulator for the X Window System (xterm) 134 WSSecurity.jar 170
testing the SDK toolkit 170
tomcat.log file 208 X
toolkit 164 xterm 134
troubleshooting
Domino integration 160
LDAP synchronization 45
phone extension problems 50
Sametime integration 106
unified inbox 160
U
UID (unique identifier) 156
ums_cbipi.log 208
unified inbox 20, 112
configuration 124
troubleshooting 160
Receive voice mail, Companies that use IBM Lotus Sametime and Lotus Domino already
have a comprehensive solution for presence awareness, e-mail, instant INTERNATIONAL
fax, and e-mail in a
messaging, and Web conferencing. With the 3Com System i IP TECHNICAL
single unified inbox
Telephony and Integrated Collaboration solution, now Sametime users SUPPORT
can make phone calls by using their IP desk phone and simply clicking ORGANIZATION
Integrate IP a contact within their Sametime contact list. Alternatively, they can
Telephony into receive voice mail, faxes, and e-mail in a single unified inbox as part of
business applications the 3Com IP Telephony Messaging for System i application integrated
with the SDK Toolkit with Domino.
Voice messages are received as attachments that can be opened and BUILDING TECHNICAL
Enable IP Telephony played on a computer by using standard multimedia applications. Faxes INFORMATION BASED ON
are displayed as a graphics attachment. Systems integrators, PRACTICAL EXPERIENCE
in the Sametime
independent software vendors (ISVs), and application developers can
Connect client IBM Redbooks are developed
integrate telephony into their business and collaboration applications by
using the application programming interfaces (APIs) that are available by the IBM International
with the 3Com IP Telephony Integration Software Development Kit (SDK)
Technical Support
Organization. Experts from
or SDK Toolkit for System i. IBM, Customers and Partners
This IBM Redbooks publication is intended for system administrators from around the world create
and field technicians to help you understand and integrate telephony timely technical information
into your collaborative environment. Specifically it shows how to based on realistic scenarios.
configure the Domino server to directly receive voice mail and faxes into Specific recommendations
the Domino inbox. This book includes information about enabling
are provided to help you
implement IT solutions more
telephony into your Sametime Connect clients. In addition, it explains effectively in your
how to synchronize your Domino Directory with the IP Telephony VCX environment.
directory.