RosettaNet documents

This section provides an overview of RosettaNet documents and shows you how to set up document flow definitions and interactions for those documents.

Overview

RosettaNet is an organization that provides open standards to support the exchange of business messages between trading partners. For more information about RosettaNet, see http://www.rosettanet.org. The standards include RosettaNet Implementation Framework (RNIF) and Partner Interface Process (PIP) specifications. RNIF defines how trading partners exchange messages by providing a framework of message packaging, transfer protocols, and security. There are two released versions: 1.1 and 2.0. A PIP defines a public business process and the XML-based message formats to support the process.

WebSphere Partner Gateway supports RosettaNet messaging using RNIF 1.1 and 2.0. When the hub receives a PIP message, it validates and transforms the message to send it to the appropriate back-end system. WebSphere Partner Gateway provides a protocol for packaging the transformed message into a RosettaNet Service Content (RNSC) message that the back-end system can handle. See the Enterprise Integration Guide for information about the packaging used on these messages to provide routing information.

The hub can also receive RNSC messages from back-end systems and create the appropriate PIP message and send the message to the appropriate trading partner (a participant). You provide the document flow definitions for the RNIF version and the PIPs you want to use.

In addition to providing routing capability for RosettaNet messages, WebSphere Partner Gateway maintains a state for each message it handles. This enables it to resend any messages that fail until the number of attempts reaches a specified threshold. The Event Notification mechanism alerts back-end systems if a PIP message cannot be delivered. Additionally, the hub can automatically generate 0A1 PIPs to send to appropriate participants if it receives certain Event Notification messages from back-end systems. See the Enterprise Integration Guide for more information about Event Notification.

RNIF and PIP document flow packages

To support RosettaNet messaging, WebSphere Partner Gateway provides two sets of zipped files called packages. The RNIF packages consist of document flow definitions required to support the RNIF protocol. These packages are in the B2BIntegrate directory.

For RNIF V1.1, the packages are:

For RNIF V02.00, the packages are:

The first package in each pair provides the document flow definitions required to support RosettaNet communications with participants, and the second package provides the document flow definitions required to support RosettaNet communications with back-end systems.

The second set of packages consists of PIP document flow packages. Each PIP document flow package has a Packages directory containing an XML file and a GuidelineMaps directory containing XSD files. The XML file specifies the document flow definitions that define how WebSphere Partner Gateway handles the PIP and define the exchanged messages and signals. The XSD files specify the format of the PIP messages and define acceptable values for XML elements in the messages. The zipped files for 0A1 PIPs also have an XML file that the hub uses as a template to create 0A1 documents.

The PIPs for which WebSphere Partner Gateway provides PIP document flow packages are:

For each PIP, there are four PIP document flow packages:

Each PIP document flow package follows a specific naming convention you can use to identify whether the package is for messages between WebSphere Partner Gateway and participants or between WebSphere Partner Gateway and back-end systems. The naming convention also identifies the RNIF version, PIP, and PIP version that the package supports. For PIP document flow packages used for messaging between WebSphere Partner Gateway and participants, the format is:

BCG_Package_RNIF<RNIF_version>_<PIP><PIP_version>.zip

For PIP document flow packages used for messaging between WebSphere Partner Gateway and back-end systems, the format is:

BCG_Package_RNSC<Backend_Integration_version>_RNIF<RNIF_version>_
<PIP><PIP_version>.zip

For example, the BCG_Package_RNIF1.1_3A4V02.02.zip is for validating documents for version 02.02 of the 3A4 PIP sent between participants and WebSphere Partner Gateway using the RNIF 1.1 protocol. For PIP document flow packages for communicating with back-end systems, the name of the package must also identify the protocol used to send the RosettaNet contents to the back-end systems. See the Enterprise Integration Guide for information about the packaging used for these messages.

Creating document flow definitions

For RosettaNet messaging, WebSphere Partner Gateway requires the RNIF packages for the version of RNIF used to send the messages. For each PIP that WebSphere Partner Gateway supports, it requires the two PIP document flow packages for the RNIF version. For example, to support the 3A4 PIP over RNIF 2.0, WebSphere Partner Gateway requires the following packages:

The first package supports RosettaNet messaging with participants and the second package supports RosettaNet messaging with back-end systems. The third and fourth packages enable WebSphere Partner Gateway to pass 3A4 messages between participants and back-end systems using RNIF 2.0.

