DB2 Everyplace Express installation notes for Version 8.1.4

Welcome to the DB2 Everyplace Version 8.1.4 installation notes. These install notes contain information about:

Prerequisites

This section explains the hardware, software, and operating system requirements for DB2 Everyplace Version 8.1.4.

Hardware requirements

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

Software requirements

To use DB2 Everyplace Sync Server, you must have the following software installed:

Operating system requirements

DB2 Everyplace Express Edition runs on the following operating systems:


Preinstallation considerations

Adjusting operating system parameters for Linux

In order for DB2 Everyplace to operate with the highest degree of efficiency, system parameters in DB2 Universal Database need to be adjusted. Failure to do so, can result in unexpected interruptions and the inability to create a new connection to the database on Linux.

For 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=<workstation>:0.0
Where <workstation> is the UNIX workstation where you want to use the Mobile Devices Administration Center.
Note: You also need to export the DISPLAY variable in the shell from which you want to start the DB2 Everyplace Sync Server.

For Linux systems running kernel 2.4 or higher, issue the following commands on the command line as the root user:

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 DB2 UDB Version 7.2 or 8.1 Release Notes for Linux.

Installing the DB2 Everyplace Sync Server

To install DB2 Everyplace Express Edition on a Windows server:

  1. Run the setup program (DB2Everyplace.exe) as an administrator. If you are installing DB2 Everyplace Express Edition from a CD-ROM, DB2 Everyplace Express Setup Wizard will automatically start. If for some reason, it does not start, run DB2Everyplace.exe. The Welcome panel opens.
  2. Click Next to open the Install Notes panel. Select the check box next to Launch the DB2 Everyplace Install Notes if want to view the install notes in your default browser. Click Next to launch the browser and open the License Agreement panel.
  3. In License Agreement panel read the License Agreement and after accepting the License Agreement, click Next to open the destination directory panel.
  4. Type the directory where you would like to install DB2 Everyplace Express or click Browse to select a directory. After selecting the destination directory, click Next. The Select the installation type window opens.
  5. Select the installation setup type:
    • Typical: This setup type will install DB2 Everyplace Express Edition with the most functionality and features using a typical configuration with default values. This is recommended for most users.
    • Custom: Select the features you would like to install on your computer. This is recommended for advanced users who are familiar with DB2 Everyplace.
    Click Next.
  6. If you select Custom:
    1. A panel opens where you can select the features that you want to install. Click Next. The Select install actions panel opens.
    2. Select the check box next to the installation action that you want to enable. You can select both options, but you must select at least one. If you do not select an installation action, you will receive an error. Specify whether you would like the Setup Wizard to install DB2 Everyplace Express on your computer or to generate a response file. A response file is used to record the user responses required during an interactive installation. It can be used for automating installation on other computers. After selecting the appropriate installation actions, click Next. The Select sample actions panel opens.
    3. Select the check box next to the sample action that you want to enable. You can specify whether you would like the Setup Wizard to create the DB2 Everyplace sample databases and Visiting Nurse server sample application and to install a pre-configured Windows client for demonstrating synchronization with the DB2 Everyplace Sync Server. Click Next. The Select Service action panel opens.
    4. Select the check box next if you want the Setup Wizard to start the windows service for DB2 Everyplace Sync Server at the end of the installation. Click Next.
  7. If you select Typical, the DB2 Everyplace Setup Wizard:
    • will not create a response file during the installation
    • creates the DB2 Everyplace sample databases, server sample application, and installs the pre-configured windows client application for demonstrating synchronization
    • starts the windows service for DB2 Everyplace Sync Server at the end of the installation
  8. Informational panels open if you do not have DB2 Universal Database installed on your computer. If you have DB2 Universal Database installed on your computer, proceed to Step 8.
    1. You will be required to specify the directory where you would like to install the embedded version of DB2 UDB Express. Type the name of the directory, or click Browse to select the directory name. After specifying the directory, click Next.
    2. You will be required to specify the user information for the DB2 UDB Database Administration Server. You can either use an existing Administrative user or specify a new user that will be created on your computer. Select the check box in order to use the same authentication information for the DB2 Everyplace Sync Server. Click Next. If you select the check box, proceed to Step 9.
  9. The Specify DB2 UDB logon information panel opens. Type the authentication information that DB2 Everyplace Sync Server will use to logon to the DB2 UDB DAS. After specifying the required information, Click Next.
  10. The Pre-Install summary panel opens which lists the features that will be installed on your computer and the configuration information for the DB2 Everyplace Sync Server. It will also list the configuration information for the embedded Application Server - Express. The Server port and the SSL port listed on this panel is used by the clients to synchronize with the DB2 Everyplace Sync Server. After reading the pre-install summary, click Next.
  11. The Installation begins as the progress bar charts the progress of the installation. During the installation, the installation Setup Wizard:
    • Installs the following:
      • the embedded version of DB2 UDB Express (if DB2 UDB is not installed)
        If the installation is unsuccessful, the Setup Wizard opens the error log and will abort. If the installation of the embedded version of DB2 Express is successful, then the Setup Wizard continues.
      • DB2 Everyplace Express
        During this installation, the files for the selected setup type and features will be copied into the destination directory that was specified previously.
      • the embedded version of the Application Server - Express
    • Performs post-installation configuration tasks, which include:
      • updates the classpath for the Mobile Devices Administration Center (if you are using DB2 Universal Database Version 8)
      • creates the DB2 Everyplace Sync Server control database
      • creates the DB2 Everyplace sample databases
      • creates the server sample application
      • installs the pre-configured Windows client
    • Starts the Windows Service for the DB2 Everyplace Sync Server.
    • Opens the post-install summary panel. This panel contains instructions for the post-install verification. After reading the information, click Finish

