SEEBURGER Business Integration Converter Adapter for SAP Exchange Infrastructure

Configuration Guide

BIC Adapter for SAP Exchange Infrastructure, Configuration Guide

Contents
Icons........................................................................................................................... ........................3 Terms and Definitions...................................................................................................... ...................4 Business Integration Converter Adapter.................................................................... .........................5 Purpose............................................................................................................................ ...............5 Integration............................................................................................................ ...........................5 Features..................................................................................................................... .....................7 Configuring BIC as a Module......................................................................................... .....................8 Use..................................................................................................................................... .............8 Integration............................................................................................................ ...........................8 Requirements................................................................................................................. .................8 Activities..................................................................................................................... .....................8 Example............................................................................................................. ...........................10 Configuring the Logging...................................................................................................... ..............11 Use.................................................................................................................................. ..............11 Integration.......................................................................................................... ...........................11 Requirements............................................................................................................... .................11 Activities................................................................................................................... .....................11

Page 2

BIC Adapter for SAP Exchange Infrastructure, Configuration Guide

Icons
Syntax Caution Component Example Function Note Recommendation

Page 3

BIC Adapter for SAP Exchange Infrastructure, Configuration Guide

Terms and Definitions

ANSI X.12: American National Standards Institute data interchange standard. BIC: Business Integration Converter. SEEBURGER software responsible for converting documents from a source format to a destination format. BIC Mapping Designer: SEEBURGER tool used to create mappings. Business Process (See SAP Exchange Infrastructure Documentation): A business process is an executable process (script), in which all the steps that are to be executed for controlling the message processing within the integration server, are defined. Communication Channel: See SAP Exchange Infrastructure Documentation. Converter: also see BIC. CSV: Comma Separated Values format. EDI: Electronic Data Interchange. EDIFACT: Electronic Data Interchange for Administration, Commerce and Transport. (http://www.unece.org/trade/untdid/welcome.htm) Mapping: Program, which defines how documents are converted from a given source format to a given destination format. Module Sequence: Also see SAP Exchange Infrastructure Documentation. Swift: Banking EDI standard. Tradacom: UK-based EDI standard. VDA: Verband der Automobilindustrie (http://www.vda.de). Xml Document: SAP Exchange Infrastructure message format is based on XML, therefore the present document refers to the messages processed by SAP Exchange Infrastructure as XML documents. Workflow: Also see Business Process.

Page 4

BIC Adapter for SAP Exchange Infrastructure, Configuration Guide

Business Integration Converter Adapter

Purpose
The SEEBURGER Business Integration Converter (BIC) is an Any-To-Any Format converter, used to translate EDI data and legacy data formats into XML and vice versa. It can also be used for complex, high performance XML-to-XML mappings or to interface to existing JDBC Data Sources. Supported EDI formats include: ANSI, EDIFACT, INHOUSE, IDOC, XML Schema, XML DTD, CSV, Delimited Data, positional data, SWIFT, EANCOM and many more. The SAP Exchange Infrastructure message format is based on XML, but it also can work with nonXML data using attachments. In some cases it may be necessary to convert the main XML document in a message, into a non-XML document. The use of BIC is very common in Business-to-Business scenarios where EDI standards are in use. E.g., BIC can convert outbound invoices from XML format (used in SAP XI) to an EDIFACT invoice. The conversion can be executed before the message is transmitted to the business partner. The other way around, once an EDIFACT message has been received from the business partner, it must first be converted to XML format, which is the format SAP XI supports. This document describes the configuration of BIC for SAP XI, however the programming of the mappings used in BIC, is beyond the scope of this document. Please refer to the BIC MD for SAP XI Configuration Guide and the BIS Documentation, Book 1 Chapters 1 to 3.

Integration
The converter is configured in the configuration part of the Integration Builder. BIC can be called as a module in the module sequence of the communication channel, or it can be executed as an adapter at the end of the module sequence. The following diagram shows how BIC is used as module to convert XML documents to EDI documents, before they are sent to the business partner using a communication adapter (e.g., oftp). Documents received from the business partners are converted from EDI format to XML in the same way.

Mappings are designed with the BIC Mapping Designer, deployed with the Deployment Manager (SDM) and configured and executed in the communication channel of the business scenario.

Page 5

BIC Adapter for SAP Exchange Infrastructure, Configuration Guide The use of BIC as an adapter is depicted in the following diagram:

Note: Adapters are normally software components used for communication with an external information system, but in this case the adapter is only a processing unit. It receives an XML document, converts it to an EDI format and sends it back to the integration server. It is mostly used in synchronous mode, as there is a response from the adapter. When used in asynchronous mode, the adapter does not send a response. It is strongly recommended to use the converter as a module and not as an adapter.

Page 6

BIC Adapter for SAP Exchange Infrastructure, Configuration Guide

Features
The Business Integration Converter converts Documents from / to : XML EDIFACT Ansi X.12 Aecma Tradacom VDA CSV Swift Database Inhouse (flatfile proprietary formats)

(Depending on the installed SEEBURGER solution article, some of the mentioned formats are deactivated!) The adapter can work with the main document of the XI Message and the attachments. This means it can read the data from the main document and write the converted data to an attachment and viceversa. It can also read from one attachment and write to a different attachment.

Page 7

BIC Adapter for SAP Exchange Infrastructure, Configuration Guide

Configuring BIC as a Module

Use
XML documents may need to be converted to and from other formats, before sending, or receiving them to and from business partners. This is normally done by executing BIC in the module sequence of the communication channel.

Integration
The converter is configured on the module tab page in the module processor of the communication channel.

Requirements
The mapping that is intended for use must already be deployed using the SDM (see SEEBURGER Master Installation Guide SAP XI and SEEBURGER Business Integration Converter Adapter for SAP XI Setup Guide).

Activities
To configure the converter, the module must be entered in the processing sequence (module sequence) and the parameters of the module must be entered in the configuration table. Both are located on the module tab page of the communication channel.

Module Execution
In order to run a BIC mapping, the converter must be executed in the module sequence of the communication channel as shown in the screenshot:

The name of the module is localejbs/CallBicXIRaBean.

Module Parameters
The mapping that is to be executed is selected in the Module Configuration table, by means of the following parameters:

Parameter mappingName

Entry Specifies the mapping to be executed. If the name is set to AUTO, it will be automatically generated with help from the Classifier module. For more information also see the Classifier documentation.

Page 8

BIC Adapter for SAP Exchange Infrastructure, Configuration Guide Parameter destSourceMsg Entry This parameter is used to specify which data has to be converted. Possible values are: MainDocument: main payload of the SAP XI message. SeeburgerMain: Attachment with name SeeburgerMain. This is the default value, if the attachment does not exist, the main document will be used. <attachment Id>: other attachment with the given id.

destTargetMsg

This parameter is used to specify where the resulting document should be placed after conversion. Possible values are: MainDocument: main payload of the SAP XI message (default value if the mapping converts to XML value). SeeburgerMain: Attachment with name SeeburgerMain (default value unless the mapping converts to XML format).

<attachmentId>: other attachment with the given id. saveSourceMsg This parameter is used to specify if and where the source message (message before conversion) should be stored. The value can be an ID for an attachment. Sets the encoding for the source message Sets the encoding for the result If the Classifier module is running before the BICModule, specify the ID of the attachment where the outputs of the Classifier were stored, here. If no attachmentname is set the defaultname MessageTypeReport will be used.

srcEncoding destEncoding classifierAttID

setSourceEncodingFromClassifier If the Classifier module is running before the BICModule, a true setting says that the source encoding is set to the value which was analyzed by the Classifier createFiles A path can be set here, where the source- and the destination message is written. These files have an incremental number. Be careful, when the adapter starts, this number is set to zero and existing files will be overwritten. This parameter may only be used for debugging purposes! Sets the destination Delimiter. You must use a String with the length of 6 characters. The order of the delimiter is as follows: subfield, field, decimal, quoting, fieldgroup, segment Sets the source Delimiter. You must use a String with the length of 6 characters. The order of the delimiter is as follows: subfield, field, decimal, quoting, fieldgroup, segment Set this parameter to true if you want to use the split option. Here you can specify a name for an attachment. Then the log about the conversion will be added to the XIMessage and you can archive this. With this parameter the xiDocumentID can be set. true, if the mapping should add a CRLF at the end of each segment/record.

destDelimiter

srcDelimiter

split logAttID

xiDocumentID newLine

Every parameter which is not known is delivered to the mapping as a key/value property and can be called in the Mapping with the getInputValue(KEY) statement. Page 9

BIC Adapter for SAP Exchange Infrastructure, Configuration Guide

Example
The following screenshot shows the configuration of a communication channel, which converts an XI message (XML Document format) to an inhouse (proprietary format), before it sends it using the OFTP adapter.

As can be seen, there are 2 steps in the module sequence: 1. Execute the Converter by calling the module localejbs/CallBicXIRaBean 2. Execute the OFTP adapter (using the standard localejbs/ModuleProcessorExitBean), so that the converted document is transmitted. The module configuration table contains the parameters for the modules in the sequence: 1. The mapping name for the module key bic. 2. The adapter name (oftp) for the ModuleProcessorExitBean. Note that the soucePayload and destPayload parameters are missing in the configuration. The default behaviour will be: destSourceMsg: will be an attachment called SeeburgerMain. If the attachment does not exist, the main Document will be used. destTargetMsg: will be an attachment called SeeburgerMain.

Page 10

BIC Adapter for SAP Exchange Infrastructure, Configuration Guide

Configuring the Logging

Use
BIC logging is used for debug and testing purposes. It enables users to have a detailed view of the mapping process.

Integration
BIC logging is integrated in the SAP J2EE logging system. It can therefore be configured with the SAP J2EE administration tool.

Requirements
Basic knowledge of the SAP J2EE logging system and the concepts of location, formatter, destination and logging level is required.

Activities
To configure the converter logging follow the following steps: 1. Start the SAP J2EE Administration tool and log in 2. Select the service Log Configurator in the Server node. 3. Use the Advance mode button and switch to the Locations tab page. 4. If the tree com.seeburger.jucon and com.seeburger.bicxiadapter do not exist, create them by using the new button. 5. Add the following desinations for com.seeburger.bicxiadapter: application_seeburger.com/com.seeburger.bicxiadapter_bicXIRa.trc and application_seeburger.com/com.seeburger.bicxiadapter_bicXIRa_read.trc

6. Add the following desinations for com.seeburger.jucon: application_seeburger.com/com.seeburger.bicxiadapter_juconXIRa.trc and application_seeburger.com/com.seeburger.bicxiadapter_juconXIRa_read.trc 7. You also can create new Destinations and Formatters

Page 11

BIC Adapter for SAP Exchange Infrastructure, Configuration Guide 8. The debug level (also formatter and destination) for the following locations can now be set: - com.seeburger.jucon: this is the BIC core package. Use this log configuration to deal with mapping issues (i.e. mapping starts, but does not finish successfully). com.seeburger.bicxiadapter: this is the SAP XI specific layer for BIC. Use this log configuration to deal with connection issues (i.e. problems before the mapping starts). The use of the DEBUG level can have an impact on the performance. Use this level for debug and testing purposes only. 9. Once the logging level has been set, the log viewer can be used to display the log files:

Page 12