Installing WebSphere Partner Gateway

When you have met all of the prerequisites noted in the previous sections, you are ready to run the Database Loader and WebSphere Partner Gateway installation wizards. These wizards can be executed directly, or through the LaunchPad. See, LaunchPad for more information.

Note:
The AIX electronic product image tar file cannot be successfully unarchived using the default tar program available on AIX since the image has path lengths of more than 100 characters. However, IBM distributes a tar program that will successfully unarchive the AIX electronic product image tar file. This tar program is available through the AIX Toolbox for Linux Applications at the following location:
http://www-1.ibm.com/servers/aix/products/aixos/linux/download.html

DISPLAY environment variable

The Database Loader and Hub install wizards use the X Windows system on UNIX to display the graphical user interface. The X Windows system requires that the DISPLAY environment variable be exported to the system environment. The following lines set the DISPLAY environment variable to the IP_Address from a Bourne shell:

DISPLAY=IP_Address:0.0

export DISPLAY

Use the syntax appropriate to your shell to set the DISPLAY environment variable.

Note:
Test that the DISPLAY system environment variable and X Windows system are properly configured by running an X client program, such as xclock, from the command line. If the xclock client displays on the X Server window (local or remote), then the wizards should also display properly.

LaunchPad

WebSphere Partner Gateway provides a LaunchPad program to provide one-stop access to the Product Overview, ReadMe File, product documentation, Database Loader, and WebSphere Partner Gateway Installer. Alternatively, you can start the database loader and installation programs using the supplied setup*.* programs. See, Creating the database, and Installing the components using the install wizard.

Note:
Some options on the LaunchPad require a browser to be installed and available in the system path.

The LaunchPad executable file is located in:

{CD_ROM/MEDIA DIR}/LaunchPad.sh

Creating the database

WebSphere Partner Gateway includes an installation wizard to set up the database tables. This wizard, Database Loader, gathers information to create and populate the tables for you. Alternatively, it can save the SQL files it uses to create the tables. You can then use the SQL files to create and populate the tables. Running the SQL files manually allows you to review the database tables before populating them.

Before you begin, verify that your database server is installed, configured correctly, and running.

DBLoader can be run on a machine that does not have the actual database. Oracle/DB2 should be installed on that machine, but the actual database can be on another machine. The DBA needs to do some configuration changes for that, which probably are out of scope of this guide. First you create the database on a remote machine. Then you configure a remote database with oracle/db2 on the machine on which dbloader will be installed, specifying on which machine its running , which port it uses etc. Once this configuration is done, DBLoader can be run as if the database is local. The Oracle/DB2 will automatically take care of the rest. All sql commands against this database will goto the correct machine for processing. The SQLs can be run automatically.

The following procedure describes how to configure the database using the Database Loader GUI. You can also install the Database Loader without using the GUI. See Installing the components using the command line for information.

Note:
Please check the DB2 documentation for specific operating system requirements, such as configuration settings or required product versions.

