Skip to end of metadata
Go to start of metadata



 IDoc Adapter 

Purpose

TheIDoc adapter enables you to process IDocs (Intermediate Documents) using the Integration Engine. IDocs from SAP systems Release 3.1x or higher are supported.

The IDoc adapter is used by SAP systems to connect to a centrally configured Integration Engine using IDocs. A system that has an Integration Engine of this type is referred to as the Integration Server. External systems can also use the IDoc adapter to connect to an Integration Server.

Implementation Considerations

Only use the IDoc adapter to integrate SAP systems with the Integration Server if a scenario of this kind suits your requirements. For example, if you want to make IDoc data in the form of XML messages available to additional receivers, or if you want to connect different components or integration processes that were previously not integrated. Only stop using existing functioning IDoc scenarios after serious consideration.

Integration

The IDoc adapter is part of the Integration Server. Essentially, the IDoc adapter comprises two parts, namely an adapter at the Integration Server inbound channel, and an adapter at the Integration Server outbound channel. The metadata for the IDoc types involved is shared.

The adapter at the inbound channel is located before the Integration Server pipeline and calls this pipeline. The adapter at the outbound channel, however, is called by the pipeline, and can therefore be regarded as part of the pipeline. 

The connected systems transfer or receive IDocs through their IDoc RFC interface.

 

Features

You require the IDoc adapter to connect SAP systems (or external systems) to the Integration Server using IDoc communication.

You need the IDoc adapter if you want to use the Integration Server to process IDocs. The IDoc adapter converts the IDocs to IDoc XML format so that they can be processed by the Integration Server pipeline.

The IDoc adapter only evaluates the payload of a received XML message. Additional attachments are ignored and not forwarded.

It is also possible to transfer XML received by the Integration Server in IDoc format to connected systems. The Integration Server pipeline must convert the received XML to IDoc XML, and then transfer this IDoc XML to the IDoc adapter. The IDoc adapter converts the IDoc XML to native IDoc format and sends the IDoc to the identified receiver system using the standard IDoc interface. The IDoc adapter can also call external subsystems.

If none of the pipeline services require the IDoc XML, then you can set a corresponding configuration parameter so that IDocs are not converted to IDoc XML, but are transported as tables instead. This only makes sense if IDocs are to be received on the Integration Server and sent again as IDocs without changes to the data records. Avoiding unnecessary conversions from and to XML can lead to improvements in system performance.

You can improve performance further by processing IDoc XML messages to the same receiver in packages. To create these message packages, use event-driven message processing.

You can also use the following transactions and functions:

●     Maintain ports in the IDoc adapter(IDX1)

●     Load, display, and delete metadata(IDX2)

●     Display IDoc XML messages (IDX5)

●     Configuring Acknowledgment Requests

●     Sending Acknowledgment IDocs as XI Request Messages

You cannot execute transactions that have the locked symbol , because you do not have the required authorizations.

The authorizations for the individual transactions are tailored to requirements and are assigned as derivations of the following roles. They are all based on the authorization object S_XMB_AUTH or S_XMB_DSP.

 

 

Authorizations and Roles

Transaction

Authorization Object

Role

IDX1

S_IDOCMETA

SAP_XI_ADMINISTRATOR

IDX2

S_IDOCMETA

SAP_XI_CONFIGURATOR

IDX5

S_XMB_DSP

SAP_XI_MONITOR

 

 1)

 Maintaining Ports 

Use

You use the port maintenance in the IDoc adapter to establish an RFC connection to the system that contains the metadata that the IDoc adapter requires to convert IDocs (Intermediate Documents) that have been sent to it to IDoc XML format. This system is defined by the sender port and the client in the IDoc control record. It is either the sender SAP system or an SAP reference system.

The metadata comprises the IDoc structures for the corresponding IDoc types. Using this port you can call this data either directly at runtime or you can load it to the Integration Server (the system with the IDoc adapter) beforehand.

You must maintain a port in the IDoc adapter for all clients in each SAP system that you want to connect to the Integration Server using IDocs.

This is also the case for receiver systems if they are subsystems (non-SAP systems). Systems of this kind are defined using the receiver port in the respective communication channel.