To install DB2 Everyplace Express on a Linux server:

  1. Run the setup program (DB2Everyplace.bin) as the root user. The Welcome panel opens.
  2. Click Next to open the Install Notes panel. Select the check box next to Launch the DB2 Everyplace Install Notes if want to view the install notes in your default browser. Click Next to launch the browser and open the License Agreement panel.
  3. In License Agreement panel read the License Agreement and after accepting the License Agreement, click Next to open the destination directory panel.
  4. Select the installation setup type:
    • Typical: This setup type will install DB2 Everyplace Express Edition with the most functionality and features using a typical configuration with default values. This is recommended for most users.
    • Custom: Select the features you would like to install on your computer. This is recommended for advanced users who are familiar with DB2 Everyplace.
    Click Next.
  5. If you select Custom:
    1. A panel opens where you can select the features that you want to install. Click Next. The Select install actions panel opens.
    2. Select the check box next to the installation action that you want to enable. You can select both options, but you must select at least one. If you do not select an installation action, you will receive an error. Specify whether you would like the Setup Wizard to install DB2 Everyplace Express on your computer or to generate a response file. A response file is used to record the user responses required during an interactive installation. It can be used for automating installation on other computers. After selecting the appropriate installation actions, click Next. The Select UNIX post install actions panel opens.
    3. Select the check box next to the post install actions that you want to enable. You can specify whether you would like the Setup Wizard to create the DB2 Everyplace Sync Server instance, to create the DB2 Everyplace sample databases and Visiting Nurse server sample application, and to install a pre-configured Linux client for demonstrating synchronization with the DB2 Everyplace Sync Server.Click Next.
  6. If you select Typical, the DB2 Everyplace Setup Wizard:
    • will not create a response file during the installation
    • creates the DB2 Everyplace Sync Server instance, creates the DB2 Everyplace sample databases, the server sample application, and installs the pre-configured windows client application for demonstrating synchronization.
  7. Informational panels open if you do not have DB2 Universal Database installed on your computer. If you have DB2 Universal Database installed on your computer, proceed to Step 6.
    1. You will be required to specify the user information for the DB2 Database Administration Server instance. Type the name of the user, the password, the name of the primary group and the user's home directory. Click Next.
    2. You will be required to specify the user information for the DB2 instance owner. Type the name of the user, the password, the name of the primary group and the user's home directory. Click Next.
    3. You will be required to specify the user information for the DB2 fenced user. Type the name of the user, the password, the name of the primary group and the user's home directory. Click Next.
  8. The Specify DB2 Everyplace Sync Server instance information panel opens. Type the user name, password, and the locale for the DB2 Everyplace Sync Server instance. After specifying the required information, Click Next.
  9. The Pre-Install summary panel opens which lists the features that will be installed on your computer and the configuration information for the DB2 Everyplace Sync Server. It will also list the configuration information for the embedded Application Server - Express. The Server port and the SSL port listed on this panel is used by the clients to synchronize with the DB2 Everyplace Sync Server. After reading the pre-install summary, click Next.
  10. The Installation begins as the progress bar charts the progress of the installation. During the installation, the installation Setup Wizard:
    • Installs the following:
      • the embedded version of DB2 Express (if DB2 UDB is not installed)
        If the installation is unsuccessful, the Setup Wizard opens the error log and will abort. If the installation of the embedded version of DB2 Express is successful, then the Setup Wizard continues.
      • DB2 Everyplace Express
        During this installation, the files for the selected setup type and features will be copied into the destination directory that was specified previously.
    • Performs post-installation configuration tasks, which include:
      • creates the DB2 Everyplace Sync Server instance
      • creates the DB2 Everyplace sample databases
      • creates the server sample application
      • installs the pre-configured Linux client
    • Opens the post-install summary panel. This panel contains instructions for the post-install verification. After reading the information, click Finish

