Readme for IBM® WebSphere® Partner Gateway, Enterprise and Advanced Editions, V6.1.0 fix pack 2



© Copyright International Business Machines Corporation 2005, 2008. All rights reserved.

US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.


These notes describe the changes made in 6.1.0 fix pack 2 of IBM WebSphere Partner Gateway, Enterprise and Advanced Editions. This fix pack is cumulative and includes all fixes released in earlier fix packs for the V6.1.0 release.


This document contains the following sections:

Prerequisites

Server and Database support

New in fix pack

Product fix history

Known problems and workarounds

Installation instructions

Uninstalling the fix pack

Prerequisites

Problems were identified with certain functionalities of WebSphere Partner Gateway (Enterprise and Advanced Editions Version 6.1.0 fix pack 2) because of the specified versions of WebSphere Application Server and DB2. For instructions on applying and downloading these APAR fixes,
see
Prerequisite APAR fixes for WebSphere Partner GatewayV6.1, V 6.1.0.1 and V6.1.0.2.

For system requirements of WebSphere Partner Gateway Enterprise and Advanced Editions Version 6.1.0, refer to http://www.ibm.com/software/integration/wspartnergateway/sysreqs


Server and Database support

The Enterprise and Advanced Editions of WebSphere Partner Gateway Version 6.1.0 fix pack 2 extends support for the following:


For more details, refer Supported software versions by WebSphere Partner Gateway levels..


New in this fix pack

This fix pack includes the following new features and improvements.

Tracking Number Description
- In this fix pack we have added the support for HP-UX 11i v3. For more details, refer http://www.ibm.com/software/integration/wspartnergateway/sysreqs.

JR26780

In this fix pack, "PartyID Type" is added as an ebXML Messaging Service (ebMS) attribute. This refers to the domain names to which the string in the PartyID element belongs. The value of the type attribute must be mutually agreed and understood by all the parties. If a DUNS number is available, WebSphere Partner Gateway populates only the field PartyID Type with a value of "duns". In case of Free-form value from the partner profile, WebSphere Partner Gateway populates this field with "string".

JR27018

For the AS2 documents which fail during document delivery, AS Retry must not be triggered. In the event of request document delivery failure, a different icon is displayed in AS Viewer. To view this behavior, the property bcg.noasretry.iffailed must be set to true.

JR27201

From this fix pack onwards, you can enter multiple DUNS/DUNS+4 IDs in a single box delimiting it with ";".

JR27202

In earlier fix packs, if a file directory existed during file receiver configuration, an error message was issued. In this fix, a new receiver is created without any error even if the root file Directory exists and uses the same Root directory. At any point of time only one file receiver will point to a particular root Directory. Console does not allow creation of multiple File Receiver with same Root Directory.

JR27205

Event codes and Alert Notifications can now be imported or exported as part of Partner migration.

JR27206

In this fix pack, the product is enhanced to select multiple documents for resend all at once using the console.

JR27207

Validate Webservices
Earlier, the WebSphere Partner Gateway provided only pass through support for Webservice protocol. As a gateway product, the SOAP Body must be validated before delivering. The De-envelope SOAP Envelope extracts the payload embedded in the SOAP envelope under SOAP Body tag. Similarly, the de-enveloped document is routed to a transformed document or re-routed as new document depending on the option you have selected.

Three actions as described below have been added.

Validate SOAP Body
In the Webservice request, payload (SOAP body) has to be validated against the associated schema (XSD), DTD mentioned in the payload, or in the selected WebSphere Partner Gateway channel. The following are the pre-conditions to validate a SOAP Body:

  1. WSDL and its associated schema to validate the SOAP Body must be available with WebSphere Partner Gateway.
  2. In the enabled Webservice channel, if the SystemId is not present in the XML as per standards, then the associated validation map routing attribute will be utilized for validation.
  3. Select Validate SOAP Body (the new WebSphere Partner Gateway action) as action for the corresponding Webservice channel.

