ROD to EDI example

This section provides an example of the Community Manager sending a ROD document to the hub, where it is transformed into an EDI transaction, enveloped within an EDI interchange, and sent to a participant.

In this example, it is assumed that the Data Interchange Services mapping specialist has created a transformation map that takes a a record-oriented document (ROD) and transforms it into a standard EDI 850 transaction (defined with the X12V5R1 dictionary, corresponding to the version 5010 of X12) that will be processed by the participant. In this example, the map is named S_DT_ROD_TO_EDI.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 ROD input and transform it into an X12 transaction. 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_ROD_TO_EDI.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_ROD_TO_EDI 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 32. Document flow definitions associated with the map
    Source Target
    Package: None
    Protocol: ROD-TO-EDI_DICT (ALL)
    Document Flow: DTROD-TO-EDI_ROD (ALL)
    Package: N/A
    Protocol: X12V5R1(ALL)
    Document Flow: 850 (ALL)

The S_DT_ROD_TO_EDI map was defined to take a ROD document associated with the ROD-TO-EDI_DICT dictionary and transform it to an X12 850 transaction that conforms to the X12V5R1 standard.

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: RODFileTarget
  3. From the Transport list, select File Directory.
  4. For Root Path, type: /Data/Manager/rodtarget
  5. From the Configuration Point list, select Preprocess.
  6. Select com.ibm.bcg.edi.receiver.preprocesshandler.RODSplitterHandler from the Available List and click Add to move it to the Configured List.
  7. Select com.ibm.bcg.edi.receiver.preprocesshandler.RODSplitterHandler from the Configured List and click Configure.
  8. Add the values shown in table:
    Table 33. ROD Splitter Handler attributes
    Field Value
    From Packaging Name None
    From Packaging Version N/A
    From Protocol Name ROD-TO-EDI_DICT
    From Protocol Version ALL
    From Process Code DTROD-TO-EDI_ROD
    From Process Version ALL
    METADICTIONARY ROD-TO-EDI_DICT
    METADOCUMENT DTROD-TO-EDI_ROD
    METASYNTAX rod
    ENCODING ascii
    BCG_BATCHDOCS ON
  9. Click Set Values.
  10. Click Save.

The Community Manager sends the ROD document to this target.

Creating the interactions

You create two interactions--one for the EDI envelope that will be sent from the hub and one for the transformation of the ROD document to EDI.

Create an interaction that has a source that represents the ROD document and a target the represents the X12 document.

  1. Click HubAdmin > Hub Configuration > Document Flow Definition.
  2. Click Manage Interactions and then Create Interaction.
  3. Expand Package: None and Protocol: ROD-TO-EDI_DICT and select DTROD-TO-EDI_ROD.
  4. Expand Package: N/A and Protocol: X12V5R1 and select Document Flow: 850.
  5. From the Transformation Map list, select S_DT_ROD_TO_EDI.
  6. From the Action list, select ROD Translate and EDI Validate.
  7. Click Save.

This interaction represents the transformation of a ROD document into a standard X12 transaction and, therefore, you must select a transformation map.

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: 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.
    Note: No transformation is occurring in this interaction. This interaction is to envelope the EDI interchange.
  6. Click Save.

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 ROD document is originating from the Community Manager and will be delivered to the participant (TP1).

  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).
  3. Click B2B Capabilities.
  4. Enable two sets of capabilities for the source participant.
    1. First, enable the document flow definition representing the ROD document:
      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: ROD-TO-EDI_DICT (ALL).
      4. Expand Protocol: ROD-TO-EDI_DICT (ALL).
      5. Click the Role is not active icon under Set Source for Document Flow: DTROD-TO-EDI_ROD (ALL).
    2. Next, enable the document flow definition representing the EDI 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 (ALL).
      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 EDI 850 transaction:
      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: X12V5R1 (ALL).
      4. Expand Protocol: X12V5R1 (ALL).
      5. Click the Role is not active icon under Set Target for Document Flow: 850 (ALL).
    2. Next, enable the document flow definition representing the 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 transformed 850 transaction.

  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 the 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 ROD document to EDI transaction:
    Table 34. ROD to EDI connection
    Source Target
    Package: N/A (N/A)
    Protocol: ROD-TO-EDI_DICT (ALL) Document Flow: DTROD-TO-EDI_ROD (ALL)
    Package: None (N/A)
    Protocol: X12V5R1 (ALL)
    Document Flow: 850
  6. Click Activate for the connection that represents the envelope:
    Table 35. 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)

Configuring 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: N/A.
  5. Click the Edit icon next to Protocol: X12V5R1.
  6. 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.
  7. Click Save.

At this point, if the Community Manager sent a ROD document to the hub, the document would be transformed to an 850 transaction, which would then be enveloped and sent to the gateway of the participant.

Copyright IBM Corp. 2003, 2005