Siebel Connector for SAP R/3 > IDOC Interfaces > Creating SAP Integration Objects with the IDOC Wizard >

IDOC Integration Objects

IDOC integration objects represent the structure of an SAP IDOC. An IDOC received from SAP has a very simple structure. It consists of a single control record followed by multiple data records. The control record contains fields that specify the IDOC type, message type, extension type, sender logical system, receiver logical system, IDOC number, and so on. The data record contains the physical data being transported in the IDOC, as well as some information about the data record, for example, the name of the IDOC segment contained in the data record.

An IDOC integration object in the Siebel application corresponds very closely to this structure. The integration object contains components for the control record and for each data record. Table 30 shows part of the DEBMAS02 IDOC Type and how this would be represented by a Siebel IDOC integration object.

Table 30.  DEBMAS02 IDOC and Siebel IDOC
DEBMAS02 IDOC
Siebel IDOC Integration Object
Control Record
IdocSegments Component
E2KNA1M Segment
E2KNA1M Component
E2KNA1H Segment
E2KNA1H Component
E2KNA1L Segment
E2KNA1L Component
E2KNVVM Segment
E2KNVVM Component
E2KNVPM Segment
E2KNVPM Component

The IdocSegments component contains the control record fields. These fields are named with a prefix of "CONTROL-". How these fields are used depends upon whether the IDOC is being sent to SAP or received from SAP. When an IDOC is sent from the Siebel Connector for SAP R/3 to SAP, you may set some control fields in a business service data map. Other fields are populated by the IDOC adapter business service or are populated by SAP. When an IDOC is received from SAP by the Siebel Connector for SAP R/3, you can access the information in the fields from a business service data map.

The fields in the control record may differ depending upon which version of SAP ALE is being used. If you are using SAP R/3 version 3.1, you are using ALE version 3X. If you are using SAP R/3 version 4.0 you should use ALE version 4X, but you can still use 3X if other constraints on your implementation dictate that it must be used. The IDOC Integration Object has a property ALEVersion that can be set to either 3X or 4X. If it is not defined, it is assumed that it is a 3X version. Its initial value is set by the IDOC wizard. Its default value is 3X for SAP R/3 3.1 and is 4X for SAP R/3 4.0 and newer. The default value for this property can be changed by setting the ALEVersion property on the EAI SAP IDOC Adapter Wizard. If you need to convert an existing IDOC Integration Object from 3X to 4X or the reverse, the ALEVersion property must be changed accordingly and the external name for the IDOC Integration Object must be consistent with the 3X or 4X usage as described later in this section.

Table 31 lists all the control record fields and indicates if they are used in a 3X or 4X control record. The "User can populate?" column indicates if you can set the value of the field from a Business Service Data Map for input to SAP. The Mandatory column indicates if the field must be filled in for SAP to process the IDOC. The IDOC Adapter Action column indicates what the IDOC Adapter does to the field prior to sending the IDOC to SAP.

Table 31.  Control Record Fields
4X Field
3X Field
User Can Populate?
Mandatory
IDOC Adapter Action
TABNAM
TABNAM
No
Yes
"EDI_DC" or "EDI_DC40"
MANDT
MANDT
No
 
Filled by SAP.
DOCNUM
DOCNUM
No
Yes
Populate incrementally within a transaction
DOCREL
DOCREL
Yes
 
 
STATUS
STATUS
Yes
 
 
DIRECT
DIRECT
No
Yes
Set to "2" for inbound direction.
OUTMOD
OUTMOD
No
 
Must remain blank
EXPRSS
EXPRSS
Yes
 
Set to "X" to override batch processing and process IDOC immediately. If set to anything other than blank, an "X" is sent.
TEST
TEST
Yes
 
Test messages can be indicated with an "X". If set to anything other than blank, an "X" is sent.
IDOCTYP
IDOCTYP
No
Yes
The basic IDOC type. For more information, read IDOCTYP Information.
CIMTYP
CIMTYP
No
Yes if extension is used
Is set to extension type parsed from External Name.
MESTYP
MESTYP
Yes
Yes
If not set, is set to message type user property in integration object
MESCOD
MESCOD
Yes
 
 
MESFCT
MESFCT
Yes
 
 
STD
STD
Yes
 
 
STDVRS
STDVRS
Yes
 
 
STDMES
STDMES
Yes
 
 
SNDPOR
SNDPOR
Yes
 
 
SNDPRT
SNDPRT
Yes
Yes
User value is used if given. Otherwise defaults to business service method argument or component property ("LS").
SNDPFC
SNDPFC
Yes
 
 
SNDPRN
SNDPRN
Yes
Yes
User value is used if given. Otherwise defaults to business service method argument or component property.
SNDSAD
SNDSAD
Yes
 
Field is not currently used by SAP
SNDLAD
SNDLAD
Yes
 
 
RCVPOR
RCVPOR
Yes
 
 
RCVPRT
RCVPRT
Yes
Yes
User value is used if given. Otherwise defaults to business service method argument or component property ("LS").
RCVPFC
RCVPFC
Yes
 
 
RCVPRN
RCVPRN
Yes
Yes
User value is used if given. Otherwise defaults to business service method argument or component property.
RCVSAD
RCVSAD
Yes
 
Field is not currently used by SAP.
RCVLAD
RCVLAD
Yes
 
 
CREDAT
CREDAT
No
 
Date set by SAP. Left blank.
CRETIM
CRETIM
No
 
Date set by SAP. Left blank.
REFINT
REFINT
Yes
 
 
REFGRP
REFGRP
Yes
 
 
REFMES
REFMES
Yes
 
 
ARCKEY
ARCKEY
Yes
 
 
SERIAL
SERIAL
Yes
 
 
None
DOCTYP
No
Yes/3X
Populated with External Name field when using the 3X interface.


 Siebel Connector for SAP R/3 
 Published: 22 August 2003