Validate SOAP Envelope
The Webservice request as a whole will be validated against SOAP1.1 schema, as per industry standards. The following are the Pre-conditions to validate SOAP Envelope:

  1. WSDL has to be uploaded and its associated channel made available.
  2. Select the Validate SOAP Envelope (new WebSphere Partner Gateway action) as the action for the corresponding Webservice channel.

De-envelope SOAP Envelope
The SOAP envelope has to de-envelope and introduce SOAP Body element for processing. Webservice Document flows through BPE process with action as "De-envelope SOAP Envelope". If the received Webservice request is with attachments, then SOAP envelope is extracted from the Mime message and SOAP body element will be extracted out from the envelope for further processing. Either de-envelope documents and attachments will be introduced into WebSphere Partner Gateway as new document or processed with the same channel depending on the configuration.

If the SOAP request contains attachment, then the payload and attachment gets enveloped into WebSphere Partner Gateway specific backend packaging and the provided destination is configured as backend packaging. In all other scenarios, WebSphere Partner Gateway will not support internally for packing the attachment with the extracted payload. You have to choose the configuration according to the Webservice request with or without the attachment.

For detailed description of this enhancement and configuration refer the document SOAP Validation and SOAP De-Enveloping Configuration.

JR27208

WebSphere Partner Gateway v6.1 scans only the directories created by WebSphere Partner Gateway in the receiver configuration file directory. In this enhancement, it can scan and retrieve the items of child directories created by the external users of the WebSphere Partner Gateway.

JR27367

Support for new PIP package 7C8 is available in this fix pack.

JR27368

In this fix pack, generation of acknowledgment has been made a part of request processing and hence the database polling for the acknowledgement generation is avoided.

JR27469

From this fix pack onwards, support is extended for Oracle 10.2.0.3.

Product fix history

The following problems are fixed in this fix pack.

Tracking Number

Description

JR26584

When an existing map was re-uploaded onto the WebSphere Partner Gateway database, the DIS client issued the error "16890". In this fix pack, this error has been resolved, and the re-uploading of an existing map is allowed in the DIS client.

JR26642

The JMS Correlation ID of an incoming message is now set on the outbound JMS message. The JMS Message ID of a message delivered by a JMS gateway can be read through user exit using the API method as:
SenderResult.getAttribute("JMSMessageID");

JR26666

As part of the fix, an inbound binary document can be routed through a custom channel.

JR26711

In this fix pack, a non-hubadmin user is restricted from performing a partner search in a LDAP authenticated WebSphere Partner Gateway setup.

JR26712

When an ebMS acknowledgement contains the element <EB:SYNCREPLY>, the WebSphere Partner Gateway throws "Missing SyncCheck Handler" error. It has been corrected in this fix pack.

JR26714

In this fix pack, the internal partners do not get logged off from the console while accessing the tabs, for which they do not have access permissions.

JR26727

In this fix pack, the description of 7B1 package was corrected to "Distribute Work In Process" from "Distribute Work in Process".

JR26794

From this fix pack onwards, the JMS Gateway allows the JMS ReplyToQ attribute to be set on the outbound message.

JR26883

From this fix pack onwards, 0KB files will not get created in the data\Inbound\process folder.

JR26912

The role attribute is added to the ebMS request and acknowledgement message.

JR26936

Earlier, EDISplitter failed when Websphere Partner Gateway received a document inbound over HTTP receiver, this has been resolved in this fix pack.

JR26947

In case of Rosettanet, when the property of correlation is provided as 'pipinstanceid' and no process instance ID is found in the header of the request, a new event is added to inform the usage of document ID as correlation ID. During such conditions, the response correlates with the request based on the document ID and this event appears in the response message.

JR26985

In this fix pack, partner migration utility can successfully export configurations having empty Definition field for a custom action.

JR27022

In this fix pack, the Pip code along with the RosettaNet PIP Name is added to the Document Viewer and other relevant pages.

