WebSphere Message Brokers
File: ac37300_
Writer: Karen Cameron

Reference topic

This build: July 31, 2007 21:20:44

SAPRequest node

Use the SAPRequest node to interact with an SAP application.

This topic contains the following sections:

Purpose

The SAPRequest node allows you to interact with SAP applications. For example, theSAPRequest node requests information from a SAP Enterprise Information System (EIS). A customer business object is sent to SAP, causing SAP to retrieve information about a customer, such as an address and account details. The information that is retrieved by the SAPRequest node can then be used by the rest of the message flow. The SAPRequest node can send and receive business data.

The SAPRequest node is contained in the WebSphere Adapters drawer of the message flow node palette, and is represented in the workbench by the following icon:

SAPRequest node icon

Using the SAPRequest node in a message flow

To function correctly, the SAPRequest node needs an adapter component, which you set using the Adapter component node property, and business object definitions, which are stored in the message set that you reference from the node. For this reason, you must provide a message set. By default, the message that is propagated from the SAPRequest node is in the DataObject domain, so the Message domain property is set to DataObject. You cannot specify a different domain. The message type is detected automatically by the node.

The SAPRequest node supports local transactions using the broker's Local Transaction Manager, and global transactions using the broker's external syncpoint coordinator.

You can deploy several WebSphere® Adapters request nodes that use the same adapter component to an execution group.

Configuring the SAPRequest node

When you have put an instance of the SAPRequest node into a message flow, you can configure it. For more information, see Configuring a message flow node. To display its properties, either double-click the node, or right-click the node and click Properties. All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk.

Terminals and properties

The SAPRequest node terminals are described in the following table.

Terminal Description
In The input terminal that accepts the request business object.
Out The output terminal to which the result business object is sent if it represents successful completion of the request, and if further processing is required within this message flow.
Failure The output terminal to which the business object is routed if a failure is detected during processing in the node.

The following tables describe the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk on the panel if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the bar file to deploy it).

The SAPRequest node Description properties are described in the following table.
Property M C Default Description
Node name No No The node type, e.g. SAPRequest The name of the node.
Short Description No No   A brief description of the node.
Long Description No No   Text that describes the purpose of the node in the message flow.
The SAPRequest node Basic properties are described in the following table.
Property M C Default Description
Adapter component Yes No   The name of the adapter component that contains configuration properties for the adapter. Either enter a name of an adapter file, or click Browse to select an adapter file from the list of files that are available in referenced message set projects.
Default method Yes Yes   The default method binding to use.
The SAPRequest node Response Message Parsing properties are described in the following table.
Property M C Default Description
Message domain No No DataObject The domain that is used to parse the incoming message. By default, the message that is propagated from the SAPRequest node is in the DataObject domain. You cannot specify a different domain.
Message set Yes No   The name or identifier of the message set in which the incoming message is defined.
Message type No No   The name of the incoming message. The node detects the message type automatically. You cannot set this property.
Message format No No   The name of the physical format of the incoming message. You cannot set this property.
The SAPRequest node Transactionality properties are described in the following table.
Property M C Default Description
Transaction mode No No Automatic This property specifies how updates are handled. If you select Yes, updates are performed in a single transaction (coordinated message flows). If you select No, updates are performed independently (uncoordinated message flows).
The SAPRequest node Request properties are described in the following table.
Property M C Default Description
Method Location Yes No $LocalEnvironment/Adapter/MethodName The business method that is used to trigger the SAPRequest node to perform an action on the external system. For example:
  • createPurchaseOrder causes the SAPRequest node to create a purchase order in the EIS.
  • deletePurchaseOrder causes the SAPRequest node to delete a purchase order in the EIS.
Data Location Yes No $Body The location in the incoming message tree from which data is retrieved to form the request that is sent from the SAPRequest node to the EIS.
The SAPRequest node Result properties are described in the following table.
Property M C Default Description
Output data location No No $OutputRoot The message tree location to which the SAPRequest node sends output.
Copy local environment No No Selected Select this check box to copy the local environment.
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2007Copyright IBM Corporation 1999, 2007. All Rights Reserved.
This build: July 31, 2007 21:20:45

ac37300_ This topic's URL is: