test

Sun B2B Suite ebXML Protocol Manager User's Guide

Chapter 5 Implementation Scenario

This chapter provides an explanation of the sample Projects provided with ebXML Protocol Manager, showing how you can use eXchange to achieve B2B solutions using the ebXML protocol.

What’s in This Chapter

Overview of Sample Implementation

The sample ebXML Protocol Manager Projects’ implementation scenario demonstrates inbound and outbound message processing between the following parties:

For the sample’s scenario, each company has an eXchange installation and trades data. The scenario also demonstrates ebXML in conjunction with SME to illustrate cryptographic features.

Overview of Basic Sample Setup

For complete information, see the eXchange Integrator User’s Guide.

Sample Scenario

The sample Projects, Environments, and related files illustrate the following scenario:

For more information on the file transactions between the companies, see the following sections:

Sample Data

The sample data contains the following files:

Importing Sample Projects and Environments

This section explains how to import the ebXML Protocol Manager sample Project, Environment, and related files. It also lists these files.

Importing the sample’s files requires the following steps:

Extracting Sample Files

This section explains how to extract the ebXML Protocol Manager sample files from the file ebXML_Manager_Sample.zip that contains them. You must perform this operation before you can import an ebXML Protocol Manager sample Project or Environment.

ebXML_Manager_Sample.zip is provided on the CD-ROM with ebXML Protocol Manager. See Chapter 2, Installing ebXML Protocol Managerfor instructions on how to obtain (download) this file.

ProcedureTo extract the sample files

  1. Extract the contents of the ebXML_Manager_Sample.zip file to a temporary directory, for example, C:\temp\eXchange. Make sure you preserve the extracted file paths.

    Note –

    It is recommended that you first create a temporary eXchange directory for the sample files and extract these files to this directory for your convenience. This action allows you to easily access the files while performing procedures provided later in this chapter.

Extracted Files and Directories

If you use the C:\temp\eXchange top-level directories, the following directories and files are created:


 C:\temp\eXchange\Sample\Certificates\CompanyA-Cert.der
C:\temp\eXchange\Sample\Certificates\CompanyB-Cert.der
C:\temp\eXchange\Sample\Data\Atlanta\payload\Blue hills.jpg
C:\temp\eXchange\Sample\Data\Atlanta\payload\payload.xml
C:\temp\eXchange\Sample\Data\Atlanta\Outbound_NoPayload.txt
C:\temp\eXchange\Sample\Data\Atlanta\Outbound_Ping.txt
C:\temp\eXchange\Sample\Data\Atlanta\Outbound_PO_AckReq.txt
C:\temp\eXchange\Sample\Data\Atlanta\Outbound_PO_Binary.txt
C:\temp\eXchange\Sample\Data\Atlanta\Outbound_PO_DupCheck.txt
C:\temp\eXchange\Sample\Data\Atlanta\Outbound_PO_NoAckReq.txt
C:\temp\eXchange\Sample\Data\Atlanta\Outbound_StatusRequest.txt
C:\temp\eXchange\Sample\Data\Berlin\payload\payload.xml
C:\temp\eXchange\Sample\Data\Berlin\payload\Blue hills.jpg
C:\temp\eXchange\Sample\Data\Berlin\Outbound_NoPayload.txt
C:\temp\eXchange\Sample\Data\Berlin\Outbound_Ping.txt
C:\temp\eXchange\Sample\Data\Berlin\Outbound_POAccep_Binary.txt
C:\temp\eXchange\Sample\Data\Berlin\Outbound_POAccep_NoAckReq.txt
C:\temp\eXchange\Sample\Data\Berlin\Outbound_POAcceptance.txt
C:\temp\eXchange\Sample\Data\Berlin\Outbound_StatusRequest.txt
C:\temp\eXchange\Sample\Environments\CommonEnvironments.zip
C:\temp\eXchange\Sample\Keys\CompanyA-Key.p12
C:\temp\eXchange\Sample\Keys\CompanyB-Key.p12
C:\temp\eXchange\Sample\Projects\SampleProjects.zip
C:\temp\eXchange\Sample\TradingPartners\envBerlin_AtlantaSME.xml
C:\temp\eXchange\Sample\TradingPartners\envAtlanta_BerlinSME.xml
Caution – Caution –

If you use the \temp directory, and your system does any kind of auto-delete operation on any directory with this name, you must disable this function.

As shown in the previous list, in addition to files for the Projects and Environments, ebXML_Manager_Sample.zip also contains key, certificate, TP, and data files.

Note –

Before you import the Environments, you must first extract them from the CommonEnvironments.zip file.

If You Use Different Path Locations

If you extract the data files to different locations, modifications are necessary in the appropriate Enterprise Designer configurations. You must also modify the appropriate eXchange ePM fields under the ToPartner and FromPartner tabs.

Importing Sample Projects

Before you import the sample Projects, your Repository must be running, and you must be logged on to Enterprise Designer. If your Repository already has a Project at the root level whose name is identical to any of the Projects you are importing, you must delete or rename such Projects before you start.

ProcedureTo import sample Projects

  1. In Project Explorer, right-click the Repository and, on the context menu, click Import.

  2. In the Import Manager dialog box, browse to the directories where you installed the sample files (such as C:\temp\eXchange\Sample\ebXML\Projects).

    The name of the Project file you must import is SampleProjects.zip.

  3. Select this file and click Import.

    A message appears saying the import operation was successful.

  4. Click OK.

  5. Close the Import Manager dialog box.

    The Project Explorer tree now displays the following Projects under ClientProjects:

    • ClientInebXML

    • ClientOutebXMLAtlanta

    • ClientOutebXMLBerlin

    • HostAtlanta

    • HostBerlin

    • JmsToFile

    • ToInternal