JR27097

In the earlier versions, XML events were getting generated on "Production" destination irrespective of whether the configuration is set for test or custom. This fix pack generates XML events on the configured destination.

JR27159

The processing of business documents in the BPE is optimized. This improves the CPU utilization and augments throughput in BPE.

JR27211

The processing of business documents in Delivery Manager is optimized in this fix pack.

JR27235

WebSphere Partner Gateway was not closing JMS resources while disabling the JMS Receiver. This problem is resolved in this fix pack.

JR27256

During Secure Socket Layer (SSL) client authentication, SSL handshake failed with no certificate error if only CA certificate was trusted by Cyclone server. This did not happen if the entire chain of certificates was trusted. As part of this fix, SSL handshakes work with the Client authentication while connecting to Cyclone server.

JR27276

In the earlier versions, WebSphere Partner Gateway used to lose child documents created in the custom variable workflow step. This fix pack enables processing of these types of child documents.

JR27423

WebSphere Partner Gateway reported errors while processing documents that got routed through many proxy servers. In this fix pack, IP address of the originating Partner is fetched from the headers to avoid the errors.

JR27424

In this fix pack, you can update validation maps from the console without "File not found" error messages.

JR27425

The outbound encoding in the XML translation was incorrect. In this fix pack, the outbound encoding is propagated and is used while creating the XML in the translation step.

JR27427

In case of an inbound AS document, when the incoming AS message was not signed and a signed message was expected by the receiving hub, an "Insufficient Message Security" event was logged, though the document was sent successfully. This behavior is corrected in this fix pack such that the documents with insufficient security is failed and not sent for delivery.

JR27430

Earlier, the timer for the AS retry was starting as soon as an entry was made in the AS state tables. In this fix pack, the timer for AS Retry will start only after the gateway's attempt to deliver is completed.

JR27435

Earlier, a document posted over a gateway with Auto queue set to "ON" remained in "Document stop process submitted" state forever when the stop process was initiated. Also, the gateway was moved to offline state. In this fix, the document is moved to failed state when the stop process is initiated.

JR27442

Earlier, after resending a failed document, when the user tried to delete the corresponding entry in the Console Gateway Queue, the Console removed the entry temporarily. But it appeared again when the refresh link was used. This problem has been resolved in this fix pack.

JR27467

Redundant indexes that caused problems were identified and removed during database migration to this fix pack.

JR27483

Rosettanet Partner Simulator used to fail for a single action PIP. In addition, there was failure with respect to 4A4 R02.00A. Both these errors are corrected in this fix pack.

JR27557

The options to update the MAS and Common shared file system have been disabled in the fix pack 2 installer.
For more details, refer to the technote
Do Not Update MAS and Common shared file system in Fix Pack 1.

JR27959

Installing only the Common File System in WebSphere Partner Gateway 6.1 Simple distributed Mode deletes the files in Windows randomly. In fix pack 2, the option to select only the Common File System has been removed. The fix for the primary issue will be available in the next WebSphere Partner Gateway release.
For more details, refer to the technote
Fix Pack 1 Simple Distributed Install - Do not select Common File System.

JR28153

Earlier, the bcgNonRepMaintenance script needed partner name as a mandatory parameter. In this fix pack, the script allows the use of '*', which means all partners.




