General steps for defining document exchanges

This section provides a high-level overview of the tasks you need to perform to establish the exchange of documents for EDI interchanges entering the hub, documents or transactions transformed at the hub, and for EDI interchanges being sent from the hub. The steps shown in the following sections are general and apply only to the importing of maps and setting up of interactions. The general steps for enabling B2B capabilities for participants (for all types of document exchanges) are described in Setting up B2B capabilities. The general steps for managing connections (for all types of document exchanges) are described in Managing connections. If you want to see a comprehensive example of an EDI document exchange, from the importing of maps all the way through the management of connections, refer to Appendix B. EDI examples. The appendix includes the following specific examples:

Importing maps

Transformation maps for EDI, XML, or record-oriented-data (ROD) documents can be created with the Data Interchange Services client program. The Data Interchange Services client is a program used to create and maintain XML schema document definitions, XML DTD document definitions, EDI standards, ROD document definitions, and maps.

The Data Interchange Services client is a separately installed program that is included on the WebSphere Partner Gateway media but that typically resides on another computer. The Data Interchange Services mapping specialist creates a map that specifies how the elements in one document are moved to the elements in another, different document. In addition to having instructions that explain how to convert a document from one format to another, Data Interchange Services must also know the layout, or format, of the source and target document. In Data Interchange Services the layout of a document is a document definition.

When the transformation map is imported into WebSphere Partner Gateway, the document definitions created in Data Interchange Services are displayed as document flow definitions (package, protocol, and document flow) on the Transformation Map and Manage Document Flow Definitions page.

For example, if you are converting an XML document to an X12 transaction, you import the map that defines the XML and X12 transaction document definitions and the transformation that is to take place.

There are two methods for receiving the map files from the Data Interchange Services. If the Data Interchange Services client has a direct connection to the WebSphere Partner Gateway database, the Data Interchange Services mapping specialist can export the file directly to the database. A more likely scenario is that you will receive the files in e-mail or as an FTP transfer. If the files are transferred to you through FTP, note that they must be in binary form.

If an error occurs during the export of a map from the Data Interchange Services client, you might still see the map name in the Community Console. The map cannot be used to translate documents. You will need to advise the Data Interchange Services client mapping specialist of the export problem and ask the mapping specialist to re-export the map before it can be used to translate documents.

To import a map, perform the following steps:

  1. Open a command window.
  2. Enter the following command or script:
  3. For transformation maps, verify that the document flow definition was imported.
    1. Click Hub Admin > Hub Configuration > Maps > Transformation Maps.
    2. From the Transformation Maps page, click the View details icon next to the map from Data Interchange Services. You will notice that the document flow definitions for the source and target are displayed, indicating the format in which the document will be received at the hub and the format in which it will be delivered from the hub.
    3. Click Hub Admin > Hub Configuration > Document Flow Definitions.
    4. Expand the packages and protocols associated with the document definitions you saw on the Transformation Maps page to verify that the document flows are displayed on the Manage Document Flow Definitions page.

You can use validation maps in conjunction with transformation maps to add additional EDI Standards validation to any translation process involving EDI Standards. Validation maps give you complete control over the validation of an EDI document.

Note that transformation and validation maps exported from the Data Interchange Services client or imported with the bcgDISImport utility cannot be downloaded from the WebSphere Partner Gateway Community Console. The Data Interchange Services client mapping specialist administers these maps by connecting to the WebSphere Partner Gateway database through the Data Interchange Services client.

Setting up an EDI to EDI flow