Using Deployment Profiles

To run an ebXML Protocol Manager Project, you must create and activate at least one Deployment Profile for the Project. The general types of Projects are:

Importing Sample Environments

Before you import the sample Environments, your Repository must be running, and you must be logged on to Enterprise Designer. If your Repository already has an Environment at the root level whose name is identical to any of the Environments you are importing, you must delete or rename such Environments before you start.

ProcedureTo Import Sample Environments

  1. In Environment Explorer, right-click the Repository and, on the context menu, click Import.

  2. In the Import Manager dialog box, browse to the directories where you installed the sample files (such as C:\temp\eXchange\Sample\ebXML\Environments).

    The name of the Environment file you must import is CommonEnvironment.zip.

  3. Select this file and click Import.

    A message appears saying the import operation was successful.

  4. Click OK.

  5. Close the Import Manager dialog box.

    The Environment Explorer tree now displays the following Environments:

    • envAtlanta

    • envBerlin

Enterprise Designer Steps

For the ebXML Protocol Manager sample Project implementation, design-time procedures in Enterprise Designer for setting up and activating the sample’s scenario consist of the following operations:

The rest of this section explains these operations.

Setting Up Companies’ Environments

This section explains how to set up the Atlanta and Berlin Companies’ sample Environments, envAtlanta and envBerlin.

The sample assumes you use default configurations for all servers, where possible, and that you make any changes in Enterprise Designer, where needed, for example:

Creating Atlanta Company’s Environment

This section explains how to create the sample’s Environment for the Atlanta Company.

ProcedureTo create the basic components

  1. In Enterprise Designer, near the lower left of the window, click the Environment Explorer tab.

  2. On the Environment Explorer tree, right-click the Repository and, on the context menu, click New Environment.

  3. Name the newly created Environment envAtlanta.

  4. Right-click envAtlanta and, on the menu, click New Logical Host and name the Logical Host lhAtlanta.

    Note –

    If you want to create any additional Logical Host, right-click it and open its Properties dialog box. Click Logical Host Configuration and change the value Logical Host Base Port to a larger multiple of 1000 (28000 if ports 28000-28009 are unused; otherwise 28100 or 29000). When you are finished, close the Properties dialog box.

  5. Create an Integration Sever under lhAtlanta and name it isAtlanta.

  6. Create a Seebeyond JMS IQ Manager under lhAtlanta and name it jmsAtlanta.

ProcedureTo create and configure the nondatabase external system instances

  1. In Enterprise Designer, on the Environment Explorer tree, right-click envAtlanta and, on the context menu, click New BatchFTP External System.

  2. Name the new external system instance extBatchFtpAtlanta, and click OK.

    These operations create, for the Environment, an external system instance for the Batch eWay in FTP mode.

  3. On the new external system’s Properties dialog box, allow the default ports for SOCKS, FTP, and SSH Tunneling.

  4. Create a Batch eWay (local file mode) external system under envAtlanta and name it extBatchLocalFileAtlanta.

  5. Create a File eWay (inbound mode) external system under envAtlanta and name it extFileInAtlanta.

  6. Create a File eWay (outbound mode) external system under envAtlanta and name it extFileOutAtlanta.

  7. Create an HTTP eWay (client mode) external system under envAtlanta and name it extHttpAtlanta.

  8. On the new HTTP eWay’s Properties dialog box, enter the in the following values:

    • URL Syntax: http://www.seebeyond.com

    • Content Type: Leave blank.

  9. Create an HTTP Server eWay external system under envAtlanta and name it extHttpServerAtlanta.

  10. Create a new keystore under envAtlanta and name it envAtlanta_ks_store. See Configuring Companies’ Cryptographic Features for details on how to add keys and certificates to the keystore.

ProcedureTo create and configure the Oracle external system instance

  1. In Enterprise Designer, on the Environment Explorer tree, right-click envAtlanta and, on the context menu, click New Oracle External System.

    Note –

    The eXchange database instance runs on Oracle. For more information Oracle requirements for eXchange and ebXML Protocol Manager, see System Requirements.

  2. Name the new component extOracleOutAtlanta, designate it Outbound Oracle eWay, and click OK.

    These operations create, for the Environment, an external system instance for the Oracle eWay in outbound mode.

  3. Right-click extOracleOutAtlanta and configure properties appropriately, as follows:

    • DatabaseName: SID for your current Oracle system.

    • DataSourceName: local.

    • Delimiter: Symbol #.

    • Description: Oracle thin driver Connection Pool Datasource.

    • Driver Properties: Blank, for this sample.

    • Password: Valid password for the current Oracle system.

    • PortNumber: 1521 (change this value only if your Oracle system administrator changed the default).

    • ServerName: myMachine: Host name of the Oracle server machine.

    • TNS Entry: Blank, for this sample.

    • User: Valid user ID for the current Oracle system.

  4. When all properties have been configured correctly for your site, click OK.

When You Are Finished

Creating Berlin Company’s Environment

This section explains how to create the sample’s Environment for the Berlin Company.

ProcedureTo create the basic components

  1. Follow the steps provided under the Creating Atlanta Company’s Environment.

  2. Name the appropriate components as follows:

    • envBerlin

    • lhBerlin

    • isBerlin

    • jmsBerlin