Response file installation instructions

To install DB2 Everyplace Express using a response file on a Windows server:

Use the following command: DB2Everyplace.exe -silent -options <response file name>

This example includes the available response file settings:

# Install location for DB2 Everyplace Express
-P installLocation=C:\Program Files\IBM\DB2Everyplace

# Install location for the embedded version of DB2 Universal Database
-W DB2eConfigProps.db2Path=C:\Program Files\IBM\SQLLIB

# Authentication information for the DB2 Database Administration Server
-W DB2eConfigProps.db2Username=db2admin
-W DB2eConfigProps.db2Password=db2admin

# Authentication information for DB2 Everyplace Sync Server
-W DB2eConfigProps.db2eUsername=db2admin
-W DB2eConfigProps.db2ePassword=db2admin

# Option to configure windows client for synchronization demonstration
-W DB2eConfigProps.createWin32Client=true

# Option to create sample database and server sample application
-W DB2eConfigProps.createSample=true

# Option to start windows service for DB2 Everyplace Sync Server at the end of installation
-W DB2eConfigProps.startWindowsService=true

To install DB2 Everyplace Express using a response file on a Linux server:

Use the following command: DB2Everyplace.bin -silent -options <response file name>

# User information for the DB2 Database Administration Server
-W DB2eConfigProps.dasInstance=dasusr1
-W DB2eConfigProps.dasInstanceGroup=dasadm1
-W DB2eConfigProps.dasInstanceHome=/home/dasusr1
-W DB2eConfigProps.dasInstancePassword=db2esync

# User information for the DB2 instance owner
-W DB2eConfigProps.db2Instance=db2inst2
-W DB2eConfigProps.db2InstanceGroup=db2grp1
-W DB2eConfigProps.db2InstanceHome=/home/db2inst2
-W DB2eConfigProps.db2InstancePassword=db2esync

# User information for the fenced user
-W DB2eConfigProps.fenceInstance=db2fenc1
-W DB2eConfigProps.fenceInstanceGroup=db2fgrp1
-W DB2eConfigProps.fenceInstanceHome=/home/db2fenc1
-W DB2eConfigProps.fenceInstancePassword=db2esync

# Option to create DB2 Everyplace Sync Server instance
-W DB2eConfigProps.createDB2eInstance=true
-W DB2eConfigProps.db2eInstance=db2inst2
-W DB2eConfigProps.db2eInstancePassword=db2esync
-W DB2eConfigProps.db2eInstanceLocale=en_US

# Option to create sample database and server sample application
-W DB2eConfigProps.createSample=true

#Option to configure Linux client for synchronization demonstration
-W DB2eConfigProps.createLinuxClient=true

Post-install verification

To verify the installation on a Windows server:

1. To verify that the DB2 Everyplace Sync Server is started successfully on your computer, type the following URL in your browser window

http://127.0.0.1:<port>/db2e/db2erdb

