test

Sun B2B Suite ASC X12 Protocol Manager User's Guide

Chapter 6 ASC X12 PM Sample Scenario Tutorial

This chapter provides a basic ASC X12 PM tutorial, explaining how to create and implement a sample scenario, as well as how you can use eXchange to achieve B2B solutions using the ASC X12 protocol.

This chapters contains the following topics:

Using This Tutorial

This chapter provides a tutorial for the ASC X12 PM sample implementation scenario and detailed procedures that describe how to construct, run, and monitor the sample, which employs the Atlanta and Berlin Companies described in Chapter 5, Quick Start for ASC X12 PM.

Quick Start and Tutorial Approaches

See Using the Quick Start Procedures for detailed instructions on how to use the quick-start and tutorial approaches to implementing the sample scenario. In summary, the instructions are:

Introduction to the Sample Implementation

To perform the sample scenario implementation, you need to set up the sample Projects, their Environments, and components using the eGate Enterprise Designer with eInsight and eXchange. See the major heading overviews in Chapter 5, Quick Start for ASC X12 PM for summary explanations of ASC X12 PM implementation.

Atlanta and Berlin: Sample Business Scenario contains a description of the sample scenario and how it operates, including the eXchange solutions provided for the business problems contained in the sample.

For more information solving business problems using eXchange with eInsight and eGate, including additional details on implementation, see the eXchange Integrator User’s Guide, eInsight Business Process Manager User’s Guide, and eGate Integrator User’s Guide.

Operational Diagram

Figure 6–1 shows an operational diagram of the sample scenario.

Figure 6–1 Sample Scenario Operation

Sample Scenario Operation

Server Configurations

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:

Preconfiguration for Atlanta and Berlin Environments

This section explains the preconfiguration operations you must perform for the Atlanta and Berlin Environments.

Creating and Starting the Domains

This section explains how to create and start the Logical Host Domains for the Atlanta and Berlin Environments.

See the eGate Integrator User’s Guide for more information on eGate Logical Hosts, Domains, and the Domain Manager feature.

ProcedureTo Create and Start the Sample Domains

  1. Create the domains

    • To create the Atlanta domain, run the following script in the \logicalhost directory:


      C:\ …
 logicalhost\createdomain --dname dmnA

      This script creates the domain name dmnA and retains the default ports 1800x.

    • To create the Berlin domain, run the following script in the \logicalhost directory:


      C:\ …
 logicalhost\createdomain --dname dmnB --startingport 28000

  2. If the repository is not already running, start it by running the following script:


    C:\ ... repository\startserver.bat

  3. Start the domains.

    • To start the Atlanta domain, type the following command:


      C:\ …
 logicalhost\start_dmnA.bat

    • To start the Berlin domain, type the following command:


      C:\ …
 logicalhost\start_dmnB.bat

  4. Use the Domain Manager interface to make sure the new domains are started and running.

Adding a New User to ePM and Message Tracking

You must add two new ePM users via the eGate Integration Server Security Gateway, one for Atlanta and one for Berlin. Doing this operation means using the set of procedures in this section twice, with appropriate changes.

ProcedureTo Add a New User To the ePM and Message Tracking Groups

  1. With the Repository running, start a new browser session.

  2. Access the appropriate URL.

    • Atlanta:http://localhost:18000

    • Berlin:http://localhost:28000

  3. Log in to Integration Server Security Gateway with the user name Administrator and the password STC.

  4. In the Integration Server Administration window, click the User Management tab.

    Integration Server Administration Window

  5. Select Add New User and supply the user name and password for the new user.

    • Atlanta:

      • Assign the user name userA

      • Assign the password userA

    • Berlin:

      • Assign the user name userB

      • Assign the password userB

  6. For GroupList, type PartnerManager, MessageTracking

    This step provides the following user privileges:

    • The PartnerManager role allows the specified user to log in to and use ePM.

    • The MessageTracking role allows the specified user to use the Message Tracking Web client.

  7. When you are finished, click Submit.

  8. Log out of Integration Server Administration and close the window.

Adding the Application Server Instances

You must add two new instances of the Application Server via the eGate Enterprise Manager, one for Atlanta and one for Berlin. Doing this operation means using the set of procedures in this section twice, with appropriate changes.

ProcedureTo Add Two New Application Server Instances

  1. With the Repository running, install Enterprise Manager by running the following script:


    C:\ …
 \emanager\install.bat

  2. In the installation wizard, follow the prompts and accept the license agreement and default port (15000).

  3. After the installation is complete, start Enterprise Manager server by running the following script:


    C:\ …
 \emanager\startserver.bat

  4. Start a new browser session and access the appropriate URL:


    http://localhost:15000

  5. Log in to Enterprise Manager with the user name Administrator and the password STC.

  6. Click J2EE.

  7. Click the Manage Servers tab and add a new application server.

    • Server Type:Sun SeeBeyond Integration Server

    • Host Name:localhost

    • Administration Port:

      • For Atlanta:18000

      • For Berlin:28000

    • User Name:Administrator

    • Password:STC

      Enterprise Manager Window

  8. Click Connect to Server.

  9. Save your changes and exit the window.

Initializing and Running Enterprise Designer

This section describes operations it is recommended that you perform upon, and directly after, initializing and running Enterprise Designer.

Note –

