EDI to XML example

This section provides an example of sending an EDI transaction (within an envelope) to the hub, where it is transformed into an XML document and sent to the Community Manager.

In this example, it is assumed that the Data Interchange Services mapping specialist has created a transformation map that takes a standard EDI 879 transaction (defined with the X12V5R1 dictionary, corresponding to the version 5010 of X12) and transforms it into an XML document that will be processed by the back-end application of the Community Manager. In this example, the map is named S_DT_EDI_TO_XML.eif.

The Data Interchange Services mapping specialist can export the transformation map directly to the WebSphere Partner Gateway database. Alternatively, the Data Interchange Services mapping specialist can send you the file, in which case you use the bcgDISImport utility to import it into WebSphere Partner Gateway. This appendix assumes the second scenario.

Importing the transformation map

This section describes the steps you take to import a transformation map that will take EDI input and transform it into XML format. In the process of importing the transformation map, you also import the document definition associated with the map.

Before you can import the transformation map, the Data Interchange Services mapping specialist must send it to you. This set of steps assumes that the file, S_DT_EDI_TO_XML.eif, is on your system.

  1. Open a command window.
  2. Enter the following command or script:

Verifying the transformation map and document flow definitions

To verify that the transformation maps and document definitions you imported are available on the Community Console, perform the following steps:

  1. Click Hub Admin > Hub Configuration > Maps > Transformation Maps.

    The S_DT_EDI_TO_XML map is displayed.

  2. Click the View details icon next to the map.

    You see the document flow definitions with which this map is associated:

    Table 26. Document flow definition associated with the map
    Source Target
    Package: N/A
    Protocol: X12V5R1
    Document Flow: 879 (ALL)
    Package: None
    Protocol: FVT-XML-TEST (ALL)
    Document Flow: WWRE_ITEMCREATIONINTERNAL (ALL)

The S_DT_EDI_TO_XML map was defined to take an X12 879 transaction (which adheres to the X12V5R1 standard) and transform it to a custom protocol.

Configuring the target

In this section, you create a file-system directory target for the hub:

  1. Click Hub Admin > Hub Configuration > Targets and click Create Target.
  2. For Target Name, type: EDIFileTarget
  3. From the Transport list, select File Directory.
  4. For Root Path, type: /Data/Manager/editarget
  5. Click Save.

The community participant sends the EDI interchange to this target.

Creating the interactions

You create two interactions--one for the EDI envelope and one for the transaction within the EDI envelope.

Create an interaction that represents the EDI envelope.

  1. Click HubAdmin > Hub Configuration > Document Flow Definition.
  2. Click Manage Interactions and then Create Interaction.
  3. Expand Package: None and Protocol: EDI-X12 and select Document Flow: ISA.
  4. Expand Package: N/A and Protocol: EDI-X12 and select Document Flow: ISA.
  5. From the Action list, select EDI De-envelope.
    Note: No transformation is occurring in this interaction. The EDI interchange is being de-enveloped, resulting in the individual transaction (879). You do not, therefore, need a transformation map for this interaction.
  6. Click Save.

Create an interaction that has a source that represents the 879 transaction and a target the represents the transformed document.

  1. Click HubAdmin > Hub Configuration > Document Flow Definition.
  2. Click Manage Interactions and then Create Interaction.
  3. Expand Package: N/A and Protocol: X12V5R1 and select Document Flow: 879.
  4. Expand Package: None and Protocol: FVT-XML-TEST and select Document Flow: WWRE_ITEMCREATIONINTERNAL.
  5. From the Transformation Map list, select S_DT_EDI_TO_XML.
  6. From the Action list, select EDI Validate and EDI Translate.
  7. Click Save.

This interaction represents the transformation of a standard EDI X12 879 transaction into a different format and, therefore, you must select a transformation map.

Creating the participants

For this example, you have two participants: the Community Manager (Manager) and a participant (TP1).

Create the Community Manager profile:

  1. Click Account Admin > Profiles > Community Participant and click Create.
  2. For Company Login Name, type: ComManager
  3. For Participant Display Name: type Manager
  4. For Participant Type, select Community Manager.
  5. Click New for Business ID and type 000000000 as the Freeform ID.
    Note: Make sure you select Freeform and not DUNS.
  6. Click New again for Business ID and type 01-000000000 as the Freeform ID.
  7. Click Save.

Create the second participant:

  1. Click Account Admin > Profiles > Community Participant and click Create.
  2. For Company Login Name, type TP1
  3. For Participant Display Name, type TP1
  4. For Participant Type, select Community Participant.
  5. Click New for Business ID and type 000000001 as the Freeform ID.
    Note: Make sure you select Freeform and not DUNS.
  6. Click New again for Business ID and type 01-000000001 as the Freeform ID.
  7. Click Save.

Creating the gateways

