WebSphere Everyplace Synchronization Server Version 5.0.0.1 Interim Fix
4 README
Last updated: March 10, 2005
This document contains information for Everyplace Synchronization
Server
Version 5.0.0.1 Interim Fix 4.
This Readme includes the following information:
What's included
Issues addressed in Interim Fix 4 include:
- Duplicate calendar entries on Nokia 9500 device after
refresh calendar sync
PK01056 - FILTERED PIM DATA THAT IS SUBSEQUENTLY DELETED ON
THE BACKEND SERVER CAN CAUSE A SLOW SYNC
PK00992 - Sync fails with error 500 on client and SQL0803 on server
PK00816 - WHEN SYNCING AN ACCEPTED INVITATION EMAIL FROM DEVICE TO
SERVER, A SYNCML 510 SERVER ERROR IS RECEIVED
PQ97617 - NO PROFILE FOUND IF DN USED AT EXTID AND USER
LINKS
TO ADMIN
PQ98603 - ALARMS DO NOT SYNC WITH DOMINO FOR SOME EVENTS
PQ98553 - LARGE EMAIL OR CALENDAR SYNC DOES NOT COMPLETE
Note: To further improve upon the performance gains
provided
via PQ98553, the following Best Practices should be considered when
setting
relative date filters.
Best practices: Improving sync times when setting relative
date
filters
When setting filters on the server, keep in mind that the
Synchronization
engine and database must keep track of all "known" PIM data. All
"known"
PIM data is everything on your backend server folder minus records that
were filtered out by the "Initial Synchronization configuration"
filter.
For example, if your "Initial Synchronization configuration"
filter
is set to "All Available Data", then it is everything on your backend
PIM
server. If it is set to 3 days, then the known PIM data will be the
last
3 days of data from the time of the very first sync plus everything
that
has been added since that time.
If you set a relative date filter, then each time the date
changes,
the "known" records stored in the sync database must be evaluated to
determine
if an add/modify/delete for each record should take place.
If you use a relative date filter and you want to reduce your
synchronization
times, then reducing the amount of data that is "known" to the sync
database
is the key. Even if you set an "Initial Synchronization configuration"
filter that is small, eventually the "known" data could build up to
several
thousand records over time if you do not delete or move PIM data to a
folder
that is not synchronized.
Return to top
Installing the Interim Fix
Use the WebSphere Everyplace Access update installer to install the
Everyplace
Sychronization Server interim fix files (ESS_EFIX_5001_IF4.jar). You
must
run the update installer for every installation of Everyplace
Synchronization
Server. The update installer will create a backup of your configuration
in case you need to remove the Interim Fix later.
Prerequisites and corequisites
Before you install this Interim Fix, verify that you have installed
WebSphere Everyplace Access Version 5.0 Interim Fix 1 or higher on the
computer (or computers) where you plan to install Interim Fix 4.
Before you install this Interim Fix, verify that you have enough
disk
space:
- 30 MB disk space for the ZIP file and the extracted files.
- 20 MB of disk space in the ess_home directory, such as /usr/WebSphere/IBMSyncServer
or C:\Program Files\WebSphere\IBMSyncServer
If the Everyplace Synchronization Server server components have been
installed
and configured on different computers (or multiple computers such as in
a clustered environment), you must install and configure the Interim
Fix
on each computer. Interim Fix 4 does not need to be installed on the
Database
server.
To install the Interim Fix:
On the computer (or computers) where the Everyplace Synchronization
Server server component is installed, do the following to install the
Interim
Fix:
- AIX only: Open a command prompt and change to the WEA_updater
directory.
(You might have already performed this step when applying another fix
pack or interim fix,
in which case you can skip this step.) Use the following command to
change
the file permissions of the updateWEA.sh file:
chmod +x updateWEA.sh - Set the WAS_HOME environment
variable. Each time you open a new
command
prompt, you need to set the WAS_HOME environment, so if you are
performing
these steps on multiple computers, remember to set the WAS_HOME
variable.
- Open a command prompt window.
- Change directory to the was_home/bin directory, where was_home
is the installation directory of the WebSphere Application Server on
the
computer
- Issue the appropriate command:
Windows:
setupCmdLine.bat
AIX:
. ./setupCmdLine.sh
Note: When running this command in an AIX shell, be sure
to use
the syntax " . ./setupCmdLine.sh ". If you do not precede the command
with
the period and space, the Java environment will not be properly set for
the active shell.
- Stop the Everyplace Synchronization Server and the Everyplace
Synchronization
enterprise application.
Windows:
Stop Synchronization Server and the Everyplace Synchronization
enterprise
application from the Windows Start Menu: Start > Programs
> IBM WebSphere > Everyplace Synchronization Server
> Stop
server
AIX:
Stop Synchronization Server by running the following command from the /usr/WebSphere/IBMSyncServer/caf/bin
directory:
./esscmd shutdown
Stop the Everyplace Synchronization enterprise application by
running
the appropriate command from the WebSphere/AppServer/bin
directory:
./stopServer.sh Everyplace_Synchronization -user was_admin_userid
-password was_admin_password
- Change to the update directory, for example:
Windows:
cd C:\Program Files\WebSphere\WEA_updater
AIX:
cd /usr/WebSphere/WEA_updater
- Ensure that the values in the weaconfig.properties file are
correct for
your environment. If these values are not set or are incorrect, the
Interim
Fix installation will fail.
- Run the update installer to apply the Interim Fix. Note: The
command
shown below might span multiple lines for clarity, but the command
begins
with updateWEA and should be entered on a single line.
Also, in the example provided, the Interim Fix file
ESS_EFIX_5001_IF4.jar needs to be in the <WebSphere_home>\WEA_updater
directory since that is the -fixDir in the example.
Windows:
updateWEA -fix -installDir "ess_home" -fixDir "C:\Program
Files\WebSphere\WEA_updater" -install -fixes ESS_EFIX_5001_IF4
-configProperties
weaconfig.properties
Where ess_home represents the full path to the
installation
directory of Everyplace Synchronization Server. For example:
updateWEA -fix -installDir "C:\Program
Files\WebSphere\IBMSyncServer"
-fixDir "C:\Program Files\WebSphere\WEA_updater" -install -fixes
ESS_EFIX_5001_IF4
-configProperties weaconfig.properties
AIX:
./updateWEA.sh -fix -installDir "ess_home" -fixDir
"/usr/WebSphere/WEA_updater"
-install -fixes ESS_EFIX_5001_IF4 -configProperties weaconfig.properties
Where ess_home represents the full path to the
installation
directory of Everyplace Synchronization Server. For example:
./updateWEA.sh -fix -installDir "/usr/WebSphere/IBMSyncServer"
-fixDir "/usr/WebSphere/WEA_updater" -install -fixes ESS_EFIX_5001_IF4
-configProperties weaconfig.properties
- Ensure that WebSphere Portal and WebSphere Application servers
are running.
Windows:
startServer.bat server1 -user was_admin_userid -password was_admin_password
startServer.bat WebSphere_Portal -user was_admin_userid
-password was_admin_password
AIX:
./startServer.sh server1 -user was_admin_userid -password
was_admin_password
./startServer.sh WebSphere_Portal -user was_admin_userid
-password was_admin_password
Verifying the version of Everyplace
Synchronization
Server
After you have applied the Everyplace Synchronization Server Interim
Fix,
you can verify the version using the update tool.
- Set the WAS_HOME environment variable.
- Set the WEA_PRODUCT_HOME environment variable using the following
command,
where ess_home is the installation directory of
Everyplace
Synchronization Server:
Note: When providing the path for the WEA_PRODUCT_HOME
environment
variable, you should not place quotes around the path.
Windows:
set WEA_PRODUCT_HOME=ess_home
AIX:
export WEA_PRODUCT_HOME=/ess_home
- Run the following command to display the current version of
Everyplace
Synchronization Server:
Windows:
WEAVersionInfo.bat -fixes
AIX:
./WEAVersionInfo.sh -fixes
- Look for the Installed Fix section of the information that is
printed to
the screen. Verify that the fix ESS_EFIX_5001_IF4 is displayed.
Return to top
Configuring the Portal to run as a root
user
Perform the steps in this section only if portal is running on AIX and
you are using Intelligent Notification
Services.
Previous Interim Fixes for Intelligent Notification Services included
steps to configure the portal to run as a non-root user. If you
configured the portal to run as a non-root user, you need to configure
it to run as the root before Configuring
the
Everyplace Synchronization Server Interim Fix . The Everyplace
Synchronization portlets cannot be updated if the portal is running as
a non-root user.
When you apply this interim fix, you have to configure the portal to
run as a root user. Therefore, you need to configure the portal to run
as a root user, apply the interim fix, and then reconfigure the portal to
run as a non-root user.
Be sure to run these commands as the root user.
- Open a browser and login WebSphere Application Server
administrative console using administrative user ID.
- Click Servers > Application Servers
> WebSphere_Portal > Process Definition
> Process Execution to go to the Process Execution page for
WebSphere_Portal.
- Delete the values for the following properties:
| Property |
Value |
| Run As User |
|
| Run As Group |
|
| UMASK |
|
(the fields should no longer contain values)
- Stop the server using the stopserver command. You need to use the
user and password option with the stopserver command. Run this command
from the Application Server bin directory, such as
/usr/WebSphere/AppServer/bin.
./stopserver WebSphere_Portal -user username -password password
- Start the server using the startServer command:
./startServer WebSphere_Portal
Preparation steps if the WebSphere Portal Server
is configured as part of a Network Deployment cell
On the WebSphere Portal computer, edit the cell name in the
wpconfig.properties file, located in the wp_home/config/file
directory, to match the CellName listed in the Network Deployment
console. If the WebSphere Portal Server has been clustered, then you
must do this for every machine on which WebSphere Portal Server is
installed.
Preparation steps if the WebSphere Portal
Server has been clustered
Each WebSphere Portal node must be told the name of the cluster in
order for portlet deployment to work correctly. On each node, modify
the DeploymentService.properties file, located in the wp_home/shared/app/config/services/
directory, and set the wps.appserver.name property to the name of the
cluster you defined.
Note: Each node in the cluster should have the same
synchronization settings to ensure consistency between WebSphere Portal
server configurations. By default, automatic synchronization will occur
between every node when a change is made to the configuration of the
cell, which is checked for updates once per minute.
Return to top
Configuring the Everyplace Synchronization
Server
Interim Fix
After you have installed the Interim Fix and verified the version on
the
computers where you have installed Synchronization Server portlets and
server, you need to configure the Interim Fix:
- On the computer where you have installed the Everyplace
Synchronization
Server administration portlets (the WebSphere Portal server),
performing
the following steps:
- Log in to WebSphere Portal as an administrator
- Click Administration.
- Click Portlets-->Manage Applications.
- Select ESSAdmin.war
- Click Update.
- Click Browse.
- Browse to ess_home/config/templates/wps/ and select the
ESSAdmin.war
file.
- Click Open.
- Click Next.
- Click Install.
- If you are running in a Network Deployment environment, you need
to
both
ensure that the application changes have been synchronized to the node
and activate any portlet application updates:
- Access the Deployment Manager console with a browser
(http://hostname:9090/admin)
- Log in as the administrator
- Expand System Administration and select Nodes.
- Select all nodes in the list except the Deployment Manager node
(or
just
the node that WebSphere Portal Server is installed on) and then click
Synchronize.
- Access Portal Administration with a browser
(http://hostname/wps/portal)
- Log in as Portal (or WebSphere Everyplace Access) administrator
and
click
Administration.
- Click Administration.
- Click Portlets-->Manage Applications.
- Select ESSAdmin.war from the list of Web modules.
- Select Concrete Everyplace Synchronization Serv from the list
of
Portlet
applications belonging to the selected web module.
- Select Activate/Deactivate to set the status of the portlet
application
to Active.
- Run the following command from the ess_home/config
directory on
the computer where you have installed the server components:
- Windows: ESSWASconfig.bat if-config
- AIX: ./ESSWASconfig.sh if-config
- Interim Fix 1 contained instructions for setting
TSS_DUPLICATE_CHECKER
values to "true" in the ess_home/caf/cfg/ESSConfig.xml file in
order
to handle duplicate resolution for contacts and tasks on Nokia 9500 or
Sony-Ericsson P900 devices. As of Interim Fix 4, the code that
handles
duplicate contacts and tasks for interrupted sync's has been enhanced
and
TSS_DUPLICATE_CHECKER values should be set back to "false".
To edit the ess_home/caf/cfg/ESSConfig.xml file, locate the
following lines in the <COMPONENT
COMPONENT_TYPE="TrueSyncServer"> section:
<PROPERTY NAME="TSS_DUPLICATE_CHECKER_CONTACT"
VALUE="true"/>
<PROPERTY NAME="TSS_DUPLICATE_CHECKER_TASK" VALUE="true"/>
Change the values from true to false. For example:
<COMPONENT COMPONENT_TYPE="TrueSyncServer">
. . .
<PROPERTY NAME="TSS_DUPLICATE_CHECKER_CONTACT" VALUE="false"/>
<PROPERTY NAME="TSS_DUPLICATE_CHECKER_TASK" VALUE="false"/>
. . .
</COMPONENT>
Where . . . represents other properties in that component.
Note: You must repeat this manual step each time you run any
configuration
task that updates the ESSConfig.xml file. For example, repeat this step
whenever you run the ESSWASconfig remove-config command followed by the
ESSWASconfig basic-config command.
- Start the Everyplace Synchronization Server and the Everyplace
Synchronization
enterprise application.
- Windows:
Start Synchronization Server and Everyplace Synchronization enterprise
application from the Windows Start Menu: Start-->Programs-->IBM
WebSphere-->Everyplace
Synchronization Server-->Start server - AIX
Start Synchronization Server by running the following command from
the /usr/WebSphere/IBMSyncServer/caf/bin directory:
./esscmd init
Start the Everyplace Synchronization enterprise application by
running
the appropriate command from the WebSphere/AppServer/bin directory:
./startServer.sh Everyplace_Synchronization -user was_admin_userid
-password was_admin_password
- To verify that the correct level of Everyplace Synchronization
Server
has
been configured:
- Log in to WebSphere Portal as an administrator
- Click Administration.
- Click WebSphere Everyplace.
- Click Server Settings.
- Verify that the product version has the following information:
Everyplace Synchronization Server 5.0.0.200503102124
Everyplace Synchronization Server Administrative Portlets 5.0.0.200503102124
Return to top
Reconfigure the portal to run as a non-root
user
Perform the steps in this section only if portal is running on AIX
and you are using Intelligent Notification
Services.
- Log on as root.
- Specify user and group ID values for the Run As User and Run As
Group settings for a server:
- Click Servers > Application Servers
> WebSphere_Portal > Process Definition
> Process Execution to go to the Process Execution page for
WebSphere_Portal.
- Change these values:
| Property |
Value |
| Run As User |
insadmin |
| Run As Group |
insgroup |
| UMASK |
002 |
- Stop the server using the stopserver command. Run this command
from the Application Server bin directory, such as
/usr/WebSphere/AppServer/bin.
stopserver WebSphere_Portal -user username -password password
- As root, use operating system tools to change file permissions.
The following examples assume that the WebSphere Application Server
installation root directory is /usr/WebSphere/AppServer:
chgrp insgroup /usr/WebSphere
chgrp insgroup /usr/WebSphere/AppServer
chgrp -R insgroup /usr/WebSphere/AppServer/config
chgrp -R insgroup /usr/WebSphere/AppServer/logs
chgrp -R insgroup /usr/WebSphere/AppServer/wstemp
chgrp -R insgroup /usr/WebSphere/AppServer/installedApps
chgrp -R insgroup /usr/WebSphere/AppServer/temp
chgrp -R insgroup /usr/WebSphere/AppServer/tranlog
chgrp -R insgroup /usr/WebSphere/AppServer/cloudscape50
chgrp -R insgroup /usr/WebSphere/AppServer/cloudscape51
chgrp -R insgroup /usr/WebSphere/AppServer/bin/DefaultDB
chmod g+w /usr/WebSphere
chmod g+w /usr/WebSphere/AppServer
chmod -R g+w /usr/WebSphere/AppServer/config
chmod -R g+w /usr/WebSphere/AppServer/logs
chmod -R g+w /usr/WebSphere/AppServer/wstemp
chmod -R g+w /usr/WebSphere/AppServer/installedApps
chmod -R g+w /usr/WebSphere/AppServer/temp
chmod -R g+w /usr/WebSphere/AppServer/tranlog
chmod -R g+w /usr/WebSphere/AppServer/cloudscape50
chmod -R g+w /usr/WebSphere/AppServer/cloudscape51
chmod -R g+w /usr/WebSphere/AppServer/bin/DefaultDB
- Run the following commands:
chgrp -R insadmin /usr/WebSphere/PortalServer
chmod -R g+w /usr/WebSphere/PortalServer
chgrp insadmin /usr/WebSphere/AppServer/wpcpaudit.log
chmod g+w /usr/WebSphere/AppServer/wpcpaudit.log
- When starting the server WebSphere_Portal, it must be started
using the user ID insadmin. Also, it is
recommended to logon to the system as root in the ksh environment and
execute the su - insadmin command because
the .profile must be called.
Return to top
Uninstalling the Interim Fix
To uninstall the Everyplace Synchronization Server Interim Fix 4, use
the
Interim Fix installer to uninstall the Interim Fix and then reconfigure
Everyplace Synchronization Server:
- Set the WAS_HOME environment variable.
- Open a command prompt window.
- Change directory to the was_home/bin directory, where was_home
is the installation directory of the WebSphere Application Server on
the
computer
- Issue the appropriate command:
Windows:
setupCmdLine.bat (Windows platforms only)
AIX:
. ./setupCmdLine.sh
Note: When running this command in an AIX shell, be sure
to use
the syntax " . ./setupCmdLine.sh ". If you do not precede the command
with
the period and space, the Java environment will not be properly set for
the active shell.
- Stop Everyplace Synchronization Server and the Everyplace
Synchronization
enterprise application:
- Windows:
Stop Synchronization Server and the Everyplace Synchronization
enterprise
application from the Windows Start Menu: Start-->Programs-->IBM
WebSphere-->Everyplace
Synchronization Server-->Stop server - AIX
Stop Synchronization Server by running the following command from the
/usr/WebSphere/IBMSyncServer/caf/bin directory:
./esscmd shutdown
Stop the Everyplace Synchronization enterprise application by running
the appropriate command from the WebSphere/AppServer/bin directory:
./stopServer.sh Everyplace_Synchronization -user was_admin_userid
-password was_admin_password
- Ensure that all properties in the weaconfig.properties file
(located in
the WEA_updater directory) have the correct values. If these values are
not set or are incorrect, the Interim Fix installation will fail.
- Change to the update directory.
Windows:
cd C:\Program Files\WebSphere\WEA_updater
AIX:
cd /usr/WebSphere/WEA_updater
- Uninstall the Everyplace Synchronization Server Interim Fix 4
files using
the update installer. If you receive a message that indicates the
WAS_HOME
is not set, the Java environment might not be properly set. Run the
following
command to remove the Interim Fix.
updateWEA.bat|sh -installDir "ess_home" -fix -uninstall
-configProperties weaconfig.properties -fixes ESS_EFIX_5001_IF4
-fixDetails
Where "ess_home" is the full path to the
directory where
Everyplace Synchronization Server is installed. For example:
Windows:
updateWEA.bat -installDir "C:\Program
Files\WebSphere\IBMSyncServer"
-fix -uninstall -configProperties weaconfig.properties -fixes
ESS_EFIX_5001_IF4
-fixDetails
AIX:
./updateWEA.sh -installDir "/usr/WebSphere/IBMSyncServer" -fix
-uninstall -configProperties weaconfig.properties -fixes
ESS_EFIX_5001_IF4
-fixDetails
- If you have a Lotus Domino content adapter configured, you must
run the
following command from the ess_home/config directory on the
computer
where you have installed and configured the server components:
Important: The custom mapping template files are located
in the esm_home\NotesData\esm\custom directory. If you
have made changes to any of the custom mapping template files, back
them
up to a temporary directory before running this command.
- Windows: ESSWASconfig.bat ess-server-notes-copy
- AIX: ./ESSWASconfig.sh ess-server-notes-copy
After you have run the command, be sure to restore any custom mapping
files
that you backed up prior to running ESSWASconfig
ess-server-notes-copy
to the esm_home\NotesData\esm\custom directory. - Start
the Everyplace Synchronization Server and the Everyplace
Synchronization
enterprise application.
- Windows:
Start Synchronization Server and Everyplace Synchronization enterprise
application from the Windows Start Menu: Start-->Programs-->IBM
WebSphere-->Everyplace
Synchronization Server-->Start server - AIX
Start Synchronization Server by running the following command from
the /usr/WebSphere/IBMSyncServer/caf/bin directory:
./esscmd init
Start the Everyplace Synchronization enterprise application by
running
the appropriate command from the WebSphere/AppServer/bin directory:
./startServer.sh Everyplace_Synchronization -user was_admin_userid
-password was_admin_password
- Verify the interim fix was removed.
- Change directory to the wea_updater_home/weabin directory,
where wea_updater_home is the installation directory
of
the WebSphere Everyplace Access update tool, such as C:\Program
Files\WebSphere\WEA_updater\weabin
or /usr/WebSphere/WEA_updater/weabin.
- Set the WEA_PRODUCT_HOME environment variable using the
following
command,
where ess_home is the installation directory of
Everyplace
Synchronization Server:
Note: When providing the path for the WEA_PRODUCT_HOME
environment
variable, you should not place quotes around the path.
Windows:
set WEA_PRODUCT_HOME=ess_home
AIX:
export WEA_PRODUCT_HOME=/ess_home
- Run the following command to display the current version of
Everyplace
Synchronization Server:
Windows:
WEAVersionInfo.bat -fixes
AIX:
./WEAVersionInfo.sh -fixes
- Look for the Installed Fix section of the information that is
printed to
the screen. Verify that the fix ESS_EFIX_5001_IF4 is not displayed.
- To uninstall the Synchronization Server portlets to the previous
maintenance
fix level of code, follow the directions in Configuring
the
Portal to run as a root user and do steps 1 and 2 of Configuring
the
Everyplace Synchronization Server Interim Fix 4
Return to top
Trademarks
IBM, WebSphere, and Everyplace are registered trademarks of the IBM
Corporation
in the United States, other countries, or both.
Microsoft, Active Directory, ActiveSync, Exchange, Pocket PC,
Internet
Explorer, Windows, Windows 2003, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
Other company, product, and service names may be trademarks or
service
marks of others.
Return to top
(c) Copyright International Business Machines Corporation 1994,
2005.
All rights reserved.
U.S. Government Users Restricted Rights - Use, duplication or
disclosure
restricted by GSA ADP Schedule Contract with IBM Corp.