Known problems and workarounds

  1. If you do not change the default value of JMS Queue Factory Name in the External Events section of the console, then events will not be published to the queue.
    Steps to change the default values of JMS Queue Factory Name:
    1. Login to the WebSphere Application Server Admin Console and create a new Queue Connection Factory.
    2. In the WebSphere partner Gateway console, navigate to Administration > Docmgr Administration > Event Engine > External Events.
    3. Provide the name of Queue Connection factory created in the step 1 for "JMS Queue Factory Name".

  2. In Simple Distributed mode of Installation, if just one Application Server(Node) is uninstalled with the Deployment Manager running, then the entire WebSphere Partner Gateway application maybe removed.
    For more details, please see Steps to Uninstall Simple Distributed mode.


  3. When Websphere Partner Gateway 6.1.0 is installed on HP-UX 11i v3 platform, it installs fine, but the uninstaller is not created in the <HUB_INSTALL>\_uninst folder. Even the 6.1.0.2 fix pack installer does not create this uninstaller under the _uninst folder.
    For users on HP-UX 11i v3, we suggest that, they follow the steps below to uninstall Websphere Partner Gateway on their machine.
    1. Stop all the servers
    2. Change directory by executing
      cd /opt/IBM/bcgappsdb/_uninst
    3. Set the following environment variable
      JAVA_HOME=<location of JDK installed on your machine> (eg: /opt/IBM/WebSphere/AppServer/java)
    4. Execute the following to uninstall Websphere Partner Gateway
      $JAVA_HOME/bin/java -jar uninstall.jar

    For more details, refer Webshpere Partner Gateway support for HP-UX 11i v3.

Installation instructions

There are separate fix packs for the Advanced and Enterprise Editions. Each fix pack has two major parts, the DBLoader and the Hub. There is no fix pack installer for MAS Database and Deployment Manager. There is a separate launcher for each operating system. The WebSphere Partner Gateway V6.1.0 fix packs are located at http://www.ibm.com/software/integration/wspartnergateway/support/
WARNING: You cannot reverse the installation of this fix pack. It is very important that you shut down WebSphere Partner Gateway and create a backup of the current installation before proceeding with the fix pack installation. Failure to do so may result in loss of data or prevent you from properly performing the fix pack uninstallation procedure.

1.       Shut down WebSphere Partner Gateway servers:
Navigate to the ProductDir/bcghub-distrib/bin directory for SimpleDistributed and FullyDistributed mode and execute the following. For Simple mode, navigate to ProductDir/bcghub-simple/bin directory. Make sure that the Deployment Manager and NodeAgent are running in case of both SimpleDistributed and FullyDistributed modes.
SimpleDistributed and FullyDistributed mode on Unix:

a.        bcgStopServer.sh console

b.       bcgStopServer.sh receiver

c.    bcgStopServer.sh router

d.    bcgStopServer.sh MAS

       Simple mode on Unix:

bcgStopServer.sh

       SimpleDistributed and FullyDistributed mode on Windows:

a.    bcgStopServer.bat console

b.    bcgStopServer.bat receiver

c.    bcgStopServer.bat router

d.    bcgStopServer.bat MAS

       Simple mode on Windows:

bcgStopServer.bat

2.      Take a backup of the database before running the installer. Use the appropriate database utility to perform this step. For example, DB2 and Oracle provide an export utility. Consult your database server documentation for instructions. Do not continue with the fix pack installation without first taking a backup of your database.
Run the DBLoader setup launcher for your operating system from under DBLoader folder in your installer, alternatively you can use the Install Application Database option when you run your launchpad for installation. This will open an installation wizard, provide the required information to install the DBloader. This will create the script files required for manual execution under the bcgappsdb\scripts folder.
Note: If you receive warnings stating that certain directories will be overwritten, for example: _jvm, then select Yes to continue with the fix pack installation.

Note: If you choose not to have the DBLoader run the SQL files automatically, you can run them manually at the completion of the DBLoader. To do this:


On DB2

Run the following commands:

a. UNIX: su - db2inst1
WINDOWS: Start the DB2CLP and make sure you are logged in as the user that owns the DB2 database.
b. db2start (if the database is not started)
c.  db2 connect to bcgapps
d.  cd <WPG INSTALL DIR>/bcgappsdb/scripts/DB2
e.  Run the applicable scripts from the following. Since the scripts are not cumulative if you are currently on V6.1.0 and would want to upgrade to 6.1.0.2 you would need to run all the scripts given below. If you are on V6.1.0.1, you would need to run only the last script to upgrade to 6.1.0.2.

