Learning Series: SAP NetWeaver Process Orchestration, business to business add-on EDI Separator Adapter Applies to: SAP NetWeaver Process Orchestration, business to business add-on 1.0 SP00 Summary This article describes the various steps involved in configuring scenarios using the EDI Separator adapter. Author: Amulya S.U. Company: SAP Labs India Pvt. Ltd. Created on: May 25, 2012 Author Bio Amulya S.U. is a developer at SAP Labs India (Technology Innovation Platform). Currently working with B2B components like AS2 adapter, EDI Separator adapter and PI NWA monitoring. She joined SAP Labs in July 2010. She has ever since been involved in development and maintainence of the PI NWA Monitors like Channel Monitor, Cache Monitor, IDoc Monitor, etc. 2012 SAP AG 1
Table of Contents Brief Introduction to EDI Separator adapter... 3 Prerequisites... 3 Scenario Overview... 3 Procedure... 4 1) Message Protocol ANSI ASC X12... 5 2) Message Protocol- EDIFACT... 7 3) Message protocol- Odette... 9 4) Message Protocol VDA... 10 Configuring the Receiver EDI Separator Channel... 11 Related Content... 13 Other Learning Series Articles... 13 Copyright... 14 2012 SAP AG 2
Brief Introduction to EDI Separator adapter The EDI Separator is a component providing the feature of splitting incoming mass EDI messages into single messages. It is implemented as a PI Adapter and therefore has sender and receiver adapter channels that are configured to perform the splitting function. Furthermore, the adapter controls the content based receiver determination. This feature of the adapter offers the possibility to use content-based routing (message identification) and split mass messages according to interfaces based on message type and partner. The SAP NW PI EDI Separator adapter supports 4 EDI formats which are: ANSI ASC X12 EDIFACT ODETTE VDA Prerequisites You have deployed the EDI Separator adapter in the SAP Process Integration environment. You must have logged in to the Integration Directory using the Integration Builder. You have entered EDI Separator in the Adapter Type field of the parameter section.. Scenario Overview EDI multi-message Msg Type 1 Adapter A SND EDI Sep RCV Msg Type 2 Msg Type 1 XYZ SAP NW PI Partner 1 Adapter A RCV Partner 2 EDI Sep SND1 Msg Type n Msg Type 2 Adapter A RCV EDI Sep SND2 Functional ACK Msg Type n/ ACK Adapter A RCV EDI Sep SNDn The above schematic diagram represents a B2B EDI multi-message transfer from Partner 1 (XYZ) to Partner 2 (SAP PI). An EDI multi-message belonging to a certain format (like EDIFACT, VDA, etc) and is composed of more than one Message Types representing various business documents/transactions (like a Purchase Order, Invoice, Delivery Forecast, etc). The multi-message consisting of n number of message types is transferred to Partner 2(PI), where a sender channel of an adapter (say, AS2 Adapter) forwards the multi-message to an EDI Separator receiver channel The content-based routing is accomplished by the EDI Separator adapter and the receiver channel then splits the incoming multi-message into n number of single messages based on the n different message types. 2012 SAP AG 3
The individual split EDI messages are then forwarded to different EDI Separator sender channels, which are configured to receive them. In some cases, say for ANSI ASC X12 messages, a functional acknowledgment is generated (only if requested) as a separate EDI message and sent back from the receiving party (Partner 2) to the sending party (Partner 1), to positively/negatively acknowledge the individual EDI messages received successfully/unsuccessfully by the EDI separator adapter via the sender channels. Note: Out of the 4 EDI formats that SAP PI EDI Separator adapter supports, only the ANSI ASC X12 format supports the generation of a functional acknowledgment in the form of a 997 message (standard/format specific transaction number representing the functional acknowledgment) Procedure Configure the sender channel to enable receiving of the multi message from the business partners into the PI pipeline. Configure the receiver channels to split the multi message. Configure the sender channels to receive the messages of each type into the PI pipeline This procedure is used to configure the message protocols, filter and character encoding settings in the sender channel. For detailed field-by-field description of the configurable parameters, refer to the official EDI Separator Adapter Configuration Guide, Page 3 and section Configuring the Sender Channel A sample screenshot of the Adapter Metadata of a sender EDI Separator channel for all supported Message Protocols, taken from the Integration Builder is as below: 2012 SAP AG 4
1) Message Protocol ANSI ASC X12 The following screenshots outline the relationship between segments/field values of sample EDI multimessages and corresponding configurable fields in the sender channel: Another sample ANSI ASC X12 multi-message X12_Multimessage.txt can be found at http://wiki.sdn.sap.com/wiki/display/xi/learning+series+sample+content-b2b+add+on (Section: EDI Separator) NOTE: More details about the X12_Multimessage.txt with respect to message types can be found at the above mentioned wiki link Snippet 1: A snippet from a sample ANSI ASC X12 file ISA*00* *00* *01*87654321 *01*12345678 *110111*0935*^*00306*000000116*0*P*\ GS*PS*812928414*18322644*110111*0935*116*X*003060 ST*830*0196 (4) (3) (2) (1) 2012 SAP AG 5
Parameters Settings: Filter Section Version/Release/Industry Identifier Code: Allows selection of a predefined ANSI ASC X12 version from the drop down values provided Other code: Checking this option allows for manually entering an adapted ANSI ASC X12 version code, which is not a part of the above mentioned drop-down list. The dependant fields which appear on checking the Other code option are the same for the predefined version codes as below Transaction Set Identifier Code: The transaction set number of the split message to be forwarded from this channel. Interchange Sender ID: The value in the ISA segment of the incoming message in the sender ID field (ISA06) identifying the sender (Partner 1) Interchange receiver ID: The value in the ISA segment of the outgoing message in the receiver ID field (ISA08)identifying the receiver (Partner 2) NOTE: The above fields can also be configured with the regular expression.* 2012 SAP AG 6
2) Message Protocol- EDIFACT Another sample EDIFACT multi-message EDIFACT_Multimessage.txt can be found at http://wiki.sdn.sap.com/wiki/display/xi/learning+series+sample+content-b2b+add+on (Section: EDI Separator) Note: More details about the EDIFACT_Multimessage.txt with respect to message types can be found at the above mentioned wiki link Snippet 2: A snippet from a sample EDIFACT file UNA:+,? ' UNB+UNOC:3+1234567+7654321+100505:1232+00869' UNH+15749206+DELFOR:D:96A:UN:A09040' (4) (5) (2) (3) (1) 2012 SAP AG 7
Parameters Settings: Filter Section Message Type: Allows selection of a predefined EDIFACT message type from the drop-down list. Eg:DESADV Advance Shipping Notice Default value: All message types Message version number: Allows selection of a predefined EDIFACT Message Version number. Eg: D Default value: All versions Message Release number: Allows selection of a predefined EDIFACT Message Release number. Eg: 96A Interchange Sender identification: The value in the Interchange Header (UNB segment) of the incoming message in the sender ID field (0004) identifying the sender of the message(partner 1) Default value:.* Interchange sender identification code qualifier: The value in the Interchange Header (UNB segment) of the incoming message in the Partner Identification code qualifier field (0007) identifying the sender of the message(partner 1) Eg: 14/ EAN International Default value: All codes Interchange recipient identification: The value in the Interchange Header (UNB segment) of the incoming message in the recipient identification field (0010) identifying the receiver of the message (Partner 2) Default value:.* Interchange recipient identification code qualifier: The value in the Interchange Header (UNB segment) of the incoming message in the Partner Identification code qualifier field (0007) identifying the receiver of the message(partner 2) Eg: 14/ EAN International Default value: All codes Note: There has to be a sender channel configured to receive every spilt message type. Hence, in this case, there has to be atleast 2 sender channels configured to receive the 2 message types in both ANSI ASC X12 and EDIFACT scenarios. The above sample shows configuration of only one such sender channel each for ANSI ASC X12 and EDIFACT. However, the configuration of the other sender channel (not shown in the screenshots) is very similar and in most cases, one may have to simple change the value of the MessageType field to receive the different split single EDI messages) 2012 SAP AG 8
3) Message protocol- Odette Another sample Odette multi-message ODETTE_Multimessage.txt can be found at http://wiki.sdn.sap.com/wiki/display/xi/learning+series+sample+content-b2b+add+on (Section: EDI Separator) Note: More details about the ODETTE_Multimessage.txt with respect to message types can be found at the above mentioned wiki link Parameters Settings: Filter Section Message Type: Allows selection of a predefined ODETTE message type from the drop-down list. Eg:DELINS Delivery Instruction Default value: All message types Message version number: Allows selection of a predefined ODETTE Message Version number. Eg: 1 Default value: All versions Interchange Sender identification: The value in the Interchange Header (UNB segment) of the incoming message in the sender ID field identifying the sender of the message (Partner 1) Default value:.* 2012 SAP AG 9
Interchange sender identification code qualifier: The value in the Interchange Header of the UNB segment of the incoming message in the Partner Identification code qualifier field identifying the sender of the message(partner 1) Eg: 14/ EAN International Default value: All codes Interchange recipient identification: The value in the Interchange Header (UNB segment) of the incoming message in the recipient identification field identifying the receiver of the message(partner 2) Default value:.* Interchange recipient identification code qualifier: The value in the Interchange Header of the UNB segment of the incoming message in the Partner Identification code qualifier field identifying the receiver of the message (Partner 2) Eg: 14/ EAN International Default value: All codes 4) Message Protocol VDA Another sample VDA multi-message VDA_Multimessage.txt can be found at http://wiki.sdn.sap.com/wiki/display/xi/learning+series+sample+content-b2b+add+on (Section: EDI Separator) Note: More details about the VDA_Multimessage.txt with respect to message types can be found at the above mentioned wiki link 2012 SAP AG 10
Parameters Settings: Filter Section Message Type: Allows selection of a predefined VDA message type from the drop-down list. Eg:4906 Invoice Default value: All types Customer number: : The value in the Interchange Header (UNB segment) of the incoming message in the customer number field identifying the customer Default value:.* Vendor number: The value in the Interchange Header (UNB segment) of the incoming message in the vendor number field identifying the vendor Default value:.* Encoding Section: (common to all message protocols) The character set encoding desired for the message. Only UTF-8, ISO-8859-15 and US-ASCII are supported. Configuring the Receiver EDI Separator Channel This procedure is used to configure the message protocols and format settings in the receiver channel to route the incoming multi-message to the appropriate sender channels. For detailed field-by-field description of the configurable parameters, refer to the official EDI Separator Adapter Configuration Guide, Page 5 and section Configuring the Receiver Channel A sample screenshot of the Adapter Metadata of a receiver EDI Separator channel for all supported Message Protocols, taken from the Integration Builder is as below 2012 SAP AG 11
Formatting settings: Indent messages: If the outgoing message payload needs to be indented, this option should be checked. Eg: If each segment in the message should appear on a new line. Also, additionally and optionally, a 997 Functional Acknowledgment message generation could be requested for, but only for the ANSI ASC X12 protocol as shown below:!!!important!!! For receiving a 997 acknowledgement (syntactic acknowledgement that is generated on correct receipt of the messages by the PI module processor, a sender channel must be configured with message type 997 (transaction Set Identifier Code) to receive it. Also, the Interchange Sender ID and Interchange Receiver ID are swapped as the acknowledgement is sent back to the sender. See screenshot below: 2012 SAP AG 12
Related Content References EDI Separator Adapter Configuration Guide bundled with the product Other Learning Series Articles SL No Product Name 1. SAP NetWeaver Process Orchestration, secure connectivity add-on 1.0 Topic Name a) How to Proceed Guide b) Installation Guide c) SFTP Adapter d) PGP Module 2. SAP NetWeaver Process Orchestration, business to business add-on 1.0 a) How To Proceed Guide b) Installation Guide c) AS2 Adapter d) OFTP Adapter e) X400 Adapter f) EDI Separator g) Archiver Module and Archiver Mapping h) Number Range Objects Module i) EDI XML Converter I. Master Guide: EDI XML Converter II. EDIFACT_Info_Guide III. X12_Info_Guide IV. TRADACOMS_Info_Guide V. ODETTE_Info_Guide VI. VDA_Info_Guide VII. PLAIN_Info_Guide j) B2B Content 3. SAP NetWeaver Process Orchestration, business to business add-on 1.0 a) Sample Scenario Set-up (contains File Adapter, AS2 Adapter, EDI XML Converter, Mapping Templates, and NRO Module) b) Sample Scenario Set-up (contains File Adapter, OFTP Adapter, EDI XML Converter, Mapping Templates, and PGP Module) c) Sample Scenario Set-up (contains File Adapter, X400 Adapter, EDI Separator Adapter, Mapping Templates, EDI XML Converter and Archiver Module) 2012 SAP AG 13
Copyright Copyright 2012 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iseries, pseries, xseries, zseries, eserver, z/vm, z/os, i5/os, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Oracle Corporation. JavaScript is a registered trademark of Oracle Corporation, used under license for technology invented and implemented by Netscape. ANSI, ASC X.12, EDIFACT, TRADACOMS, VDA, ODETTE are registered trademarks and/or copyrighted and/or wordmarks of their respective companies/associations. SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects S.A. in the United States and in other countries. Business Objects is an SAP company. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. 2012 SAP AG 14