This section describes interactions needed to receive an EDI interchange, de-envelope the interchange, transform a transaction from one EDI format to another, envelope the transaction, and deliver it.

  1. Verify that a document flow definition exists for the EDI interchange that is received at the hub. Remember that after the interchange is de-enveloped, the original envelope does not continue to be processed. In other words, it has no delivery point. Therefore, you will use N/A for Package on the target interaction.
    1. Click Hub Admin > Hub Configuration > Document Flow Definition.
    2. Check to see whether a document flow definition already exists. For example, if a participant will be sending an EDI interchange in AS packaging, EDI-X12 protocol, and ISA document flow, the definition is already available. Similarly, an N/A/EDI-X12/ISA document flow definition already exists.
    3. Enter a value (or select the value from the list) for any attribute you want associated with the profile. For example, if you want to specify that the envelope should be discarded if errors are found with any of the transactions, click the Edit attribute values icon next to Document Flow. In the Discard Envelope if Any Errors row, select Yes from the list.
    4. If a document flow definition does not exist, create one by selecting the Package, Protocol, and Document Flow.
  2. Create an interaction for the interchange.
    1. Click Hub Admin > Hub Configuration > Document Flow Definitions > Manage Interactions.
    2. Select Create Interaction.
    3. Select the source and target document flow definitions. Except for the packaging (which will be N/A for the target), the document flow definitions will be the same.
    4. Select EDI De-envelope from the Action list.
  3. Import the transformation map that provides document definitions of the EDI transactions and that describes how the transaction is transformed from one EDI format to another. See Importing maps.

    If the interchange contains more than one transaction, repeat this step for each transaction.

  4. If you want to edit attributes of the document definitions associated with the map, perform the following steps:
    1. Click Hub Admin > Hub Configuration > Document Flow Definition.
    2. Click the Edit attribute values icon next to the protocol. For EDI protocols, you see a long list of attributes that you can set.
    3. Enter a value (or select the value from the list) for any attribute you want associated with the protocol.
    4. Click the Edit attribute values icon next to the document flow. You generally see a smaller list of attributes than those associated with the protocol.
    5. Enter a value (or select the value from the list) for any attribute you want associated with the document flow. For example, you can change the Validation Map associated with the document flow.

      Make sure you select an envelope profile for the transaction.

  5. Create an interaction for the map you just imported.
    1. Click Hub Admin > Hub Configuration > Document Flow Definitions > Manage Interactions
    2. Click Create Interaction.
    3. Under Source, select the document flow associated with the transaction. Expand the package and protocol and select the document flow. This will typically be N/A (because the transaction itself did not originate from a participant), the protocol defined in the map (for example, X12V4R1) and the actual EDI document defined in the map (for example, 850).
    4. Under Target, select the document flow definition for the transformed document. Expand the package and protocol and select the document flow. Because the transaction will be enveloped (and will, therefore, not be directly delivered to a participant), the packaging will again be N/A.
    5. From the transformation map list, select the map that defines how to transform this document.
    6. From the Action list, select EDI Validate and EDI Translate.
  6. Verify that a document flow definition exists for the EDI interchange that is being sent from the hub, and set any attributes that you want associated with the interchange.
    1. Click Hub Admin > Hub Configuration > Document Flow Definition.
    2. Check to see whether a document flow definition already exists. The source package will be N/A, with the protocol and document flow matching the protocol and document flow used to deliver the interchange. For example, if the interchange will be delivered as AS/EDI-X12/ISA, the source will be N/A/EDI-X12/ISA.
    3. Edit any attributes that apply to the interchange that is being delivered.
    4. If a document flow definition does not exist, create one by selecting the Package, Protocol, and Document Flow.
  7. Create an interaction for the EDI interchange that is sent from the hub after the transaction is transformed.
    1. Click Hub Admin > Hub Configuration > Document Flow Definitions > Manage Interactions.
    2. Click Create Interaction.
    3. Select the source and target documents. Except for the packaging (which will be N/A for the source document), the document flow definitions will be the same.
    4. Select Pass Through from the Action list.

To add an acknowledgment to the flow, see Setting up acknowledgments.

After setting up the interactions, create B2B capabilities for the participants.

The detailed steps for creating B2B capabilities are described in Setting up B2B capabilities.

After setting up B2B capabilities for the participants, create connections. You need three connections:

The detailed steps for creating connections are described in Managing connections.

Setting up an EDI to XML or ROD flow

This section describes interactions needed to receive an EDI interchange, de-envelope the interchange, transform a transaction from an EDI format to an XML or ROD document, and deliver it.

