EDI to ROD example

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

De-enveloping and transforming an EDI interchange

In this example, it is assumed that the Data Interchange Services mapping specialist has created a transformation map that takes a standard EDI 850 transaction (defined with the X12V5R1 dictionary, corresponding to the version 5010 of X12) and transforms it into a record-oriented document (ROD) that will be processed by the back-end application of the Community Manager. In this example, the map is named S_DT_EDI_TO_ROD.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 record-oriented data (ROD) 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_ROD.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_ROD 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 19. Document flow definition associated with the map
    Source Target
    Package: N/A
    Protocol: X12V5R1 (ALL)
    Document Flow: 850 (ALL)
    Package: None
    Protocol: DEMO850CL_DICTIONARY(ALL) Document Flow: DEMO850CLSUW (ALL)

The S_DT_EDI_TO_ROD map was defined to take an X12 850 transaction (which adheres to the X12V5R1 standard) and transform it to a custom protocol (DEMO850CL_DICTIONARY) and document flow (DEMO850CLSUW).

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. Under Source, expand Package: None and Protocol: EDI-X12 and select Document Flow: ISA.
  4. Under Target, 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 (850). You do not, therefore, need a transformation map for this interaction.
  6. Click Save.

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

  1. Click HubAdmin > Hub Configuration > Document Flow Definition.
  2. Click Manage Interactions and click Create Interaction.
  3. Under Source, expand Package: N/A and Protocol: X12V5R1 and select Document Flow: 850.
  4. Under Target, expand Package: None and Protocol: DEMO850CL_DICTIONARY and select Document Flow: DEMO850CLSUW.
  5. From the Transformation Map list, select S_DT_EDI_TO_ROD.
  6. From the Action list, select EDI Validate and EDI Translate.
  7. Click Save.

This interaction represents the transformation of a standard EDI X12 850 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 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 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 850 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: 850.
  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 representing the envelope:
      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: DEMO850CL_DICTIONARY (ALL).
      4. Expand Protocol: DEMO850CL_DICTIONARY (ALL).
      5. Click the Role is not active icon under Set Target for Document Flow: DEMO850CLSUW(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 20. 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 850 transaction to the transformed document:
    Table 21. EDI transaction to ROD document connection
    Source Target
    Package: N/A (N/A)
    Protocol: X12V5R1
    Document Flow: 850 (ALL)
    Package: None (N/A)
    Protocol: DEMO850CL_DICTIONARY (ALL) Document Flow: DEMO850CLSUW (ALL)

Adding attributes

Set the attribute that allows documents with duplicate IDs:

  1. Click Hub Admin > Hub Configuration > Document Flow Definition.
  2. Click the Expand icon next to Package: None.
  3. Click the Edit Attribute Values icon next to Protocol: EDI-X12.
  4. Scroll down to the Document Flow Context Attributes section of the page. In the Allow documents with duplicate document ids row, select Yes from the list.
  5. Click Save.

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

Adding a TA1 to the exchange

In X12, the TA1 is an optional segment that can be used to acknowledge receipt of an interchange. The sender can request a TA1 from the receiver by setting element 14 of the ISA Interchange Control Header to 1. The Allow a TA1 request attribute in WebSphere Partner Gateway can be used to control whether a TA1 is sent when the sender requests it.

The &WDI_TA1_ACK map is installed during the installation of WebSphere Partner Gateway, so you do not have to import it.

Creating the associations

To associate the map with a document flow definition, perform the following steps:

  1. Click Hub Admin > Hub Configuration > Maps > EDI FA Maps.

    The &WDI_TA1_ACK map is displayed.

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

    You see information about the map as well as a folder for each type of package available on the system.

  3. Create the association to the document flow definition by performing these steps:
    1. Select the check box next to Package: None and expand the folder.
    2. Select the check box next to Protocol: EDI-X12 (ALL) and expand the folder.
    3. Select the check box next to Document Flow: ISA (ALL).
    4. Click Save.

You have created an association between the &WDI_TA1_ACK1 map and the document flow definition for the envelope.

Creating interactions

Create an interaction that represents the TA1 transaction.

  1. Click HubAdmin > Hub Configuration > Document Flow Definition.
  2. Click Manage Interactions and then Create Interaction.
  3. Under Source, expand Package: N/A and Protocol: &X44TA1 and select Document Flow: TA1.
  4. Under Target, expand Package: N/A and Protocol: &X44TA1 and select Document Flow: TA1.
  5. From the Action list, select Pass Through.
  6. Click Save.

Create an interaction that has a source that represents the EDI envelope that will hold the TA1.

  1. Click HubAdmin > Hub Configuration > Document Flow Definition.
  2. Click Manage Interactions and then Create Interaction.
  3. Under Source, expand Package: N/A and Protocol: EDI-X12 and select Document Flow: ISA.
  4. Under Target, expand Package: None and Protocol: EDI-X12 and select Document Flow: ISA.
  5. From the Action list, select Pass Through.
  6. Click Save.

Enabling B2B capabilities

Next, you add the newly created interactions to the B2B capabilities of the participants.

  1. Click on Account Admin > Profiles > Community Participant and click Search.
  2. Click the View details icon for the source participant for this example (Manager).
    Note: Remember that the TA1 flows from the participant that receives the ROD document to the participant that sent it. In this example, the Manager is the source of the TA1 and participant TP1 is the target.
  3. Click B2B Capabilities.
  4. Enable two sets of capabilities for the source participant.
    1. First, enable the capability for the TA1.
      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: &X44TA1.
      4. Expand Protocol: &X44TA1.
      5. Click the Role is not active icon under Set Source for Document Flow: TA1 (ALL).
    2. Next, enable the capability for the envelope:
      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: EDI-X12.
      4. Expand Protocol: EDI-X12 (ALL).
      5. Click the Role is not active icon under Set Source for Document Flow: ISA (ALL).
  5. Click on Account Admin > Profiles > Community Participant and click Search.
  6. Click the View details icon for the target participant for this example (TP1).
  7. Click B2B Capabilities.
  8. Enable two sets of capabilities for the target participant.
    1. First, enable the document flow definition representing the TA1:
      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: &X44TA1 (ALL).
      4. Expand Protocol: &X44TA1 (ALL).
      5. Click the Role is not active icon under Set Target for Document Flow: TA1 (ALL).
    2. Next, enable the document flow definition representing the EDI envelope:
      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: 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).

