Sun B2B Suite ebXML Protocol Manager User's Guide

Chapter 2 Installing ebXML Protocol Manager

This chapter explains how to install ebXML Protocol Manager, as well as supported operating systems and system requirements. The chapter also includes necessary post-installation procedures.

What’s in This Chapter

Supported Operating Systems

ebXML Protocol Manager for eXchange is available for the following operating systems:

For more details on exact supported operating systems, see the Readme.txt file for eXchange Integrator.

System Requirements

To use ebXML Protocol Manager, you need:

Logical Host Requirements

ebXML Protocol Manager must have its configuration properties set and be administered using Enterprise Designer. For complete information on Enterprise Designer system requirements, see the Sun Java CAPS Installation Guide.

Supported External Applications

ebXML Protocol Manager, in conjunction with eXchange, requires external database support, as described in this section.

Database for eXchange Partner Management and Message Tracking

The eXchange database is required by ebXML Protocol Manager. This database provides a run-time persistent store for Trading Partner (TP) management and message tracking. For eXchange, the following databases are supported:

Database for Persistence and Monitoring via eInsight Engine

In addition, eXchange can optionally use the eInsight engine (supplied with eXchange) to collect and persist data from your B2B protocol processes. This feature provides for recovery and also enables some monitoring and reporting capabilities in Enterprise Manager. The eInsight engine supports the following databases:

Before You Install

Open and review the Readme.txt file for Java CAPS to gain current information you may need, for example for eGate or eInsight, before installing ebXML Protocol Manager. You can find this file in the root directory of the Java CAPS installation’s Repository CD-ROM.

Also, ebXML Protocol Manager has its own Readme.txt file that contains additional information specific to this application, including required ESRs.


Note –

See the Sun Java CAPS Installation Guide for details on how to obtain the Readme.txt , ebXML Protocol Manager sample scenario, and documentation files.


Configuring eGate Projects for Large Messages

If an eGate Project uses SeeBeyond JMS IQ Manager and is estimated to process messages or transactions over 8 MB for Windows, or 16 MB for UNIX, you must increase the Segment Size property of JMS IQ Manager as explained in the eGate Integrator JMS Reference Guide.

Installing ebXML Protocol Manager Product Files

During the Java CAPS installation operation, use Enterprise Manager, a Web-based application, to select and upload ebXML Protocol Manager and add-on application .sar files from the Java CAPS installation CD-ROM to the Repository.

When the Repository is running on a UNIX operating system, you must still install ebXML Protocol Manager using Enterprise Manager and Microsoft Internet Explorer on a Windows computer connected to the Repository server.

Follow the general instructions for installing the Java CAPS, which you can find in the Sun Java CAPS Installation Guide. You must begin by installing eGate.

eGate Installation

The eGate (eGate.sar) installation process includes the following operations:

Before Installing ebXML Protocol Manager

Before you install ebXML Protocol Manager ensure that:

Installing ebXML Protocol Manager

This section explains how to install ebXML Protocol Manager, that is, how to upload the ebXML_Manager.sar file to the Repository.

ProcedureTo install ebXML Protocol Manager

  1. Make sure the eGate.sar file has been uploaded to the Repository using Enterprise Manager.

  2. Make sure you have selected and uploaded, to the Repository, the .sar files listed under eGate Installation and Before Installing ebXML Protocol Manager.

  3. Upload the ebXML_Manager.sar file. This operation installs ebXML Protocol Manager.

  4. Upload ebXML_ManagerDocs.sar (if you have not done so already). This file contains:

  5. ebXML_Manager_Guide.pdf file with the product’s documentation

  6. ebXML_Manager_Sample.zip file containing the sample scenario Projects and related files (see Run-time Steps for details on this file)

  7. Readme.txt file

    To obtain these files, follow the instructions provided by the Sun Java CAPS Installation Guide and Enterprise Manager.

After You Install

Once ebXML Protocol Manager is installed and configured, it must then operate in conjunction with an eGate Project before it can perform its intended functions. You must create these Projects specifically for ebXML Protocol Manager.

See the eXchange Integrator User’s Guide and eGate Integrator User’s Guide for detailed information on incorporating these types of Projects into eGate. See Run-time Steps for a sample business scenario with Projects already created, using eXchange and ebXML Protocol Manager.

The rest of this section provides important information on steps you must take to ensure that ebXML Protocol Manager operates correctly with eGate and eXchange.

Database Scripts

eXchange allows you to collect database information and persist data about your TP profiles. eXchange provides database scripts to create and upgrade this database feature for eXchange. For more information, see the eXchange Integrator User’s Guide.

You can also track message delivery histories, using the eXchange Message Tracking feature. See Using Message Tracking for more information.

Additional Policy .jar Files Required To Run SME

To correctly use ebXML Protocol Manager, you must download and apply additional policy .jar files. This operation provides reliable cryptographic features that use libraries supplied with SeeBeyond Secure Messaging Extension (SME), contained in the SMEWebServices.sar installation file.

