The Integration Engine, as a runtime component of SAP NetWeaver PI, has the following tasks:
• Receive XML messages
• Process XML messages
• Forward XML messages
During message processing, collaboration agreements are evaluated, the receivers are determined, and mapping activities are executed. Collaboration agreements define which communication channel to use to process messages for particular combinations of senders and receivers. In a collaboration agreement, senders and receivers can also agree on additional security settings, which refer to the content of the messages.
The Integration Engine provides additional features like:
• Time Controlled Processing
• Special queue for large messages
• Message Prioritization
• Balancing between parallel queues
• “Switch Procedure” for message deletion
To use the Integration Engine, it must be configured for the current system landscape, keeping in mind the Integration Processes involved.
Figure 55: PI Start Menu for Administrator User
Call the Integration Engine – Administration (SXMB_ADM) and the system displays the screen Integration Engine: Administration.
2008 © 2008 SAP AG. All rights reserved.
75
The screenIntegration Engine: Administration. contains a menu that comprises two areas: Administration and Configuration. Administration and configuration are mainly system administrator tasks used to set up the processing of XML messages. This enables you to make changes to SAP default settings or to configure test settings.
Figure 56: Transaction SXMB_ADM
The following functions are available to help you manage and administer the functions of the Integration Engine:
• Under Manage Queue
you will find features for registering, de-registering, and activating queues.
These changes take effect while the Integration Engine is online.
• Scheduling jobs for archive and deletion of PI messages
• Configure settings to support Error Analysis
You cannot execute options in the menu that have the locked symbol, if you do not have the required authorization. The authorizations for the individual functions are tailored to requirements and are assigned as derivations of the composite role SAP_XI_ADMINISTRATOR. They are all based on the authorization object S_XMB_ACT.
The following functions are available to help you configure an Integration Engine:
• Maintaining filters for event-driven processing and queue prioritizations
• Configure Sender/Receiver IDs
• Setting Integration Engine global and specific configuration
• Defining the procedures for deletion of PI messages persisted on the Integration Engine
• Defining the interfaces to be archived and the retention period of PI messages persited on the Integration Engine
• Displaying pipeline definitions
Maintaining filters for event-driven processing:
You can define filters to select messages that you do not wish to process immediately but for a later event by:
• Assigning filters to sender and receiver IDs already configured
• Defining jobs to schedule the processing of messages that have been sorted by a filter and not processed immediately
To schedule the processing of messages explicitly, you have to:
• Define the required senders and receivers
• Define a filter for selecting the required messages
• Define a job that schedules the processing of the filtered messages or message packages
Note: This only applies to messages with quality of service EO (Exactly Once) or EOIO (Exactly Once In Order). All settings here are client-specific.
From the main screen of transaction SXMB_ADM Integration Engine -Administration, select Configure Event-Driven Message Processing. This will bring you to the Maintain Message Filter screen.
2008 © 2008 SAP AG. All rights reserved.
77
Figure 57: Transaction SXMB_ADM: Event Driven Processing
Figure 58: Schedule Message Processing
For Job Maintenance, traffic light above the job list shows the status of the scheduled job.
• A green light signals that the scheduler job is scheduled.
• An amber light signifies that the scheduler job is scheduled, but overdue.
• A red light signifies that the scheduler job is not scheduled.
A job is started as soon as the relevant criteria are met. The job is active and the scheduler job used to schedule the jobs for message processing is running. If necessary, you have the option to reschedule the scheduler by selecting Scheduler Overview from within the Job Maintenance view.
Defining Sender/Receiver IDs:
You define IDs for senders and receivers so that you can use them in other functions, for example, in event-driven message processing.
Figure 59: Transaction SXMB_ADM: Configure Sender/Receiver ID
2008 © 2008 SAP AG. All rights reserved.
79
Figure 60: Creating a Sender/Receiver Definition
Creating a new sender/receiver definition:
• Switch to change mode.
• Select New Entries.
• Enter a sender/receiver ID (be as descriptive as possible).
• Make the remaining entries for the sender/receiver definition.
An input help containing normalized addresses is available on the Integration Server to assist you when making these entries. You are not permitted to use other address data here. IDocs are an exception as no normalized data is available.
There is no input help available in an Integration Engine. You have to maintain the communication channel data specified in the Integration Directory manually in this case. You can enter an asterisk as a wildcard.
Changing an existing sender/receiver definition:
• Enter transaction SXMB_ADM.
• Select Configure Sender/Receiver ID.
• Switch to change mode.
• Make the required changes (you can change all properties except for the sender/receiver ID).
Setting up the Integration Engine's configuration data:
There are two types of configuration data:
• Global configuration data
• Specific configuration data
The specific configuration data to define parameters, which you use to configure your Integration Engine.
The configuration data for the Integration Engine is client-specific. This means that you can configure multiple business systems in different ways in one SAP system. You use the global configuration data to define the role of your current business system (i.e. Integration Server). You can load the global configuration data from the System Landscape Directory, if it is already maintained there.
You can also define a configuration locally, for example for test purposes, using configuration data that differs from that of the System Landscape Directory.
Loading the global configuration data from the System Landscape Directory:
Choose Edit→ Change Selected Configuration Data → Choose System Landscape - Load Configuration (save the loaded data, F6).
To undo the loading of global configuration data from the System Landscape Directory, choose Revoke Changes (Ctrl. F6).
Figure 61: Loading Configuration Data
Changing the configuration data displayed:
Choose Edit→ Change Selected Configuration Data.
To change the usage type of your business system, in the field Role of Business System, select an option using the input help.
A business system can have one of the following roles:
2008 © 2008 SAP AG. All rights reserved.
81
Integration Server:
This is a centrally configured Integration Engine that is not able to execute application logic. It receives XML messages, determines the receiver, executes mappings, and routes the XML messages on to the corresponding receiver system.
There can only be one Integration Server in an SAP system. This means that only one client can be defined as the Integration Server.
Application system:
The system can act as a sender or receiver of XML messages, but it does not contain any integration logic. Therefore, neither routing nor mapping can be executed locally. Instead, they must be executed by the Integration Server, which is called by the application system. Even though it is equipped with a local Integration Engine it requires the Integration Server to execute the integration logic (the Integration Server can run in another client of the same SAP system).
In changing Selected Configuration Data, there are two ways of specifying an address:
• http://hostname:port/sap/xi/engine?type=entry, where hostname is the host name of the Integration Server and port is the HTTP port.
• Dest://IntegrationServer-Destination, where IntegrationServer-Destination is an RFC destination of type HTTP Connection (type H) for the Integration Server in the current system. In this case, the RFC destination contains the host name, port, and path prefix. In other cases, it may also contain logon information.
If you want to call an Integration Server, but do not want to configure your business system as an Integration Server, enter the address for the particular Integration Server in the field Corresponding Integration Server. The name of the user and the password must be defined with the HTTP service (/sap/xi/engine) in the target system. The user is the person who processes the XML messages on the Integration Server. First, create an RFC destination of type H with the host name and the HTTP port of the Integration Server.
Enter the following path prefix: /sap/xi/engine?type=entry.
In changing the Specific Configuration Data, input help is available for the field category of parameters to which you want to apply the changes.
Choose Change Configuration Data. This displays the view Configuration of the Integration Engine. The view displayed contains a table with configuration parameters that have already been defined for the selected category.
For more information about the individual parameters, choose the information icon (input help) in the corresponding line. If you did not select a category of parameters for the field Category in the previous step, the table contains all configuration parameters that have already been defined.
Mark the checkbox in the column Prefix to define the corresponding subparameter as a prefix. This way it is possible to define a configuration value generically for a set of subparameters. Parameters are local parameters and therefore are not automatically transported.
Message Restart Administration
The message processing might fail due to temporary
failure situations, like network connection issues. For such cases it is
recommended to schedule a message restart job on the Integration Engine. The program searches for failed (could not be processed correctly) or missing (were deleted manually from the queue) messages and tries to restart these messages automatically. The maximum number of restart attempts and the interval between these attempts is set with the qRFC scheduler. After the maximum number of restarts, the restart of the messages is canceled if it was not successful.
Job Name Report Recommended Interval
SAP_XMB_RESTART_
MESSAGES
RSXMB_RESTART_
MESSAGES
Every 5 minutes
IDOC Adapter Refresh Status Administration
This job checks the status of messages that were sent to the IDoc
adapter. Since the IDoc adapter does not send response messages, it is not automatically known whether a message was processed or not.
Job Name Report Recommended Interval
SAP_XMB_REFRESH_
Every hour or only evey day, this is depending on your IDOC Adapter usage