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:

• Setting Up Companies’ Environments

• Updating Files for Java Collaboration Definitions

• Setting Up Companies’ B2B Host Projects

• Configuring Companies’ Cryptographic Features

• Creating Additional Deployment Profiles

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:

• Oracle: You must create a new outbound Oracle external system instance for each Environment and configure it, even if you imported the sample Environments. Sample parameters are for reference only. Any Oracle database used by eXchange must be accessible to eGate, and you must know its Oracle SID, user name, and password.

• Ports: To run anything other than Integration Server on ports 18000 through 18009, you must make adjustments to configuration values for port numbers, depending on the type of application server you are using.

• HTTPS: For information on how 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.

  ---

  Note –

  After you have created all of the external system instances you need for the current B2B host Project, another external system instance, an eXchange service, is created in this Project automatically when you activate the Project. See Setting Up Companies’ B2B Host Projects for details.

  ---

Creating Atlanta Company’s Environment

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

To 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.

To 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.

To 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

• Your result appears as shown in When You Are Finished.

• Collapse the envAtlanta Environment Explorer tree, click Save All, and close all canvases.

Creating Berlin Company’s Environment

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

To 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

To 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.

To 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

• Your result appears as shown in When You Are Finished.

• Collapse the envBerlin Environment Explorer tree, click Save All, and close all canvases.

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.

To 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:

• bhAtlanta and bhBerlin are the actual B2B hosts. These hosts have the following components and functions:

  • ebXML, under Business Protocols (BPs), the only messaging attribute definition (MAD) contained in the Project, for each B2B host.

  • BPs that reference two message services (both under ebXML): PurchaseService and urn:oasis:names:tc:ebxml-msg:service, for each B2B host.

  • PurchaseService message service contains the Projects’ messaging actions, inbound and outbound.

  • There are two external delivery channels (XDCs) for the single ebXML MAD in each B2B Host. These XDCs are named xdcAtlanta_ebXML_via_HTTP and xdcBerlin_ebXML_via_HTTP.

  • For transport to and from TPs, these XDCs reference the standard SeeBeyond-supplied HTTP transport attribute definitions (TADs).

  • Only bhAtlanta has internal delivery channels (IDCs). These channels use JMS to communicate in the sender (ToInternal) direction. These IDCs are:

    • idcAtlanta_ebXML_Send_via_File

    • idcAtlanta_ebXML_Recv_via_File

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:

• bhAtlanta1: Only input, an instance of bhAtlanta, with two outbound connections.

• extOracleOut: Only output, an instance of extOracleOutAtlanta, with two inbound connections.

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

  ---

  Note –

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

  ---

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

• bhBerlin1: Only input, an instance of bhBerlin, with two outbound connections.

• extOracleOut: Only output, an instance of extOracleOutBerlin, with two inbound connections.

• mtrk: Instance of Message Tracking, connecting to the other two 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.

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:

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

• Input file name: Outbound*.txt

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:

• Directory: C:\temp\eXchange\Sample\Data\Berlin\OutboundebXML\

• Input file name: Outbound*.txt

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.

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 .

To 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.

To 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:

• Inaccessible, in which case ensure that Oracle is running and that the Environment’s extOracleOutAtlanta or extOracleOutBerlin properties match the instance’s host name, SID, user name, and password. If necessary, see the Creating Atlanta Company’s Environment or the eXchange Integrator User’s Guide for more information.

  • Misdefined as inbound, in which case delete the Environment’s extOracleOutAtlanta or extOracleOutBerlin and re-create either instance as outbound. Then, click Save All, followed by Refresh All from Repository.

Configuring Companies’ Cryptographic Features

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

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.

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.

To 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.

To 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.

   ---

To 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:

• xdc_Atlanta_ebXML_via_HTTP for bhAtlanta1 eXchange Service

• xdc_Berlin_ebXML_via_HTTP for bhBerlin1 eXchange Service

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.