Installing, Upgrading, and Uninstalling the Adapter for Siebel

Overview

This chapter explains how to install, upgrade, and uninstall IBM webMethods Adapter for Siebel 6.0 SP3. The instructions use the IBM webMethods Installer and the IBM webMethods Uninstaller wizards. For complete information about the wizards or other installation methods, or to install other webMethods products, see the Installing IBM webMethods Products On Premises for your release.

Requirements

For a list of the operating systems and Siebel products supported by Adapter for Siebel 6.0 SP3, see the IBM webMethods Adapters System Requirements.

Adapter for Siebel 6.0 SP3 requires the Siebel components listed below; see the IBM webMethods Adapters System Requirements for supported versions.

Component Comment
Siebel Server The Siebel Server can be on a different machine than the Adapter for Siebel.
Siebel Client A supported Siebel client must be installed on the same machine as the Adapter for Siebel. If you use a Siebel Java Data Bean client, obtain the following .jar files from the Siebel Server installation CD and place them in the wmSiebelAdapter\code\jars directory:
  • Pre-7.1.1 Siebel Clients - SiebelJI_Common.jar
  • Siebel Client 7.7.1 or later - Siebel.jar
  • SiebelJI_locale.jar (for example, SiebelJI_enu.jar for English)

Adapter for Siebel 6.0 SP3 has no hardware requirements beyond those of the host Integration Server.

Installing Adapter for Siebel 6.0 SP3

About this task

Note: If you are installing the Adapter for Siebel in a clustered environment, you must install the adapter on each Integration Server in the cluster, and each installation must be identical. For more information about working with the adapter in a clustered environment, see Package Management.

To install the IBM webMethods Adapter for Siebel:

Procedure

  1. Adapter for Siebel 6.0 SP3 provides a new feature that lets you dynamically provide the user name and password credentials associated with a specific adapter service at run time. To use this feature, apply the appropriate fixes below:
    Integration Server Fixes
    6.5 ID_6-5_Fix2 and IS_ART_6-5_Fix7
    6.1 ID_6-1_SP1_Fix7 and IS_ART_6-1_SP1_Fix7
    6.0 ID_6-0-1_SP1_Fix11 and IS_ART_6-0-1_SP4_Fix4

    For instructions on using this feature, see Overview of the Adapter.

  2. If you are going to use Adapter for Siebel 6.0 SP3 with Siebel Server 8.0, also apply fix SBL_6-0_SP3_Fix8 for Siebel Server 8.0.
  3. Download IBM webMethods Installer .
  4. If you are installing the adapter on an existing Integration Server, shut down Integration Server.
  5. Start IBM webMethods Installer.
    • Choose the webMethods release that includes the Integration Server on which you want to install the adapter. For example, if you want to install the adapter on Integration Server 7.1, choose the 7.1 release.
    • If you are installing on an existing Integration Server, specify the webMethods installation directory that contains the host Integration Server. If you are installing both the host Integration Server and the adapter, specify the installation directory to use. The Installer will install the adapter in the Integration Server_directory\packages directory.
    • In the product selection list, select Adapters > webMethods Siebel Adapter > Program Files 6.0 SP3. You can also choose to install documentation and the Siebel Server Component 6.0 SP3, which contains the EAI webMethods Transports required for Siebel-to-webMethods connections.
  6. After installation is complete, start the host Integration Server.

    When starting the adapter, you might receive a local encoding-related error message similar to the following: 

    Error: ... threw a SiebelException: code(8210), msg(Code Page "8859_1" is not 
supported. Use "-encoding" option to change the file encoding.)

    To fix this problem, append an appropriate value to the -Dfile.encoding parameter in the JAVA_MEMSET variable in your server.bat or server.sh file. For example: 

    set JAVA_MEMSET=-ms%JAVA_MIN_MEM% -mx%JAVA_MAX_MEM% -Dfile. 
encoding="ISO8859-1"

    For a complete list of encoding values, see your Java documentation.

  7. Configure your system to use the Transports, as described in Configuring Your System to Use the EAI webMethods Transports.