Creating the envelope profile

You next create the profile for the envelope that will contain the TA1:

  1. Click Hub Admin > Hub Configuration > EDI > Envelope Profile.
  2. Click Create.
  3. Type the name of the profile: EnvProf1.
  4. From the EDI Standard list, select X12.
  5. The General button is selected by default. Type the following values for the general attributes of the envelope:
  6. Click the Interchange button and type the following values for the interchange attributes:
  7. Click Save.

Activating participant connections

To activate the connections:

  1. Click Account Admin > Participant Connections.
  2. Select Manager from the Source list.
  3. Select TP1 from the Target list.
  4. Click Search.
  5. Activate the connection that represents the TA1.
    Table 22. TA1 connection
    Source Target
    Package: N/A (N/A)
    Protocol: &X44TA1 (ALL)
    Document Flow: TA1 (ALL)
    Package: N/A (N/A)
    Protocol: &X44TA1 (ALL)
    Document Flow: TA1 (ALL)
  6. Activate the connection that represents the envelope:
    Table 23. Envelope connection
    Source Target
    Package: N/A (N/A)
    Protocol: EDI-X12 (ALL)
    Document Flow: ISA (ALL)
    Package: None (N/A)
    Protocol: EDI-X12 (ALL)
    Document Flow: ISA (ALL)

Configuring the attributes

To specify attributes for the envelope profile:

  1. Click Account Admin > Profiles > Community Participant and click Search.
  2. Select TP1 from the list.
  3. Click B2B Capabilities.
  4. Click the Expand icon next to Package: None.
  5. Click the Edit icon next to Protocol: EDI-X12 (ALL).
  6. In the Allow a TA1 Request row, select Yes.
  7. Click Save.
  8. Click B2B Capabilities again.
  9. Click the Expand icon next to Package: N/A.
  10. Click the Edit icon next to Protocol: &X44TA1 (ALL).
  11. Specify the following attributes:
    1. In the Envelope Profile row, select EnvProf1 from the list.
    2. In the Interchange qualifier row, type 01.
    3. In the Interchange identifier row, type 000000001.
    4. In the Interchange usage indicator row, type T.
  12. Click Save.

In this series of tasks, you have added a TA1 acknowledgment to the exchange. When the interchange is received, WebSphere Partner Gateway sends a TA1 back to the sender (TP1). The TA1 is sent in an envelope that conforms to envelope profile EnvProf1.

Adding an FA map

This section describes how to add a standard functional acknowledgment (997) to the flow described in EDI to ROD example. The functional acknowledgment provides confirmation to the sender that the transaction was received.

Note: This example is similar to Adding a TA1 to the exchange. However, it is not directly related to that example. Instead, it builds on the tasks you performed in EDI to ROD example.

WebSphere Partner Gateway includes a set of preinstalled functional acknowledgment map names that begin with $DT_FA. This is followed by the name of the functional acknowledgment message and the version and release of the message. For example, Version 2 Release 4 of the 997 functional acknowledgment message is named $DT_997V2R4. See Functional acknowledgments for the list of maps provided with WebSphere Partner Gateway.

Creating the associations

To associate the map with a document flow definition, perform the following steps:

  1. Click Hub Admin > Hub Configuration > Maps > EDI FA Maps.

    The &DT_FA997V2R4 map is displayed.

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

    You see information about the map as well as a folder for each type of package available on the system.

  3. Create the association to the document flow definition by performing these steps:
    1. Select the check box next to Package: N/A and expand the folder
    2. Select the check box next to Protocol: X12V5R1 and expand the folder.
    3. Select the check box next to Document Flow: 850.
    4. Click Save.

