PeopleSoftRequest node

Use the PeopleSoftRequest node to interact with a PeopleSoft application.

The PeopleSoftRequest node is available in the following operation modes:

Developer
Application Integration Suite
Standard
Advanced
Scale
Adapter

For more information, see Operation modes.

This topic contains the following sections:

Purpose
Using this node in a message flow
Terminals and properties

Purpose

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

The PeopleSoftRequest node is contained in the WebSphere Adapters drawer of the message flow node palette, and is represented in the IBM® Integration Toolkit by the following icon:

Using this node in a message flow

To function correctly, the PeopleSoftRequest 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 PeopleSoftRequest 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.

To maximize performance and avoid unnecessary data conversion, ensure that messages that are passed to the PeopleSoftRequest node contain the correct data types. The DataObject domain is the default domain when parsing messages that are produced by the PeopleSoftRequest node. However, when passing data to the PeopleSoftRequest node (for example, by using an MQInput node), the use of a different domain can improve performance. For example, use the XMLNSC parser with the MQInput node to parse XML messages.

The PeopleSoftRequest node supports local transactions using the integration node Local Transaction Manager, and global transactions using the integration node external syncpoint coordinator.

To effectively maintain the pool of connections to PeopleSoft, you can set a connection timeout value on a configurable service. For more information, see Configuring EIS connections to expire after a specified time.

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

You can use the mqsisetdbparms command in the following format to configure an account name with a user name and password for the Adapter for PeopleSoft Enterprise.

mqsisetdbparms integrationNodeName -n adapter name -u user name -p password

For example:

mqsisetdbparms BRK1 -n eis::PeopleSoftCustomerOutbound.outadapter -u peoplesoftuid -p ********

Using configurable services for PeopleSoft nodes

PeopleSoft nodes can get PeopleSoft connection details from either the adapter component or a configurable service. By using a configurable service, you can change the connection details for an adapter without the need to redeploy the adapter. For more details about creating, changing, reporting, and deleting the configurable services for PeopleSoft, see Changing connection details for PeopleSoft adapters.

Terminals and properties

When you have put an instance of the PeopleSoftRequest node into a message flow, you can configure it; see Configuring a message flow node. The properties of the node are displayed in the Properties view. If you double-click a PeopleSoftRequest node, you open the Adapter Connection wizard. All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk.

The PeopleSoftRequest 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 response business object is sent if it represents successful completion of the request, and if further processing is required within this message flow.
Failure	If an error happens in the PeopleSoftRequest node, the message is propagated to the Failure terminal. Information about the error, and business object events can also be propagated to the Failure terminal.

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 PeopleSoftRequest node Description properties are described in the following table.

Property	M	C	Default	Description
Node name	No	No	The node type, PeopleSoftRequest	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 PeopleSoftRequest node Basic properties are described in the following table.

Property	M	C	Default	Description	mqsiapplybaroverride command property
Primary 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. When thePeopleSoftRequest node receives data from the PeopleSoft system, it associates that data with a method name. The PeopleSoftRequest node attempts to call methods that are defined in the primary adapter. If the method is not defined in the primary adapter, the node can call methods that are defined in matching secondary adapters that are deployed to the same integration server. Note: You can override the properties in the adapter file at run time by creating a PeopleSoftConnection configurable service that has the same name as the adapter file. For more information see Changing connection details for PeopleSoft adapters
Secondary adapter mode	No	Yes	None	Specifies whether the node can call methods that are defined in secondary adapters. If you set the Secondary adapter mode property to None, the PeopleSoftRequest node calls only methods that are defined in the primary adapter. If the method is not defined in the primary adapter, an error occurs. If you set this property to All adapters in application, the node can call methods that are defined in any PeopleSoft outbound adapter that is deployed to the same application. If the node is deployed as an independent resource (that is, it is not contained within an application), the node can call methods that are defined in any PeopleSoft outbound adapter that is also deployed as an independent resource.	secondaryAdapterMode
Default method	Yes	Yes		The default method binding to use.	defaultMethod

Property

Default

Description

mqsiapplybaroverride command property

Primary adapter component

Yes

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.

When thePeopleSoftRequest node receives data from the PeopleSoft system, it associates that data with a method name. The PeopleSoftRequest node attempts to call methods that are defined in the primary adapter. If the method is not defined in the primary adapter, the node can call methods that are defined in matching secondary adapters that are deployed to the same integration server.

Note: You can override the properties in the adapter file at run time by creating a PeopleSoftConnection configurable service that has the same name as the adapter file. For more information see Changing connection details for PeopleSoft adapters

Secondary adapter mode

Yes

None

Specifies whether the node can call methods that are defined in secondary adapters.

If you set the Secondary adapter mode property to None, the PeopleSoftRequest node calls only methods that are defined in the primary adapter. If the method is not defined in the primary adapter, an error occurs.

If you set this property to All adapters in application, the node can call methods that are defined in any PeopleSoft outbound adapter that is deployed to the same application. If the node is deployed as an independent resource (that is, it is not contained within an application), the node can call methods that are defined in any PeopleSoft outbound adapter that is also deployed as an independent resource.

secondaryAdapterMode

Default method

Yes

The default method binding to use.

defaultMethod

The PeopleSoftRequest 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 response message. By default, the response message that is propagated from the PeopleSoftRequest node is in the DataObject domain. You cannot specify a different domain.
Message model	Yes	No	Set automatically	The name or location of the message model schema file in which the response message is defined. This field is set automatically from the Adapter component property. If you set this property, then subsequently update the project dependencies to remove this message model reference, a warning is issued. Either update the Message model property, or restore the reference to this message model.
Message	No	No		The name of the response message. The node detects the message type automatically. You cannot set this property.
Physical format	No	No		The name of the physical format of the response message. You cannot set this property.

The PeopleSoftRequest node Transactionality properties are described in the following table.

Property	M	C	Default	Description
Transaction mode	No	No	No	This property specifies that updates are performed independently, not as part of a local transaction. You cannot change this property.

The PeopleSoftRequest node Request properties are described in the following table.

Property	M	C	Default	Description
Method Location	Yes	No	$LocalEnvironment/Adapter/MethodName	The location of the business method (such as createPurchaseOrder or deletePurchaseOrder) that is used to trigger the PeopleSoftRequest node to perform an action on the external system.
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 PeopleSoftRequest node to the EIS.

The PeopleSoftRequest 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 PeopleSoftRequest node sends output.
Copy local environment	No	No	Selected	This property controls how the local environment is copied to the output message. If you select the check box, at each node in the message flow, a new copy of the local environment is created in the tree, and it is populated with the contents of the local environment from the preceding node. So if a node changes the local environment, the upstream nodes do not see those changes because they have their own copies. This behavior might be an issue if you are using a FlowOrder node, or if you use the propagate command on a Compute node. If you clear the check box, each node does not generate its own copy of the local environment, but it uses the local environment that is passed to it by the previous node. So if a node changes the local environment, those changes are seen by the upstream nodes.

The Monitoring properties of the node are described in the following table.

Property	M	C	Default	Description
Events	No	No	None	Events that you have defined for the node are displayed on this tab. By default, no monitoring events are defined on any node in a message flow. Use Add, Edit, and Delete to create, change or delete monitoring events for the node; see Configuring monitoring event sources by using monitoring properties for details. You can enable and disable events that are shown here by selecting or clearing the Enabled check box.