Using Enterprise Designer, you must make sure to increase the eDesigner_heap_size property to 1024. For more information, see the eXchange Integrator User’s Guide.

ProcedureTo Initialize and Run Enterprise Designer

  1. With the Repository running, start Enterprise Designer by running the following script:


    C:\ …
 \edesigner\bin\runed.bat

  2. Choose Update Center from the Tools menu.

  3. In the Update Center wizard, follow the steps to check for updates, and to add all available updates and new modules.

  4. When you are done, restart Enterprise Designer (referred to as IDE in the user interface).

    Note –

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

  5. Log in to Enterprise Designer with the user nameAdministrator and the password STC.

Editing the Sample Data .xml Files

Data files are supplied with the sample scenario, which reference a path enclosed between the XML tags: <dir> … </dir>. You must first export these files using Enterprise Designer’s Project Explorer. Then, edit these files to reflect the path location where you actually export the sample scenario files.

Note –

For a list of the sample scenario’s files, see Exporting Sample Files.

ProcedureTo Export the Sample Data Files

  1. Locate the export files for the Atlanta sample data in Enterprise Designer’s Project Explorer under eXchange ⇒ Samples ⇒ X12 ⇒ RecvFromInt ⇒ Files

    These files are:

    • 850-SendingOutbound.dat.~in

    • 850.dat.

  2. Export these files to a folder on your C drive. It is recommended that you set up a folder structure to contain these files, under C:\temp, for example:


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

  3. Locate the export files that ensure Berlin returns the correct messages to Atlanta in Project Explorer, under eXchange ⇒ Samples ⇒ X12 ⇒ 855_FromInt_850 ⇒ Files:

    These files are:

    • X12_4010_855_template.st

    • X12_dlg_850_In_Atlanta_850_In.xml

  4. Export these files to a folder on your C drive. It is recommended that you set up a folder structure to contain these files, under C:\temp, for example:C:\temp\eXchange\Sample\X12\Data\Berlin

    You must make sure that the 850-SendingOutbound.dat.~in file is updated to reflect the appropriate Atlanta data path location. You may do this operation using a text editor.

ProcedureTo Edit the Atlanta 850-SendingOutbound.dat.~in File

  1. Make sure you have exported the sample data files.

  2. Use the Enterprise Designer’s Export feature to export the sample data files to a specified location, for example:


    cd /d C:\temp\eXchange\Sample\X12\Data\Atlanta

  3. Change directories to the subdirectory of the location where you exported the sample data files.

  4. Use a text editor open the following file:

    850-SendingOutbound.dat.~in

    You see text that resembles the following text:


    <?xml version="1.0" encoding="UTF-8"?>