To set up the database tables:

  1. Log in as the root user.

    Database Loader requires administrator privileges to automatically run the SQL create/change ownership of the tablespaces directories.

  2. From the Database Loader directory, run the setup executable listed in Table 9 specific to your platform:

    cd DBLoader

    Table 9. Platform-specific executables for Installer
    Platform Executable

    Linux

    setupLinux

    AIX

    setupAIX

    Solaris

    setupSunOS

    The Database Loader wizard starts and displays the Welcome window. Click Next.

  3. In the Software License Agreement window, read the Software License Agreement. If you agree to the terms in the agreement, select I accept the terms of the license agreement. Click Next.
  4. In the Directory Name window, type the path and directory name of the directory that the Database Loader will use when it sets up the database. IBM recommends that you create a new directory location, or select an empty one. Embedded spaces or special characters should not be used in directory names.

    Select a location with enough space for your database and all the application data that will be stored in it. Click Next.

    Note:
    When browsing to select a directory, enter a "." in the Enter file name field after selecting the desired install path. If a "." is not entered, the Select a directory window will not return to the window from which it was launched.
  5. In the database type selection window, select the database server you plan to use for WebSphere Partner Gateway. You can select either DB2 8.2 or Oracle 9i 9.2.0.4 or later. Click Next.
  6. In the database information window, type the following database information, then click Next when you are finished.

    DB2:

    If you selected DB2, the DB2 Database Information window appears. Enter the following DB2 database information:

    Oracle:

    1. If you selected Oracle, the Oracle Database Information window appears. Enter the following Oracle database information:
      • Administrator login ID
      • Administrator password
      • Oracle SID
      • Schema owner login
      • Schema owner password
    2. The Oracle home location window appears. Type in or click Browse to input the Oracle Home directory location. See Figure 2.

      Figure 2. Oracle home directory location window
  7. In the database location window, Figure 3 for DB2 and Figure 4 for Oracle, type the full path for the location of the database and each of its tablespaces on the database server. For example the DB2 database directory path might look like the this: DB2Home/IBM/bcgdbloader/tables.
    Note:
    When browsing to select a directory, enter a "." in the Enter file name field after selecting the desired install path. If a "." is not entered, the Select a directory window will not return to the window from which it was launched.
    If any of these values are changed, they must exist before the SQL files are executed. If they do not exist, then they must be created manually.

    Once you have entered the required information, click Next.

    Note:
    Select a file system location with sufficient space to hold the database and all application data. The database size will increase while WebSphere Partner Gateway runs.

    DB2

    Figure 3. DB2 database location window

    Oracle

    Figure 4. Oracle database location window
  8. In the Component configuration window, Figure 5, type the login information for the WebSphere Partner Gateway components and the location of the common shared files. Click Next when you are finished.

    In the User name and Password fields for the Community Console, Document Manager, and Receiver, type the name and password of the user for each component. If using DB2, these users were created when the server was configured.

    In the Group Name field, type the name of the group that contains the WebSphere Partner Gateway users.

    Figure 5. Component configuration window
  9. From the Mount point for shared information window, type the location of the common shared files used by the main components of WebSphere Partner Gateway.
    Notes:
    1. If you are installing WebSphere Partner Gateway on multiple machines, the shared common folder must use the same mount point and directory structure on all of the machines.
    2. When browsing to select a directory, enter a "." in the Enter file name field after selecting the desired install path. If a "." is not entered, the Select a directory window will not return to the window from which it was launched.
  10. The wizard displays a window where you can select whether the Database Loader just creates the SQL files or creates the SQL files and then runs them. See Figure 6.

    When the Database Loader runs the SQL files, it does the following:

    Because the Database Loader restarts the DB2 instance as part of its routine, disconnect any applications that are using the DB2 instance where you are setting up the WebSphere Partner Gateway database.

    If you want the Database Loader to run the files for you, select the Run the SQL files check box. Click Next.

    Figure 6. Run the SQL files window
  11. Confirm the Database Loader installation location. Click Next.
  12. Click the Finish button when it is enabled.
  13. If you are running the SQL manually, refer to the Instructions.txt file in the bcgdbloader/scripts subdirectory (installed by the Database Loader installation wizard) for more information.

    When you have set up the WebSphere Partner Gateway database, you are ready to install the WebSphere Partner Gateway components.

    The following section describes how to install the components using the InstallShield wizard GUI. You can also install the components without using the GUI. See Installing the components using the command line for information.

Installing the components using the install wizard

WebSphere Partner Gateway has three main components: Community Console, Receiver, and Document Manager. All three components share common content. You can install the components and common content on a single server, install each component on a separate server, or use a combination of these two options. You must install one instance of each component on at least one server. See Environment planning and Topologies for information on how to plan the placement of the various components on different servers.

Note:
If you are installing WebSphere Partner Gateway on multiple machines, the shared common folder must use the same mount point and directory structure on all of the machines.