Creating a Port

To establish an RFC connection using the port maintenance in the IDoc adapter, proceed as follows:

...

       1.      Call the transaction Port Maintenance in IDoc Adapter (IDX1).

On the left-hand side the system displays a list of ports that are already defined, for example SAPABC_123, and a description.

       2.      Choose Create to create a new port (a new RFC connection) for the selected system.

The system converts the display area on the right-hand side of the screen into an input area where you can enter the specifications for the new port.

Specifications for Port to Be Created

Specification

Meaning

Port

Port name. For SAP systems this comprises the type and ID of the connected system, for example, SAPABC.

Client

Three figure number of the respective client, for example, 123.

Description

A short description of the port.

RFC Destination

The RFC destination for the connected system. This comprises, for example, the system ID and the client, for example, ABC_123.

Receiver of Status Messages

Partner number and partner type of receiver.

The specifications for Port and Client correspond to the sender port and the client in the IDoc control record.

       3.      Enter the required data for the new port and save the data.

The system creates the new entry and places it alphabetically in the list of already defined ports. The system displays a corresponding message.

Changing a Port

To change the specifications for a port, proceed as follows:

...

       1.      Select the port from the port list and choose Change.

The system converts the display area on the right-hand side of the screen into an input area where you can make your changes. The port name and the client cannot be changed.

       2.      Make your changes to the selected port and save the data.

The system returns the input area on the right-hand side of the screen to display mode and displays the selected port with your changes.

Deleting a Port

To delete a port, proceed as follows:

...

       1.      Select the port from the port list and choose Delete.

The system displays a dialog box asking if you really want to delete the port.

       2.      To delete the port, choose Yes.

The system deletes the entry and displays a corresponding message.

 2)

Loading, Displaying, and Deleting Metadata 

Use

IDoc (Intermediate Document) metadata comprises structures for the corresponding IDoc types that are required by the IDoc adapter to convert these IDocs to IDoc XML format and the other way around.

Using an RFC connection, metadata of this type can be either called directly at runtime or loaded to the Integration Server beforehand.

The system containing the metadata is either the sender or receiver SAP system or, if the sender or receiver system is a subsystem, the SAP reference system where the metadata is saved.

You can display metadata that has already been loaded, or if you are upgrading the application system then you can delete the metadata and reload it.

Prerequisites

To access the metadata in the sender system, you must establish an RFC connection to this system using the port maintenance in the IDoc adapter.

Procedure

...

       1.      To find out what metadata has already been loaded, call the transaction Metadata Overview for IDoc Adapter (IDX2).

The system displays a screen with the directory of all systems connected with the IDoc adapter (including a description) for which metadata has already been loaded. Choose Port Maintenance in IDoc Adapter () to call the corresponding transaction and to create additional ports.

       2.      Expand the individual systems to display the IDoc types and clients including a description for each system. The system displays the metadata for each connected system for which metadata has already been loaded.

       3.      To apply the metadata structure loaded from a particular system to another system (for example, to an SAP reference system), select the link to the corresponding IDoc type and choose Copy .

The system displays a dialog box in which you can copy the IDoc type description to another system (Target Port).

       4.      To delete metadata that has already been loaded, select the link to the corresponding IDoc type and choose Delete.

The system asks you if you really want to delete the selected structure.

       5.      To delete the metadata structure, choose Yes.

       6.      To load additional metadata, choose Create.

The system displays a dialog box where you can enter the IDoc Type includingExtension and the system (Source Port).

       7.      Make the required entries and choose Continue.

The new structure is inserted in the tree structure as follows:

-         ¡        If the structure originates from a system from which metadata has already been loaded, it is inserted below the structures already loaded from this system.

-         ¡        If the structure originates from a system from which no metadata has already been loaded, it is inserted together with the system below the already listed systems.

       8.      To display details about a metadata structure that has already been loaded, choose the link to the corresponding IDoc type. To display this structure in detail, choose Display (). The system displays the structure in a hierarchy tree.

       9.      To display the corresponding system (port) and the basic type from the detailed display, choose Header Information .

   10.      To display the segment versions of all segment types in the structure, choose All Segment Versions .

   11.      Select a segment to display all its fields.

 3)