ProcedureTo create and configure the nondatabase external system instances

  1. Follow the steps provided under the Creating Atlanta Company’s Environment, under envBerlin.

  2. Name the appropriate external system instances as follows:

    • extBatchFtpBerlin (use default properties)

    • extBatchLocalFileBerlin

    • extFileInBerlin

    • extFileOutBerlin

    • extHttpBerlin (use the same properties values as extHttpAtlanta)

    • extHttpServerBerlin.

    • envBerlin_ks_store.

ProcedureTo create and configure the Oracle external system instance

  1. Follow the steps provided under the Creating Atlanta Company’s Environment, using envBerlin.

  2. Name the new component extOracleOutBerlin, designate it Outbound Oracle eWay.

  3. Configure extOracleOutBerlin as shown in the list provided in step Creating Atlanta Company’s Environment under the Creating Atlanta Company’s EnvironmentCreating Atlanta Company’s Environment.

When You Are Finished

Updating Files for Java Collaboration Definitions

Special steps are required to update the ebXML Protocol Manager’s sample Java Collaboration Definitions (JCDs) to take advantage of the cryptographic .jar files used in SME and the sample.

ProcedureTo update the JCDs used for signing and verifying

  1. In Enterprise Designer’s Project Explorer tree open this Project folder: SeeBeyond > eXchange > User Components > Crypto > Sign > JCDs.

  2. For each of the four elements under the JCDs folder, perform the following steps:

    1. Right-click the JCD and check it out.

    2. Double-click the JCD to edit it in the Collaboration Editor (Java).

    3. On the Tool Palette, click Import JAR file.

    4. In the Add/Remove Jar Files dialog box, click Add.

    5. Navigate up four levels, then down to SeeBeyond > SME > External JARs.

    6. Select the file com.stc.smeapi.jar.

    7. Click Import and click Close.

    8. Click Save.

See Also

For more information, see the eGate Integrator User’s Guide.

Setting Up Companies’ B2B Host Projects

On the Project Explorer tree, you can open a B2B host Project (HostBerlin or HostAtlanta) to display its components. This section provides a summary of a B2B host’s contents.

Activating a B2B host Project creates an eXchange service that acts as a channel manager and provides a connection to Message Tracking and the eXchange database instance.

See Using Message Tracking and the eXchange Integrator User’s Guide for more information on Message Tracking.

Components of Companies’ B2B Host Projects

The following list describes the B2B host Projects’ components and their functions:

The Enterprise Designer canvas cmHostAtlanta is a Connectivity Map. It shows a graphical view of the cmHostAtlanta components.

This Connectivity Map has the following components:

The Enterprise Designer canvas cmHostBerlin is also a Connectivity Map (similar to Components of Companies’ B2B Host Projects) and has the following components:

Configuring eWays on Connectivity Maps

This section explains how to configure the properties of eWay external system instances on the sample Projects’ Connectivity Maps.

Note –

If directories listed in this section are not already present as subdirectories of C:\temp\eXchange\Sample\, you must create them, according to the path locations shown.

Use the default properties, except in the following cases:

File eWay: From Atlanta

The Atlanta Company’s clientOutebXMLAtlanta Project Connectivity Map cmClientOutebXML has an eWay external system instance named extFileIn. Modify the default properties as follows:

File eWay: From Berlin

Inbound: The Berlin Company’s clientOutebXMLBerlin Project Connectivity Map cmClientOutebXML has an eWay external system instance named extFileIn. Modify the default properties as follows:

Batch eWay

Configure the Target Directory Name property for the external system instance extBatchLocalFileOut on the Connectivity Map cmToInternal as follows:


C:\temp\eXchange\Sample\Data\ToInternal

Activating Companies’ B2B Host Deployment Profiles

Before performing this operation, make sure you are using the current Project’s Environment (envAtlanta or envBerlin) and that it contains a correctly installed and configured Oracle external system instance (see the Creating Atlanta Company’s Environment). Your Oracle system must be running, because the eXchange database instance runs on Oracle.

Note –

When you activate a B2B host, eXchange automatically creates another external system instance, an eXchange service. For more information on this service, see the eXchange Integrator User’s Guide .

ProcedureTo activate the B2B host’s Deployment Profile for the Atlanta Company

  1. On Enterprise Designer’s Project Explorer tree, right-click HostAtlanta and, on the context menu, point at New and click Deployment Profile.

  2. Name the new Deployment Profile dpHostAtlanta, point it at envAtlanta, and click OK.

    The Deployment Editor opens. Its left pane shows two services and two Oracle external system instances (representing Oracle eWays).

    Its right pane contains windows representing the basic components and external system instances in envAtlanta.

  3. On the right pane, minimize all windows except lhAtlanta and extOracleOutAtlanta.

  4. Click the Automap button. See Activating Companies’ B2B Host Deployment Profiles.

    The services and eWays automatically map to the appropriate windows on the right pane. The result looks like Activating Companies’ B2B Host Deployment Profiles, except without the eXchange service.

  5. Click Save All.

  6. Click Activate to activate the Deployment Profile.

    A dialog box appears, indicating the activation is successful. A new external system instance is created, named bhAtlanta1 eXchange Service. You can view this service on envAtlanta on the Environment Explorer tree, as well as on the right pane of Deployment Editor.

    A dialog box appears with a message communicating the status of the activation. If the activation is not successful, repeat the steps in this procedure, carefully rechecking every action. If the activation is successful, go on to the next step.

  7. After the Deployment Profile is activated successfully, a dialog box with the message Apply Environment updates as well. [LogicalHost may be restarted] appears, prompting you to apply the changes to all running Logical Hosts. You can take one of the following actions:

    • If no Logical host is running, click No.

    • If one or more Logical Hosts are running, click Yes, then decide whether there are Environment changes to be applied and:

      • If yes, check the check box and press Enter.

      • If no, clear the check box and press Enter.

        Note –

        For the purpose of this sample Project, at this point in the procedure, leave the dialog box’s check box checked and press Esc .

  8. When you are finished, click Save All, close all canvases, and click Refresh All from Repository.

