Skip to main content
Skip table of contents

SAP Connector (JCo 2)

SAP Connector (JCo 2): Enables the transmission of data from the X4 ESB to an SAP R/3 system. It retrieves any Remote Function Call (RFC) or any BAPI function module in an SAP system. In addition, IDocs can be sent to SAP R/3.

Properties

Operation

Determines which operation the adapter executes

Possible values: Execute: Execute adapter


Parameters

Adapter

Main class of the adapter (do not change!)

Possible values: en.softproject.x4.sapadapter.SAPAdapter: Main class (default)

x4.connectionPoolEnabled

Use Connection Pooling

x4.connectionPoolUID

ID of the connection pool. The SAP adapter can use an already existing connection pool if the same connection parameters and the same connection pool ID have been set.

x4.connectionPoolMax

Maximum number of defined connections in the connection pool

x4.transactionEnabled

Enable or disable transactional processing.

x4.transactionID

Transaction ID; all operations of the SAP adapter within a process are executed as one transaction and have the same transaction ID. The SAP adapter can use a transaction that has already been started if they have the same transaction parameters and the same transaction ID.

jco.client.client

SAP-specific parameter: SAP client

jco.client.user

SAP-specific parameter: User name

jco.client.passwd

SAP-specific parameter: Password

jco.client.lang

SAP-specific parameter: Logon language

jco.client.sysnr

SAP-specific parameter: SAP system number

jco.client.ashost

SAP-specific parameter: SAP application server

jco.client.mshost

SAP-specific parameter: SAP message server

jco.client.gwhost

SAP-specific parameter: Gateway Host

jco.client.gwserv

SAP-specific parameter: Gateway Service

jco.client.r3name

SAP-specific parameter: R/3 name

jco.client.group

SAP-specific parameter: SAP application server group

jco.client.tpname

SAP-specific parameter: Programme ID of an external server application

jco.client.tphost

SAP-specific parameter: Host of the external server application

jco.client.type

SAP-specific parameter: Type of remote host

Possible values:

  • 2: R/2

  • 3: R/3

  • E: External

jco.client.trace

SAP-specific parameter: RFC trace

Possible values:

  • 0: Deactivate RFC trace

  • 1: Activate RFC trace

jco.client.codepage

SAP-specific parameter: Initial code page in SAP notation

jco.client.abap_debug

SAP-specific parameter: ABAP debugging

Possible values:

  • 0: Deactivate ABAP debugging

  • 1: Activate ABAP debugging

jco.client.use_sapgui

SAP-specific parameter: Name of an SAP graphical user interface to be used.

jco.client.getsso2

SAP-specific parameter: SSO ticket received after login

Possible values:

  • 0: No SSO ticket received

  • 1: SSO ticket received after registration

jco.client.mysapsso2

SAP-specific parameter: Name of the SAP cookie version 2 to be used as a logon ticket.

jco.client.x509cert

SAP-specific parameter: Name of the X509 certificate to be used as the logon ticket.

jco.client.lcheck

SAP-specific parameter: Logon check on opening

Possible values:

  • 0: Deactivate login verification

  • 1: Enable login verification when opening

jco.client.grt_data

SAP-specific parameter: Additional data for the SAP graphical user interface

jco.client.use_guihost

SAP-specific parameter: Host to which the remote SAP graphical user interface is to be forwarded.

jco.client.use_guiserv

SAP-specific parameter: Service to which the remote SAP graphical user interface is to be forwarded.

jco.client.use_guiprogid

SAP-specific parameter: Programme ID of the server that starts the remote SAP graphical user interface.

jco.client.snc_mode

SAP-specific parameter: Secure network connection (SNC)-Mode

Possible values:

  • 0: Deactivate SNC mode

  • 1: Activate SNC mode

jco.client.snc_partnername

SAP-specific parameter: SNC partner, e.g. p:CN=R3, O=XYZ-INC, C=EN

jco.client.snc_qop

SAP-specific parameter: SNC security level

Possible values:

1...9: SNC security level

jco.client.snc_myname

SAP-specific parameter: SNC name (overwrites the default SNC partner)

jco.client.snc_lib

SAP-specific parameter: Path to a library that provides the SNC service

jco.client.dest

SAP-specific parameter: R/2 destination

jco.client.saplogon_id

SAP-specific parameter

jco.client.extiddata

SAP-specific parameter: External authentication data (PAS)

jco.client.extidtype

SAP-specific parameter: Type of external authentication (PAS)

A complete description of all (connection) parameters can be found in the SAP JCo 2 documentation.

Status values

1The operation was executed successfully.
-1The operation failed due to a technical error.

Call RFC/BAPI

Input

The adapter expects an input XML document according to the following pattern, which calls the corresponding function module with input data and the affected tables, if applicable:

HTML/XML
<X4SAP>
 <bapicall name="BAPI-Name" id="IDoc-ID">
   <input>
      <INPUT>
         <!--Parameter und Parameterwerte -->
      </INPUT>
   </input>
   <table>
      <!--Tabellen-->
   </table>
 </bapicall>
</X4SAP>


Example

To call BAPI IDOCTYPE_READ_COMPLETE in SAP, this adapter expects the following input XML document:

HTML/XML
<X4SAP>
 <bapicall name="IDOCTYPE_READ_COMPLETE" id="IDoc-ID">
   <input>
      <INPUT>
         <PI_CIMTYP />
         <PI_IDOCTYP> <!--IDoc-Typ--> </PI_IDOCTYP>
         <PI_RELEASE>SY-S</PI_RELEASE>
         <PI_VERSION>3</PI_VERSION>
      </INPUT>
   </input>
   <table>
      <TABLES>
         <PT_FIELDS>
            <SEGMENTTYP />
            <FIELDNAME />
            <INTLEN />
            <EXTLEN />
            <FIELD_POS />
            <BYTE_FIRST />
            <BYTE_LAST />
            <ROLLNAME />
            <DOMNAME />
            <DATATYPE />
            <DESCRP />
            <ISOCODE />
            <VALUETAB />
         </PT_FIELDS>
         <PT_FVALUES>
            <STRNAME />
            <FIELDNAME />
            <FLDVALUE_L />
            <FLDVALUE_H />
            <DESCRP />
         </PT_FVALUES>
         <PT_MESSAGES>
            <MESTYP />
            <DESCRP />
            <IDOCTYP />
            <CIMTYP />
            <RELEASED />
         </PT_MESSAGES>
         <PT_SEGMENTS>
            <NR />
            <SEGMENTTYP />
            <SEGMENTDEF />
            <QUALIFIER />
            <SEGLEN />
            <PARSEG />
            <PARPNO />
            <PARFLG />
            <MUSTFL />
            <OCCMIN />
            <OCCMAX />
            <HLEVEL />
            <DESCRP />
            <GRP_MUSTFL />
            <GRP_OCCMIN />
            <GRP_OCCMAX />
            <REFSEGTYP />
         </PT_SEGMENTS>
      </TABLES>
   </table>
 </bapicall>
</X4SAP>


Send IDoc

Input

To send an IDoc to SAP, use an XML document like the following as input to the adapter:

HTML/XML
<X4SAP>
   <X4IDoc type="MATMAS02" description="">
      <X4Mandatory>
         <X4RecipientPartnerType>LS</X4RecipientPartnerType>
         <X4RecipientPartnerNumber>X4_T</X4RecipientPartnerNumber>
         <X4RecipientPartnerFunction />
         <X4SenderPort>SAPT01</X4SenderPort>
         <X4SenderPartnerType>LS</X4SenderPartnerType>
         <X4SenderPartnerNumber>ST01_200</X4SenderPartnerNumber>
         <X4SenderPartnerFunction />
         <X4SenderAddress />
         <X4SenderLogicalAddress />
         <X4MsgType>
            <MSGTYPE>MATMAS02</MSGTYPE>
         </X4MsgType>
      </X4Mandatory>
      <X4Structure>