webMethods Transport Files in Adapter for Siebel 6.0 SP3

With Adapter for Siebel 6.0 SP3, the Siebel transport sif file for pre-7.7.1 Siebel Servers is also available. For more information on the Siebel Server versions supported by the Adapter for Siebel, see Requirements.

The Siebel transport sif files are different, depending on the Siebel Server versions:

  • For Siebel Server version 7.7.1 and later, the sif file is WmISTransport.sif.
  • For Siebel Server version prior to 7.7.1, the sif file is WmISTransport_Pre7.7.1.sif.

Both the files are located in the bin\wmTransport folder in the Integration Server_directory\WmSiebelAdapter\backEnd\WmISTransport<platform>.zip file.

Configuring Your System to Use the EAI webMethods Transports

For Siebel-to-webMethods communications to function, you must install the EAI webMethods Transports (Siebel Server Component). You must then configure your system to use the transports using the appropriate procedure below.

Note: If you are using Siebel Server 7.7 or later, you must add Siebel.jar to the CLASSPATH. You do not need to add the SiebelJI_Common.jar file.

Windows

About this task

To configure your Windows system :

Procedure
  1. Stop your Siebel Server.
  2. Copy the following files to the TransportsRoot_directory\bin\wmTransport directory:
    For Integration Server... Copy these jar files...
    7.1 and later 
    
installation_directory\common\lib\wm-isclient.jar
    
installation_directory\IntegrationServer\lib\wm- 
isserver.jar
    
installation_directory\common\lib\ext\enttoolkit.jar
    

installation_directory\common\lib\ext\mail.jar
    7.0 and earlier 
    
installation_directory\lib\client.jar
    
installation_directory\IntegrationServer\lib\server.jar
    
installation_directory\common\lib\ext\enttoolkit.jar
    
installation_directory\common\lib\ext\mail.jar

    TransportsRoot_directory and installation_directory are the directories in which you installed the EAI webMethods Transports and the webMethods products, respectively.

  3. Open the TransportsRoot_directory\bin\wmTransport\wmISTransportCfg.txt file and assign values to its variables as indicated in the file's comments.
  4. Modify your system variables using the Windows Control Panel as follows:
    1. Modify the PATH variable as follows:
      For... Modify the PATH as follows...
      JDK 1.4 and later 
      PATH=jdk_install_dir\bin;jdk_install_dir\​jre\bin;jdk_install_dir\​jre\bin\client;%PATH%

      where jdk_install_dir is the directory in which you installed the Java Development Kit. For example, if you installed JDK in the c:\jdk1.5 directory, your PATH statement would be: 

      PATH=C:\jdk1.5\bin;C:\jdk1.5\jre\bin;C:\jdk1.5\​jre\bin\client;%PATH%
      JDK 1.3 and earlier 
      PATH=jdk_install_dir\bin;jdk_install_dir\jre\bin;​jdk_install_dir\jre\bin\classic;%PATH%

      where jdk_install_dir is the directory in which you installed the Java Development Kit. For example, if you installed JDK in the c:\jdk1.3.1 directory, your PATH statement would be: 

      PATH=C:\jdk1.3.1\bin;C:\jdk1.3.1\jre\bin;C:\jdk1.3.1 