ProcedureTo activate the B2B host’s Deployment Profile for the Berlin Company

  1. On Enterprise Designer’s Project Explorer tree, right-click HostBerlin and, on the context menu, point at New and click Deployment Profile.

  2. Name the new Deployment Profile dpHostBerlin, point it at envBerlin, and click OK.

    The Deployment Editor opens. Its right pane shows two services and two Oracle external system instances (representing Oracle eWays).

    Its left pane contains windows representing the basic components and external system instances in envBerlin. The result is similar to that shown in Activating Companies’ B2B Host Deployment Profiles.

  3. On the right pane, minimize all windows except lhBerlin and extOracleOutBerlin.

  4. Click the Automap button (see Activating Companies’ B2B Host Deployment Profiles).

    The services and eWays automatically map to the appropriate windows on the right pane.

  5. Click Save All.

  6. Click Activate to activate the Deployment Profile.

    A dialog box appears, indicating the activation is successful. A new external system instance is created, named bhBerlin1 eXchange Service. You can see this service on envBerlin, under extOracleOutBerlin on the Environment Explorer tree.

    The result is similar to that shown in Activating Companies’ B2B Host Deployment Profiles.

  7. Click or press the appropriate button or key to close the dialog box.

    Note –

    For the purpose of this sample Project, at this point in the procedure, leave the dialog box’s check box checked and press Esc .

  8. When you are finished, click Save All, close all canvases, and click Refresh All from Repository.

Troubleshooting Tips

If extOracleOutAtlanta or extOracleOutBerlin refuses to accept eWays, this issue may be an indication that the referenced eXchange database instance is:

Configuring Companies’ Cryptographic Features

This section explains how to configure the eXchange Service’s cryptographic features.

Note –

To use ebXML Protocol Manager’s cryptographic features, make sure you have installed the appropriate . jar files, as explained under After You Install.

Since the sample assumes you are using cryptographic features (encryption, decryption, signatures, and verifications), additional steps are required for configuring these features for bhAtlanta1 eXchange Service and bhBerlin1 eXchange Service.

Note –

If the Logical Host is running while you are configuring private keys, you must apply any changes you make by selecting the Environment Explorer tree, then right-clicking lhAtlanta or lhBerlin (whichever is current) and, on the context menu, click Apply.

ProcedureTo configure the private key for the Atlanta Company

  1. On the envAtlanta Environment Explorer tree, right-click envAtlanta_ks_store.

  2. On the context menu, click Manage Private Keys.

    A Private Keys dialog box appears.

  3. Click Import.

    An Import Private Keys dialog box appears.

  4. Enter the following information, all lower-case:

    • Alias: privatekey1

    • Password: companya

  5. Browse to and select the CompanyA-Key.p12 file (see Extracted Files and Directories).

  6. Click OK, then click Close.

  7. Right-click bhAtlanta1 eXchange Service and, on the context menu, click Properties.

    A Properties dialog box appears. This dialog box allows you to configure the public and private keys for the current B2B host’s XDC named xdc_Atlanta_ebXML_via_HTTP.

  8. Using the drop-down menus, select privatekey1 under the Signature Key and Decryption Key columns. See Configuring Companies’ Cryptographic Features.

  9. Click OK.

    Note –

    If privatekey1 does not appear in the drop-down list, click the ellipsis [...] and click Import. Using the alias privatekey1 , import the CompanyA-Key.p12 file with the previously given password.

  10. When you are finished, click Save All.

ProcedureTo configure the public certificate for the Atlanta Company

  1. On the envAtlanta Environment Explorer tree, right-click envAtlanta_ks_store.

  2. On the context menu, click Manage Public Certificates.

    A Public Certificates dialog box appears.

  3. Click Import.

    An Import Public Certificates dialog box appears.

  4. Enter the following information, all lower-case:

  5. Alias: signkey

  6. Browse to and select the CompanyB-Cert.der file (see Extracted Files and Directories).

  7. Click OK, then click Close.

  8. When you are finished, click Save All.

    Note –

    Additionally, if the Logical Host is running, you must, on the Environment Explorer tree, right-click lhAtlanta or lhBerlin and, on the context menu, click Apply.

ProcedureTo configure the private key and public certificate for the Berlin Company

  1. Follow the envAtlanta steps provided under the Configuring Companies’ Cryptographic Features and the Configuring Companies’ Cryptographic Features with envBerlin, with the following exceptions:

    • For the envBerlin key store password, enter companyb.

    • Import the CompanyB-Key.p12 file

    • Import the CompanyA-Cert.der file.

      Note –

      See Extracted Files and Directories.

Results

The appropriate cryptographic information is now configured and associated with the following XDCs for each B2B Host:

Creating Additional Deployment Profiles

On Project Explorer, you must create, automap, and activate additional Atlanta and Berlin Company Deployment Profiles for the rest of the Projects in the sample scenario, in the same way as described previously.

Create additional Deployment Profiles for the appropriate Environments and with the names, as shown in Table 5–1.

Table 5–1 Additional Deployment Profiles

Projects 

Deployment Profiles and Names 

Environments 

ClientOutebXMLAtlanta 

dpOutEbXMLAtlanta 

envAtlanta 

ClientOutebXMLBerlin 

dpOutEbXMLBerlin 

envBerlin 

ClientInebXML 

dpInEbXMLAtlanta 

envAtlanta 
 

dpInEbXMLBerlin 

envBerlin 

JmsToFile 

dpFileAtlanta 

envAtlanta 
 

dpFileBerlin 

envBerlin 

Main (created by eXchange) 

dpMainAtlanta 

envAtlanta 
 

dpMainBerlin 

envBerlin 

Importing and Configuring TPs in ePM

This section explains how import TPs, as well as how to enter values and use the ePM configuration parameters for the TPs in the sample scenario.

Note –

For procedures on how to create TPs, see the eXchange Integrator User’s Guide.

Getting Started

Before you begin, your Repository and your eXchange database (Oracle) must be running and accessible. Enterprise Designer does not need to be running, and you do not need to have any Logical Hosts running.

In addition, you must perform the following operations:

The rest of this section explains these operations. For detailed information on configuring ePM, see Increasing the Oracle Number of Processes.

Starting ePM

This section explains how to start running ePM.

ProcedureTo start eXchange ePM

  1. Start a new browser session (that is, do not clone a new window of an existing session)

  2. Enter a Repository URL, with epm appended, for example:

    • If your Repository were running local on port 12000, the URL is:


          http://localhost:12000/epm

    • For a Repository running on machine herMachine on port 33000, the URL is:


          http://herMachine:33000/epm

    • IP addresses are also permissible, for example:


          http://10.18.75.85:36271/epm

      The string epm is case sensitive. In other words, ePM, Epm, and EPM are all errors.

  3. When the sign-in window appears, enter Enterprise Manager user name and password and click Sign In.

    The initial ePM window appears.

Importing TPs

Your next step is importing the Atlanta and Berlin Company TPs (TP files), as explained under this section. Keeping track of the TPs, where they are sent from and where they are received depends on which company is the current company. See Current Company Viewpoint and TPs.

This sample scenario has the following TPs:

ProcedureTo import the tpBerlin to envAtlanta

  1. From the initial ePM window, on the upper left side, click Import.

    The Import New Trading Partner window appears.

  2. Open B2B Repository then open envAtlanta.

  3. Select bhAtlanta1.

  4. Enter tpBerlin as the name for the new TP.

  5. Browse to


     C:\temp\eXchange\Sample\ebXML\TradingPartners
 and select the envAtlanta_BerlinSME.xml file and click Import.

    On the Explorer tree tpBerlin appears under envAtlanta.

ProcedureTo locate tpBerlin in the ePM window

  1. In the upper left side of the ePM window, click Select.

    A new window opens, prompting you to select a B2B host and TP.

  2. Open the B2B Repository and envAtlanta and click bhAtlanta1.

  3. Click Search, then click OK.

    On the Explorer tree tpBerlin reappears under envAtlanta.

ProcedureTo import tpAtlanta to envBerlin

  1. Follow the same steps as those in the Importing TPs, with the following exceptions:

    • Under B2B Repository open envBerlin.

    • Select bhBerlin1 and enter tpAtlanta as the TP name.

    • Import the file envBerlin_AtlantaSME.xml.

ProcedureTo locate tpAtlanta in the ePM window

  1. Search for tpAtlanta under envBerlin and bhBerlin1.

Current Company Viewpoint and TPs

When you are configuring a TP and pointing it to envAtlanta, you must take the viewpoint of that Environment’s company. So, the Atlanta Company’s TP is tpBerlin.

Therefore, in terms of the companies, ToPartner means from the Atlanta Company and FromPartner to the Atlanta Company.

Conversely, When you are configuring a TP and pointing it to envBerlin, you must take the viewpoint of that Environment’s company. So, the Berlin Company’s TP is tpAtlanta.

Therefore, in terms of the companies, ToPartner means from the Berlin Company and FromPartner to the Berlin Company.

Configuring TP Parameters

When you import a TP, its related configuration parameter values are set in part based on parameters stored in the export file and in part based on the name of the TP. This section explains how to update these parameters under the following sections:

XDC Parameters

You must set the configuration properties governing the Atlanta or Berlin Company’s message exchange with the appropriate TP using the companies’ XDCs, both named ebXMLProtocol_delivery_channel1. These properties are the XDC parameters.

Before you begin to configure these parameters, be sure to display the appropriate TP’s name in the ePM Explorer (lower left side of the window).

Note –

The channels named External Delivery Channels (XDCs) in Enterprise Designer are named Delivery Channels in ePM. When referring to this component in ePM, the text still uses the term XDC, except when referring to specific text in the user interface.

This section explains how to set the Delivery Channel (external) parameters governing message exchange for tpAtlanta and tpBerlin.

