Chapter 4 Quick Start Guide

This chapter provides a basic, general description of how to successfully operate ebXML Protocol Manager in eXchange. Its purpose is to provide a summary of how to get started using ebXML Protocol Manager.

What’s in This Chapter

• Overview: Basic Operations and Concepts

• Design Steps in Enterprise Designer

• Creating and Configuring TPs in ePM

• Run-time Steps

For more information on any of the topics discussed in this chapter, see the eXchange Integrator User’s Guide. You can also refer to the steps, as provided in Run-time Steps, for setting up the sample Projects that come with the ebXML Protocol Manager installation CD-ROM.

Overview: Basic Operations and Concepts

The following list describes the basic operations necessary to use ebXML Protocol Manager successfully:

• Create, design, deploy, and activate the appropriate Projects and their Deployment Profiles (DPs), using Enterprise Designer.

• As part of the previous operations, create and set up an Oracle external system instance on a B2B host’s Environment using Enterprise Designer. For more information on Oracle database requirements for eXchange and ebXML Protocol Manager, see System Requirements.

• Also using Enterprise Designer, set up the appropriate features on the current Project’s Environment. This operation includes some configuration steps.

• Configure and activate eXchange external and internal delivery channels (XDCs and IDCs) in ePM for the Trading Partners (TPs). This operation includes setting general eXchange configuration parameters and configuration steps specific to ebXML.

  ---

  Note –

  See Increasing the Oracle Number of Processes for information on how to configure ebXML Protocol Manager in ePM.

  ---

• Perform the required initial run-time steps and run the Project.

This chapter briefly and generally describes the installation, setup, design, and run-time steps required to get an ebXML Protocol Manager Project and its ePM configuration set up and running. The chapter’s purpose is to provide a quick, easy set of procedures for reaching these goals, for the user who does not necessarily want or need all of the details.

For a complete, more detailed explanation of how to perform these steps, using the sample scenario provided with the CD-ROM with ebXML Protocol Manager, see Run-time Steps. The rest of this chapter describes, in general and without detail, how you can quickly perform the steps shown in the previous list.

Design Steps in Enterprise Designer

For ebXML Protocol Manager sample Project implementation, design-time procedures in Enterprise Designer consist of the following basic operations:

• Setting Up B2B Host Projects

• Creating and Activating Project DPs

The rest of this section describes these operations.

Setting Up B2B Host Projects

You must create a B2B host Project for each ebXML Protocol Manager installation. This section provides a summary of this operation.

For complete information on how to perform these operations, see the eGate Integrator User’s Guide and the eXchange Integrator User’s Guide, as well as the sample scenario provided in Chapter 5, Implementation Scenario.

Using Projects

Before you can use the ebXML Protocol Manager with eXchange, perform the following actions:

• Create and set up at least one ebXML B2B host Project

• Create and set up other Projects, as needed

• Deploy and activate the Project Profiles

The sample scenario provided in Chapter 5, Implementation Scenario assumes you use the sample Projects provided and the default configurations where possible.

Using Environments

Each ebXML Protocol Manager installation requires at least one Environment. The sample scenario provided in Chapter 5, Implementation Scenario assumes you use the sample Environments provided and the default configurations for all servers where possible.

You must also make any changes where needed, for example:

• Ports: Run the SeeBeyond Integration Server on ports 18000 through 18009; to use a different application server, you must use different port numbers.

• HTTP(S): To configure your HTTP server or client to use SSL, see the HTTP(S) eWay Intelligent Adapter User’s Guide for eWay settings and Integration Server configuration.

• Oracle: You must create a new outbound Oracle external system instance and configure it. The eXchange database instance runs on Oracle.

Each of the companies in the sample scenario has an eXchange installation with one Environment.

Creating B2B Host Projects’ Environments

Your first step is to create the Project’s Environment and its basic setup as follows:

• Using Enterprise Designer, create a new Environment.

• Create at least one new Logical Host, as follows:

  • Create the Integration Server for the Logical Host.

  • Create the SeeBeyond JMS IQ Manager for that Logical Host.

  Create a keystore then import at least one key file and certificate file to activate the protocol’s cryptographic features.

Create the following external system instances:

• Batch eWay in local file mode

• Inbound and outbound File eWays

• HTTP(S) Server

• HTTP(S) (client)

• Oracle (must also be configured; see Setting Up Oracle External System)

Creating and Activating B2B Host Project DPs

Activating a Project DP creates an eXchange service that provides a connection to Enterprise Manager’s Message Tracking feature and the eXchange database.

The B2B host Project contains the following components:

• At least one message service used by the B2B host. It contains messaging actions, alternating inbound and outbound.