To upload the RosettaNet packages:

  1. Click Hub Admin > Hub Configuration > Document Flow Definition.
  2. Click Upload/Download Packages.
  3. Select No for WSDL Package.
  4. Click Browse and select the RNIF package for communicating with participants.

    The RNIF packages are located, by default, in the B2BIntegrate/Rosettanet directory on the installation medium. For example, if you were uploading RNIF version 2.00 package, you would browse to the B2BIntegrate/Rosettanet directory and select: Package_RNIF_V0200.zip.

  5. Make sure Commit to Database is set to Yes.
  6. Click Upload.
  7. Click Browse again and select the RNIF package for communicating with back-end applications.

    For example, if you were uploading the RNIF version 2.00 package, you would browse to the B2BIntegrate/Rosettanet directory and select Package_RNSC_1.0_RNIF_V02.00.zip.

  8. Click Upload.

    The packages needed to communicate with participants or with the back-end system are now installed in the system. If you check the Manage Document Definitions page, you see an entry for Package: RNIF/Protocol: RosettaNet, which represents the packaging for communicating with participants, and Package: Backend Integration/Protocol: RNSC, which represents the packaging for communicating with back-end applications.

  9. For each PIP you want to support, upload the PIP document flow package for the PIP and for the RNIF version you are supporting. For example, to upload the 3A6 PIP (Notify of Remittance Advice) to be sent to a participant, perform the following steps:
    1. Click Browse and select BCG_Package_RNIFV02.00_3C6V02.02 from the B2BIntegrate/Rosettanet directory.
    2. Make sure Commit to Database is set to Yes.
    3. Click Upload.

    The 3C6V02.02 PIP now appears as the document flow underneath Package: RNIF/Protocol: RosettaNet on the Manage Document Definitions page. An activity, action, and two signals are also displayed. They are included in the upload of the PIP.

    To upload the 3A6 PIP to be sent to the back-end application, perform the following steps:

    1. Click Browse and select BCG_Package_RNSC1.0_RNIFV02.00_3C6V02.02.zip.
    2. Make sure Commit to Database is set to Yes.
    3. Click Upload.

    The 3C6V02.02 PIP now appears as the document flow underneath Package: Backend Integration/Protocol: RNSC on the Manage Document Flow Definitions page.

    If WebSphere Partner Gateway does not provide a package for the PIP or PIP version you want to use, you can create your own and upload it. See Creating PIP document flow packages for more information.

Configuring attribute values

For PIP document flow definitions, most of the values of the attributes are already set and do not need to be configured. However, you do need to set the following attributes:

RNIF (1.0) package

RNIF (V02.00) package

Note that the PIPs for which WebSphere Partner Gateway provides PIP document flow packages are not synchronous. As a result, you do not need to change the Sync Ack Required and Sync Supported attributes for these PIPs.

Note: The behavior of the Sync Ack Required attribute differs between 1-way and 2-way PIPs. For a 2-way PIP, when Sync Ack Required is set to No, this setting takes precedence over a NonRep of Rec setting of Yes. For example, suppose you send a 3A7 with the following settings:

For a 2-way PIP, you receive an error message on the incoming document. On a 1-way PIP, however, you see the incoming document on the console, and a 0KB 200 is returned to the participant.

To set the attributes, perform the following steps:

  1. Click Hub Admin > Hub Configuration > Document Flow Definition.
  2. Click Expand icons to individually expand a node to the appropriate document flow definition level or select All to expand all displayed document flow definition nodes.
  3. In the Actions column, click the Edit Attribute Values icon for the package (for example, Package: RNIF (1.1) or Package: RNIF (V02.00)) you want to edit.
  4. In the Document Flow Context Attributes section, go to the Update column of the attribute you want to set and select or type the new value. Repeat for each attribute that you want to set.
  5. Click Save.

Note: You can also update RosettaNet attributes at the connection level by clicking Attributes for the source or target and then entering or changing the values in the Update column. Refer to Specifying or changing attributes.

Creating interactions

The following process describes how to create an interaction between a back-end system and a participant. Note that you must create an interaction for each PIP that you want to send and one for each PIP that you want to receive.

Before you begin, make sure that the appropriate RNIF document flow definitions have been uploaded and that the packages for the PIP you want to use have been uploaded. If you want the ability to generate an 0A1 PIP (Notification of Failure), make sure you have uploaded that PIP, as described in step 9.