\jre\bin\classic;%PATH%
      Note: With Integration Server 7.1 and later, wmISTransport can be run only on JDK 1.5 and later.
    2. Add the WEBMTCFG variable as follows: 
      WEBMTCFG=TransportsRoot_directory\bin\wmTransport
    3. Modify the CLASSPATH variable to add the jar files as follows:
      For Integration Server... The jar files are...
      7.1 and later 
      CLASSPATH=%CLASSPATH%;TransportsRoot_directory\bin​\wmTransport\wmISTransport.jar;​TransportsRoot_directory\bin​\wmTransport\enttoolkit.jar;​​TransportsRoot_directory\bin\wmTransport\wm-isclient.jar;​TransportsRoot_directory\bin\wmTransport\wm-isserver.jar;​​TransportsRoot_directory\bin&\wmTransport\mail.jar
      7.0 and earlier 
      CLASSPATH=%CLASSPATH%;TransportsRoot_directory\bin\​wmTransport\wmISTransport.jar;​​TransportsRoot_directory\bin\wmTransport\enttoolkit.jar;​TransportsRoot_directory\bin\wmTransport\client.jar;​TransportsRoot_directory\bin\wmTransport\server.jar;​TransportsRoot_directory\bin\wmTransport\mail.jar
  5. Import TransportsRoot_directory\bin\wmTransport\wmISTransport.sif into your Siebel Server's Repository using Siebel Tools.
    Note: If you are using a version of Siebel Server prior to 7.7.1, the sif file name is WmISTransport_Pre7.7.1.sif. For more information, see webMethods Transport Files in Adapter for Siebel 6.0 SP3.
  6. Compile your Siebel repository. Make sure you have Write access to your Siebel Server's siebel.srf file.
  7. Restart your Siebel Server.

HP-UX

About this task

To configure your HP-UX system :

Procedure
  1. Stop your Siebel Server.
  2. Copy the necessary jar files from installation_directory/common/lib to TransportsRoot_directory/bin directory:
    • For Integration Server 7.1 and later, the jar file is wm-isclient.jar.
    • For Integration Server 7.0 and earlier, the jar file is client.jar.
  3. Open the TransportsRoot_directory/bin/wmTransport/wmISTransportCfg.txt file and assign values to its variables as indicated in the file's comments.
  4. Open the SiebelServer_directory/siebsrvr/siebenv.sh file and modify or add the following variables at the end of the file as follows:
    1. Modify the CLASSPATH statement as shown below:
      For Integration Server... The CLASSPATH statement looks like...
      7.1 and later 
      CLASSPATH=${CLASSPATH}:${SIEBEL_ROOT}/bin/ 
wmTransport/wmISTransport.jar:${SIEBEL_ROOT}/bin/ 
wmTransport/wmisclie.nt.jar:${SIEBEL_ROOT}/bin/ 
wmTransport/SiebelJI_Common.jar:${SIEBEL_ROOT}/bin/ 
wmTransport/Siebel.jar:${SIEBEL_ROOT}/bin/wmTransport/ 
SiebelJI_enu.jar ; export CLASSPATH
      7.0 and earlier 
      CLASSPATH=${CLASSPATH}:${SIEBEL_ROOT}/bin/​wmTransport/wmISTransport.jar:​${SIEBEL_ROOT}/bin/​wmTransport/client.jar:${SIEBEL_ROOT}/bin/​​wmTransport/SiebelJI_Common.jar:${SIEBEL_ROOT}/bin/​wmTransport/Siebel.jar:​${SIEBEL_ROOT}/bin/​wmTransport/SiebelJI_enu.jar ; export CLASSPATH
    2. Add the transport: 
      WEBMTCFG=${SIEBEL_ROOT}/bin/wmTransport ; export WEBMTCFG
    3. Modify the PATH statement:
      For Integration Server... Use...
      7.1 and later JRE 1.5 or higher: 
      PATH=${PATH}:/opt/java1.5/bin:/opt/​java1.5/jre/bin:/opt/java1.5/jre/ bin/PA_RISC ; export PATH
      7.0 and earlier The JVM that is installed with Integration Server. For example: 
      PATH=${PATH}:/opt/java1.3/bin:/opt/​java1.3/jre/bin:/opt/java1.3/jre/ bin/PA_RISC ; export PATH
    4. Modify the library paths and heap size statements:
      For Integration Server... Use...
      7.1 and later JRE 1.5 or higher: 
      SHLIB_PATH=${SHLIBPATH}:${SIEBEL_ROOT}/bin:${SIEBEL_ROOT}​/lib:/lib:/usr/lib:/opt/java1.5/jre/lib/ 