Replace the port with the server port listed in the post-install summary panel. You will receive a message similar to DB2e SyncServer (Fri Sep 19 07:47:34 PDT 2003) specifying that the server was started successfully along with the date and the time it was started.

2. To synchronize with the DB2 Everyplace Sync Server that is installed on your computer using the pre-configured Windows client, follow these instructions:

a. Open a command window and change the directory to %DSYINSTDIR%\Server\sample\democlient.

b. Execute goSample.bat. This batch file performs a synchronization operation with the DB2 Everyplace Sync Server and displays a message indicating whether it was successful or not.

c. In order to query and update the tables that were synchorinzed to the pre-configured Windows client:

d. After changing the data on the client, you must synchronize your changes to the source database by executing goSample.bat again.

e. Use the DB2 Command Center in order to query the source database to ensure that the changes have been made to the source tables.

3. In order to stop the windows service for DB2 Everyplace Sync Server, use the services menu from the Control Panel. The name of the service created by the Setup Wizard for DB2 Everyplace Sync Server is IBM WebSphere Application Server V5 - IBMDB2eServer. You can also use the shortcuts from the start menu to start and stop DB2 Everyplace Sync Server.

4. In order to start Mobile Devices Administration Center, use the shortcut from the start menu. Alternately, you can also change directory to %DSYINSTDIR%\Server\bin and use dsyadmin.bat.

To create subscriptions and other synchronization objects in the Mobile Devices Administratyion Center, refer to the IBM DB2 Everyplace Sync Server Administration Guide, Chapter 4. "Mobiles Devices Administration Center and sybchronization objects" and Chapter 5. "Using the Mobile Devices Administration Center".

To create subscriptions and other synchronization objects using the XML Scripting tool, refer to the IBM DB2 Everyplace Sync Server Administration Guide, Chapter 6. "The XML Scripting tool".

To install DB2 Everyplace on the mobile devices, refer to the IBM DB2 Everyplace Installation and User's Guide, Chapter 2, "Installing DB2 Everyplace on mobile devices".

Note: In order to access the DB2 Everyplace library, use the shortcuts located in Start --> Programs --> IBM DB2 Everyplace --> Information. Alternatively, the DB2 Everyplace documentation is installed in %DSYINSTDIR%\doc\<lang> directory. Replace <lang> with the locale of the DB2 Everyplace Express installation.

To verify the installation on a Linux server:

Note:
  1. On Linux, you need to be logged in as the DB2 Everyplace Sync Server instance in order to perform any post-install verification.
  2. The DISPLAY variable must be exported to a valid display prior to starting the Mobile Devices Administration Center and the DB2 Everyplace Sync Server.

1. Start the DB2 Everyplace Sync Server for the DB2 Everyplace instance created by the Setup Wizard. Open a new shell and change the directory to $DSYINSTDIR/Server/bin and run dsysync.sh. You will receive a notification when the server is started.

2. To verify that the DB2 Everyplace Sync Server is started successfully on your computer, type the following URL in your browser window:

http://127.0.0.1:<port>/db2e/db2erdb

Replace <port> with the server port listed in the post-install summary panel for the DB2 Everyplace Sync Server instance created by the Setup Wizard. You will receive a message similar to DB2e SyncServer (Fri Sep 19 07:47:34 PDT 2003) specifying that the server was started successfully along with the date and the time it was started.

3. To synchronize with the DB2 Everyplace Sync Server that is installed on your computer using the pre-configured Linux client, follow these instructions:

a. Login as the DB2 Everyplace Sync Server instance created by the Setup Wizard and change the directory to $DSYINSTDIR/Server/sample/democlient.

b. Execute goSample.sh. This shell script performs a synchronization operation with the DB2 Everyplace Sync Server and displays a message indicating whether it was successful or not.

c. In order to query and update the tables that were synchorinzed to the pre-configured Linux client:

d. After changing the data on the client, you must synchronize your changes to the source database by executing goSample.sh again.

e. Use the DB2 Command Center in order to query the source database to ensure that the changes have been made to the source tables.

