IBM DB2 Everyplace Express Edition

Installation Notes

Version 8.2
Third Edition (September 2004)

This edition applies to version 8, release 2 of IBM DB2 Everyplace and to all subsequent releases and modifications until otherwise indicated in new editions.

Copyright International Business Machines Corporation 1998, 2004. All rights reserved.
US Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents

DB2 Everyplace Express Edition installation notes for version 8.2
Migrating
Installing
Before you install
Adjusting system parameters for Linux
Installing DB2 Everyplace Express Edition
DB2 Everyplace Express Edition installation requirements
Installing DB2 Everyplace Express Edition on a server
Removing DB2 Everyplace Express Edition
On a mobile device
Supported mobile device processors and operating systems
Installing DB2 Everyplace files on a Linux mobile device
Installing DB2 Everyplace files on a Palm OS device
Installing files on a QNX Neutrino mobile device
Installing files on a Symbian OS Version 7 device
Installing files on a Windows CE device
Installing files on a Windows client
Configuring
Configuring DB2 Everyplace Express Edition
Configuring DB2 Everyplace Express Edition by using the Configuration wizard
Configuring mobile devices
Configuring SSL for DB2 Everyplace client devices
Configuring the DB2 Everyplace ODBC driver
Starting the First Steps launchpad
Troubleshooting
Troubleshooting configuration errors
Testing the Sync Server servlet
Tracing and diagnostics
Data integrity check tool
DB2 Everyplace Update Tool error messages

DB2 Everyplace Express Edition installation notes for version 8.2

Welcome to the DB2 Everyplace Express Edition installation notes for version 8.2. These notes provide information about:

Migrating

If you are migrating from an earlier version of DB2 Everyplace, refer to the migration instructions in the DB2 Everyplace installation and user's guide for version 8.2, available for download at the following location:

http://www.ibm.com/software/data/db2/everyplace/library.html

Installing

Before you install

Adjusting system parameters for Linux

In order for DB2 Everyplace to operate with the highest degree of efficiency, system parameters need to be adjusted. Failure to do so can result in the inability to create a new connection to the database on Linux. It is recommended that the kernel parameters are adjusted.

Note:
Only 32-bit DB2 Universal Database instances are supported.

Modify the login profile to include the following: export DISPLAY=hostname:0.0

Where hostname is the workstation where you want to use the Mobile Devices Administration Center.

  1. For Linux systems running kernel 2.4 or higher, issue the following commands on the command line as the root user:
  2. To execute the commands automatically, edit the file /etc/rc.d/rc.local, and place the above commands at the end of the file. On every subsequent system boot, the values will be set automatically. Additional setting recommendations can be found in the Linux 7.2 Release Notes for the fix pack you are running.

Installing DB2 Everyplace Express Edition

You need to install the DB2 Everyplace Sync Server on a server, and install the DB2 Everyplace mobile database and Sync Client software on each mobile device or emulator that connects to the server. Requirements vary depending on the hardware, software, and operating system of the target server, device, or emulator.

After you install and configure DB2 Everyplace, you can start the First Steps launchpad, which provides links to sample applications and other resources that will help you get started using DB2 Everyplace.

DB2 Everyplace Express Edition installation requirements

Hardware requirements

The exact configuration you need to support your environment with satisfactory response time will vary depending on the size of the objects you are working with and other factors. Individual display response times vary depending on workstation speed, memory, size of objects, and network and server workload. Minimum recommended configurations must be evaluated and adjusted according to your unique requirements. Disk space recommendations below are for the product installation and working space only. The actual hard disk space required varies, depending upon your installation.

To use DB2 Everyplace Express, your system must meet or exceed the following hardware requirements:

Software requirements

The DB2 Everyplace Sync Server requires the following software:

Operating system requirements

DB2 Everyplace Express runs on the following operating systems:

For the DB2 Everyplace Sync Server:
For the DB2 Everyplace Database and Sync Client:

Operating system requirements vary depending on the target device's processor. See Table 4 for more information.

Device considerations and limitations

Supported source databases

Installing DB2 Everyplace Express Edition on a server

Prerequisites:

Windows
Log in as an administrator.
Linux

For all supported operating systems, the server must meet or exceed the requirements specified in DB2 Everyplace Express Edition installation requirements.

To install DB2 Everyplace Express Edition on a server:

Choose one of the following methods:

If you need to change the configuration after installing files, you can use the Configuration wizard to specify parameters interactively, or use the command line configuration tool to configure DB2 Everyplace Express by using that is data specified in a file.

Installing DB2 Everyplace Express Edition by using the Installation wizard

The DB2 Everyplace Express Edition Installation wizard copies files from a source (such as a CD or compressed archive) to a server and configures the installation. You can choose one of the following installation types:

Typical

Copies a predefined set of files to default locations relative to a directory you specify, then configures the installation.

In addition to the target directory, the wizard prompts you for the following information:

(Windows) DB2 Universal Database user ID and password
Provide user ID and password to access a database already installed on the server. This information is required.
(Linux) Sync Server instance name and locale and password
Specify a Sync Server instance name and locale and password. Databases and samples are created or copied using the specified locale. This information is required.
Custom

You specify the files to copy (for example, to support specific mobile devices), and you can specify additional configuration information. A custom installation also allows you to save your specifications in a response file that you can use to automate the installation process on other computers at a later time.

In addition to the information required for a typical installation, the wizard prompts you for the following parameters:

Class path for non-DB2 JDBC drivers
Enter the full path (including drive letter) to JDBC drivers from third parties such as Oracle or Sybase. Use Java CLASSPATH syntax: no spaces, single quotation marks, or double quotation marks are allowed. Use the separator character for your operating system (semicolon for Windows, colon for Linux). This information is not required. If no such drivers are installed on the server, you can leave the field blank.
Message store option
DB2 Everyplace can store messages from client devices in the server's file system or in a DB2 UDB database. The database option is recommended for most installations.
Application server configuration information
Enter a server name, IP address, server port, and SSL port.
(Windows) Start the Windows service for the DB2 Everyplace Sync Server
Specify whether you want to start the windows service for DB2 Everyplace Sync Server at the end of the configuration. Starting the Windows service can take a few minutes.
(Linux) Start the daemon for DB2 Everyplace Sync Server
Specify whether you want to start the daemon for DB2 Everyplace Sync Server at the end of the configuration. Starting the daemon can take a few minutes.

To install DB2 Everyplace Express Edition by using the Installation wizard:

  1. Start the DB2 Everyplace Launchpad

    The procedure for starting the Launchpad varies depending on your operating system and whether you are installing from a CD or an archive (for example, a compressed file downloaded from ibm.com).

    Table 2. Starting the DB2 Everyplace Launchpad from a CD
    Operating system Procedure
    Windows The Launchpad starts automatically when you insert the CD.
    Linux
    1. Mount the CD.
    2. Run dsysetup as the root user.
    Linux for iSeries
    1. Mount the CD.
    2. Run dsysetup as the root user.

    Table 3. Starting the DB2 Everyplace Launchpad from an archive
    Operating system Procedure
    Windows
    1. Unzip the archive file.
    2. Run the DB2EveryplaceExpress82Windows\ dsysetup.exe file.
    Linux
    1. Untar the archive file.
    2. Change the working directory to DB2EveryplaceExpress82Linux
    3. Run ./dsysetup as root.
    Linux for iSeries
    1. Untar the archive file.
    2. Change the working directory to DB2EveryplaceExpress82iLinux
    3. Run ./dsysetup as root.
  2. Click Install to start the Install wizard. You can also read release notes and installation instructions from the launchpad.
  3. Proceed by following the wizard's prompts. DB2 Everyplace files are not copied to your system until you click Next in the Pre-installation Summary page.

After it copies the files to the server, the Installation wizard configures DB2 Everyplace Express Edition. If you need to change the configuration, you can start the Configuration wizard manually. You can also configure the installation by using the command line configuration tool.

Installing DB2 Everyplace Express Edition by using a response file and the command line installation tool

The command line installer can read input from a file called a response file, which can automatically install DB2 Everyplace on multiple systems. A response file is an ASCII text file that contains setup data. The response file can be generated either by performing a custom installation with the DB2 Everyplace Installation wizard or by manual editing.

To install DB2 Everyplace Express Edition by using a response file and the command line installation tool:

  1. Open a command window and navigate to the top level directory of the CD or archive.

    The command line installer, installSilent, is in the top level directory of the CD or archive.

  2. Run the installSilent command.

    Windows
    installSilent.bat full_path_to_response_file
    Linux
    ./installSilent.sh full_path_to_response_file

    A sample response file is provided in the lib directory of the CD or archive.

The following example starts the command line installation tool on Windows and specifies C:\db2eSilent.rsp as the response file.

installSilent.bat C:\db2eSilent.rsp

Removing DB2 Everyplace Express Edition

Use the Uninstall wizard to remove DB2 Everyplace Express Edition from a server.

Prerequisites:

Windows
Linux

To remove DB2 Everyplace Express Edition:

  1. Start the DB2 Everyplace Uninstall wizard
    Windows
    You have two choices:
    • Run the DB2EveryplaceUninstall.exe file, installed by default in the %DSYINSTDIR%\Uninstaller directory.
    • Use the Windows Add/Remove Programs feature.
    Linux
    As root user, run theDB2EveryplaceUninstall.bin file, installed by default in the $DSYPATH/Uninstaller directory.
    Linux for iSeries
    Execute the command java -jar $DSYPATH/Uninstaller/uninstall.jar as the root user. Use IBM JDK 1.3.1 or later to start the Uninstall Wizard.
  2. Proceed by following the wizard's prompts.
  3. When you click Finish, the DB2 Everyplace files are deleted from the server.

On a mobile device

Supported mobile device processors and operating systems

In the following table, supported combinations of mobile device processors and operating systems are marked with an X. Availability of devices and the level of device support may change over time based on device manufacturer's actions. Some devices may go out of support; new devices may be added.

Table 4. Supported mobile device processors and operating systems
Processor / OS ARM ARM v4T Strong ARM x86 XScale WINS MIPS
Palm OS 4.1 X
Palm OS 5.0 X
Palm OS 5.2.1 X X
Windows(R) CE v3 X X
Windows CE v4 X X X X X
Symbian OS 7 X X
Linux(TM) X X X
QNX Neutrino X X
Windows 2000 / XP / 2003 Server X

The design of some devices may limit the DB2(R) Everyplace(R) capabilities that can be used by the device. Not all devices can support all of the functions offered by DB2 Everyplace. IBM(R) cannot guarantee that all devices will work correctly due to differences in manufacturing, configuration and preloaded device software. Some DB2 Everyplace clients for the supported devices are available as downloads rather than being included on the DB2 Everyplace media.

Installing DB2 Everyplace files on a Linux mobile device

Prerequisites:

Prerequisites for installing DB2 Everyplace files on a Linux mobile device vary depending on the device.

Linux mobile devices take various forms. Depending on the type of mobile device that you have, there are several installation options. For example, you could transfer files to your mobile device by using one of the following methods, depending on the type of mobile device and how that mobile device is configured:

The following table lists required run-time libraries for various processors.

Table 5. Required run-time libraries
Processor Library
x86 glibc-2.2.4-13
StrongARM glibc-2.2.5
XScale glibc-2.2.5

To install DB2 Everyplace files on a Linux mobile device:

  1. Install the DB2 Everyplace mobile database files.

    DB2 Everyplace mobile database files for Linux mobile devices are in the %DSYINSTDIR%\Clients\linux\database\ directory, where proc is a processor type, for example, strongarm or x86, and lang represents the language.

    The file names are:

  2. Install the DB2 Everyplace Sync Client files.

    The files are located in %DSYINSTDIR%\clients\linux\sync\proc, where proc is a processor type, for example, strongarm or x86.

    Copy the following library files for the appropriate processor into usr/lib/DB2e/:

    DB2 Sync console is located at %DSYINSTDIR%\Clients\linux\sync\lang\proc\db2sync_console where proc represents a processor type and lang represents the language.

    Note:
    The SSL libraries for Linux are no longer packaged with the sync client in DB2 Everyplace 8.2. Obtain the OpenSSL libraries (libcrypto.so, libssl.so) separately from http://www.openssl.org. DB2 Everyplace 8.2 currently only supports version 0.9.7. Optionally, for Sharp Zaurus devices, install the .ipk file that contains both the database and sync client libraries.
  3. Set the environment variable LD_LIBRARY_PATH to the path where the DB2 Everyplace CLI shared library (libdb2e.so) is installed.

    For example, if the DB2 Everyplace CLI shared library is in the %DSYINSTDIR%\database\x86 directory, append %DSYINSTDIR%\database\x86 to the existing LD_LIBRARY_PATH by using the following statement:

    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/DB2e/database/x86

DB2 Everyplace also includes a development database library for Linux devices. The development library generates trace data in addition to the diagnostic data that release libraries generate. This data helps you troubleshoot problems as you develop and test DB2 Everyplace applications. The development library is located in the directories that end in "Dev". For example, the development library for Linux devices with x86 processors are located in %DSYINSTDIR%\Clients\linux\database\x86Dev. To install this library, follow the procedure described in this topic, but copy the file from the appropriate Dev directory.

Installing DB2 Everyplace files on a Palm OS device

Prerequisites:

  1. On a Windows workstation, install and configure the HotSync connection software that came with the Palm OS device.
  2. Connect the Palm OS mobile device to the Windows workstation. Use the mobile device's documentation to ensure that the mobile device is connected correctly.

Install DB2 Everyplace by transferring files onto your device using one of the following methods, depending on whether you are using a mobile device or an emulator.

Mobile device
On the workstation, use the Install Tool of the HotSync connection software that is included with the Palm OS mobile device to install the files. After you install the files, perform a HotSync function to complete the installation of the DB2 Everyplace files to the Palm OS mobile device.
Emulator
Drag and drop the files into the emulator window. After you install all the files, reset the emulator.

To install DB2 Everyplace files on a Palm OS device:

  1. Install the database engine and supporting files listed in the following table.

    These files are in the %DSYINSTDIR%\Clients directory.

    In the following table, lang is a language code, for example, en_US.

    Table 6. Palm OS database files
    File name Description
    palmos\database\ CryptoPlugin.prc Encryption library
    palmos\database\ DB2eCat.prc DB2 Everyplace database engine
    palmos\database\ DB2eCLI.prc DB2 Everyplace database engine
    palmos\database\ DB2eComp.prc DB2 Everyplace database engine
    palmos\database\ DB2eDMS.prc DB2 Everyplace database engine
    palmos\database\ DB2eRunTime.prc DB2 Everyplace database engine
    palmos\database\ PBSPkcs11.prc Encryption library. Encryption support is available only on Palm OS 4.1 devices or later. The PBSPkcs11.prc file must be installed to use encryption between a Palm OS mobile device and the DB2 Everyplace Sync Server.
    palmos\database\ lang \DB2eCLP\DB2eCLP.prc DB2 Everyplace command line processor
    utilities\ lang \DB2eImport DB2 Everyplace Import tool
  2. Optional: Install the Sync Client files listed in the following table.

    These files are required if you plan to use the DB2 Everyplace sync server. They are in the %DSYINSTDIR%\Clients\palmos\sync\ directory.

    In the following table, lang is a language code, for example, en_US.

    Table 7. Palm OS sync client files
    File name Description
    imsaconfig.prc IBM Sync Configuration adapter
    imsadb2e.prc IBM Sync DB2 Everyplace adapter
    imsafile.prc IBM Sync File adapter
    isyncconf.prc IBM Sync engine
    isyncore.prc IBM Sync engine
    isyncstat.prc IBM Sync statistics
    isyncxpt.prc IBM Sync transport library
    SSLlib.prc IBM Sync SSL library
    wbxmllib.prc IBM Sync WBXML library
    \lang\ db2sync.prc DB2 Sync client GUI
    \lang\ dsyagent.prc IBM Sync Remote Stored Procedure adapter
    \lang\ upgrade\ iUpgrade.prc IBM Sync Auto Deploy

Installing files on a QNX Neutrino mobile device

Prerequisites:

Installation procedures for QNX Neutrino mobile devices vary depending on the device. Options include:

For additional information on transferring files to your device, see the documentation provided with that device. You can also consult the QNX Neutrino Software Developer's Kit (SDK).

  1. Install the DB2 Everyplace mobile database files.

    DB2 Everyplace database files for QNX Neutrino mobile devices are located in the %DSYINSTDIR%\Clients\neutrino\database\ directory.

    In the following list, proc represents a processor type, for example, strongarm or x86. :

    Note:
    This library cannot be used with the J9 JVM.
  2. Install the DB2 Everyplace Sync Client files.

    The files are located in %DSYINSTDIR%\clients\neutrino\sync\proc, where proc represents a processor type, for example, strongarm or x86.

    Copy the following library files for the appropriate processor into usr/lib/DB2e/:

    Note:
    Only QNX Neutrino 6.2 and above support Sync client libraries.
  3. Set the environment variable LD_LIBRARY_PATH to the path where the DB2 Everyplace CLI shared library (libdb2e.so) is installed. For example, if the DB2 Everyplace CLI shared library is stored in %DSYINSTDIR%/database/x86, append %DSYINSTDIR%/database/x86 to your existing LD_LIBRARY_PATH using the following statement:
    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/DB2e/database/x86
  4. Start the mqueue process to enable encryption.
    1. To ensure the mqueue process is running, run the ps command. A list of active processes is displayed on the device.
    2. Verify that mqueue is listed. If not, use the mqueue command to start the process.
      Note:
      If the application terminates unexpectedly after you initialize the encryption library, the library could be corrupted.

DB2 Everyplace also includes a development database library for QNX Neutrino devices. The development library generates trace data in addition to the diagnostic data that release libraries generate. This data helps you troubleshoot problems as you develop and test DB2 Everyplace applications. The development library is located in the directories that end in "Dev". For example, the development library for QNX Neutrino devices with x86 processors are located in %DSYINSTDIR%\Clients\neutrino\database\x86Dev. To install this library, follow the procedure described in this topic, but copy the file from the appropriate Dev directory.

Installing files on a Symbian OS Version 7 device

Prerequisites:

  1. On a Windows workstation, install and configure the connection software that came with the Symbian OS Version 7 mobile device.
  2. Connect the Symbian OS Version 7 mobile device to the workstation. Use the mobile device's documentation to ensure that the mobile device is correctly connected.

To install DB2 Everyplace files on a Symbian OS Version 7 device:

  1. Use the Install Tool from the connection software that is included with the Symbian OS Version 7 mobile device to install the DB2 Everyplace mobile database files listed in the following table. The files are in the %DSYINSTDIR%\Clients\symbian7\database directory.

    In the following table, lang is a language code, for example, en_US.

    Table 8. Symbian OS Version 7 database files
    File name Description
    armi\DB2e.sis DB2 Everyplace database engine
    armi\db2ejdbc.sis DB2 Everyplace JDBC driver
    lang\DB2eCLP\UIQ\DB2eCLP.sis DB2 Everyplace Command Line Processor
    lang\install\UIQ\DB2e_Symbian7.sis DB2 Everyplace package (all the above in a single package)
  2. Install the sync client files. The files are in the %DSYINSTDIR%\Clients\symbian7\sync\lang\proc\ directory, where lang is a language code, for example, en_US and proc is a processor type, for example, wins or arm.
    Table 9. IBM Sync Client files
    File name Description
    DB2Sync.sis DB2 Sync Client
    upgrade\IUpgrade.app IBM Update Tool
    upgrade\IUpgrade.rsc IBM Update Tool

Installing files on a Windows CE device

Prerequisites:

  1. On a Windows workstation, install and configure the Windows CE Services software (also known as ActiveSync) that came with the Windows CE mobile device.
  2. Connect the Windows CE mobile device to the Windows workstation. Use the mobile device's documentation to ensure that the mobile device is connected correctly.
  3. Encryption support for Pocket PC 2000 is available only with the Microsoft High Encryption Pack for Pocket PC V1.0 available fromMicrosoft. High (128-bit) encryption support for Pocket PC 2002 is available with the Pocket PC 2002 SDK under \Windows CE Tools\wce300\Pocket PC 2002\support\EnhancedCrypto. The Microsoft High Encryption Pack for Pocket PC must be installed to use encryption between Windows CE or Pocket PC mobile devices and the DB2 Everyplace Sync Server. High encryption support comes built-in for Pocket PC 2003 devices.