PA_RISC:/opt/java1.5/jre/lib/PA_RISC/classic ; export
      SHLIB_PATH LD_LIBRARY_PATH=${SHLIB_PATH} ; export 
LD_LIBRARY_PATH IST_MIN_HEAP_SIZE=128M ; export 
IST_MIN_HEAP_SIZE IST_MAX_HEAP_SIZE=128M ; export 
IST_MAX_HEAP_SIZE
      7.0 and earlier The JVM that is installed with Integration Server. For example: 
      SHLIB_PATH=${SHLIBPATH}:${SIEBEL_ROOT}/bin:${SIEBEL_ROOT}/​lib:/lib:/usr/lib:/opt/java1.3/jre/lib/ 
PA_RISC:/opt/java1.3/jre/lib/PA_RISC/ classic ; export 
SHLIB_PATH LD_LIBRARY_PATH=${SHLIB_PATH} ; export 
LD_LIBRARY_PATH IST_MIN_HEAP_SIZE=128M ; export 
IST_MIN_HEAP_SIZE IST_MAX_HEAP_SIZE=128M ; export 
IST_MAX_HEAP_SIZE
    5. Save and close the file.
  5. Import TransportsRoot_directory/bin/wmTransport/wmISTransport.sif into your Siebel Server's repository using Siebel Tools.
    Note: If you are using a version of Siebel Server prior to 7.7.1, the sif file name is WmISTransport_Pre7.7.1.sif. For more information, see webMethods Transport Files in Adapter for Siebel 6.0 SP3.
  6. Compile your Siebel repository. Make sure you have Write access to your Siebel Server's siebel.srf file.
  7. Execute the siebenv.sh file that you edited earlier.
  8. Restart your Siebel Server.

Solaris

About this task

To configure your Solaris system :

Procedure
  1. Stop your Siebel Server.
  2. Copy the necessary jar files from installation_directory/common/lib to TransportsRoot_directory/bin directory:
    • For Integration Server 7.1 and later, the jar file is wm-isclient.jar.
    • For Integration Server 7.0 and earlier, the jar file is client.jar.
  3. Open the TransportsRoot_directory/bin/wmTransport/wmISTransportCfg.txt file and assign values to its variables as indicated in the file.
  4. Open the SiebelServer_directory/siebsrvr/siebenv.sh file and modify or add the following variables at the end of the file as follows:
    1. Modify the CLASSPATH statement as shown below:
      For Integration Server... The CLASSPATH statement looks like...
      7.1 and later 
      CLASSPATH=${CLASSPATH}:${SIEBEL_ROOT}/bin/wmTransport 
/wmISTransport.jar:${SIEBEL_ROOT}/bin/ 
wmTransport/wmisclient.jar:${SIEBEL_ROOT}/bin/ 
wmTransport/SiebelJI_Common.jar:${SIEBEL_ROOT}/bin/ 
wmTransport/Siebel.jar:${SIEBEL_ROOT}/bin/wmTransport
      /SiebelJI_enu.jar ; export CLASSPATH
      7.0 and earlier 
      CLASSPATH=${CLASSPATH}:${SIEBEL_ROOT}/bin/wmTransport/​wmISTransport.jar:${SIEBEL_ROOT}/bin/​wmTransport/client.jar:${SIEBEL_ROOT}/​bin/​wmTransport/SiebelJI_Common.jar:${SIEBEL_ROOT}/​bin/​wmTransport/Siebel.jar:${SIEBEL_ROOT}/​bin/wmTransport/
SiebelJI_enu.jar ; export CLASSPATH
    2. Add the transport:
      WEBMTCFG=${SIEBEL_ROOT}/bin/wmTransport ; export WEBMTCFG
    3. Modify the PATH statement:
      For Integration Server... Use...
      7.1 and later JRE 1.5 or higher: 
      PATH=${PATH}:/opt/java1.5/bin:/opt/java1.5/jre/bin:/ 
opt/java1.5/jre/bin/PA_RISC ; export PATH
      7.0 and earlier the JVM that is installed with Integration Server. For example: 
      PATH=${PATH}:/opt/javal.3/bin:/opt/java1.3/jre/bin/ 