The type of .jar files required depends on the version of Java Virtual Machine (JVM) you are using. Refer to your JVM vendor for exact details on the specific policy .jar file requirements.

Use Table 2–1 to determine which JRE is included in your eGate Logical Host.

Table 2–1 JRE Versions Listed by Operating System

Operating System 

JRE 

URL 

Windows, Solaris, HP-UX, Linux, Tru64 

1.4.2 

http://java.sun.com/j2se/1.4.2/download.html 

AIX 

1.4.1 

http://java.sun.com/products/archive/j2se/1.4.1_07/index.html 

ProcedureTo download the required policy.jar files

  1. Scroll to the bottom of the appropriate Web page listed in Table 2–1 for your Logical Host’s JRE.

  2. Click the DOWNLOAD link for Unlimited Strength Jurisdiction Policy Files 1.4.2. (or, for AIX, Unlimited Strength Jurisdiction Policy Files 1.4.1).

  3. Click the link to download the .zip file containing the required policy .jar files as follows:

    • For JRE 1.4.2, follow the link Download jce_policy-1_4_2.zip.

    • For JRE 1.4.1, follow the link Download jce_policy-1_4_1.zip.

  4. Extract the following required policy .jar files:

    • local_policy.jar

    • US_export_policy.jar

  5. For each of your Logical Hosts, using the extracted .jar files, replace the existing versions of these files in the following location:


    <Logical Host>\jre\lib\security\
  6. If you are running a repository on AIX, also replace, using the extracted .jar files, the existing versions of these files in the following location:


    <AIX Repository>/jre/1.4.x/lib/security/
See Also

For complete information on SME, see the Secure Messaging Extension User’s Guide.

Additional File for ebXML Cryptographic Features

For ebXML, you must also download and apply an additional .jar file, xss4j.jar, for XML security. This file can be downloaded as part of the XML Security Suite, from the following Web site:

http://www.alphaworks.ibm.com/tech/xmlsecuritysuite

The only file needed is xss4j.jar. After extracting it, copy it to the following location for each Logical Host:


<logicalhost>\stcis\lib\

Note –

The directories stcis\lib\ are not created by the initial installation. They are created automatically when you first run the Logical Host. If you are copying this file to its correct location, and you have not yet run the Logical Host, you must first create the folders manually.


Configuring eGate Projects for Large Messages

For eGate Projects that are expected to process large messages and transactions, or large numbers of transactions, you can configure the Project in the following ways to increase throughput and improve performance:

Increasing Logical Host Heap Size

To avoid memory errors on the Logical Host, increase the heap size for the Logical Host to at least 1024 MB as explained in this section.

ProcedureTo increase the Logical Host heap size

  1. On the Environment Explorer tab of the Enterprise Designer, select and expand the Logical Host folder.

  2. Right-click the Logical Host, and click Properties.

    The Properties dialog box appears. See Increasing Logical Host Heap Size.

  3. Under Configuration > Logical Host Configuration, enter the heap size 1024 in the Heap Size text box.

  4. When you are finished, click OK.

Improving Performance

The eInsight engine has the following properties that affect performance:

The Max Concurrent Instances property indicates the amount of inbound messages that each BP processes simultaneously. For example, if you set this property to 10, the BP processes up to ten inbound messages at the same time. When the eleventh message is received, the BP does not process the message until the processing of one of the ten messages has been completed.

The Max Runtime Thread Pool Size property defines how many threads that BPs can invoke simultaneously.

These settings constitute a trade-off between performance and memory. Depending on how much memory your system has, you can specify these settings accordingly. There are no recommended settings for these properties because they depend on the specific memory capacity of your system. If your Project processes too slowly or messages are lost, increase these settings as your system allows.

For instructions on configuring run-time properties for the eInsight engine, see the eXchange Integrator User’s Guide. For additional information about these properties, see the eInsight Business Process Manager User’s Guide.

ProcedureTo Improve Performance

  1. On the Environment Explorer tab of the Enterprise Designer, select and expand the Logical Host folder.

  2. Right-click the Integration Server, and click Properties.

    The Properties dialog box appears (see Improving Performance).

  3. Expand the IS Configuration, Sections, and eInsight Engine Configuration folders.

  4. Increase the value of the setting for the Max Concurrent Instances property, as necessary. See Improving Performance.

  5. Increase the value of the setting for the Max Runtime Thread Pool Size property, as necessary. See Improving Performance.

  6. When you are finished, click OK.

Increasing the JMS IQ Manager Segment Size Property

If a Java CAPS Project that uses the SeeBeyond JMS IQ Manager needs to process messages or transactions over 8 MB for Windows or 16 MB UNIX, increase the Segment size property of the JMS IQ Manager, as explained in the eGate Integrator JMS Reference Guide.

Increasing the Oracle Number of Processes

To increase Oracle throughput performance, increase the Oracle number of processes to handle simultaneous database process requests, such as 500. For specific information, refer to your Oracle documentation.