Note: For a comprehensive example of the EDI to XML flow, see EDI to XML example. For a comprehensive example of the EDI to ROD flow, see EDI to ROD example.

  1. Verify that a document flow definition exists for the EDI interchange that is received at the hub. Remember that after the interchange is de-enveloped, the envelope does not continue to be processed. In other words, it has no delivery point. Therefore, you will use N/A for Package on the target interaction.
    1. Click Hub Admin > Hub Configuration > Document Flow Definition.
    2. Check to see whether a document flow definition already exists. For example, if a participant will be sending an EDI interchange in AS packaging, EDI-X12 protocol, and ISA document flow, the definition is already available. Similarly, an N/A/EDI-X12/ISA document flow definition already exists.
    3. If a document flow definition does not exist, create one.
  2. Create an interaction for the EDI interchange that is received at the hub.
    1. Click Hub Admin > Hub Configuration > Document Flow Definitions > Manage Interactions.
    2. Select Create Interaction.
    3. Select the source and target documents. Except for the packaging (which will be N/A for the target), the document flow definitions will be the same.
    4. Select EDI De-envelope from the Action list.
  3. Import the transformation map that provides document definitions of the EDI transaction and the XML or ROD document and describes how the transaction is transformed into the XML or ROD document. See Importing maps.

    If the interchange contains more than one transaction, repeat this step for each transaction.

  4. Create an interaction for the map you just imported.
    1. Click Hub Admin > Hub Configuration > Document Flow Definitions > Manage Interactions.
    2. Click Create Interaction.
    3. Under Source, select the document flow associated with the transaction. Expand the package and protocol and select the document flow. This will typically be N/A (because the transaction itself did not originate from a participant), the protocol defined in the map (for example, X12V4R1) and the actual EDI document defined in the map (for example, 850).
    4. Under Target, select the document flow definition for the transformed (XML or ROD) document. Expand the package and protocol and select the document flow.
    5. From the transformation map list, select the map that defines how to transform this document.
    6. From the Action list, select EDI Validate and EDI Translate.

To add an acknowledgment to the flow, see Setting up acknowledgments.

After setting up the interactions, create B2B capabilities for the participants.

The detailed steps for creating B2B capabilities are described in Setting up B2B capabilities.

After setting up B2B capabilities for the participants, create connections. You need two connections:

The detailed steps for creating connections are described in Managing connections.

Setting up an XML or ROD to EDI flow

This section describes interactions needed to receive an XML or ROD document, transform it into an EDI transaction, envelope the transaction, and deliver it.

Note: For a comprehensive example of the XML to EDI flow, see XML to EDI example. For a comprehensive example of the ROD to EDI flow, see ROD to EDI example.

  1. Import the transformation map that provides document definitions of the XML or ROD document and EDI transaction and describes how the document is transformed to the EDI transaction. See Importing maps.
  2. Create an interaction for the map you just imported.
    1. Click Hub Admin > Hub Configuration > Document Flow Definitions > Manage Interactions.
    2. Click Create Interaction.
    3. Under Source, select the document flow definition associated with the XML or ROD document. Expand the package and protocol and select the document flow.
    4. Under Target, select the document flow associated with the EDI transaction. Expand the package and protocol and select the document flow. Because the transaction will not be delivered directly (it will be put into an envelope before delivery), N/A will be listed for Package.
    5. From the transformation map list, select the map that defines how to transform this document.
    6. From the Action list, select XML Translate and EDI Validate or ROD Translate and EDI Validate.
  3. Verify that a document flow definition exists for the EDI interchange that is being sent from the hub, and set any attributes that you want associated with the interchange.
    1. Click Hub Admin > Hub Configuration > Document Flow Definition.
    2. Check to see whether a document flow definition already exists. N/A should be used for Package for the source document (the interchange being sent from the hub).
    3. Edit any attributes that apply to the interchange that is being delivered.
    4. If a document flow definition does not exist, create one by selecting the Package, Protocol, and Document Flow.
  4. Create an interaction for the EDI interchange that is sent from the hub after the document is transformed.
    1. Click Hub Admin > Hub Configuration > Document Flow Definitions > Manage Interactions
    2. Click Create Interaction.
    3. Select the source and target documents. The source and target documents have different packaging (the source document has a package of N/A), but the protocol (for example, EDI-X12) and the document flow (for example, ISA) should be the same.
    4. Select Pass Through from the Action list.

After setting up the interactions, create B2B capabilities for the participants.

The detailed steps for creating B2B capabilities are described in Setting up B2B capabilities.

After setting up B2B capabilities for the participants, create connections. You need two connections:

The detailed steps for creating connections are described in Managing connections.

Setting up multiple XML or ROD documents in one file to EDI flow