Displaying XML Messages 

Use

You display XML messages to track inbound and outbound messages in the IDoc adapter. This gives you an overview of which messages were sent or received by the adapter. IDoc tracking (advanced functions) enables you to track IDocs and display them in the remote system.

Prerequisites

●     You have called the transaction IDoc Adapter - Monitoring (IDX5). The system navigates to the screen XML Messages in IDoc/RFC Adapter.

●     For IDoc tracking you need authorizations in the systems in which you are tracking the IDocs:

-         ○      To start the XI message monitor in the remote system

S_XMB_MONI with ACTVT = 03

-         ○      To start the IDoc monitor in the remote system

S_IDOCMONI with ACTVT = 03

-         ○      Authorization for function groups:

-         ■      BDMON

-         ■      BDMT

-         ■      IDOC_TRACING

-         ■      SXMB_MONI

Procedure

On the XML Messages in IDoc/RFC Adapterscreen, you can select and list XML messages using various selection criteria. To do this, proceed as follows:

       1.      Select XML messages by specifying a creation date and creation time for the messages, or enter a specific message ID or transaction ID to determine a specific message to be selected. The transaction ID is the ID of the transaction in the IDoc adapter.

The transaction ID is only unique for each sender or receiver.

       2.      You can specify additional selection criteria in the IDoc group box.

The following selection criteria are available:

Selection Criterion

Entry

System ID

Name of port in IDoc adapter

IDoc number

Number of the IDoc from the IDoc control record

IDoc Object

Name of a customer enhancement or IDoc basic type

Direction

Direction of IDoc transfer

Choose Execute.

The system sorts and lists the XML messages according to the time that they were created. Messages that were received and sent as IDocs are listed together and are identified by the same message ID.

The system also uses the list of messages to summarize the number of messages displayed for each direction. In addition to the specified selection criteria, the system also displays the client.

       3.      To display a summary of the information for each XML message, select the corresponding message in the list and choose Details.

       4.      If you want to navigate to the monitoring of the Integration Engine, select one of the listed messages by double clicking its message ID.

The Integration Engine monitoring displays additional information about the selected message. You can do the following:

-         ○      Display the content of the message

Compare existing versions with each other

-         ○      Reschedule messages with errors

-         ○      Display the children of a message that are the result of branching

       5.      If you want to navigate to the tRFC queue (transaction SM58), select one of the listed messages by double clicking its transaction ID.

This is only useful when the message direction is outbound.

       6.      If you want to display IDoc packages, select a message and choose  Display IDoc Package.

Performing IDoc Tracking

       7.      To track IDocs, choose Advanced Functions.

Fields for the IDoc number, status, and XI Message ID are added to the list.

       8.      To track where an IDoc is located or where it came from, select a line and choose IDoc Tracking.

       9.      To display an IDoc in the remote system, select the line and choose Monitor.

The message line shows which monitor is displayed.

Outbound:

-         ○      If the IDoc number and status are set, the IDoc has been sent to an SAP system.

You can display the IDoc remotely in the IDoc monitor of the SAP system.

See:IDoc Display

-         ○      If the XI message ID is set, the IDoc has been sent to an Integration Server.

You can display the message remotely in the monitor for processed XML messages.

See:Monitor for Processed XML Messages

-         ○      If none of the additional fields are set, you have the following options:

-         ■      The IDoc is in one of the qRFC outbound queues.

You can display the qRFC outbound queues.

-         ■      The IDoc is in a queue of the transactional RFC.

You can display the queue.

-         ■      It was not possible to connect to the system.

Inbound:

Tracking searches for the RFC destination for the sender system for each port. If none is found, the partner number and partner type specified in port maintenance are used. This information is used to call the IDoc monitor remotely.

See Maintaining Port.

   10.      You can display and edit the conversion of the XI message status in connection with the acknowledgment status to the IDoc status in table IDX_TRXSTATUS.

 

 

 

 

 

 

 

 

 

  • No labels