Before you begin, make sure that the prerequisite software is installed and configured properly. Consult the Requirements for all WebSphere Partner Gateway servers table in Platform, hardware, and software requirements for software prerequisites and Installation overview for information on how to configure that software. You must also have the WebSphere Partner Gateway database set up. For information on this, see Creating the database. Finally, your database server and WebSphere MQ must be running, including the queue manager and listener.

Common components need to be installed only once when using anything other than the consolidated topology.

To install WebSphere Partner Gateway:

  1. Log in as root administrator.

    The Hub installer requires root/Administrator privilege to integrate with the native software registry.

  2. In the hub directory, run the setup executable listed in Table 10 specific to your platform.
    Table 10. Platform-specific executables for Installer
    Platform Executable

    Linux

    setupLinux

    AIX

    setupAIX

    Solaris

    setupSolaris

    The wizard starts and displays the Welcome window. Click Next.

  3. In the Software License Agreement window, read the license agreement. If you agree to its terms, click I accept the terms of the license agreement. Click Next.
  4. In the Directory Name window, type the path and name of the directory that the wizard should use when it installs WebSphere Partner Gateway. IBM recommends that you create a new directory location, or select an empty one. Embedded spaces or special characters should not be used in directory names. Click Next.
    Note:
    When browsing to select a directory, enter a "." in the Enter file name field after selecting the desired install path. If a "." is not entered, the Select a directory window will not return to the window from which it was launched.
  5. In the component selection window, Figure 7, select the components you want to install on the server. You can select multiple components. Click Next.
    Figure 7. Component selection window

    The rest of this procedure assumes that you are installing all of the components. If you are not installing all of them, some of the windows described in the rest of this procedure will not appear.

  6. Specify the fully qualified host name for the machine that you are installing on. Click Next.
  7. Select one of the following WebSphere Application Servers that will be used to host WebSphere Partner Gateway. See Figure 8. Click Next:
  8. In the Database server selection window, Figure 9, select the database server that you plan to use. You can select either DB2 8.2 or later or Oracle 9i 9.2.0.4 or later. Click Next.
    Figure 9. Database selection window
  9. The Database information window appears. If you selected DB2 as your Database server, follow the DB2 specific instructions in this procedure. If you selected Oracle as your Database server, follow the Oracle specific instructions in this procedure.

    DB2

    If you selected DB2, the DB2 Database information window appears. Figure 10.

    Enter the Host name of the computer running DB2 if it is not installed on the current system by replacing localhost with the name of the system containing DB2.

    In the Port field, type the port number that the DB2 instance is using. To find out which port the DB2 instance is using either use the DB2 Control Center (GUI) to determine the properties or enter the following DB2 configuration command on a command prompt: db2 get dbm cfg. This DB2 configuration information is also saved by the Database Loader in the system temp/bcgdbloader/logs directory. The default port is 50000.

    In the Owner name, Owner password, Database name, and Schema name fields, type the owner name, owner's password, database name and the instance name respectively. These are the names used in the Database Loader installation to define the database. See Creating the database.

    Click Next.

    Figure 10. DB2 information window

    Oracle:

    If you selected Oracle, the database information window appears, see Figure 11.

    Enter the required information about the Oracle database. The default port is 1521.

    The full path and name of the JDBC driver must point to the correct version of the driver on this computer. The driver can be found in the Oracle installation directory.

    It can also be downloaded from http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html. In the section JDBC Driver Downloads, click on Oracle xx Release x drivers. Be sure to select the driver version that matches the Oracle xx version that you are running.

    Note:
    When browsing to select a directory, enter a "." in the Enter file name field after selecting the desired install path. If a "." is not entered, the Select a directory window will not return to the window from which it was launched.

    Click Next.

    Figure 11. Oracle database information window

    The database connection confirmation window will appear. See Figure 12. If your connection is successful, note and confirm the Table, View, Function, and Procedure count information. If the connection fails, review the information window for guidance, or refer to your database documentation to address the error code.

    Figure 12. Database connection confirmation window
  10. In the User Information window, enter the user name, password, and group name of the administrator responsible for the installation. Click Next.
    Note:
    This information must match the information used in the Database Loader installation.
  11. In the Common information directory window, enter the location of the common information shared by the components. Click Next.
    Note:
    When browsing to select a directory, enter a "." in the Enter file name field after selecting the desired install path. If a "." is not entered, the Select a directory window will not return to the window from which it was launched.
  12. In the WebSphere MQ Server window, Figure 13, enter the host name of the computer running WebSphere MQ if it is not installed on the same computer. Make sure to change the name of the queue manager if the default name was not used.

    In the Host name field, if WebSphere MQ is not on the current machine, replace localhost with the name of the system containing WebSphere MQ.

    In the Queue Manager field, replace the default name with the name that was used when configuring WebSphere MQ (See step 2 in Configuring WebSphere MQ).

    In the Listener Port field, type the port that the listener is using (see Configuring WebSphere MQ). The default port is 9999.

    Click Next.

    Figure 13. WebSphere MQ Server window
  13. If you selected to install the Community Console, configure it using the Community Console configuration window. See Figure 14.

    In the User name field, type the user ID that the Community Console component uses to log in to the database.

    In the Password field, type the password associated with the user name. Make sure that you enter the correct password because the Community Console will not function with an incorrect password.

    In the HTTP port field, type the name of the port on which the component listens for messages. The Community Console, Receiver, and Document Manager must have unique port numbers, and they must be available on this computer. The default port is 58080.

    In the HTTPS port field, type the name of the secure port on which the component listens for messages. The Community Console, Receiver, and Document Manager must have unique port numbers, and they must be available on this computer. The default port is 58443.

    Click Next.

    Note:
    If the database connection fails, the database information window will appear. Review the information window for guidance, or refer to your database documentation to address the error code.
    Figure 14. Community Console configuration window
  14. If you selected the Receiver or Document Manager components, configure them using their configuration windows. These windows have the same fields as the Community Console configuration window. All three components (Community Console, Receiver, and Document Manager) must have different HTTP and HTTPS ports. See figures Figure 15 and Figure 16 on page Figure 15.
    Note:
    If you are installing the Receiver and Document Manager on different machines, the Receiver machine must have a host name that can be resolved by the Document Manager machine.
    Figure 15. Receiver configuration window
    Figure 16. Document Manager configuration window
  15. In the RosettaNet configuration window, Figure 17, type the contact information for RosettaNet messages. If you do not know the proper values, use the required default values. This information is required if you are using RosettaNet and is recommended for all installations.

    In the Name field, type the name of the person that should be contacted for RosettaNet problems.

    In the Phone number and Fax number fields, type the telephone and fax numbers for the RosettaNet contact.

    In the e-mail address field, type the e-mail address for the RosettaNet contact person.

    Click Next.

    Figure 17. RosettaNet configuration window
  16. In the alert notification window, Figure 18, configure WebSphere Partner Gateway so that it can send alerts by e-mail. Values are required. Use the default values if you do not know the proper values.

    In the SMTP relay field, type the host name of the SMTP if it is not running on this computer.

    In the From e-mail address field, type the e-mail address, that WebSphere Partner Gateway will use to send e-mails.

    In the To e-mail address field, type the destination e-mail address that users responding to alert notifications use when they send a response e-mail.

    Click Next.

    Figure 18. Alert notification window
  17. In the Summary window, review the information, which identifies the components that will be installed. If any of this information is incorrect, click Back to return to previous windows. When all of the information on the summary window is correct, click Next.
  18. The WebSphere Partner Gateway Installer installs and configures the selected components. When it has completed this task, the Installer enables the Finish button. Click Finish.

Repeat this procedure on each server where you want to install WebSphere Partner Gateway components. The common content needs to be installed only once because it is available to all computers via the shared file system.

When you have installed all WebSphere Partner Gateway components, see Starting WebSphere Partner Gateway.

Copyright IBM Corp. 2003, 2005