4. To start the Mobile Devices Administration Center, change directory to $DSYINSTDIR/Server/bin and execute dsyadmin.sh.
Note: You must start the DB2 JDBC Applet Server before starting Mobile Device Administration Center. This can be accomplished by executing db2jstrt. The default port for the DB2 JDBC Applet Server is 6789. In case port 6789 is already taken by another process, you must provide a different port as an optional parameter to db2jstrt. In case, you start the DB2 JDBC Applet Server on a port other than 6789, you must provide that port as a parameter to dsyadmin.sh. The DB2 JDBC Applet Server needs to be restarted every time the machine is rebooted.

5. To stop the DB2 Everyplace Sync Server, change the directory to $DSYINSTDIR/Server/bin and execute dsysyncstop.sh. You will receive a notification when the server is stopped.

To create subscriptions and other synchronization objects in the Mobile Devices Administratyion Center, refer to the IBM DB2 Everyplace Sync Server Administration Guide, Chapter 4. "Mobiles Devices Administration Center and sybchronization objects" and Chapter 5. "Using the Mobile Devices Administration Center".

To create subscriptions and other synchronization objects using the XML Scripting tool, refer to the IBM DB2 Everyplace Sync Server Administration Guide, Chapter 6. "The XML Scripting tool".

To install DB2 Everyplace on the mobile devices, refer to the "IBM DB2 Everyplace Installation and User's Guide", Chapter 2, Installing DB2 Everyplace on mobile devices.

Note: The DB2 Everyplace documentation is installed in $DSYINSTDIR/doc/<lang> directory. Replace <lang> with the locale of the DB2 Everyplace Sync Server instance.

Post installation considerations

Creating a DB2 Everyplace instance on Linux

If you did not create a DB2 Everyplace Sync Server instance during installation or you would like to create additional instances outside of the installation process, use the dsyicreate.sh command. Note: A DB2 Everyplace instance must be a DB2 Universal Database instance as well. Therefore, only user IDs which are DB2 instance owners can host a DB2 Everyplace instance.

To create a DB2 Everyplace instance, use the dsyicreate.sh command located in the instance directory of the root installation directory
(/opt/DB2Everyplace81 on Linux. Execute the dsyicreate.sh command as the root user. Execute dsyicreate.sh to display the list of parameters required to create a DB2 Everyplace Sync Server instance.

Uninstalling DB2 Everyplace Express Edition

This section explains how to uninstall DB2 Everyplace Express Edition on windows and Linux platforms.

To Uninstall DB2 Everyplace Express on a Windows server:

Note: It is highly recommended that you stop the Windows Service for the DB2 Everyplace Sync Server prior to uninstalling DB2 Everyplace Express. The Uninstall Setup Wizard will also uninstall the embedded version of DB2 UDB Express. You must drop all the databases created in the local system catalog prior to uninstalling DB2 Everyplace Express.

1. Start the Uninstall Setup Wizard either by using the Add/Remove Programs or by double clicking DB2EveryplaceUninstall.exe located in %DSYINSTDIR%\Uninstaller directory. You must run this as an administrator.

2. Follow the instructions on the screen to uninstall DB2 Everyplace Express.

3. DB2 Everyplace Uninstall Setup Wizard will attempt to stop the Windows Service for the DB2 Everyplace Sync Server prior to removing it. In case of any errors, the error information will be logged into uninstall.log.

To Uninstall DB2 Everyplace Express Edition on a Linux server:

Note:It is highly recommended that you stop the servers running under the DB2 Everyplace Sync Server instances prior to uninstalling the DB2 Everyplace Express. The Uninstall Setup Wizard will also uninstall the embedded version of DB2 UDB Express. You must drop the DB2 UDB DAS instance, DB2 UDB Fence user, all DB2 UDB instances and the databases created in the local system catalog prior to uninstalling the DB2 Everyplace Express.

1. Start the Uninstall Setup Wizard as the root user by executing DB2EveryplaceUninstall.bin located in /opt/DB2Everyplace81/Uninstaller directory.

2. Follow the instructions on the screen to uninstall DB2 Everyplace Express.

3. DB2 Everyplace Uninstall Setup Wizard will attempt to stop the servers running under the DB2 Everyplace Sync Server instances prior to dropping them. In case of any errors, the error information will be logged into uninstall.log.