PA_RISC ; export PATH
    4. Modify the library and heap size statements.
      For Integration Server... Use...
      7.1 and later JRE 1.5 or higher: 
      SHLIB_PATH=${SHLIBPATH}:${SIEBEL_ROOT}/bin:${SIEBEL_ROOT}/​lib:/lib:/usr/lib:/opt/java1.3/jre/lib/PA_RISC:/opt/java1.3/​jre/lib/PA_RISC/classic ; export SHLIB_PATH 
LD_LIBRARY_PATH=${SHLIB_PATH} ; export LD_LIBRARY_PATH 
IST_MIN_HEAP_SIZE=128M ; export IST_MIN_HEAP_SIZE 
IST_MAX_HEAP_SIZE=128M ; export IST_MAX_HEAP_SIZE
      7.0 and later the JVM that is installed with Integration Server. For example: 
      SHLIB_PATH=${SHLIBPATH}:${SIEBEL_ROOT}/bin:${SIEBEL_ROOT}/​lib:/lib:/usr/lib:/opt/java1.3/jre/lib/ 
PA_RISC:/opt/java1.3/jre/lib/PA_RISC/ classic ; export 
SHLIB_PATH LD_LIBRARY_PATH=${SHLIB_PATH} ; export 
LD_LIBRARY_PATH IST_MIN_HEAP_SIZE=128M ; export 
IST_MIN_HEAP_SIZE IST_MAX_HEAP_SIZE=128M ; export 
IST_MAX_HEAP_SIZE
    5. Save and close the file.
  5. Import TransportsRoot_directory/bin/wmTransport/wmISTransport.sif into your Siebel Server's repository using Siebel Tools.
    Note: If you are using a version of Siebel Server prior to 7.7.1, the sif file name is WmISTransport_Pre7.7.1.sif. For more information, see webMethods Transport Files in Adapter for Siebel 6.0 SP3.
  6. Compile your Siebel repository. Make sure you have Write access to your Siebel Server's siebel.srf file.
  7. Execute the siebenv.sh file that you edited earlier.
  8. Restart your Siebel Server.

Configuring Your System to Use Siebel Visual Basic Scripts

To use Siebel VB scripts, complete the appropriate procedure below. The procedure you choose depends on whether you installed the Adapter for Siebel on the same machine as the Siebel Server or on a different machine.

When Adapter for Siebel and Siebel Server Are on the Same Machine

About this task

To enable Siebel VB scripts when Adapter for Siebel and Siebel Server are on the same machine :

Procedure
  1. Append jdk\jre\bin\classic to the PATH system environment variable.
  2. Append the necessary jar file from the installation_directory\common\lib directory to the CLASSPATH system environment variable as follows:
    • For Integration Server 7.1 and later, the jar file is wm-isclient.jar.
    • For Integration Server 7.0 and earlier, the jar file is client.jar.
  3. Run the following command: 
    regsvr32  
						  Integration Server_directory\support\win32\webMethods.dll

When Adapter for Siebel and Siebel Server Are on Different Machines

About this task

To enable Siebel VB scripts when Adapter for Siebel and Siebel Server are on different machines :

Procedure
  1. On the appropriate Siebel Server machine, create a directory called drive:\webMethods, where drive: is any valid drive, for example, c:\webMethods.
  2. Copy Integration Server_directory\support\win32\webMethods.dll to drive:\webMethods\webMethods.dll, where Integration Server_directory is the directory in which you installed the Integration Server.
  3. Copy the necessary jar files as follows:
    • For Integration Server 7.1 and later, copy installation_directory\common\lib\wm-isclient.jar to drive:\webMethods\lib\wm-isclient.jar.
    • For Integration Server 7.0 and earlier, copy installation_directory\lib\client.jar to drive:\webMethods\lib\Client.jar.
  4. Append jdk\jre\bin\classic to the PATH system environment variable, where jdk is the directory in which you installed the Java Development Kit.
  5. Modify the CLASSPATH statement as follows:
    • For Integration Server 7.1 and later, append drive\webMethods\lib\wm-isclient.jar to the CLASSPATH system environment variable.
    • For Integration Server 7.0 and earlier, append drive\webMethods\lib\Client.jar to the CLASSPATH system environment variable.
  6. Run the following command: 
    regsvr32 drive:\webMethods\webMethods.dll