This section describes interactions needed to receive multiple XML or ROD documents in one file, transform the documents into EDI transactions, envelope the transactions, and deliver the EDI interchange.

  1. Import the transformation map that provides the document definitions of the XML or ROD documents and the EDI transactions and that describes the transformation. See Importing maps.
  2. Create an interaction for the source and target documents.
    1. Click Hub Admin > Hub Configuration > Document Flow Definitions > Manage Interactions.
    2. Click Create Interaction.
    3. Select the source and target documents, and select XML Translate and EDI Validate or ROD Translate and EDI Validate from the Action list.
  3. Repeat step 2 for the source document and each target document produced by the transformation map.
  4. Verify that a document flow definition exists for the EDI interchange that is being sent from the hub, and set any attributes that you want associated with the interchange.
    1. Click Hub Admin > Hub Configuration > Document Flow Definition.
    2. Check to see whether a document flow definition already exists. The source will be N/A, with the protocol and document flow matching the protocol and document flow used to deliver the interchange. For example, if the interchange will be delivered as AS/EDI-X12/ISA, the source will be N/A/EDI-X12/ISA.
    3. Edit any attributes that apply to the interchange that is being delivered.
    4. If a document flow definition does not exist, create one by selecting the Package, Protocol, and Document Flow.
  5. Create an interaction for the EDI interchange that is sent from the hub after the transaction is transformed.
    1. Click Hub Admin > Hub Configuration > Document Flow Definitions > Manage Interactions.
    2. Click Create Interaction.
    3. Select the source and target documents. The source and target documents have different packaging (the source document has a package of N/A), but the protocol (for example, EDI-X12) and the document flow (for example, ISA) should be the same.
    4. Select Pass Through from the Action list.

After setting up the interactions, create B2B capabilities for the participants.

The detailed steps for creating B2B capabilities are described in Setting up B2B capabilities.

After setting up B2B capabilities for the participants, create connections. You need several connections:

The detailed steps for creating connections are described in Managing connections.

Setting up an XML to ROD or ROD to XML document flow

This section describes interactions needed to receive an XML or ROD document, transform it into the other document type (XML to ROD or ROD to XML) and deliver it.

  1. Import the transformation map that provides document definitions of the XML and ROD documents and that describes how the documents are transformed. See Importing maps.
  2. Click Hub Admin > Hub Configuration > Maps > Transformation Maps and click the View details icon next to the map you just imported.
  3. Create an interaction for the map you just imported.
    1. Click Hub Admin > Hub Configuration > Document Flow Definitions > Manage Interactions
    2. Click Create Interaction.
  4. Select the source and target documents, and select XML Translate and EDI Validate or ROD Translate and EDI Validate from the Action list.

After setting up the interactions, create B2B capabilities for the participants.

The detailed steps for creating B2B capabilities are described in Setting up B2B capabilities.

After setting up B2B capabilities for the participants, create connections. You need one connection--for the XML to ROD flow or for the ROD to XML flow. The detailed steps for creating connections are described in Managing connections.

Setting up an XML to XML or ROD to ROD flow

This section describes interactions needed to receive an XML or ROD document, transform it into a document of the same type (XML to XML or ROD to ROD) and deliver it.

  1. Import the transformation map that provides document definitions of the XML or ROD documents and that describes how the documents are transformed. See Importing maps.
  2. Click Hub Admin > Hub Configuration > Maps > Transformation Maps and click the View details icon next to the map you just imported.
  3. Create an interaction for the map you just imported.
    1. Click Hub Admin > Hub Configuration > Document Flow Definitions > Manage Interactions.
    2. Click Create Interaction.
    3. Select the source and target documents.
    4. Select XML Translate and EDI Validate or ROD Translate and EDI Validate from the Action list.

After setting up the interactions, create B2B capabilities for the participants.

The detailed steps for creating B2B capabilities are described in Setting up B2B capabilities.

After setting up B2B capabilities for the participants, create connections. You need one connection--for the XML to XML flow or for the ROD to ROD flow. The detailed steps for creating connections are described in Managing connections.

Setting up acknowledgments

This section describes how to set up interactions to send acknowledgments of interchange or transaction receipt to the originator of the document.

Functional acknowledgments

Functional acknowledgment maps are used to provide generation of functional acknowledgments when responding to EDI documents received from a participant. WebSphere Partner Gateway provides a set of functional acknowledgment maps that produce the commonly used EDI functional acknowledgments. The mapping specialist can also create FA and validation maps, in which case these maps would be uploaded to WebSphere Partner Gateway.

Note: A functional acknowledgment map should be created only when a custom functional acknowledgment is required.