To create an interaction for a particular PIP, perform the following steps:

  1. Click Hub Admin > Hub Configuration > Document Flow Definition.
  2. Click Manage Interactions.
  3. Click Create Interaction.
  4. Expand the Source tree to the Action level and expand the Target tree to the Action level.
  5. In the trees, select the document flow definitions to use for the source context and the target context. For example, if the participant is the initiator of a 3C6 PIP (a one-action PIP), select the following document flow definitions:
    Table 5. 3C6 PIP initiated by a participant
    Source Target
    Package: RNIF (V02.00) Package: Backend Integration (1.0)
    Protocol: RosettaNet (V02.00) Protocol: RNSC (1.0)
    Document Flow: 3C6 (V01.00) Document Flow: 3C6 (V01.00)
    Activity: Notify of Remittance Advice Activity: Notify of Remittance Advice
    Action: Remittance Advice Notification Action Action: Remittance Advice Notification Action

    If the back-end system is the initiator of the 3C6 PIP, select the following document flow definitions:

    Table 6. 3C6 PIP initiated by a back-end system
    Source Target
    Package: Backend Integration (1.0) Package: RNIF (V02.00)
    Protocol: RNSC (1.0) Protocol: RosettaNet (V02.00)
    Document Flow: 3C6 (V01.00) Document Flow: 3C6 (V01.00)
    Activity: Notify of Remittance Advice Activity: Notify of Remittance Advice
    Action: Remittance Advice Notification Action Action: Remittance Advice Notification Action

    For a two-action PIP such as 3A4 initiated by a participant, select the following document flow definitions for the first action:

    Table 7. 3A4 PIP initiated by a participant
    Source Target
    Package: RNIF (V02.00) Package: Backend Integration (1.0)
    Protocol: RosettaNet (V02.00) Protocol: RNSC (1.0)
    Document Flow: 3A4 (V02.02) Document Flow: 3A4 (V02.02)
    Activity: Request Purchase Order Activity: Request Purchase Order
    Action: Purchase Order Request Action Action: Purchase Order Request Action

    If a back-end system initiates the two-action 3A4 PIP, select the following document flow definitions for the first action:

    Table 8. 3A4 PIP initiated by a back-end system
    Source Target
    Package: Backend Integration (1.0) Package: RNIF (V02.00)
    Protocol: RNSC (1.0) Protocol: RosettaNet (V02.00)
    Document Flow: 3A4 (V02.02) Document Flow: 3A4 (V02.02)
    Activity: Request Purchase Order Activity: Request Purchase Order
    Action: Purchase Order Request Action Action: Purchase Order Request Action
  6. In the Action field, select Bi-Directional Translation of RosettaNet and RosettaNet Service Content with Validation.
  7. Click Save.
  8. If you are setting up a two-action PIP, repeat the steps needed to create the interaction for the second action. For example, select the following document flow definitions for the second action for a 3A4 PIP initiated by a participant. This is the action in which the back-end system sends the response.
    Table 9. 3A4 PIP initiated by a participant (second action)
    Source Target
    Package: Backend Integration (1.0) Package: RNIF (V02.00)
    Protocol: RNSC (1.0) Protocol: RosettaNet (V02.00)
    Document Flow: 3A4 (V02.02) Document Flow: 3A4 (V02.02)
    Activity: Request Purchase Order Activity: Request Purchase Order
    Action: Purchase Order Confirmation Action Action: Purchase Order Confirmation Action

    For the second action for a back-end system initiated 3A4 PIP, select the following document flow definitions:

    Table 10. 3A4 PIP initiated by a back-end system (second action)
    Source Target
    Package: RNIF (V02.00) Package: Backend Integration (1.0)
    Protocol: RosettaNet (V02.00) Protocol: RNSC (1.0)
    Document Flow: 3A4 (V02.02) Document Flow: 3A4 (V02.02)
    Activity: Request Purchase Order Activity: Request Purchase Order
    Action: Purchase Order Confirmation Action Action: Purchase Order Confirmation Action
  9. If you want to generate the 0A1 Notification of Failure, create an interaction for XMLEvent.
    1. Click Hub Admin > Hub Configuration > Document Flow Definition.
    2. Click Manage Interactions.
    3. Click Create Interaction.
    4. Expand the Source tree to the Document Flow level and expand the Target tree to the Document Flow level.
    5. Select the following document flow definitions:
      Table 11. XML Event document flow definition
      Source Target
      Package: Backend Integration (1.0) Package: Backend Integration (1.0)
      Protocol: XMLEvent (1.0) Protocol: XMLEvent (1.0)
      Document Flow: XMLEvent (1.0) Document Flow: XMLEvent (1.0)
    6. In the Action field, select Pass Through.
    7. Click Save.
  10. Create an interaction for XMLEvent to 0A1 RNSC.
    1. Click Hub Admin > Hub Configuration > Document Flow Definition.
    2. Click Manage Interactions.
    3. Click Create Interaction.
    4. Expand the Source tree to the Document Flow level and expand the Target tree to the Activity level.
    5. Select the following document flow definitions:
      Table 12. XML Event to 0A1 document flow definition
      Source Target
      Package: Backend Integration (1.0) Package: Backend Integration (1.0)
      Protocol: XMLEvent (1.0) Protocol: RNSC (1.0)
      Document Flow: XMLEvent (1.0) Document Flow: 0A1 (V02.00)
      Activity: Distribute Notification of Failure.
    6. In the Action field, select Bi-directional Translation of RosettaNet and XML with Validation.
    7. Click Save.

Copyright IBM Corp. 2003, 2005