*-----------------------------------------------------------* * (C) Copyright IBM Corp. 2002, 2005. All Rights Reserved. * * * * THIS SOFTWARE, INCLUDING DOCUMENTATION, IS SAMPLE CODE * * AND IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * * EXPRESS OR IMPLIED, FOR USE BY LICENSEES OF IBM'S * * WEBSPHERE EVERYPLACE ACCESS PRODUCT. THE CODE IS TO BE * * USED FOR THE PURPOSES OF TESTING, EVALUATING, MONITORING, * * SUPPORTING, AND FOR NO OTHER PURPOSE WITHOUT IBM'S * * PRIOR WRITTEN APPROVAL. * *-----------------------------------------------------------* Sample Utilities for Everyplace Synchronization Server This readme file contains basic information in three areas. These areas are Installation Notes, Brief Utility Descriptions, and Usage or Configuration Notes. ------------------ Installation Notes ------------------ WARNING. THE SAMPLE PROGRAMS CONTAINED WITH THIS PACKAGE SHOULD NOT BE RUN ON THE SAME MACHINE AS THE EVERYPLACE SYNCHRONIZATION SERVER. THIS MAY CAUSE SERIOUS PROBLEMS WITH THE EVERYPLACE SYNCHRONIZATION SERVER. 1. Download the SUforESS.zip file and decompress it on a machine running the Windows(TM) Operating System, Windows 2000 or above. 2. The machine should have Java installed and the java.exe should be found in the System Path. 3. The Lotus Client is needed for several of the sample utilities including LotusPIM, ClearLotus, and MonitorESSserver require this to properly run. 4. If the Lotus Client is required, Lotus Notes 6 or above is required. Lotus Notes should be installed. The Windows environment variable notesdirectory should be set to the value of the directory where Lotus Notes is installed. Some typical values might be C:\Program Files\Lotus\Notes or C:\Lotus\Notes. The proper value depends on where Lotus Notes is installed on one's machine. 5. The Notes.jar should be installed with the Lotus Client. Check that Notes.jar is installed in the directory pointed to be the environment variable notesdirectory described in the previous step. Example: if notesdirectory=C:\Lotus\Notes the Lotus Notes Client should be installed in C:\Lotus\Notes and the file C:\Lotus\Notes\Notes.jar should be present. 6. When executing these samples always run the samples from the directory where they reside. For example if SyncUser.bat is installed in the C:\ssforess directory. It should be started from a Command Prompt from that directory. -------------------------- Brief Utility Descriptions -------------------------- SyncUser - This sample acts like a SyncML Client. This may be used similar to a device. One may synchronize the data on Lotus or Exchange systems through the Everyplace Synchronization Server to the SyncUser client. The synchronized data is stored On the machine from where SyncUser is run. One should keep in Mind that the sample is provided "AS IS" and there is no warranty that SyncUser obeys all protocol that a true SyncML client must obey. PopulateSync - This sample provides the ability to create, modify, or delete data that the SyncUser sample can then synchronize. For example, data created for the "sample user" with PopulateSync may be on the actual Lotus or Exchange System after being synchronized by SyncUser through the Everyplace Synchronization Server. SumSync - This sample gives a brief count on how many PIM data Items, that is the number of items on the Inbox, Calendar, Memo, Contacts, or Tasks folder of the "sample user" supported by SyncUser. ScanSync - SyncUser has contains a debug parameter which may be used to redirect it flows to a file. If such a trace file is collected by running SyncUser with the debug parameter, then ScanSync may be used to reformat the trace to a more easily readable format. WipeSync - This is used to effectively wipe out the data that SyncUser saves when it acts as a "sample user". AlarmClock - May be used in script files to cause scripts to pause for fixed amounts of time. CheckEnv - This sample may be used to check if certain environment variables are set. CheckEnv is typically called from another script that uses environment variables to confirm that the environment variables are set before continuing. ScanSync - SyncUser has contains a debug parameter which may be used to redirect it flows to a file. If such a trace file is collected by running SyncUser with the debug parameter, then ScanSync may be used to reformat the trace to a more easily readable format. SendLotusMail - If the Lotus Client is installed this may be used to create and send mail for the "current user". See Usage or Configuration Notes for more details. LotusPIM - This also requires the Lotus Client. It may be used to generate a variety of data for the actual Lotus User account, including email, calendar data, task data, contacts data, and journal data. See Usage and Configuration for more details. ClearLotus - This also requires the Lotus Client. It may be used to remove data for the Lotus User account. See Usage or Configuration for more details. CheckLotusSetup - This helps check to see that the Lotus Client is properly configured the correct way for such programs as LotusPIM to run as intended. It first checks using CheckEnv that environment variables for lotususer lotuspw and lotusmaildirectory are set. It then calls LotusPIM using these values to test if it functions properly while using these values. CheckSyncSetup - This helps check to see that SyncUser and in fact the IBM Everyplace Synchronization Server are setup properly to Sync. It first checks to see that environment variables such as esshost, essuser, and esspassword, and uses these variables to issue a Sync. MonitorESSserver.bat - This sample uses SyncUser and AlarmClock to monitor the ability of the IBM Sychronization Server to properly sync. It uses environment variables for parameters. CheckLotusSetup and CheckSyncSetup are designed to help check that the required environment variables are set correctly for this to function. It is designed to use SendLotusMail to send notification if a test synchronization run by SyncUser is not successful. SampleSetup - This sample illustrates the environment variables that need to be set prior to running other samples such as CheckLotusSetup, CheckSyncSetup, and MonitorESSserver. ---------------------------- Usage or Configuration Notes ---------------------------- The Everyplace Synchronization Server if configured to support the Domino Adapter do not attempt to run any of the Lotus functions from the same machine. Do not run LotusPIM, ClearLotus, SendLotusMail, or SummaryLotus from the Everyplace Synchronization Server machine. The Sample Utilities for Everyplace Synchronization Server (ESS) should be run on a machine with TCP/IP connectivity. SyncUser has a host= parameter. This parameter points to the Everyplace Synchronization Server that SyncUser is to communicate through. One should be able to ping the host. Example if host=myess.myserver.com then one should be able to ping myess.myserver.com and expect the ping to succeed. If it cannot, then SyncUser will not function either. In order to function properly SyncUser needs a properly configured Everyplace Synchronization Server behind it. The required parameters for SyncUser the host=, userid=, and password=. Where host= userid= password=. The Portal ID specified by the userid= parameter should be a member of an "ESSGROUP" and should have a defined Synchronization Profile. If needed see the product documentation for the IBM Everplace Sychronization Server on how to do this. In most cases to use the Lotus Notes Client to communicate to the Lotus Domino Server, a valid Notes ID file is typically needed. When one uses Notes one typically presents the notes ID password. This same password must be provided to LotusPIM, ClearLotus, or SendNotesMail if these programs are to operate properly. Suppose one wishes to use LotusPIM to populate data. The following parameters must be provided host= userid= password= AND the following configuration should be true as well. The Home/mail server: field as viewed from the Lotus Client should contain the same as is specified with the host= parameter from LotusPIM. The Home/mail server field may be found from the Lotus Notes Client GUI starting from the menubar File ---> Perferences ---> Location Perference and selecting the Servers tab. The userid should represent the "Lotus Shortname" for the user. The Lotus Client typically remembers the last user by saving information in the 'Notes.ini' namely the ID file that was last used to 'Login' to the Lotus Client. The userid= parameter should be the "Lotus Shortname" of this last user to 'Login' the password= parameter must contain the valid password for this user as well. LotusPIM constructs the name of the mail folder that the userid uses. It constructs the name using folder= parameter, the tail= parameter, and the userid= parameter. By default folder=mail/ and tail= is empty. So for example if the shortname is johndoe, then mail folder used would be mail/johndoe.nsf If the actual mail folder is of the form shortname followed by some suffix then the tail parameter may be useful for example if the parameters are userid=janedoe folder=mail4 tail=001 then the mail folder for the actual ID had better be mail4/janedoe001.nsf If the actual mail folder is not of the form folder shortname [option suffix] then the complete path (Relative to the Server) may be specified for example userid=shortone folder=mail77/tallguy.nsf In this case though the shortname of the Lotus User is shortone the actual mail folder needs to be mail77/tallguy.nsf ClearLotus and SummaryLotus should be correctly configured if LotusPIM is configured. The host= userid= and password= parameters have the same meaning as they do with LotusPIM. SendLotusMail requires the same configuration as LotusPIM, plus in addition the Mail file location: field should be correctly defined. The Mail file location field may be found from the Lotus Notes Client GUI starting from the menubar File ---> Perferences ---> Location Perference and selecting the Mail tab.