In addition to the functional acknowledgment maps provided with WebSphere Partner Gateway, the &FUNC_ACK_METADATA_DICTIONARY protocol and associated &FUNC_ACK_META are provided. They are listed under Package: None in the Document Flow Definitions page. &FUNC_ACK_META is the source document definition for all functional acknowledgment maps. This map provides the structure of the functional acknowledgment. A functional acknowledgment flows to participants, and the functional acknowledgment map tells the system how the acknowledgment should be generated. The name of the source document definition cannot be changed. The Data Interchange Services client mapping specialist cannot create a functional acknowledgment map without this document definition in your database.

The target document definition in a functional acknowledgment map describes the layout of the functional acknowledgment. It must be an EDI document definition with a name of 997, 999, or CONTRL.

The following functional acknowledgment maps are installed with WebSphere Partner Gateway and appear on the Manage Document Flow Definitions page under Package: N/A:

Table 16. System-supplied functional acknowledgment maps
Protocol Document Flow Description
&DTCTL21 CONTRL Functional Acknowledgement CONTRL - UN/EDIFACT Version 2 Release 1 (D94B)
&DTCTL CONTRL Functional Acknowledgement CONTRL - UN/EDIFACT prior to D94B
&DT99933 999 Functional Acknowledgement 999 - UCS Version 3 Release 3
&DT99737 997 Functional Acknowledgement 997 - X12 Version 3 Release 7
&DT99735 997 Functional Acknowledgement 997 - X12 Version 3 Release 5
&DT99724 997 Functional Acknowledgement 997 - X12 Version 2 Release 4

In addition, the &X44TA1 protocol (with an associated TA1 document flow) are listed under Package: N/A. This map is used to generate a TA1. TA1 is a functional acknowledgment that is generated for incoming X12 interchanges.

The &WDIEVAL protocol (with an associated X12ENV) is also provided under Package: N/A.

Like EDI transactions, functional acknowledgments are always put into an EDI interchange before being delivered.

TA1 acknowledgments

TA1 is an EDI segment that provides X12 interchange acknowledgment. It acknowledges the receipt and syntactical correctness of an X12 interchange header and trailer (ISA and IEA) pair. The sender can request a TA1 from the receiver by setting element 14 of the ISA Interchange Control Header to 1. The interchange control number of a TA1 is matched to a previously transmitted X12 interchange with the same control number to complete the acknowledgment process.

Like EDI transactions and functional acknowledgments, TA1s are always put into an EDI interchange before being delivered.

Adding an acknowledgment to the document flow

To add an acknowledgment to a flow, perform the following steps:

  1. If the functional acknowlegment map is not supplied by WebSphere Partner Gateway, import the map from the Data Interchange Services client. See Importing maps.
  2. Associate the FA map with a document flow definition:
    1. Click Hub Admin > Hub Configuration > Maps > EDI FA Maps.
    2. Click the View details icon next to the map.
    3. Click the Expand icon next to a package to individually expand to the appropriate level (for example, expand the Package and Protocol folders and select the transaction).
    4. Click Save.
  3. Create an interaction for the map you just imported.
    1. Click Hub Admin > Hub Configuration > Document Flow Definition > Manage Interactions.
    2. Click Create Interaction.
    3. Under Source, select the document flow associated with the functional acknowledgment. Expand the package and protocol and select the document flow.
    4. Under Target, select the same values.
    5. From the Action list, select Pass Through.
  4. Verify that a document flow definition exists for the EDI interchange that is being sent from the hub, and set any attributes that you want associated with the interchange.
    1. Click Hub Admin > Hub Configuration > Document Flow Definition.
    2. Check to see whether a document flow definition already exists. The source will be N/A, with the protocol and document flow matching the protocol and document flow used to deliver the interchange. For example, if the interchange will be delivered as AS/EDI-X12/ISA, the source will be N/A/EDI-X12/ISA.
    3. Edit any attributes that apply to the interchange that is being delivered.
    4. If a document flow definition does not exist, create one by selecting the Package, Protocol, and Document Flow.
  5. Create an interaction for the EDI interchange that is sent from the hub after the document is transformed.
    1. Click Hub Admin > Hub Configuration > Document Flow Definitions > Manage Interactions.
    2. Click Create Interaction.
    3. Select the source and target documents.
    4. Select Pass Through from the Action list.

After setting up the interactions, create B2B capabilities for the participants. Note that the target participant in a functional acknowledgment transmission is the source participant of the original EDI document.

The detailed steps for creating B2B capabilities are described in Setting up B2B capabilities.

After setting up B2B capabilities for the participants, create connections. You need two connections:

The detailed steps for creating connections are described in Managing connections.

Copyright IBM Corp. 2003, 2005