API for IDoc Types and Segment Definitions

Definition

A wide range of function modules is available for developing segments and IDoc types automatically. This programming interface (API) is also used by the IDoc type editor and the segment editor.

Use

IDoc types are used in BAPIs to transport business information. When a new BAPI is developed, the corresponding IDocs are also generated using this API.

Structure

The API is divided into three function groups: The function modules which operate on segments are located in function group EDIJ, while those which operate on basic types and extensions are located in function group EDIM. The third function group contains RFC-compatible function modules which can be used from external development environments.

Function modules in the EDIJ group (segments)

Name

Description

SEGMENT_CREATE

Creates a new segment. The segment structure is transferred as a table. The new (and up to now only) segment definition has the temporary release indicator <SPACE>. The first version ( Segment definition) is 000.

SEGMENT_MODIFY

Changes an existing segment. Depending on the release indicator, a new segment definition is created or an existing one modified.

SEGMENT_DELETE

Deletes a complete segment.

SEGMENTDEFINITION_DELETE

Deletes a segment definition which has not been released.

SEGMENTDEFINITION_CLOSE

Releases a segment definition, that is, sets the release indicator. The released segment definition is assigned the identifier from the current release.

SEGMENTDEFINITION_UNCLOSE

Cancels the release, that is, deletes the release indicator. The relevant segment definition is assigned the release indicator <SPACE>.

SEGMENT_CHECK_EXISTENCE

Returns a table with the existing segment definitions with the release indicators.

SEGMENT_CHECK_CONSISTENCY

Among other things, checks whether the individual segment fields can be added seamlessly to the segment, whether the segment is included in a transport request, whether the last user to change a field in the dictionary is identical to the last user to change this field in the segment.

SEGMENT_TRANSPORT_INSERT

Inserts a segment with all the relevant segment definitions in a transport request. CAUTION: A request and task number must be entered.

Function modules in the EDIM group (basic types and extensions)

<OBJECT> represents the object on which the function module operates: IDOCTYPE for basic type, EXTTYPE for extension. Since an extended basic type consists of a basic type and an extension, separate function modules are not required.

Name

Description

<OBJECT>_CREATE

Generates an existing basic type or extension using a syntax description provided in a table. Also checks whether the object already exists. The new object is then included in a transport request.

<OBJECT>_UPDATE

Changes an existing basic type or extension using a syntax description provided in a table.

<OBJECT>_READ

Reads all the information for an object: Syntax, any extensions or predecessors.

<OBJECT>_DELETE

Deletes a basic type or extension.

<OBJECT>_CLOSE

Releases an object, that is, sets the release indicator.

<OBJECT>_UNCLOSE

Cancels the release of an object.

<OBJECT>_EXISTENCE_CHECK

Checks whether the transferred basic type or extension already exists. If so, the attributes are read (links to basic types, predecessors, and so on).

<OBJECT>_INTEGRITY_CHECK

Checks the general syntax. In the case of successors, checks whether they have been created correctly from predecessors.

<OBJECT>_TRANSPORT

Includes the basic type or extension in a transport request.

Function modules in the EDIMEXT group (API for external programs)

Name

Description

IDOCTYPES_FOR_MESTYPE_READ

Reads all IDoc types assigned to a message type (logical message). You can deal with several message types with an incomplete name and a *.

IDOCTYPE_READ_COMPLETE

Reads the structure and attributes (segments), as well as the segment attributes (fields and fixed values), for an IDoc type. In this case, the version of the record types and segments must be sent to the function module.

IDOC_RECORD_READ

Reads the structure of the record types for the specified version.

SEGMENT_READ_COMPLETE

Reads the structure and attributes for a segment. In this case, the version of the record types and the release for the segments must be sent to the function module.

IDOCTYPES_LIST_WITH_MESSAGES

Delivers all IDoc and message types released for the release entered. If you do not enter the release, the objects that are not released are also encapsulated.