db2 -td! -f BCGUpgrade_610_610FP1.sql -z /tmp/bcgdbloader/logs/BCGUpgrade_610_610FP1.log

db2 -td! -f BCGUpgrade_610FP1_610FP2.sql -z /tmp/bcgdbloader/logs/BCGUpgrade_610FP1_610FP2.log

On Oracle
Run the following commands:

a. UNIX: su - oracle
WINDOWS: Make sure you are logged in as the owner of the Oracle database.
b. Run the applicable scripts from the following. Since the scripts are not cumulative if you are currently on V6.1.0 and would want to upgrade to 6.1.0.2 you would need to run all the scripts given below. If you are on V6.1.0.1, you would need to run only the last script to upgrade to 6.1.0.2.

cd <WPG INSTALL DIR>/bcgappsdb/scripts/Oracle

sqlplus -L bcgapps/<password> @BCGUpgrade_610_610FP1.sql >/tmp/bcgdbloader/logs/BCGUpgrade_610_610FP1.log

sqlplus -L bcgapps/<password> @BCGUpgrade_610FP1_610FP2.sql >/tmp/bcgdbloader/logs/BCGUpgrade_610FP1_610FP2.log

  1. Run the Hub setup launcher for your operating system from under the hub folder in your installer . This will open an installation wizard, provide the required information to install the hub. Alternatively you can choose to install the hub by using the launchpad.
  2. Start WebSphere Partner Gateway servers:
    Navigate to the ProductDir/bcghub-distrib/bin directory for SimpleDistributed and FullyDistributed mode and execute the following. For Simple mode, navigate to ProductDir/bcghub-simple/bin directory. Make sure that the Deployment Manager and NodeAgent are running in case of both SimpleDistributed and FullyDistributed modes.
    SimpleDistributed and FullyDistributed mode on Unix:

    a.        bcgStartServer.sh console

    b.       bcgStartServer.sh receiver

    c.    bcgStartServer.sh router

    d.    bcgStartServer.sh MAS

    Simple mode on Unix:

    bcgStartServer.sh

    SimpleDistributed and FullyDistributed mode on Windows:

    a.    bcgStartServer.bat console

    b.    bcgStartServer.bat receiver

    c.    bcgStartServer.bat router

    d.    bcgStartServer.bat MAS

    Simple mode on Windows:

    bcgStartServer.bat


Note: If the WebSphere Application Server Administration console welcome page opens, then your server is running. If the server is not running, then there is a problem with the installation. To determine the issue, go to the bcgHubInstall.log file in the bcghub/logs folder under the temp directory to see the problem. The console welcome page should display the version of Websphere Partner Gateway with the correct fix pack level applied. After fix pack 2 is applied the version should display "Console version : 6.1.0.2.<build number>" at the center of the lower portion of the welcome screen.


Uninstalling the fix pack

To uninstall the fix pack, WebSphere Partner Gateway must be restored to its original state (prior to the fix pack installation). Restore the system to its original state using the database backup that was created before the fix pack was installed. Failure to do so may result in loss of data or prevent you from properly performing the following fix pack uninstallation procedure. Any changes to configuration files must be manually saved and restored.

Note: It is recommended to uninstall the hub before uninstalling the DBLoader. Also, uninstall hub apps before uninstalling hub Deployment Manager.

1.      Uninstall hub apps version 6.1.0.2

1.      Shutdown WebSphere Partner Gateway servers. Make sure that the Deployment Manager and NodeAgent are running in case of both SimpleDistributed and FullyDistributed modes.
Note: The node agent and deployment manager are started by the installer upon installation of the WebSphere Partner Gateway product. If the deployment manager is not started, you will not be able to login to the Websphere Application Server admin console, which is http://<host name or IP address of the Deployment Manager>:55090/ibm/console.Once logged into the Websphere Application Server admin console, check to see if your NodeAgent is running from the console by clicking on System Administration then Node Agent from the left panel.