<!--Sample XML file generated by XMLSPY v2004 rel. 3 U 
(http://www.xmlspy.com)--><TestInput xmlns:xsi=
"http://www.w3.org/2001/XMLSchema-instance"
 xsi:noNamespaceSchemaLocation="C:\X12Sample\xsd\ServiceInput.xsd">
<dir>path</dir>
<filename>850.dat</filename>
<tradingPartner>Berlin</tradingPartner>
<service>PurchaseOrder_AG_Profile</service>
<action>850</action>
<createnumberofmsgs>1</createnumberofmsgs>
</TestInput>

    The lines preceding the last line </TestInput> have the following meaning:

    • The <dir>…</dir> line supplies the path of the directory that holds the payload data file to be processed.

    • The <filename>…</filename> line supplies the file name of the payload data file for the current transaction.

    • The <tradingpartner>…</tradingpartner> line supplies the name of the current TP.

    • The <service>…</service> line supplies the name of the Transaction Profile Group of the current TP; used in ePM.

    • The <action>…</action> line supplies the transaction number, in this case, 850.

  5. If necessary, in the line <dir> path </dir> (shown in the previous example), change the string represented by path, to the actual path of the directory that holds your local copy of the 850.dat file.

    For example:


    <dir>C:\temp\eXchange\Sample\X12\Data\Atlanta</dir>

    Or:


    <dir>/~myname/eXchange/Sample/X12/Data/Atlanta</dir>

  6. If you have already run the sample and you want to experiment with other changes (such as using a payload file with a different file name, or using a TP with a different name), be sure they are also reflected here.

  7. When you are finished, save your changes and exit the text editor.

    You must make sure that the Berlin X12_dlg_850_In_Atlanta_850_In.xml file is updated to reflect the appropriate Berlin data path location. You may do this operation using a text editor.

ProcedureTo Edit the Berlin X12_dlg_850_In_Atlanta_850_In.xml File

  1. Make sure you have exported the sample data files.

  2. Use the Enterprise Designer’s Export feature to export the sample data files to a specified location, for example:


    cd /d C:\temp\eXchange\Sample\X12\Data\Berlin

  3. Change directories to the subdirectory of the location where you exported the sample data files.

  4. Use a text editor open the following file: X12_dlg_850_In_Atlanta_850_In.xml

    You see text that resembles the following text:


    < <?xml version="1.0" encoding="UTF-8"?>
<FileAndService>
    <TradingPartner>Atlanta</TradingPartner>
    <TPProfileID></TPProfileID>
    <Service>PurchaseOrder_Inb_AG</Service>
    <Action>855</Action>
    <Files Directory="path">
        <Name>X12_4010_855_template.st</Name>
    </Files>
</FileAndService>

  5. If necessary, in the line <dir> path </dir> (shown in the previous example), change the string represented by path, to the actual path of the directory that holds your local copy of the X12_dlg_850_In_Atlanta_850_In.xml and X12_4010_855_template.st files.

    For example:


    <dir>C:\temp\eXchange\Sample\X12\Data\Berlin</dir>

    Or:


    <dir>/~myname/eXchange/Sample/X12/Data/Berlin</dir>

  6. If you have already run the sample and you want to experiment with other changes (such as using a payload file with a different file name, or using a TP with a different name), be sure they are also reflected here.

  7. When you are finished, save your changes and exit the text editor.

    Note –

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

Constructing the Environments

In implementing ASC X12 PM Projects, you must set up at least one Environment for each eXchange installation. The sample scenario is set up to operate on one machine but mimic two TPs. As a result, for the sample scenario, you need to construct the Environments as explained under the following sections:

Using Environment Explorer

You perform these operations using Enterprise Designer’s Environment Explorer and its canvas windows. The sample Environments contain the following types of components:

For example, the Oracle external system must be configured to reference your Oracle setup. Other external systems (for example, the File and Batch eWays) have configurations that may differ depending on your system setup, and so forth. Also, you may be using nonstandard ports or user name/password combinations.

The remainder of this section describes the procedures to construct the sample scenario’s Environments.

Note –

Before you begin, make sure you have followed the preliminary instructions provided under Getting Started.

Setting up the Environments

This section explains how to create the sample’s Environments for Atlanta and Berlin. Use the procedures to set up Atlanta first, then Berlin.

ProcedureTo Create the Basic Components

  1. On 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 envA (envB for Berlin).

  4. Right-click envA (envB for Berlin) and, on the menu, click New Logical Host and name the Logical Host lhA (lhB for Berlin).

  5. Right-click IntegrationSvr1 and select Properties from the context menu.

    The Properties dialog box for IntegrationSvr1 appears. See the figure below.

    Integration Server Properties Dialog Box: Environment

  6. For lhA ⇒ IntegrationSvr1 on Environment Explorer, set the Configuration ⇒ SeeBeyond Integration Server properties as follows:

    • Integration Server URL: Points to the Integration Server, for example:

      • http://localhost:18000 for envA

      • http://localhost:28000 for envB

    • Username: Administrator

    • Password: STC (masked)

    • Debug port: 1044

    • Application Workspace: c:\temp

    • Number of Local Transactions: 0

  7. For the rest of the IntegrationSvr1 properties settings, accept the defaults.

  8. Create a Sun SeeBeyond JMS IQ Manager under IntegrationSvr1 and name it SBJMSIQMgr1.

  9. Right-click SBJMSIQMgr1 and select Properties from the context menu.

    The Properties dialog box for SBJMSIQMgr1 appears.

  10. For lhA ⇒ SBJMSIQMgr1 on Environment Explorer, set the Configuration ⇒ SeeBeyond JMS IQ Manager Configuration property as follows:

    Password: STC

ProcedureTo Create and Configure the Oracle External System

  1. On Enterprise Designer, on the Environment Explorer tree, right-click envA (envB for Berlin) and, on the context menu, click New Oracle External System.

  2. Name the new component esOracleand click OK.

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

    Note –

    The eXchange database uses Oracle. For more information on Oracle requirements for eXchange and ASC X12 PM, see the Readme file that accompanies ASC X12 PM.

  3. Right-click esOracleand select Properties from the context menu.

    The Properties dialog box for the external system appears. See the figure below.

    Oracle External System Properties Dialog Box: Environment

  4. Configure the Configuration ⇒ Outbound Oracle eWay ⇒ JDBC Connector settings properties for esOracle as follows:

    • Description: Oracle Connection Pool Datasource

    • ServerName: Host name of the Oracle server machine

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

    • DatabaseName: SID for your current Oracle system

    • User: Valid user ID for the current Oracle system

    • Password: Valid password for the current Oracle system (masked)

    • Driver Properties: Blank, for this sample

    • Delimiter: #

    • TNS Entry: Blank, for this sample

    • MinPoolSize: 0

    • MaxPoolSize: 10

    • MaxIdleTime: 0

  5. Configure the Configuration ⇒ Outbound Oracle non-Transactional eWay ⇒ JDBC Connector settings properties for esOracle as follows:

    • Description: Oracle non-Transactional Connection Pool Datasource

    • ServerName: Host name of the Oracle server machine

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

    • DatabaseName: SID for your current Oracle system

    • User: Valid user ID for the current Oracle system

    • Password: Valid password for the current Oracle system (masked)

    • Driver Properties: Blank, for this sample

    • Delimiter: #

    • TNS Entry: Blank, for this sample

    • MinPoolSize: 0

    • MaxPoolSize: 10

    • MaxIdleTime: 0

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

ProcedureTo Create and Configure the LDAP External System

  1. Create a new LDAP external system(New ⇒ LDAP External System) under envA (envB for Berlin) and name it esLDAP.

  2. Set the Environment Configuration ⇒ Connection properties for esLDAP as follows:

    • Initial Context Factory: com.sun.jndi.ldap.LdapCtxFactory

    • Provider URL: As necessary for your system, according to the provided syntax For example, ldap://mycompany.co.in:1389/dc=co,dc=in

    • Authentication: simple

    • Principal: As necessary for your system. For example, Manager

    • Credentials: Password, as necessary for your system. For example, exchange

      Note –

      A separate LDAP external system instance is required for each B2B Host.

  3. For all other esLDAP properties, accept the defaults.

ProcedureTo Create and Configure the B2B Configurator Service External System

  1. Create a B2B Service Configurator (New ⇒ B2B Configurator Service) external system under envA and name it esB2BService.

  2. Set the environment-configuration ⇒ Database Settings properties for esB2BService as follows:

    • Type: Oracle

    • URL: Points to the eXchange database; an example of the URL syntax is: jdbc:oracle:thin:@hostname:port:exchange

    • UserName: Valid user ID for the current Oracle system. For example, ex_admin

    • Password: Valid password for the current Oracle system (masked). For example, ex_admin

    • Set the environment-configuration ⇒ JMS Settings properties for esB2BService as follows:

    • JMS Server URL: Points to the IQ Manager port. The envA Logical Host is on 18000 (envB on 28000), the IQ Manager port for envA is 18007 (28007 for envB). This port number is listed in the Domain Manager for the current Logical Host; an example of the URL syntax is: stcms://hostname:port

    • Security Principal: Administrator

    • Security Credentials: STC (masked)

    • Connection Factory: connectionfactories/topicconnectionfactory

    • Resend Topic: topics/EX_TODELIVERY

    • Timeout Topic: topics/EX_ERROR

    • Business Protocol Topic for Batching: topics/EX_BATCHER

    • Delivery Protocol Topic for Batching: topics/EX_DELIVERYBATCHER

  3. For the rest of the esB2BService properties settings, accept the defaults.

ProcedureTo Create and Configure the File External Systems

  1. Create a new File eWay (New ⇒ File External System) in inbound mode under envA and name it esFileA.

  2. Set the Configuration ⇒ Inbound File eWay ⇒ Parameter Settings property for esFileA as follows:

    Directory:


     C:/temp/eXchange/Sample/X12/Data/Atlanta
    Note –

    Make sure this folder and the folder for envB are correctly configured under the appropriate parameter in ePM. It is recommended that you create an additional folder under X12 named Errors.

  3. Set the Configuration ⇒ Outbound File eWay ⇒ Parameter Settings property (for DLQ and processing errors) for esFileA as follows:

    Directory:


     C:/temp/eXchange/Sample/X12/Errors/Atlanta

  4. For all other File eWay (esFileA and esFileB) properties, accept the defaults.

  5. Create a new File eWay (New ⇒ File External System) in inbound mode under envB and name it esFileB.

  6. Set the Configuration ⇒ Inbound File eWay ⇒ Parameter Settings property for esFileB as follows:

    Directory:


     C:/temp/eXchange/Sample/X12/Data/Berlin

  7. Set the Configuration ⇒ Outbound File eWay ⇒ Parameter Settings property (for DLQ and processing errors) for esFileB as follows:

    Directory:


     C:/temp/eXchange/Sample/X12/Errors/Berlin

ProcedureTo Create and Configure the Additional External Systems

  1. In Enterprise Designer, on the Environment Explorer tree, right-click envA (envB for Berlin) and, on the context menu, click New Batch Local File System.

  2. Name the new external system esBLF, and click OK.

    These operations create, for the Environment, an external system for the Batch eWay in local file mode.

  3. In the new external systems’ Properties dialog boxes and accept the defaults.

    Note –

    When you are finished with each Properties dialog box, click OK.

  4. Create an HTTP eWay (client mode) external system under envA (envB for Berlin) and name it esHTTP.

  5. Open the Properties dialog boxes for esHTTP and accept the defaults.

  6. Create an HTTP eWay (server mode) external system under envA (envB for Berlin) and name it esHTTPserver.

  7. Open the Properties dialog boxes for esHTTPserver and accept the defaults.

    Note –

    When you build a B2B Host Deployment Profile, eXchange automatically creates another external system on the chosen Environment. This external system is called an eXchange service. For more information on this service, see the eXchange Integrator User’s Guide. Also, see Constructing the B2B Host Project.

When You Are Finished for Atlanta

Result: You have set up the Environment for Atlanta, envA. See Figure 6–2.

Figure 6–2 Sample Scenario’s Atlanta Environment

Sample Scenario’s Atlanta Environment

When You Are Finished for Berlin

Final Result: You have now finished setting up the Environments for Atlanta and Berlin, including the external system components to be used by both.

Constructing the Projects

This section explains how to construct the Projects in the ASC X12 PM in order to run the sample scenario. This operation includes:

Building a Deployment Profile creates the application .ear file for the Project. After creating this file, you must deploy it for all Deployment Profiles except the B2B Host.

You perform these operations using Enterprise Designer’s Project Explorer and its canvas windows. The remainder of this section describes the necessary procedures under the following sections:

Constructing the B2B Host Project

This section explains how to set up, and configure the ASC X12 PM sample scenario’s B2B Host Project, X12Host. Constructing the B2B Host Project creates an eXchange service that acts as a channel manager and provides a connection to the eXchange database. You must build two Deployment Profiles, one for each company, Atlanta and Berlin. However, you do not deploy these Deployment Profiles.

ProcedureTo Build the B2B Host’s Deployment Profile for Atlanta

  1. On Enterprise Designer’s Project Explorer tree, right-click X12Host under eXchange ⇒ B2BHosts and, on the context menu, choose New and click Deployment Profile.

  2. In the resulting dialog box, name the new Deployment Profile dpHost_A, point it at envA, make sure it is using only the cmX12 Connectivity Map, and click OK.

    Deployment Editor opens. Its left pane shows the X12 B2B Host instance, the Oracle1 external application, and the LDAP1 external application. These are the components created in the Connectivity Map cmX12.

    The Deployment Editor right pane contains windows representing the Logical Host and external systems created in envA.

  3. Click Automap to map the components.

    The components in the left pane automatically map to the appropriate windows on the right pane of Deployment Editor for dpHost_A. See the figure below.

    Deployment of dpHost_A

  4. Click Save.

  5. Click Build to build the Deployment Profile.

    A dialog box appears, indicating the status of the build operation. A new service, X12 eXchange Service, is created and assigned to the current Deployment Profile and Environment.

    You may view this X12 eXchange Service on envA, in the Environment Explorer tree, as well as in the right pane of Deployment Editor for dpHost_A.

    Note –

    Do not deploy the B2B Host Project.

    If the build operation is not successful due to incomplete or incorrect configuration, repeat the steps in this procedure, carefully rechecking every action. When the build is successful, go to the next step.

    Note –

    Building Deployment Profiles for large Projects may take approximately 10 to 15 minutes or more.

  6. When you are finished, click Save All and close all canvases.

ProcedureTo Build the B2B Host’s Deployment Profile for Berlin

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

  2. In the resulting dialog box, name the new Deployment Profile dpHost_B, point it at envB, make sure it is using cmX12, and click OK.

  3. In Deployment Editor, click Automap to map the components.

  4. Click Save.

  5. Build the Deployment Profile for Berlin in the same way as you did for Atlanta, except make sure to use envB and cmX12.

    The X12 eXchange Service is created and assigned to the current Deployment Profile and Environment. Do not deploy the B2B Host Project. Once more, if there are any errors, troubleshoot until you are ready to go to the next step.

  6. When you are finished, click Save All and close all canvases.

    Result: You have now finished constructing the B2B Host Project, including creating, mapping, and building Deployment Profiles for Atlanta and Berlin.

eXchange Deployment Project

This section explains how to set up, build, and deploy Atlanta and Berlin Deployment Profiles in the eXchange Deployment Project. This Project makes all of the core B2B services and processing available to the application .ear files built from the Deployment Profiles.

To complete this operation, you must set up a Connectivity Map for ASC X12 OTD validation and Deployment Profiles for both Atlanta and Berlin. You must map, build, and deploy both Deployment Profiles.

Creating the Validation Connectivity Map

To complete this operation, you must You must deploy OTD validation BPs via a Connectivity Map, to allow you to configure the Trading Partner Profiles to specify the custom validation handlers. You must then map, build, and deploy two Deployment Profiles, one each for Atlanta and Berlin.

ProcedureTo Create the OTD Validations Connectivity Map

  1. Create a Connectivity Map using Project Explorer, under eXchange ⇒ Deployment, named, for example, cmX12OtdValidation (or a convenient name for your system, with fewer characters).

  2. From Project Explorer, drag Sun SeeBeyond ⇒ eXchange ⇒ User Components ⇒ OTD Validations ⇒ X12 ⇒ v4010 ⇒ X12_4010_850_FullSynValhandler onto the Connectivity Map canvas.

  3. From the same Project Explorer location, drag the X12_4010_855_FullSynValhandler component onto the Connectivity Map canvas.

  4. Drag one eXchangeService from eXchange ⇒ Deployment folder onto the canvas

  5. Double-click bpX12_850_FullSynValhandler1 and link InboundeXchangeService to eXchangeService.

  6. Double-click bpX12_855_FullSynValhandler1 and link InboundeXchangeService to eXchangeService.

    For the results, see the figure below.

    OTD Validation Connectivity Map Linking

  7. Open and save all the default properties for the eWays on the Connectivity Map.

  8. Click Save All then close the Connectivity Map.

Building and Deploying the Deployment Profiles

When you are finished, you must create Deployment Profiles for both Atlanta and Berlin. These Deployment Profiles are for the eXchange Deployment Project.

ProcedureTo Build and Deploy the eXchange Deployment Project’s Deployment Profile for Atlanta

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

  2. In the resulting dialog box, name the new Deployment Profile dpA, point it at envA, and click OK.

  3. On Deployment Editor, click Automap to map the components.

  4. Click Build to build the Deployment Profile for Atlanta.

  5. Click Deploy to deploy the Deployment Profile.

    Note –

    After each of the operations, map, build, and deploy, you receive a status message. If you receive any errors, troubleshoot your previous procedures, as necessary. Deploying Deployment Profiles may take as long or longer than building them.

  6. When you are finished, click Save All and close all canvases.

ProcedureTo Build and Deploy the eXchange Deployment Project’s Deployment Profiles for Berlin

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

  2. In the resulting dialog box, name the new Deployment Profile dpB, point it at envB, and click OK.

  3. On Deployment Editor, click Automap to map the components.

  4. Click Build to build the Deployment Profile for Berlin.

  5. Click Deploy to deploy the Deployment Profile.

  6. When you are finished, click Save All and close all canvases.

    Result: You have now finished constructing the eXchange Deployment Project, including creating, mapping, building, and deploying Deployment Profiles for Atlanta and Berlin.

Constructing the 855_FromInt_850 Project

This section describes how to set up, build, and deploy the Berlin Deployment Profile for the 855_FromInt_850 Project. This Project operates with envB and makes sure the X12 855 message is returned from Berlin to Atlanta.

Updating the bp855 Business Process

You must make sure the Berlin system is using the data file path listed under Editing the Sample Data .xml Files by checking the bp855 BP in 855_FromInt_850. To do this action, open eXchange ⇒ Samples ⇒ X12 ⇒ 855_FromInt_850 ⇒ BPs ⇒ bp855 in Project Explorer.

The BP structure appears in Business Process Editor, in Enterprise Designer’s right pane. See Figure 6–3.

Figure 6–3 Business Process Editor: bp855

Business Process Editor: bp855

Make sure that the path given in the indicated component, in the previous figure, reflects your Berlin data path, for example:


C:\temp\eXchange\Sample\X12\Data\Berlin

This is also the path location of the X12_dlg_850_In_Atlanta_850_In.xml and X12_4010_855_template.st files.

Note –

This setup has been created for the purpose of the sample scenario only. It is recommended that, when creating your own inbound BPs, you configure the BP to read this type of path information from the inbound eWay.

Building and Deploying the Deployment Profile

This section describes how to build and deploy the 855_FromInt_850 Project’s Deployment Profile for Berlin.

ProcedureTo Build and Deploy the 855_FromInt_850 Project’s Deployment Profile for Berlin

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

  2. In the resulting dialog box, name the new Deployment Profile dp855_B, point it at envB, make sure it is using all the checked Connectivity Maps, and click OK.

  3. On Deployment Editor, click Automap to map the components.

  4. Click Build to build the Deployment Profile for Berlin.

  5. Click Deploy to deploy the Deployment Profile.

  6. When you are finished, click Save All and close all canvases.

    Result: You have now finished setting up the 855_FromInt_850 Project, including creating, mapping, building, and deploying Deployment Profile for Berlin only (there is no Atlanta Deployment Profile for this Project).

Constructing the Remaining Projects’ Deployment Profiles

Construct the following Projects’s Deployment Profiles, as shown under eXchange in Project Explorer, in the same way you have done for the previous Projects in the sample scenario:

To construct the remaining Projects’ Deployment Profiles locate, name, and deploy Deployment Profiles for the Projects shown in the previous list, as depicted in Table 6–1.

Final Result: You have constructed, built, and deployed (if necessary) all the Projects’ Deployment Profiles for the sample scenario.

Summary of Sample Scenario Projects

Table 6–1 provides a summary list of the sample scenario’s Projects, their Deployment Profiles, and corresponding Environments. It is recommended that you construct the Projects and their Deployment Profiles in the order shown in the table.

Table 6–1 Sample Scenario Projects Summary

Location Under eXchange 

Projects 

Deployment Profiles 

Environments 

B2BHosts 

X12Host 

dpHost_A; not deployed 

envA 
   

dpHost_B; not deployed 

envB 

Deployment 

eXchange Deployment 

dpA 

envA 
   

dpB 

envB 

Samples ⇒ X12 

855_FromInt_850 

dp855_B 

envB 

GUI 

ePM 

dpePM_A 

envA 
   

dpePM_B 

envB 
 

Tracker 

dpTrack_A 

envA 
   

dpTrack_B 

envB 

Error 

Sub_DLQ 

dpSDLQ_A 

envA 
   

dpSDLQ_B 

envB 
 

Sub_ProcErrors 

dpSPErrors_A 

envA 
   

dpSPErrors_B 

envB 

Samples ⇒ X12 

RecvFromInt 

dpRecvInt_A 

envA 
 

RecvFromTP/Batch Local File 

dpRecvTP_A 

envA 
   

dpRecvTP_B 

envB 
 

SendToInt 

dpSendInt_B 

envB 

Importing and Configuring Components in ePM

This section explains how import, create, and configure TPs, Action Groups, Transaction Profiles, and Schedules in the ASC X12 PM sample scenario, using the eXchange ePM. Additionally, the section describes how to use ePM to set the configuration parameter values for the Transaction Profiles and their related components.

Note –

For detailed procedures on how to use TPs, Action Groups, Transaction Profiles, and Schedules, see the eXchange Integrator User’s Guide.

Getting Started

Before you begin, it is recommended that you do all the procedures given in the previous sections of this chapter. Also, your Integration Server must be running. Also, your LDAP system and eXchange database (Oracle) must be running and accessible. However, Enterprise Designer does not need to be running.

Note –

For a general description of the outbound and inbound messaging ToPartner and FromPartner model used by ePM, see Configuring ePM: ToPartner and FromPartner Messaging Model.

You must do the procedures given under Running ePM to run ePM. In addition, after you run ePM, it is recommended that you do the procedures given under Importing B2B Hosts and Importing TPs.

Note –

If you want, you can create your own B2B Hosts and TPs using the procedures given in this section and using the sample scenario B2B Hosts and TPs as models. For more details, see the eXchange Integrator User’s Guide.

The remainder of this section explains these operations.

Note –

For detailed information on configuring ePM, see After You Install.

Exporting the Necessary ePM Files

The ePM export files for the B2B Hosts, TPs, and Schedules are located in Project Explorer under eXchange, as follows:

For more information, see Exporting ePM Files. It is recommended that you set up a folder structure to contain these files, which reflects this organization, for example:


C:\temp\eXchange\Sample\X12\TP_Profiles
Note –

For information on how to use ePM, see the eXchange Integrator User’s Guide.

Running ePM

This section explains how to start running ePM.

ProcedureTo Run eXchange ePM

  1. Start a browser session.

  2. Enter the Logical Host name and ePM port number with


     epm
 appended, as follows:http://logicalhost:port+1/epm

    For example:


    http://localhost:18001/epm

  3. When the sign-in window appears, enter your Enterprise Manager user name (or the new user described under Adding a New User to ePM and Message Tracking), as well as the appropriate password, and click Sign In.

    The initial ePM window appears. See the figure below.

    Initial ePM Window

    The ePM window has the following sections:

    • ePM Explorer

    • B2B Host Configuration tab

    • Trading Partner Configuration tab

    • ePM Canvas

      Note –

      For complete instructions on how to use ePM, see the eXchange Integrator User’s Guide..

Importing B2B Hosts

Your next step is importing the Atlanta and Berlin B2B Host files, as explained under this section.

This sample scenario has the following B2B Hosts:

ProcedureTo Import the envA B2B Host

  1. Log in to ePM for envA (dmnA).

  2. Click the B2B Host Configuration tab, if Host Explorer is not already displayed.

  3. In Host Explorer, click and expand B2B Repository.

  4. Select the B2B Host envA_X12.

  5. At the bottom of ePM Canvas, click Import.

  6. When you are finished, click Save.

ProcedureTo Import the envB B2B Host

  1. Log in to ePM for envB (dmnB).

  2. Click the B2B Host Configuration tab, if Host Explorer is not already displayed.

  3. In Host Explorer, click and expand B2B Repository.

  4. Select the B2B Host envB_X12.

  5. At the bottom of ePM Canvas, click Import.

  6. When you are finished, click Save.

Using Schedules

Next, you must import the Schedules for the B2B Hosts.

ProcedureTo Import a Schedule

  1. Log in to ePM for envA (dmnA) for Atlanta; use envB (dmnB) for Berlin.

  2. Click the B2B Host Configuration tab.

  3. ePM Explorer with this tab selected appears.

  4. Click the Schedule icon in ePM Explorer.

  5. Select the Schedule file you want to import (envA_X12_S1.exp for envA and envB_X12_S1.exp for envB).

  6. Click Import.

  7. When you are finished, click Save.

ProcedureTo Modify an Existing Schedule

  1. Log in to ePM for envA (dmnA) for Atlanta; use envB (dmnB) for Berlin.

  2. Click the B2B Host Configuration tab.

    ePM Canvas with this tab selected appears.

  3. Click the Settings tab.

  4. In ePM Canvas, modify the scheduling information for the current Schedule, as necessary. This information is for inbound only.

  5. When you are finished, click Save.

Importing TPs

Your next step is importing or creating the Atlanta and Berlin 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 you consider to be your current company. See Configuring ePM: ToPartner and FromPartner Messaging Model.

This sample scenario has the following TPs:

This sample scenario has the following TP files (under TP_Profiles):

ProcedureTo Import the Berlin TP to envA

  1. Click the Trading Partner Configuration tab.

    The ePM window with this tab selected appears. See the figure below.

    ePM Window With Trading Partner Configuration Tab Selected

  2. From this window, click Import.

    The Import a Trading Partner - Step 1 of 2 window appears in ePM Canvas.

  3. Name the TP Berlin.

  4. Browse to the folder where you have stored your TP files and select envA_X12_TP_Berlin.exp, then click Next.

    The Import a Trading Partner - Step 2 of 2 window appears.

    Note –

    See Exporting Sample Files for a list of the sample scenario’s data files.

  5. Choose envA_X12, from the pull-down menu.

  6. Click Finish.

ProcedureTo Locate the Berlin TP in the ePM Window

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

    The Select the Trading Partner to Configure window appears in ePM Canvas.

  2. Click Search on the canvas.

    Any available TPs appear directly below.

  3. In this case, you are looking for Berlin, which appears.

  4. Click the TP name, in this case Berlin, to configure the TP.

ProcedureTo Import the Atlanta TP to envB

  1. Click the Trading Partner Configuration tab.

    The ePM window with this tab selected appears.

  2. From this window, click Import.

    The Import a Trading Partner - Step 1 of 2 window appears in ePM Canvas.

  3. Name the TP Atlanta.

  4. Browse to the folder where you have stored your TP files and select envB_X12_TP_Atlanta.exp, then click Next.

    The Import a Trading Partner - Step 2 of 2 window appears.

  5. Choose envB_X12, from the pull-down menu.

  6. Click Finish.

ProcedureTo locate the Atlanta TP in the ePM window

  1. Use the same procedure as explained to locate the Berlin TP.

Using Action Groups and Transaction Profiles

You do the actual configuration of Action Groups and Transaction Profiles using parameters available using the following levels of the ePM Explorer tree:

More information on how to configure Transport parameters is available in the eXchange Integrator User’s Guide. For information on how to configure these parameters in the sample scenario, see Configuring Transports.

Configuring the Sample Scenario

You may use the ePM for the Projects in the sample scenario as a model to complete the configuration of ePM. Enter information in ePM as shown in the sample. For more information, see After You Install and the eXchange Integrator User’s Guide.

Using Parameters in ePM

Many of the Business and Delivery Protocol parameters are the same, regardless of the PM and business communication protocol you are using. However, some of them are ASC X12 PM-specific and are only present for ASC X12.

This section describes these parameters under:

For more information on these parameters, see Configuring ASC X12 PM ePM Parameters.

Note –

For more information on parameters not described under this section, see the eXchange Integrator User’s Guide.

ProcedureTo Enter an Override value for a Parameter

  1. Click the check box next to the parameter you want to override, under the Override column (see Figure 6–4 for an example).

  2. Enter the appropriate override in the text box for the parameter.

  3. Click Save.

ePM Configuration General Operation

In the sample scenario, you import preconfigured B2B Hosts and TPs. When you are configuring your own (for example, if you are creating B2B Hosts and TPs from scratch), it is recommended that you use the following general order of configuration operations when setting values in ePM:

Interchange Envelope Parameters

The ASC X12 PM-specific Interchange Envelope (outer envelope or ISA) parameters appear in ePM Canvas as shown in Figure 6–4. The example shown is for the Berlin TP’s 850ToPartner Transaction Profile.

Figure 6–4 ASC X12 PM-specific Interchange Envelope Parameters: Example

ASC X12 PM-specific Interchange Envelope Parameters: Example

You may display the example in Figure 6–4 by using ePM Explorer, under B2B Repository ⇒ envA_X12 ⇒ Business Protocols ⇒ X12.

As you can see, there are no override values entered in Figure 6–4, and the configuration accepts all the defaults. You may override the defaults for any parameter by clicking a check box under Override and entering a different value, as necessary.

You may, of course, do the same override operation with other ePM parameters, as described under Configuring eXchange Partner Manager: Overview.

Functional Group Parameters

The ASC X12 PM-specific Functional Group (inner envelope or GS) parameters appear in ePM Canvas as shown in Figure 6–5. The example shown is for the Atlanta TP’s 850 FromPartner Transaction Profile.

Figure 6–5 ASC X12 PM-specific Functional Group Parameters: Example

ASC X12 PM-specific Functional Group Parameters: Example

As you can see, one override value has been entered in Figure 6–5, and the configuration uses the defaults for all other displayed parameters. As explained previously, you may override the default values, as necessary.

Configuring Transports

Table 6–2 lists the Transports parameter override values you must enter to configure B2B Host Configuration ⇒ envA_X12 ⇒ Transports ⇒ BatchLocalFile.

Table 6–2 Overrides for Atlanta B2B Host Configuration ⇒ … ⇒ BatchLocalFile

Category 

Parameter 

Override Value 

Outbound ToPartner 

TargetDirectoryName 

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

Inbound FromPartner 

TargetFileName 

ToAtlanta_[a-zA-Z0-9_]*\.isa

ACK - Outbound ToPartner 

TargetDirectoryName 

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

ACK - Inbound FromPartner 

TargetFileName 

ToAtlanta_[a-zA-Z0-9_]*\.isa

Table 6–3 lists the Transport parameter override values you must enter to configure B2b Host Configuration ⇒ envB_X12 ⇒ Transports ⇒ BatchLocalFile.

Table 6–3 Overrides for Berlin B2B Host Configuration ⇒ … ⇒ BatchLocalFile

Category 

Parameter 

Override Value 

Outbound ToPartner 

TargetDirectoryName 

C:\temp\eXchange\Sample\X12\Data\Berlin

Inbound FromPartner 

TargetFileName 

ToBerlin_[a-zA-Z0-9_]*\.isa

ACK - Outbound ToPartner 

TargetDirectoryName 

C:\temp\eXchange\Sample\X12\Data\Berlin

ACK - Inbound FromPartner 

TargetFileName 

ToBerlin_[a-zA-Z0-9_]*\.isa

Running the Sample

See Running the Sample Scenario for information on how to complete the passing of data between the two TPs.

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 ASC X12 PM.

Before You Begin

Accessing Message Tracking

This section explains how to access Message Tracking.

ProcedureTo Access Message Tracking

  1. Start a browser session.

  2. Point your browser at the following URL:


    http://logicalhost:port+1/objname

    Where:

    • logicalhost: 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 18001 for the first Integration Server in the first-created Logical Host. (or 28001 for the first Integration Server in the second-created Logical Host, and so on). For the sample scenario, use 18001 for Atlanta ( envA) and 28001 for Berlin ( envB).

    • objname: The name of the Message Tracking instance as it appears on the current Connectivity Map. For the sample scenario, this name is tracker.

    Example: To access Message Tracking for the sample scenario, use the following URLs:


    • http://localhost:18001/tracker
      Note –

      You can only use the same port number for different Message Tracking instances if they reside on different machines.

    As stated previously, the sample must be running before you access Message Tracking, and messages must have been transported before any become accessible.

Message Tracking Window

When you first run Message Tracking, the Message Tracking window appears. After you perform a search, as necessary, in the window’s left pane, message information results appear in the right pane. See Figure 6–6.

Figure 6–6 Atlanta Host, Example Message Tracking Window

Atlanta Host, Example Message Tracking Window

See the eXchange Integrator User’s Guide for information on how to use Message Tracking.