<MATMAS02>
    <IDOC BEGIN="1">
        <EDI_DC40 SEGMENT="1">
            <TABNAM>EDI_DC40</TABNAM>
            <MANDT/>
            <DOCNUM/>
            <DOCREL/>
            <STATUS/>
            <DIRECT/>
            <OUTMOD/>
            <EXPRSS/>
            <TEST/>
            <IDOCTYP>MATMAS02</IDOCTYP>
            <CIMTYP/>
            <MESTYP>MATMAS</MESTYP>
            <MESCOD/>
            <MESFCT/>
            <STD/>
            <STDVRS/>
            <STDMES/>
            <SNDPOR>SAPJCOIDOC</SNDPOR>
            <SNDPRT>LS</SNDPRT>
            <SNDPFC/>
            <SNDPRN>JCOCLNT000</SNDPRN>
            <SNDSAD/>
            <SNDLAD/>
            <RCVPOR/>
            <RCVPRT>LS</RCVPRT>
            <RCVPFC/>
            <RCVPRN>TSTCLNT000</RCVPRN>
            <RCVSAD/>
            <RCVLAD/>
            <CREDAT>20050519</CREDAT>
            <CRETIM>104537</CRETIM>
            <REFINT/>
            <REFGRP/>
            <REFMES/>
            <ARCKEY/>
            <SERIAL/>
        </EDI_DC40>
        <E1MARAM SEGMENT="1">
            <MSGFN>005</MSGFN>
            <MATNR>BOXCOOKIES</MATNR>
            <ERSDA>20020801</ERSDA>
            <ERNAM>TIGGER</ERNAM>
            <LAEDA/>
            <AENAM/>
            <PSTAT>KBG</PSTAT>
            <LVORM/>
            <MTART>FERT</MTART>
            <MBRSH>L</MBRSH>
            <MATKL>G1113</MATKL>
            <BISMT/>
            <MEINS>PCE</MEINS>
            <BSTME/>
            <ZEINR/>
            <ZEIAR/>
            <ZEIVR/>
            <ZEIFO/>
            <AESZN/>
            <BLATT/>
            <BLANZ>000</BLANZ>
            <FERTH/>
            <FORMT/>
            <GROES/>
            <WRKST/>
            <NORMT/>
            <LABOR/>
            <EKWSL/>
            <BRGEW>0.550</BRGEW>
            <NTGEW>0.000</NTGEW>
            <GEWEI>KGM</GEWEI>
            <VOLUM/>
            <VOLEH/>
            <BEHVO/>
            <RAUBE/>
            <TEMPB/>
            <TRAGR/>
            <STOFF/>
            <SPART/>
            <KUNNR/>
            <WESCH/>
            <BWVOR/>
            <BWSCL/>
            <SAISO/>
            <ETIAR/>
            <ETIFO/>
            <EAN11/>
            <NUMTP/>
            <LAENG/>
            <BREIT/>
            <HOEHE/>
            <MEABM/>
            <PRDHA/>
            <CADKZ/>
            <ERGEW/>
            <ERGEI/>
            <ERVOL/>
            <ERVOE/>
            <GEWTO/>
            <VOLTO/>
            <VABME/>
            <KZKFG/>
            <XCHPF/>
            <VHART/>
            <FUELG/>
            <STFAK/>
            <MAGRV/>
            <BEGRU/>
            <QMPUR/>
            <RBNRM/>
            <MHDRZ/>
            <MHDHB/>
            <MHDLP/>
            <VPSTA>KBG</VPSTA>
            <EXTWG/>
            <MSTAE/>
            <MSTAV/>
            <MSTDE/>
            <MSTDV/>
            <KZUMW/>
            <KOSCH/>
            <NRFHG/>
            <MFRPN/>
            <MFRNR/>
            <BMATN/>
            <MPROF/>
            <PROFL/>
            <IHIVI/>
            <ILOOS/>
            <KZGVH/>
            <XGCHP/>
            <COMPL/>
            <KZEFF/>
            <RDMHD/>
            <IPRKZ/>
            <PRZUS/>
            <MTPOS_MARA/>
            <GEWTO_NEW/>
            <VOLTO_NEW/>
            <WRKST_NEW/>
            <AENNR/>
            <MATFI/>
            <CMREL/>
            <SATNR/>
            <SLED_BBD/>
            <GTIN_VARIANT/>
            <GENNR/>
            <SERLV/>
            <RMATP/>
            <E1MAKTM SEGMENT="1">
                <MSGFN>005</MSGFN>
                <SPRAS>D</SPRAS>
                <MAKTX>Schachtel mit Keksen</MAKTX>
                <SPRAS_ISO>DE</SPRAS_ISO>
            </E1MAKTM>
            <E1MAKTM SEGMENT="1">
                <MSGFN>005</MSGFN>
                <SPRAS>E</SPRAS>
                <MAKTX>Box of cookies</MAKTX>
                <SPRAS_ISO>EN</SPRAS_ISO>
            </E1MAKTM>
            <E1MARCM SEGMENT="1">
                <MSGFN>005</MSGFN>
                <WERKS>0001</WERKS>
                <PSTAT>BG</PSTAT>
                <LVORM/>
                <BWTTY/>
                <MAABC/>
                <KZKRI/>
                <EKGRP/>
                <AUSME/>
                <DISPR/>
                <DISMM/>
                <DISPO/>
                <PLIFZ>0</PLIFZ>
                <WEBAZ>0</WEBAZ>
                <PERKZ>M</PERKZ>
                <AUSSS>0.00</AUSSS>
                <DISLS/>
                <BESKZ>E</BESKZ>
                <SOBSL/>
                <MINBE/>
                <EISBE/>
                <BSTMI/>
                <BSTMA/>
                <BSTFE/>
                <BSTRF/>
                <MABST/>
                <LOSFX/>
                <SBDKZ/>
                <LAGPR/>
                <ALTSL/>
                <KZAUS/>
                <AUSDT/>
                <NFMAT/>
                <KZBED/>
                <MISKZ/>
                <FHORI/>
                <PFREI/>
                <FFREI/>
                <RGEKZ/>
                <FEVOR/>
                <BEARZ/>
                <RUEZT/>
                <TRANZ/>
                <BASMG/>
                <DZEIT/>
                <MAXLZ/>
                <LZEIH/>
                <KZPRO/>
                <GPMKZ/>
                <UEETO/>
                <UEETK/>
                <UNETO/>
                <WZEIT/>
                <ATPKZ/>
                <VZUSL/>
                <HERBL/>
                <INSMK/>
                <SSQSS/>
                <KZDKZ/>
                <UMLMC/>
                <LADGR/>
                <XCHPF/>
                <USEQU/>
                <LGRAD/>
                <AUFTL/>
                <PLVAR/>
                <OTYPE/>
                <OBJID/>
                <MTVFP/>
                <PERIV/>
                <KZKFK/>
                <VRVEZ/>
                <VBAMG/>
                <VBEAZ/>
                <LIZYK/>
                <BWSCL/>
                <KAUTB/>
                <KORDB/>
                <STAWN/>
                <HERKL/>
                <HERKR/>
                <EXPME/>
                <MTVER/>
                <PRCTR/>
                <TRAME/>
                <MRPPP/>
                <SAUFT/>
                <FXHOR/>
                <VRMOD/>
                <VINT1/>
                <VINT2/>
                <STLAL/>
                <STLAN/>
                <PLNNR/>
                <APLAL/>
                <LOSGR/>
                <SOBSK/>
                <FRTME/>
                <LGPRO/>
                <DISGR/>
                <KAUSF/>
                <QZGTP/>
                <TAKZT/>
                <RWPRO/>
                <COPAM/>
                <ABCIN/>
                <AWSLS/>
                <SERNP/>
                <STDPD/>
                <SFEPR/>
                <XMCNG/>
                <QSSYS/>
                <LFRHY/>
                <RDPRF/>
                <VRBMT/>
                <VRBWK/>
                <VRBDT/>
                <VRBFK/>
                <AUTRU>X</AUTRU>
                <PREFE/>
                <PRENC/>
                <PRENO/>
                <PREND/>
                <PRENE/>
                <PRENG/>
                <ITARK/>
                <PRFRQ/>
                <KZKUP/>
                <STRGR/>
                <LGFSB/>
                <SCHGT/>
                <CCFIX/>
                <EPRIO/>
                <QMATA/>
                <PLNTY/>
                <MMSTA/>
                <SFCPF/>
                <SHFLG/>
                <SHZET/>
                <MDACH/>
                <KZECH/>
                <MMSTD/>
                <MFRGR/>
                <FVIDK/>
                <INDUS/>
                <MOWNR/>
                <MOGRU/>
                <CASNR/>
                <GPNUM/>
                <STEUC/>
                <FABKZ/>
                <MATGR/>
                <LOGGR/>
                <VSPVB/>
                <DPLFS/>
                <DPLPU/>
                <DPLHO/>
                <MINLS/>
                <MAXLS/>
                <FIXLS/>
                <LTINC/>
                <COMPL/>
                <CONVT/>
                <FPRFM/>
                <SHPRO/>
                <FXPRU/>
                <KZPSP/>
                <OCMPF/>
                <APOKZ/>
                <AHDIS/>
                <EISLO/>
                <NCOST/>
                <MEGRU/>
                <ROTATION_DATE/>
                <UCHKZ/>
                <UCMAT/>
            </E1MARCM>
            <E1MBEWM SEGMENT="1">
                <MSGFN>005</MSGFN>
                <BWKEY>0001</BWKEY>
                <BWTAR/>
                <LVORM/>
                <VPRSV>S</VPRSV>
                <VERPR>0.00</VERPR>
                <STPRS>15.50</STPRS>
                <PEINH>1</PEINH>
                <BKLAS>7920</BKLAS>
                <VMVPR/>
                <VMVER/>
                <VMSTP/>
                <VMPEI/>
                <VMBKL/>
                <VJVPR>S</VJVPR>
                <VJVER>0.00</VJVER>
                <VJSTP>15.50</VJSTP>
                <LFGJA>2002</LFGJA>
                <LFMON>08</LFMON>
                <BWTTY/>
                <ZKPRS/>
                <ZKDAT/>
                <BWPRS/>
                <BWPRH/>
                <VJBWS/>
                <VJBWH/>
                <VVJLB/>
                <VVMLB/>
                <VVSAL/>
                <ZPLPR/>
                <ZPLP1/>
                <ZPLP2/>
                <ZPLP3/>
                <ZPLD1/>
                <ZPLD2/>
                <ZPLD3/>
                <KALKZ/>
                <KALKL/>
                <XLIFO/>
                <MYPOL/>
                <BWPH1/>
                <BWPS1/>
                <ABWKZ/>
                <PSTAT>BG</PSTAT>
                <KALN1>000100126602</KALN1>
                <KALNR>000100126603</KALNR>
                <BWVA1/>
                <BWVA2/>
                <BWVA3/>
                <VERS1/>
                <VERS2/>
                <VERS3/>
                <HRKFT/>
                <KOSGR/>
                <PPRDZ/>
                <PPRDL/>
                <PPRDV/>
                <PDATZ/>
                <PDATL/>
                <PDATV/>
                <EKALR>X</EKALR>
                <VPLPR>0.00</VPLPR>
                <MLMAA/>
                <MLAST/>
                <VJBKL>7920</VJBKL>
                <VJPEI>1</VJPEI>
                <HKMAT/>
                <EKLAS/>
                <QKLAS/>
                <MTUSE/>
                <MTORG/>
                <OWNPR/>
                <BWPEI>0</BWPEI>
            </E1MBEWM>
        </E1MARAM>
    </IDOC>
</MATMAS02>
</X4Structure>
   </X4IDoc>
</X4SAP>


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.