• The B2B host component, which performs the following functions:

  • Has business protocols that reference the Project’s services.

  • Defines XDCs for the Project’s messaging attribute definitions (MADs). For transport to and from TPs, these channels reference the standard SeeBeyond-supplied HTTP transport attribute definitions (TADs).

  • Defines IDCs (optional). These channels use the Java Messaging Service (JMS) to communicate in the Sender direction.

  A Connectivity Map with the following components:

  • Input, an instance of the B2B host, with two outbound connections

  • Output, an instance of the eXchange database (Oracle), with two inbound connections

  • Instance of Message Tracking, connecting to the other two components

    ---

    Note –

    For more information on the Message Tracking feature, see the eXchange Integrator User’s Guide.

    ---

  You must activate the B2B host’s DP. This action creates an eXchange service for the B2B host. The creation and activation of this service is necessary for data communication between TPs.

  ---

  Note –

  Before you activate a B2B host Project DP, this DP must be pointed to the appropriate Environment, and this Environment must contain a correctly configured Oracle external system instance.

  ---

Setting Up Oracle External System

You must set up an Oracle external system instance in a B2B host’s Environment in Enterprise Designer. Perform this operation using the following general steps:

• Create an Oracle external system instance for the current Project on the Environment.

• Set the instance up, that is, customize it, for your intended uses.

For complete information on how to create a new external system and its instance in Enterprise Designer’s Environment, see the eGate Integrator User’s Guide. Also, see the Oracle eWay Intelligent Adapter User’s Guide.

The procedure in the rest of this section explains how to set up an Oracle external system instance for ebXML Protocol Manager.

To set up an Oracle external system instance

1. In the Environment Explorer tree, navigate to the appropriate Project.

2. Correctly configure the following properties in the eWay’s Properties dialog box:

   • DatabaseName

   • Delimiter

   • Description

   • Password

   • PortNumber

   • ServerName

   • User

     ---

     Note –

     Other properties are optional.

     ---

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

See Also

The Project’s Environment now has its Oracle external system instance configured correctly for activation of the B2B host. For details, see the sample scenario explained in Run-time Steps.

Creating and Activating Project DPs

To run all ebXML Protocol Manager Projects, you must create, set up, and activate DPs for the following types of Projects:

• B2B host

• Inbound and outbound

• Error-handler

• Additional Projects, as required by your data communication setup (see the sample scenario explained in Run-time Steps for examples of additional types of supporting Projects that may be required)

  ---

  Note –

  There are also DPs named dpMain <Project name> that reside inside the Project folder named eXchange , under the sub-Project Deployment .

  ---

Create, set up, and configure additional dpMain Projects in the same way as you do the Project for the B2B host. Keep in mind that details of these steps may vary, depending on the reason for and functioning of any additional Project.

---

Note –

Only the B2B host Project’s Environment requires an Oracle external system instance.

---

Use Enterprise Designer to activate each DP. See Run-time Steps and the eXchange Integrator User’s Guide for details.

Creating and Configuring TPs in ePM

This section describes the steps for creating and configuring TPs using ePM.

Basic ePM Steps

Before you begin this operation, your Repository and your eXchange Oracle database must be running and accessible to eXchange.

---

Note –

Enterprise Designer does not need to be running, and you do not need to have any Logical Hosts running.

---

Using ePM to create TPs includes the following basic operations:

• Starting eXchange ePM

• Creating (or importing) the necessary TPs in ePM

• Configuring the TPs in ePM, including XDCs, named Delivery Channels in ePM, and IDCs; IDCs are optional

• Activating the TPs

For ePM configuration information, see Increasing the Oracle Number of Processes. For an implementation example, including importing and activating TPs, see the sample scenario in Run-time Steps.

Configuring eXchange Service With Cryptographic Features

Your use of the ebXML protocol assumes you are also using its cryptographic features (encryption, decryption, signatures, and verifications). Additional steps are required in setting up the eXchange service to use these features.

You must associate encryption information with each XDC eXchange service. For complete information on setting up an eXchange service with cryptographic features for Protocol Managers, see the eXchange Integrator User’s Guide. For specific examples, see the encryption setup used in the sample Project explained in Run-time Steps.

Run-time Steps

You run an ebXML Protocol Manager Project using the Logical Host. Running a Project requires the following basic steps:

• Starting and running the Logical Hosts

• Making sure your TPs have been activated

• Supplying input data

• Checking output data

• Making sure all client Projects and eXchange deployments deployed successfully

You can check the output data either by checking the configured output file directory or using the eXchange Message Tracking feature, whichever is appropriate. For more information on Message Tracking, see Using Message Tracking.

---

Note –

You can use Enterprise Designer to make changes to a Project while it is running. See Applying Changes Without Shutting Down Logical Host for details.

---

Once you do these steps, your Project is active, and you are ready to send and receive data. For detailed information on these steps, see the sample scenario provided with ebXML Protocol Manager and supplied with the installation CD-ROM, as explained in Run-time Steps.