To install the DB2 Everyplace files on a Windows CE device:

  1. Use the Install Tool from the Windows CE Services connection software (or ActiveSync) that is included with the Windows CE device to install the files listed in the following table. These files are in the %DSYINSTDIR%\Clients\wince\database directory.

    In the following table, ver is the Windows CE version, for example, v3 for version 3, or v4 for version 4; and proc is the processor type, for example, ARMRel or X86Rel.

    Table 10. Windows CE database files
    File Name Description
    jdbc\db2ejdbc.jar DB2 Everyplace JDBC driver
    ver\proc\CryptoPlugin.dll DB2 Everyplace database engine for data encryption
    ver\proc\DB2e.dll DB2 Everyplace database engine
    ver\proc\DB2eJDBC.dll DB2 Everyplace JDBC driver
  2. Use the Install Tool from the Windows CE Services connection software (or ActiveSync) that is included with the Windows CE device to install the files listed in the following table.
  3. Optional: If you plan to use the DB2 Everyplace Sync Server, install the files listed in the following table These files are in the %DSYINSTDIR%\Clients\wince\sync\lang\ver\proc directory,

    where ver is the Windows CE version, for example, v3 for version 3, or v4 for version 4;proc is the processor type, for example, ARMRel or X86Rel; and lang is the language code, for example, en_US.

    Sync Client XScale libraries are available only for devices that run Windows CE 4.x. For Windows CE 3.0 (most Pocket PC 2000 and 2002 devices), use Sync Client libraries from ARM. For the DB2 Everyplace mobile database, XScale libraries are available for Windows CE 3 and 4.

    Table 11. Windows CE Sync Client files
    File Name Description
    db2sync.exe IBM Sync Client GUI
    dsyagent.dll IBM Sync Remote Stored Procedure adapter
    imsaconfig.dll IBM Sync Configuration adapter
    imsadb2e.dll IBM Sync DB2 Everyplace adapter
    imsafile.dll IBM Sync File adapter
    isync4j.dll IBM Sync Java interface
    isync4j.jar IBM Sync Java interface
    isyncconf.dll IBM Sync engine
    isyncore.dll IBM Sync engine
    isyncstat.dll IBM Sync client statistics
    isyncxpt.dll IBM Sync transport library
    wbxmllib.dll IBM Sync WBXML library
    upgrade\iUpgrade.exe IBM Sync Auto Deploy
    As an alternative, you can install a CAB file for your processor and software version under, stored in %DSYINSTDIR%\Clients\wince\sync\lang\install that contains the Sync Client libraries listed above.
  4. Perform a sync function to complete the installation of the DB2 Everyplace libraries and application files to the Windows CE mobile device.

    The following table shows where to obtain Sync Client libraries for various emulators:

    Table 12. Sync Client libraries for emulators
    File Name Description
    \Clients\WinCE\sync\lang\v3\X86EMRel Pocket PC 2000 emulator
    \Clients\WinCE\sync\lang\v3\X86Rel Pocket PC 2002/2003 emulator
    \Clients\WinCE\sync\lang\v4\emulatorRel WinCE .NET emulator
    Note:
    Sync client libraries are not supported on the STANDARD SDK emulator that comes with Embedded Visual C++ 4.0. Use the Pocket PC 2003 emulator instead.

DB2 Everyplace also includes a development database library for Windows CE version 3 devices. The development library generates trace data in addition to the diagnostic data that release libraries generate. This data helps you troubleshoot problems as you develop and test DB2 Everyplace applications. The development library is located in the directories that end in "Dev". For example, the development library for Windows CE version 3 devices with x86 processors are located in \Clients\wince\database\wce300\x86Dev. To install this library, follow the procedure described in this topic, but copy the file from the appropriate Dev directory.

Installing files on a Windows client

Prerequisites:

The Microsoft Strong Encryption download (available from Microsoft) for your operating system must be installed to use encryption between Windows clients and the DB2 Everyplace Sync Server.

To install DB2 Everyplace files on a Windows client:

  1. Copy DB2 Everyplace files from your Windows server to a folder on your Windows client.

    DB2 Everyplace files are in the %DSYINSTDIR%\Clients\win32\database directory.

    In the following table, lang represents a language code, for example, en_US.

    Table 13. DB2 Everyplace files
    File name Description
    x86\CryptoPlugin.dll DB2 Everyplace database engine for data encryption
    x86\DB2e.dll DB2 Everyplace database engine
    x86\DB2eJDBC.dll DB2 Everyplace JDBC driver
    x86\DB2eODBC.dll DB2 Everyplace ODBC driver
    jdbc\db2ejdbc.jar DB2 Everyplace JDBC driver
    jdbc\DB2eAppl.class Sample Java application
    jdbc\DB2eJavaCLP.class Command Line Processor written in Java
    lang\DB2eCLP\uicode\DB2eCLP.exe Command Line Processor executable
    x86\ODBCInst.exe Registers the DB2 Everyplace ODBC driver
  2. Optional: If you plan to use the DB2 Everyplace Sync Server, copy the Sync Client files to the same folder as in the previous step.

    The Sync Client files are in the %DSYINSTDIR%\Clients\win32\sync\lang\ directory, where lang is a language code, for example, en_US.

    Table 14. Sync Client files
    File Name Description
    db2sync_console.exe DB2 Sync interface
    dsyagent.dll IBM Remote Stored Procedure adapter
    imsaconfig.dll IBM Sync Configuration adapter
    imsadb2e.dll IBM Sync DB2 Everyplace adapter
    imsafile.dll IBM Sync File adapter
    isync4j.dll IBM Sync Java interface
    isync4j.jar IBM Sync Java interface
    isyncconf.dll IBM Sync engine
    isyncore.dll IBM Sync engine
    isyncstat.dll IBM Sync Client statistics
    isyncxpt.dll IBM Transport library
    wbxmllib.dll IBM Sync WBXML library
  3. Optional: install your own DB2 Everyplace applications in the same folder as in the previous step.

DB2 Everyplace also includes a development database library for Windows devices. The development library generates trace data in addition to the diagnostic data that release libraries generate. This data helps you troubleshoot problems as you develop and test DB2 Everyplace applications. The development library is located in the directories that end in "Dev". For example, the development library for Windows devices with x86 processors are located in %DSYINSTDIR%\Clients\win32\database\x86Dev.

Configuring

Configuring DB2 Everyplace Express Edition

DB2 Everyplace Express Edition provides a wizard and a command line tool you can use to change a DB2 Everyplace configuration.

The topic Troubleshooting configuration errors provides information about errors that might arise when you configure DB2 Everyplace.

Configuring DB2 Everyplace Express Edition by using the Configuration wizard

Prerequisites:

DB2 Everyplace files must be installed before you configure DB2 Everyplace.

(Windows)
Log in as an administrator.
(Linux)
Log in as the root user.

The Configuration wizard prompts you for the following data:

(Windows) DB2 Universal Database user ID and password
Provide user ID and password to access a database already installed on the server. This information is required.
(Linux) Sync Server instance name, password, and locale
Specify a Sync Server instance name, password, and locale. Configuration on Linux creates a DB2 Everyplace Sync Server instance. Databases and samples are also created or copied using the specified locale. This data is required.

To configure DB2 Everyplace Express Edition after you perform a custom installation, the wizard prompts you for additional data:

Class path for non-DB2 JDBC drivers
Enter the full path (including drive letter) to JDBC drivers from third parties such as Oracle or Sybase. Use Java CLASSPATH syntax: no spaces, single quotation marks, or double quotation marks are allowed. Use the separator character for your operating system (semicolon for Windows, colon for Linux). This information is not required. If no such drivers are installed on the server, you can leave the field blank.
Message store option
DB2 Everyplace can store messages from client devices in the server's file system or in a DB2 UDB database. The database option is recommended for most installations.
Application server configuration information
Enter a server name, IP address, server port, and SSL port.
(Windows) Start the Windows service for the DB2 Everyplace Sync Server
Specify whether you want to start the windows service for DB2 Everyplace Sync Server at the end of the configuration. Starting the Windows service can take a few minutes.
(Linux) Start the daemon for DB2 Everyplace Sync Server
Specify whether you want to start the daemon for DB2 Everyplace Sync Server at the end of the configuration. Starting the daemon can take a few minutes.

To configure DB2 Everyplace Express Edition by using the DB2 Everyplace Configuration wizard:

  1. Start the DB2 Everyplace Configuration wizard.
    Windows

    Run the DSYconfig.exe file, installed by default in the %DSYINSTDIR%\config\bin directory.

    You can also use a Start menu shortcut: Start -> Programs -> IBM DB2 Everyplace Express -> Setup Tools -> DB2 Everyplace Configuration Wizard.

    Linux
    As the root user, run the DSYconfig.bin file, installed by default in the $DSYPATH/config/bin directory.
    Linux for iSeries
    As the root user, run the DSYconfig.sh file, installed by default in the $DSYPATH/config/bin directory.
  2. Click Next.
  3. Proceed by following the wizard's prompts.

    DB2 Everyplace is not configured until you click Next in the Pre-configuration Summary panel.

Configuring mobile devices

Topics in this section provide information that will help you configure DB2 Everyplace on mobile devices.

Configuring SSL for DB2 Everyplace client devices

Secure Sockets Layer (SSL) provides added security when synchronizing by encrypting data. To use SSL, you must install a certificate on the client device so that it can verify that it is in communication with the appropriate server. The certificate must be obtained from the public SSL certificate of the HTTP server with which the clients will synchronize data. Refer to the documentation for the server that is providing the SSL service for information about how to obtain and export the certificate in a format that the client can install and use. If you are using the IBM HTTP Server that is installed with the WebSphere Application Server, use the ikeyman tool in the <IHS>\bin directory to export the SSL certificate. If you are using the embedded version of the WebSphere Application server, ikeyman is in the <DSYINSTDIR>\WAS\bin directory. Be sure to export the public certificate.

Windows CE and Symbian devices do not need manual installation of certificates. When synchronizing with these client devices, you only need to specify the address of the SSL server. For example, https://www.syncsample:9558/

To configure SSL for DB2 Everyplace client devices:

Configuring SSL for Linux client devices

Prerequisites:

Linux device clients require the OpenSSL libraries. Download these libraries from http://www.openssl.org and install the libraries before configuring SSL on Linux client devices.

To configure SSL for Linux client devices:

  1. Obtain the certificate file that you want to install on the DB2 Everyplace Sync Client. Use base-64 encoded X.509 format. Tip: You can obtain the certificate by using a web browser and then export it to the needed format. The web site will send it to the client on the first connection.
  2. Copy this file to /usr/share/ss/certs as the root user.
  3. Find out the hash value of the certificate by entering the following command:

    openssl x509 -noout -hash -in ca_certificate file

    where ca_certificate file is the name of the base-64 encoded X.509 certificate file.
  4. Create a symbolic link to the certificate file. The name of the link must be the hash value appended with a ".0". For example:

    ln -s ca_certificate file 9c975d97.0

    where ca_certificate file is the name of the certificate file and 9c975d97 is the hash value obtained from the previous step.
  5. Verify the installation of the certificate by entering the following command:

    openssl verify -CApath /usr/share/ssl/certs /usr/share/ssl/certs/ca_certificate_file

    You will see a message similar to the following if the installation succeeded: /usr/share/ssl/certs/ca_certificate_file: OK

    If you receive an error message, go to http://www.openssl.org/docs/apps/verify.html to look up the error message.

Configuring SSL for Palm OS client devices

Prerequisites:

Download the certificate conversion utility, palmdb.exe, from http://www.ibm.com/support/.

To configure SSL for Palm OS client devices:

  1. Start IBM Key Management (ikeyman), which is included with the IBM HTTP server.
  2. Open a key database file that includes an appropriate certificate.
  3. Select a certificate to extract.

    For a self-signed certificate:

    For a real certificate that is obtained from CA:

  4. Select Binary DER data as the Data type.
  5. Enter cacerts.bin as the certificate file name and save it.
  6. Put the palmdb.exe file in the same directory as cacerts.bin.
  7. Enter palmdb.exe at the command prompt with no arguments. Make sure a file named SSLCaCerts.pdb was created in the same directory as palmdb.exe and cacerts.bin after running the command.
  8. Install SSLCaCerts.pdb on the Palm OS client device using the Palm Desktop
  9. Check SSL enable on the Palm OS client device.