Create file-directory gateways for both participants in the example. First, create a gateway for the Manager:

  1. Click Account Admin > Profiles > Community Participant and click Search.
  2. Click the View details icon next to the Manager profile.
  3. Click Gateways and then Create.
  4. Enter the following values for the gateway. Remember that the file directory (the entire path) must already exist on your file system.
    1. For Name, type ManagerFileGateway.
    2. From the Transport List, select File Directory.
    3. For Address, type: file:///Data/Manager/filegateway
    4. Click Save.
  5. Click List to list all the gateways for the Community Manager.
  6. Click View Default Gateways.
  7. From the Production list, select the gateway you created in step 4.
  8. Click Save.

Next, create a gateway for the participant.

  1. Click Account Admin > Profiles > Community Participant and click Search.
  2. Select the other participant you created for this example by clicking on the View details icon next to TP1.
  3. Click on Gateways and then Create.
  4. Enter the following values for the gateway. Remember that the file directory (the entire path) must already exist.
    1. For Name, type TP1FileGateway.
    2. From the Transport list, select File Directory.
    3. For Address, type: file:///Data/TP1/filegateway
    4. Click Save.
  5. Click List to list all the gateways for the participant.
  6. Click View Default Gateways.
  7. From the Production list, select the gateway you created in step 4.
  8. Click Save.

Setting up B2B capabilities

Enable the B2B capabilities of the two participants in this exchange. In this example, the EDI interchange is originating with the community participant (TP1) and will be delivered to the Community Manager.

  1. Click on Account Admin > Profiles > Community Participant and click Search.
  2. Click the View details icon for the source participant for this example (TP1).
  3. Click B2B Capabilities.
  4. Enable two sets of capabilities for the source participant.
    1. First, enable the document flow definition representing the EDI envelope:
      1. Click the Role is not active icon under Set Source for Package: None to enable it.
      2. Expand Package: None.
      3. Click the Role is not active icon under Set Source for Protocol EDI-X12 (ALL).
      4. Expand Protocol EDI-X12 (ALL).
      5. Click the Role is not active icon under Set Source for Document Flow: ISA (ALL).
    2. Next, enable the document flow definition representing the transaction:
      1. Click the Role is not active icon under Set Source for Package: N/A to enable it.
      2. Expand Package: N/A.
      3. Click the Role is not active icon under Set Source for Protocol: X12V5R1 (ALL).
      4. Expand Protocol: X12V5R1 (ALL).
      5. Click the Role is not active icon under Set Source for Document Flow: 879.
  5. Click on Account Admin > Profiles > Community Participant and click Search.
  6. Click the View details icon for the target participant for this example (Manager).
  7. Click B2B Capabilities.
  8. Enable two sets of capabilities for the target participant.
    1. First, enable the document flow definition:
      1. Click the Role is not active icon under Set Target for Package: N/A to enable it.
      2. Expand Package: N/A.
      3. Click the Role is not active icon under Set Target for Protocol: EDI-X12 (ALL).
      4. Expand Protocol: EDI-X12 (ALL).
      5. Click the Role is not active icon under Set Target for Document Flow: ISA (ALL).
    2. Next, enable the document flow definition representing the transformed document:
      1. Click the Role is not active icon under Set Target for Package: None to enable it.
      2. Expand Package: None.
      3. Click the Role is not active icon under Set Target for Protocol: FVT-XML-TEST (ALL).
      4. Expand Protocol: FVT-XML-TEST (ALL).
      5. Click the Role is not active icon under Set Target for Document Flow: WWRE_ITEMCREATIONINTERNAL(ALL).

Activating the connections

To activate the connections:

  1. Click Account Admin > Participant Connections.
  2. Select TP1 from the Source list.
  3. Select Manager from the Target list.
  4. Click Search.
  5. Click Activate for the connection that represents the envelope:
    Table 27. Envelope connection
    Source Target
    Package: None (N/A)
    Protocol: EDI-X12 (ALL)
    Document Flow: ISA (ALL)
    Package: N/A (N/A)
    Protocol: EDI-X12 (ALL)
    Document Flow: ISA (ALL)
  6. Click Activate for the connection that represents the 879 transaction to the transformed document:
    Table 28. EDI transaction to XML document connection
    Source Target
    Package: N/A (N/A)
    Protocol: X12V5R1 (ALL)
    Document Flow: 879 (ALL)
    Package: None (N/A)
    Protocol: FVT-XML-TEST (ALL)
    Document Flow: WWRE_ITEMCREATIONINTERNAL (ALL)

At this point, if TP1 sent an EDI interchange containing an 879 transaction to the Community Manager, the EDI interchange would be de-enveloped, resulting in an 879 transaction. The 879 transaction would then be transformed and the transformed document would be sent to the gateway of the Community Manager.

Copyright IBM Corp. 2003, 2005