ProcedureTo configure the XDC parameters for the current TP

  1. In the Explorer (lower left) side of ePM, click tpAtlanta or tpBerlin.

    The canvas displays the TP’s general properties.

  2. Click the Components tab.

    The selected TP’s XDC parameters for that tab appear (see the following table.).

    Binding Name 

    tpAtlanta: xdc_Berlin_ebXML_via_HTTP

    tpBerlin: xdc_Atlanta_ebXML_via_HTTP

    ToPartner Transport Name 

    HTTP 

    FromPartner Transport Name 

    HTTP 

    Packager Name 

    ebXML 

  3. Click the appropriate binding name. You are now entering parameters for this current binding.

    Note –

    The General parameters allow you to define general eXchange settings. See the eXchange Integrator User’s Guide for information on these parameters.

  4. Click the ToPartnerTransport tab.

    The tab’s parameters appear. These parameters allow you to supply information needed to transport data to the TP, that is, allowing the TP to receive data.

  5. For Use Synchronous Channel and Track For Auditing, enter false for both TPs.

  6. For All Purpose End Point, enter:


    http://<machine_ID><port_no>

    Where:

    • machine_ID: The name or IP address of the TP’s destination machine.

    • port_no: The name of the TP’s destination port number.

  7. Enter the value for Destination URL. The URL syntax used for this parameter is:


    http://<machine_ID><port_no>/<dep_profile>_servlet_<MSH_type>/    <MSH_type>

    Where:

    • machine_ID: The name or IP address of the TP’s destination machine.

    • port_no: The TP’s destination machine port number.

    • dep_profile: The current deployment profile name.

    • MSH_type: The message service handler type, in this case, ebXMLMSH.

      For the sample, enter:


      tpBerlin: http://<Atlanta_machine_ID>:<Atlanta_port_no>/dpInEbxmlBerlin_servlet_ebXMLMSH/ebXMLMSH

tpAtlanta: http://<Berlin_machine_ID>:<Berlin_port_no>/dpInEbxmlAtlanta_servlet_ebXMLMSH/ebXMLMSH

  8. Leave the rest of the parameters blank.

  9. When you are finished, click Save.

    Note –

    Be sure to click Save after you are finished configuring the parameters on each tab.

  10. Click the FromPartnerTransport tab.

    The tab’s parameters appear. These parameters allow you to supply information needed to transport data from the TP.

  11. Enter the values under the FromPartnerTransport tab in the same way as you do the ToPartnerTransport tab (see steps earlier in this procedure). Keep in mind that these are the values that allow you to send data from the TP.

  12. Click the ToPartner Packaging tab, and enter values for tpBerlin as shown in the following table.

    Note –

    The parameters listed in ePM before Soap Media Type are standard eXchange parameters. See the eXchange Integrator User’s Guide. for information on how to configure these parameters.

    Parameter 

    Value 

    SOAP Media Type 

    Multipart/Related 

    Digital Envelope Protocol 

    http://www.w3.org/2001/04/xmlenc# 

    Non-repudiation Protocol 

    XMLDSIG 

    Signature Algorithm 

    http://www.w3.org/2000/09/xmldsig#rsa-sha1 

    Digest Method/HashFunction 

    http://www.w3.org/2000/09/xmldsig#-sha1 

    Canonicalization Method 

    http://www.w3.org/TR/2001/REC-xml-c14n-20010315 

    Encryption Algorithm 

    DES3 

    Signature Type 

    SoapEnveloped 

    Ack Signature Required 

    perMessage 

    Ack Request is Per Message 

    true 

    Duplicate Elimination is Per Message 

    true 

    SOAP Actor 

    urn:oasis:names:tc:ebxml-msg:actor:toPartyMSH 

    Sync Reply 

    mshSignalsOnly 

    Language 

    en-us 

  13. Click the FromPartner Packaging tab and edit the parameters as listed in the following table.

    Note –

    The parameters listed in ePM before Signature Type are standard eXchange parameters. See the eXchange Integrator User’s Guide for information on how to configure these parameters.

    Parameter 

    Value 

    Digital Envelope Protocol 

    http://www.w3.org/2001/04/xmlenc# 

    Non-Repudiation Protocol 

    XMLDSIG 

    Signature Type 

    SoapEnveloped 

    Ack Signature Required 

    perMessage 

    Ack Request is Per Message 

    true 

    Duplicate Elimination is Per Message 

    true 

    SOAP Actor 

    urn:oasis:names:tc:ebxml-msg:actor:toPartyMSH 

    Sync Reply 

    mshSignalsOnly 

    Language 

    en-us 

  14. With the ToPartnerPackaging tab open, click Import (to the right of the Encryption Key text box) to import the current company’s public certificate.

    The Import a Certificate dialog box appears. Import the certificate as follows:

    • For Certificate Name, enter the appropriate certificate alias.

    • For Import from file, click Browse and navigate to the current company’s certificate file. See Extracted Files and Directories for file names.

    Note –

    If you are importing a certificate using ePM, you must apply the changes made during this step to the current Environment or restart the Logical Host. Otherwise, the certificate does not appear in the . keystore file.

  15. Repeat step 13 for the FromPartnerPackaging tab.

  16. When you are completely finished, click Save.

IDC Parameters

You can set the parameters governing the current company’s internal message processing, when handling messages received and preparing messages to be sent. These properties are the IDC parameters.

Before you begin to configure these parameters, be sure to display the appropriate TP’s name in the ePM Explorer (lower left side of the window).

Note –

IDC bindings are optional and not required for an ebXML Protocol Manager Project.

This section explains how to set the Internal Delivery Channel parameters used for the current company’s internal message processing.

Note –