Configuring SSL for Windows client devices

To configure SSL for Windows client devices:

  1. Connect to the SSL server using a web browser using the following address:

    https://server:port/db2e/db2erdb/.

    Note:
    If a window displays telling you that you are viewing pages over a secure connection, click OK. The Security Alert window opens.
  2. Click View Certificate. The Certificate window opens
  3. Click on Install Certificate. The Certificate Import Wizard opens.
  4. Click Next.
  5. Select Automatically select the certificate store based on the type of certificate and click Next.
  6. Click Finish. The Security Warning window opens.
  7. Click Yes. The Certificate Import Wizard window opens confirming a successful import.
  8. Click OK. The Certificate window opens.
  9. Click OK. The Security Alert window opens.
  10. Click Yes to connect to the SSL server. You should see the DB2 Everyplace Sync Server message: DB2e SyncServer (date and time).

Configuring the DB2 Everyplace ODBC driver

Prerequisites:

Open Database Connectivity (ODBC) is an application programming interface for developing programs that are database independent or that access multiple data sources simultaneously. To reduce DB2 Everyplace's footprint, DB2 Everyplace ODBC driver and setup functions are provided in a separate file, DB2eODBC.dll.

The DB2 Everyplace ODBC driver supports the same functions as the DB2 Everyplace CLI interface, and faces the same limitations. It might not meet the requirements of most ODBC GUI tools. One good use of this driver is to write database-independent code without compiling or linking with DB2 Everyplace files. You can also access multiple data sources from different vendors simultaneously.

When you install DB2 Everyplace, the following files are copied to the same directory as DB2e.dll (default location: C:\Program Files\IBM\DB2Everyplace\Clients\win32\database\x86).

To configure the DB2 Everyplace ODBC driver:

  1. Register the DB2 Everyplace ODBC driver with the desktop ODBC manager. From command line, enter odbcinst.exe -i
  2. Add a user data source.
    1. Start the "ODBC Data Sources" program from the Control Panel

      Choose Start -> Settings -> Control Panel -> Administrative Tools -> Data Sources (ODBC)

    2. Click Add in the User DSN panel.
    3. Choose IBM DB2 Everyplace ODBC Driver from the list of drivers in the Create New Data Source window.
    4. Click Finish.
    5. Enter the following in the IBM DB2 Everyplace ODBC Driver configuration panel:
      • Data Source Name: ODBC data source name.
      • Description: A description of the data source.
      • DB2 Everyplace Database Directory: DB2 Everyplace data source name. Example: C:\data\employee\

After you configure the DB2 Everyplace ODBC driver, you can use it to execute the functions provided in the DB2 Everyplace CLI interface, plus the following additional C/C++ function.

SQLGetFunctions()

This function reports whether a specific function is supported, allowing applications to adapt to varying levels of support when connecting to different database servers.

Syntax

SQLRETURN SQLGetFunctions( 
     SQLHDBC ConnectionHandle, 
     SQLUSMALLINT FunctionId, 
     SQLUSMALLINT * SupportedPtr); 

Arguments

ConnectionHandle 
    [Input]

Connection handle.

FunctionId 
    [Input] 

A #define value that identifies the ODBC function of interest:

SupportedPtr 
[Output] 

SupportedPtr can point to a single value or an array of values, depending on the value of FunctionId, as shown in the following table. Arrays returned in SupportedPtr use zero-based indexing

FunctionId SupportedPtr
identifies a single ODBC function Points to a single SQLUSMALLINT value. The value is SQL_TRUE if the specified function is supported by the driver; otherwise, the value is SQL_FALSE.
SQL_API_ODBC3_ALL_FUNCTIONS Points to a SQLSMALLINT array with a number of elements equal to SQL_API_ODBC3_ALL_FUNCTIONS_SIZE. The Driver Manager treats this array as a 4,000-bit bitmap that can be used to determine whether an ODBC 3.x or earlier function is supported.
SQL_API_ALL_FUNCTIONS Points to an SQLUSMALLINT array of 100 elements. The array is indexed by #define values used by FunctionId to identify each ODBC function; some elements of the array are unused and reserved for future use.

An array element's value is SQL_TRUE if it identifies an ODBC 2.x or earlier function supported by the driver. It is SQL_FALSE if it does not identify an ODBC function, or if it identifies an ODBC function that the driver does not support.

Starting the First Steps launchpad

The First Steps launchpad provides links to sample applications and other resources that will help you get started using DB2 Everyplace.

Prerequisites:

Install and configure DB2 Everyplace.

To start the First Steps launchpad:

Run the First Steps command.
(Windows)
There are two ways to run the First Steps command:
(Linux and UNIX)
As the Sync Server instance user, run the dsyfs.sh file in the $DSYPATH/Server/bin directory.

The First Steps launchpad provides buttons linked to resources that will help you get started with DB2 Everyplace. The number of buttons and associated resources varies depending on your operating system and DB2 Everyplace configuration.

Troubleshooting

Troubleshooting configuration errors

This topic provides information that will help you troubleshoot errors that may arise while using the Configuration wizard or the command line configuration tool.

Stop the Sync Server

If you receive an error message due to an incorrect or invalid value for a property in the Configuration wizard or the dsyconfig.properties file, stop the servlet or process for the DB2 Everyplace Sync Server (the default name is IBMDB2eServer) before you run the Configuration wizard or command line configuration tool again.

To stop the Sync Server, open a command window and issue the following command:

Windows
%DSYINSTDIR%\server\bin\dsysyncstop

You can also use a Start menu shortcut:

Enterprise Edition
Start -> Programs -> IBM DB2 Everyplace Enterprise -> Admin tools -> Stop Servlet for Sync Server
Express Edition
Start -> Programs -> IBM DB2 Everyplace Express -> Admin tools -> Stop Servlet for Sync Server

.

Linux
  1. Log in to the desired Sync Server instance (also called a DSY instance).
  2. Run the $DSYINSTDIR\server\bin\dsysyncstop command.

Unconfiguration of embedded Application Server - Express fails

When a Windows service is stopped, files that are locked by that service are not always released immediately. As a result, the DB2 Everyplace configuration tools might be unable to delete certain files and directories, and the unconfiguration process will fail. If this happens, start the unconfiguration process again.

Testing the Sync Server servlet

To ensure that the Sync Server can successfully communicate with clients, make sure that the servlet is running. You do not need to have any clients installed in order to perform a check.

  1. To test the servlet on Windows:
    1. Start the DB2 Everyplace Sync Server.
    2. In a Web browser, go to http://yourhostname.yourdomain:8080/db2e/db2erdb. 8080 is the default HTTP port number. Substitute port 8080 with the correct port number of the DB2 Everyplace Sync Server which is listed in the Post-install summary panel which is displayed at the end of the DB2 Everyplace installation.
  2. To test the servlet on Linux:
    1. Login as the DB2 Everyplace Sync Server instance owner
    2. Open a shell window and change the directory to $DSYINSTDIR/Server/bin
    3. Run dsysync.sh.
    4. In a Web browser, go to http://yourhostname.yourdomain:8080/db2e/db2erdb. 8080 is the default HTTP port number. Substitute port 8080 with the correct port number of the DB2 Everyplace Sync Server which is listed in the Post-install summary panel which is displayed at the end of the DB2 Everyplace installation.
  3. If the servlet is running correctly, it will display the following message: DB2e SyncServer <datetime string>
  4. For the Application Server - Express that ships with DB2 Everyplace, the server log files located in $DSYINSTDIR/Server/logs/servername might contain a message saying that the port is already taken by another program. If you receive this message, change the port number. The default value during installation for the server name is IBMDB2eServer. The default value during installation for the server IP address is 127.0.0.1.
  5. Optional: To change the port number:

Tracing and diagnostics

DB2 Everyplace provides basic error logging facilities for devices that use Linux, QNX Neutrino, or Windows 32-bit operating systems. DB2 Everyplace also provides development libraries that you can install on these devices to generate trace data. This data can help you troubleshoot problems as you develop and test DB2 Everyplace applications.

Tracing

To enable tracing, install development libraries on the mobile device. These libraries are in directories that end in "Dev". For example, the development libraries for Linux devices with x86 processors are located in \Clients\linux\database\x86Dev.

When you use the development libraries to run an application, DB2 Everyplace writes data to a trace file in the database directory, using a file name listed in the following table. If a trace file exists in the database directory, CLI trace information is appended to that file.

Table 15. Tracing and diagnostics file names
Long file name Short file name (8.3 format)
Trace file DSY_DB2eTRACE _trc.DBs
Log file db2ediag.log _diag.DBs
Dump files DB2e_cxxxxx * _cxxxxx.DBs *

* xxxxx is the process identifier (PID) number of the affected process.

Diagnostic data

DB2 Everyplace generates diagnostic data for applications running either release or development libraries. When an application encounters a severe system error (SQLState 58005), DB2 Everyplace logs the error in a log file and captures the system state in a dump file. The previous table lists the file names for log files and dump files. All files are located in the same directory as the database.

Data in the following log files can also help you diagnose problems:

Data integrity check tool

The data integrity check tool reports whether tables and indexes are corrupted. To run this tool, execute the DBCHECK command in the sample CLP application. The command syntax is:

DBCHECK outputfile

The outputfile parameter specifies a text file in the database directory where the tool will write the results.

Note:
This tool is supported on Linux and Windows 32-bit operating systems only.

DB2 Everyplace Update Tool error messages

The table below lists all of the error messages that can be generated by the DB2 Everyplace Update Tool. Table 16 displays the error message and a possible remedy for the problem.

Table 16. Troubleshooting Guide
Error message Possible remedy
Authentication failed (invalid encryption key) - update aborted Verify that the client settings match the user's settings defined in the Mobile Device Administration Center.
File size exceeds available memory Delete any applications or files that are no longer needed on the device and try again.
Internal server error This is an internal error that you need to report to IBM Software Support with the trace file.
Failed to open connection Check your network connection and the SyncServer. Make sure that the host is connected and the server is running.
Failed to establish connection Check your network connection and the SyncServer. Make sure that the host is connected and the server is running.
Failed to send request Try to synchronize again when there is less traffic on the network or try to synchronize from a faster network.
Failed to receive reply Try to synchronize again when there is less traffic on the network or try to synchronize from a faster network.
Timeout while receiving reply Specify a larger timeout value or try to synchronize when there is less traffic on the network.
Failed to receive acknowledge Try to synchronize again when there is less traffic on the network or try to synchronize from a faster network.
Failed to open Net library Verify that the network library exists on the device. Try to reinstall the library.
Failed to resolve hostname Verify that the hostname and the DNS addresses are correct.
Failed to allocate working buffer for transport Delete any applications or files that are no longer needed on the device and try again.
Unknown network error This is an internal error that you need to report to IBM Software Support with the trace file.
Failed to create target file Verify that the target file is not being used by another application. If the target file is being used, unlock it and synchronize again.
No files received for update This is an informational message stating that the server does not have an update for the mobile device.