You have associated this functional acknowledgment 997 map with the X12 protocol.

Creating interactions

Create an interaction that represents the 997 acknowledgment.

  1. Click HubAdmin > Hub Configuration > Document Flow Definition.
  2. Click Manage Interactions and then Create Interaction.
  3. Under Source, expand Package: N/A and Protocol: &DT99724 and select Document Flow: 997.
  4. Under Target, expand Package: N/A and Protocol: &DT99724 and select Document Flow: 997.
  5. From the Action list, select Pass Through.
  6. Click Save.

Create an interaction that represents the envelope.

  1. Click HubAdmin > Hub Configuration > Document Flow Definition.
  2. Click Manage Interactions and then Create Interaction.
  3. Expand Package: N/A and Protocol: EDI-X12 and select Document Flow: ISA.
  4. Expand Package: None and Protocol: EDI-X12 and select Document Flow: ISA.
  5. From the Action list, select Pass Through.
  6. Click Save.

Enabling B2B capabilities

Next, you add the newly created interactions to the B2B capabilities of the participants.

  1. Click on Account Admin > Profiles > Community Participant and click Search.
  2. Click the View details icon for the source participant for this example (Manager).
    Note: Remember that the functional acknowledgment flows from the participant that receives the ROD document to the participant that sent it. In this example, the Manager is the source of the functional acknowledgment, and participant TP1 is the target.
  3. Click B2B Capabilities.
  4. Enable two sets of capabilities for the source participant.
    1. First, enable the capability for the FA.
      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: &DT99724.
      4. Expand Protocol: &DT99724.
      5. Click the Role is not active icon under Set Source for Document Flow: 997 (ALL).
    2. Next, enable the capability for the envelope:
      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: EDI-X12.
      4. Expand Protocol: EDI-X12 (ALL).
      5. Click the Role is not active icon under Set Source for Document Flow: ISA (ALL).
  5. Click on Account Admin > Profiles > Community Participant and click Search.
  6. Click the View details icon for the target participant for this example (TP1).
  7. Click B2B Capabilities.
  8. Enable two sets of capabilities for the target participant.
    1. First, enable the document flow definition representing the 997:
      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: &DT99724 (ALL).
      4. Expand Protocol: &DT99724 (ALL).
      5. Click the Role is not active icon under Set Target for Document Flow: 997 (ALL).
    2. Next, enable the document flow definition representing the EDI envelope:
      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: 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).

Creating the envelope profile

You next create the profile for the envelope that will contain the 997 functional acknowledgment. A functional acknowledgment, like a transaction, must be enveloped before it can be sent.

  1. Click Hub Admin > Hub Configuration > EDI > Envelope Profile.
  2. Click Create.
  3. Type the name of the profile: EnvProf1.
  4. From the EDI Standard list, select X12.
  5. The General button is selected by default. Type the following values for the general attributes of the envelope:
  6. Click the Interchange button and type the following values for the interchange attributes:
  7. Click Save.

Activating participant connections

To activate the connections:

  1. Click Account Admin > Participant Connections.
  2. Select Manager from the Source list.
  3. Select TP1 from the Target list.
  4. Click Search.
  5. Click Activate for the connection that represents the 997 functional acknowledgment:
    Table 24. Functional acknowledgment connection
    Source Target
    Package: N/A (N/A)
    Protocol: &DT99724 (ALL)
    Document Flow: 997 (ALL)
    Package: N/A (N/A)
    Protocol: &DT99724 (ALL)
    Document Flow: 997 (ALL)
  6. Click Activate for the connection that represents the EDI envelope being sent back to the originator of the exchange.
    Table 25. Envelope connection
    Source Target
    Package: N/A (N/A)
    Protocol: EDI-X12 (ALL)
    Document Flow: ISA (ALL)
    Package: None (N/A)
    Protocol: EDI-X12 (ALL)
    Document Flow: ISA (ALL)

Configuring attributes

First, you specify which FA map to use:

  1. Click Account Admin > Profiles > Community Participant and click Search.
  2. Select TP1 from the list.
  3. Click B2B Capabilities.
  4. Click the Expand icon next to Package: N/A.
  5. Click the Edit icon next to Protocol: X12V5R1 (ALL).
  6. In the FA Map row, select &DT_FA997V2R4.
  7. Click B2B Capabilities again.
  8. Click the Expand icon next to Package: N/A.
  9. Click the Edit icon next to Protocol: &DT99724 (ALL).
  10. Specify the following attributes:
    1. In the Envelope Profile row, select EnvProf1 from the list.
    2. In the Interchange qualifier row, type 01.
    3. In the Interchange identifier row, type 000000001.
    4. In the Interchange usage indicator row, type T.
  11. Click Save.

In this series of tasks, you have added an EDI-X12 997 functional acknowledgment to the exchange, so that when the Community Manager receives the document, it sends the 997 back to the sender (TP1). The 997 acknowledgment is sent in an envelope that conforms to envelope profile EnvProf1.

Copyright IBM Corp. 2003, 2005