In the sample scenario, tpBerlin (for the Atlanta Company) has no IDCs.

ProcedureTo configure the IDC parameters for the tpBerlin

  1. In the Explorer, click tpBerlin.

    The canvas displays the TP’s general properties.

  2. Click the Components tab.

    The current TP’s delivery channel parameters are displayed.

  3. Click the Internal Delivery Channels tab for the current TP.

    The IDC parameters appear. See the following tables.

    Binding Name 

    idcAtlanta_ebXML_Send_via_File 

    Direction 

    Sender 

    Transport Name 

    JMS 

    Binding Name 

    idcAtlanta_ebXML_Rcv_via_File 

    Direction 

    Receiver 

    Transport Name 

    JMS 

  4. To continue IDC configuration for tpBerlin, click the binding name for the first IDC (idcAtlanta_ebXML_Send_via_File), click the Sender Transport tab, and make changes as shown in the following table.

    FilePattern: * 

    *.txt 

    Directory: * 

    C:\temp\eXchange\Sample\Data\Atlanta\OutboundebXML\

  5. To finish IDC configuration for tpBerlin, click the binding name for the second IDC (idcAtlanta_ebXML_Rcv_via_File), click the Sender Transport tab, and make changes as shown in the following table.

    FilePattern: * 

    *.txt 

    Directory: * 

    C:\temp\eXchange\Sample\OutputebXML\

  6. When you are finished, click Save.

    Note –

    See Increasing the Oracle Number of Processes and the eXchange Integrator User’s Guide for more information.

Messaging Actions Parameters

You must also configure ebXML Protocol Manager’s messaging actions under the ePM Messaging Service Configuration. These settings control messaging actions (inbound and outbound) for an ebXML MAD.

Configure the Properties and Messaging Actions for the TPs, using the parameters under these tabs, for the appropriate Messaging Service.

These configuration parameters define settings that allow ebXML Protocol Manager to set up, control, and order the sending and receiving of messages. For information on how to configure these parameters, see Configuring Messaging Actions.

TP Activation

This section explains how to activate a TP. You must save all the configuration information to the eXchange database instance to make it available at run time. Before you begin to activate a TP, the eXchange database instance for the corresponding B2B host must be running.

ProcedureTo activate a TP

  1. In the Explorer (lower left) side of the ePM window, click tp Berlin or tpAtlanta .

  2. In the bottom lower left of the canvas, click Activate.

  3. In response to the confirmation prompt, click Activate.

    The canvas displays the following confirmation message:

    Trading Partner is successfully activated

Initial Run-time Steps

For ebXML Protocol Manager sample Project implementation, initial run-time steps consist of:

Starting Logical Hosts

The procedures in this section assume you have installed two or more Logical Hosts, and that you have replaced the additional files as listed under the following sections:

Applying Deployment Profiles to Logical Host

At this point, apply all Deployment Profiles to the appropriate Environment’s Logical Host. Return to previous procedures in this chapter to troubleshoot any possible problems appropriately until all Deployment Profiles apply with no errors.

Running Logical Host

The directory for the Logical Host that runs the Atlanta Company is called lhAtlanta (associated with envAtlanta), and the directory for the Logical Host that runs the Berlin Company is called lhBerlin (associated with envBerlin).

ProcedureTo run the current Logical Host for the first time

  1. Access a command prompt and change directories to the run executable file’s location (for example, beginning with lhAtlanta) of the Logical Host:


    cd lhAtlanta\bootstrap\bin

  2. Start the run script using the appropriate parameters, for example:


    bootstrap- r http://<myMachine:12345>/<myRepository>- i <myID>
    -p <myPassword>- e envAtlanta- l lhAtlanta -f

    Where:

    • For the -r (Repository) parameter), supply the correct URL with the Repository name.

    • For the -i and -p (user ID and password) parameters, supply the appropriate values.

    • For -e (Environment name) parameter, use envAtlanta

    • For -l (Logical Host name) parameters, use lhAtlanta

    • You need not supply the -f (force) flag if all configuration changes have already been applied, or if this is the first time that the run script has been executed.

    After a brief time, the Logical Host starts running, and all activated Projects that reference envAtlanta are automatically applied to it.

  3. Repeat steps Step 1 and Step 2 on the envBerlin Logical Host, referencing the same Repository but pointing it at lhBerlin, for example:


    cd lhBerlin\bootstrap\bin

bootstrap- r http://<myMachine:12345>/<myRepository>- i <myID>
    -p <myPassword>- e envBerlin- l lhBerlin -f

ProcedureTo run the Logical Host at later times

  1. Enter the command bootstrap.

Applying Changes Without Shutting Down Logical Host

This procedure is optional. You only need to use it if changes are made to parameters in an Environment while a Logical Host is running, for example, adding or modifying keystores for an eXchange service.

Use these steps to apply the changes without having to shut down and rerun the Logical Host. This procedure is the equivalent of shutting down the Logical Host and running it again using the -f flag.

ProcedureTo apply Environment changes when a Logical Host is running

  1. In Enterprise Designer’s Environment Explorer, open the Environment where the changes have occurred.

  2. Right-click the Logical Host that is running and, on the context menu, click Apply.

  3. Repeat the previous step, as needed, for other Logical Hosts in the same Environment.

    In the Logical Host, a brief shutdown and restart occur, and the changes are applied to the running Logical Host.

Supplying Input Data

Before you begin, your Logical Hosts must both be running and the Oracle system used by the eXchange database instance must be accessible to eXchange.