Upgrading to Adapter for Siebel 6.0 SP3

About this task

You can upgrade from webMethods Enterprise Adapter: Siebel Edition 4.2.1 to Adapter for Siebel 6.0 SP3. The upgrade procedure converts operations you configured using the earlier adapter into adapter services that can run on Adapter for Siebel 6.0.

The webMethods Pre-6.0 Enterprise to webMethods 6 Upgrade Guide describes how to upgrade the earlier adapter and other pre-6.0 webMethods Enterprise business logic components so you can use them in a webMethods 6 development environment. This section explains how to install the upgrade utility software you will need to perform the upgrade process.

To upgrade from webMethods Enterprise Adapter: Siebel Edition 4.2.1 :

Procedure

  1. Start IBM webMethods Installer 6.1.
  2. Go to Upgrade Utilities > Enterprise Upgrade Utility and select all the child nodes. The Upgrade Utility installs upgrade tools in the installation_directory\Upgrade directory.
  3. Select Adapters > Adapter Upgrades > Enterprise Adapters > webMethods Enterprise Adapter: Siebel Edition 4.2.1 Upgrade Utility Plug-in 6.0. The plug-in installs the siebelAdapterPlugin.jar file in the Integration Server_directory\Upgrade\lib\plugin directory.
  4. Perform the upgrade process described in the webMethods Pre-6.0 Enterprise to webMethods 6 Upgrade Guide.

Mappings of Configured Operations to Adapter Services

The following table maps the configured operations of the webMethods Enterprise Adapter: Siebel Edition 4.2.1 to the adapter services of the IBM webMethods Adapter for Siebel 6.0.

Enterprise Adapter for Siebel Configured Operation Adapter for Siebel 6.0 Service
Query Query
Insert Insert
Update Update
Delete Delete
Associate Associate
Attachment File Attachment
Siebel Business Service Invoke Siebel Business Service
Invoke Business Component Method

The Upgrade Utility converts your configured operations to adapter services as completely as possible. However, due to architectural differences between the adapters, the conversion may produce some differences that will not affect the adapter services' run-time functionality.

The Upgrade Utility produces a Manual Tasks folder in the output project that contains tasks you need to perform to complete the upgrade. To locate these manual tasks, drill down through the Manual Tasks folder, then click each task. The Upgrade Utility displays the task instructions. You can also access the manual task instructions in the form of HTML files located in the UpgradeUtility_directory\project_output\reports directory. For details, see the webMethods Pre-6.0 Enterprise to webMethods 6 Upgrade Guide.

Uninstalling Adapter for Siebel 6.0 SP3

About this task

To uninstall Adapter for Siebel 6.0 SP3

Procedure

  1. Shut down the host Integration Server. You do not need to shut down any other webMethods products or applications that are running on your machine.
  2. IBM webMethods Uninstaller will not delete any user-defined Adapter for Siebel 6.0 SP3 components such as connections and adapter services. Because these components will not work without the adapter, delete them manually, either at the file system level or using Digital Event Services or Designer. For instructions, see the IBM webMethods Service Development Help for your release.
  3. Start IBM webMethods Uninstaller, selecting the webMethods installation directory that contains the host Integration Server. In the product selection list, select Adapters > webMethods Siebel Adapter . You can also choose to uninstall documentation.
  4. Restart the host Integration Server.

Results

Uninstaller removes all Adapter for Siebel-related files that were installed. However, Uninstaller does not delete files created after you installed the Adapter for Siebel (for example, user-created or configuration files), nor does it delete the directory structure that contains the files. You can go to the Integration Server_directory\packages directory and delete the WmSiebelAdapter directory.