2.      Navigate to the ProductDir/bcghub-distrib/bin directory for SimpleDistributed and FullyDistributed mode and execute the following. For Simple mode, navigate to ProductDir/bcghub-simple/bin directory. 

SimpleDistributed and FullyDistributed mode on Unix:

a.        bcgStopServer.sh console

b.        bcgStopServer.sh receiver

c.    bcgStopServer.sh router

d.    bcgStopServer.sh MAS

Simple mode on Unix:

bcgStopServer.sh

      SimpleDistributed and FullyDistributed mode on Windows:

a.    bcgStopServer.bat console

b.    bcgStopServer.bat receiver

c.    bcgStopServer.bat docmgr

d.    bcgStopServer.bat MAS

             Simple mode on Windows:

bcgStopServer.bat

3.      Save any hub configuration using backupConfig.bat/.sh.(under ProductDir/bcghub-distrib /wasND/Profiles/bcgprofile/bin). This will create a zip file name with current timestamp. For example, WebSphereConfig_2007-06-05.zip. This will create backup for all servers (bcgconsole, bcgreceiver, bcgdocmgr, bcgmas and nodeagent). Log file (backupConfig.log) will be created under deployment manager profile logs. The hub configuration settings that are not stored in the database are located in the following directory:ProductDir/bcghub-distrib/wasND/Profiles/bcgprofile/config. The script backupConfig.bat/sh takes a backup of all the files present in this directory.

4.      Save the ProductDir/bcghub-distrib/common tree to the backup location.

5.      Uninstall the version 6.1.0.2 hub using uninstall.exe/uninstall.sh, located under ProductDir /_uninst. This will open an uninstallation wizard. Select all components while uninstallation.
Note:
Do not delete the ProductDir/bcgappsdb and ProductDir/common directories.

2.      Revert the bcgapps database and DBLoader to the previously installed version. This will restore the database and customer data.

1.      Uninstall the DBLoader using uninstall.exe/uninstall.sh, located under ProductDir\bcgappsdb\_uninst. Do not drop the database.

2.      Restore the bcgapps database using the backup created before the fix pack was installed.

3.      Run the DBLoader for V6.1.0. Do not run SQL. If you revert to V6.1.0.1, make sure that you run the DBLoader for V6.1.0.1.

3.      Reinstall Hub

1.      Install hub version 6.1.0.0 to the same location ProductDir. If revert to V6.1.0.1, make sure that you run the Hub install for V6.1.0.1.
Note: Be sure to specify the same installation information that was used during the previous installation. For previous fixpack releases, refer to Fixpacks for Websphere Partner Gateway.

2.      Start WebSphere Partner Gateway servers.

3.      Navigate to the ProductDir/bcghub-distrib/bin directory and execute the following:

SimpleDistributed and FullyDistributed mode on Unix:

a.    bcgStartServer.sh console

b.    bcgStartServer.sh receiver

c.    bcgStartServer.sh router

d.    bcgStartServer.sh MAS

Simple mode on Unix:

bcgStartServer.sh

      SimpleDistributed and FullyDistributed mode on Windows:

a.    bcgStartServer.bat console

b.    bcgStartServer.bat receiver

c.    bcgStartServer.bat router

d.    bcgStartServer.bat MAS

            Simple mode on Windows:

bcgStartServer.bat

4.      Restore the previous configuration by executing restoreConfig.bat/.sh backup_file command under ProductDir/bcghub-distrib/wasND/Profiles/bcgprofile/bin. This will restore configuration for all servers (bcgconsole, bcgreceiver, bcgdocmgr, bcgmas and nodeagent) in the following directory: ProductDir/bcghub-distrib/wasND/Profiles/bcgprofile/config

5.      Restore the ProductDir/common tree using the backup copy if it was deleted.




Trademarks and service marks:

For trademark attribution, visit the IBM Terms of Use Web site.