The originating B2B host sends an outbound status request and receives an inbound status response. The originating ePM sends an outbound “ping” and receives an inbound “pong.”

Both companies can trade data back and forth with one another, so you can reverse the inbound and outbound settings, depending on which company you want to be the sender and which the receiver. The sample’s scenario (as supplied) is set up according to the procedure in this section.

See Sample Data for a list of the sample scenario’s data files and the directory locations created when the sample scenario’s files are first extracted.

Note –

You may have given different names to the \temp\eXchange\ directories shown in the path locations listed under Sample Data. If so, substitute those names for the \temp\eXchange\ directories given in this procedure.

ProcedureTo send input data to the HostBerlin Project

  1. Before you start, change the .txt file extensions for your outbound data to .~in.

  2. Copy the outbound data files to the following directory:


    C:\temp\eXchange\Sample\Data\Atlanta\OutboundebXML\

  3. Make sure the file names of your outbound data (any of the files you want to send) have .txt file extensions. Any file with a .txt file extension changes to .~in as the file is picked up for delivery by eXchange.

    This operation also copies the information in the payload data files and sends it along with the outbound files, so you see no change to the payload data file names. The Berlin Company returns the inbound data files to the following directory:


    C:\temp\eXchange\Sample\Data\ToInternal

    You can use the Message Tracking tool in eXchange to view the acknowledgement message. See the next section for information on how to use Message Tracking.

Using Message Tracking

eXchange provides a special feature, Message Tracking, allowing you to monitor the status of messages as they are received and processed through eXchange and ebXML Protocol Manager.

Before You Begin

Accessing Message Tracking

This section explains how to access an instance of Message Tracking.

ProcedureTo access Message Tracking

  1. Start a new browser session (that is, do not clone a window of an existing session).

  2. Point your browser at the following URL:


    http://<loghostname>:<port>/<appname>/msgTrack/EnterPkgTrack.do

    Where:

    • loghostname: The host name or IP address of a Logical Host running your Project, that is, the current Logical Host.

    • port: is The Web server connector port configured in your Integration Server. To discover this information, use Environment Explorer to open the current Logical Host. Right-click the Integration Server and select Properties. Open IS Configuration > Sections > Web Container > Web Server > Default Web Server; port is the value set for Connector Port. If you have several Web server configurations, check them also.

      The default port-number value is 18004 for the first Integration Server in the first-created Logical Host (or 19004 for the first Integration Server in the second-created Logical Host, and so on).

    • appname: The name of the Message Tracking instance as it appears on the current Connectivity Map.

Example 5–1 Message Tracking Initial Window, on Startup

Example: To access Message Tracking for the ebXML Protocol Manager sample scenario, use the following URL:


http://localhost:18004/mtrk1/

As stated previously, the sample must be running before you access Message Tracking, and messages must have been passed before any become accessible. When you first run Message Tracking, its initial window appears.

Message Tracking Operation

This section explains how to use the Message Tracking feature.

ProcedureTo search by B2B host, TP, and protocol

  1. Under Search Criteria, use the current B2B host’s drop-down list to choose the B2B host whose messages you want to examine, then click GO.

  2. Under Trading Partner, either click ALL or choose a particular TP from the drop-down list.

  3. Under Protocols, either click ALL or choose a protocol from the drop-down list.

  4. At the lower left of the window, click SEARCH.

    The canvas (right side), under Search Results, displays a page containing the Package IDs of the previous ten tracked messages fitting the criteria you specified. Navigation links (Previous, Next, and Go to Page) allow you to view other pages of ten results each.

ProcedureTo search by B2B host, protocol, and Package ID

  1. Under Search Criteria, use the current B2B host’s drop-down menu to choose the B2B host whose messages you want to examine, and click GO.

  2. Under Protocols, either click ALL or choose a particular protocol from the list.

  3. Under Package Type (to search by Package ID) either click ALL or choose a particular packaging protocol from the drop-down list. Perform the next steps:

    1. Under ID, enter a string for matching the message ID.

    2. At the lower left of the window, click SEARCH.

      The canvas displays a page containing the Package IDs of the previous ten tracked messages fitting the criteria you specified.

ProcedureTo filter results by error type, direction, and/or date

  1. After performing a search, or after setting up a search using either of the two previous procedures, you can specify one or more further search criteria.

ProcedureTo Specify Additional Search Criteria

  1. Near the bottom of the left pane, under Filters, specify one or more of the following characteristics:

    • Error Type: If you do not choose ALL, you can restrict your search either to display error messages only, or to display nonerror messages only.

    • Direction: If you do not choose ALL, you can restrict your search either to display inbound messages only, or to display outbound messages only.

    • Date: You can choose to include only those messages whose processing date exists within a range you specify, or only those messages whose acknowledgment date exists within the range.

  2. At the lower left of the window, click SEARCH.

    The canvas displays a page containing the Package IDs of the previous ten tracked messages fitting the criteria you specified.

    On a package-by-package basis, you can also view the message text. After you view the text in a new window, you can preform cut, copy, and paste operations on any text in the window.

ProcedureTo obtain details of a specified package

  1. After obtaining results from a search, using any of the procedures provided earlier, click the Package ID name for any of the returned results.

  2. In the Details for package <package-ID> pane, click Open to view the contents of the current message in a new window.

    Note –

    Keep in mind that the current message could be encrypted, depending on your selection for the encryption parameters in the ePM configuration.