PeopleSoftInput node

Use the PeopleSoftInput node to interact with a PeopleSoft application.

The PeopleSoftInput 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 PeopleSoftInput node to interact with PeopleSoft applications. For example, a PeopleSoftInput node monitors a PeopleSoft system for a specified event. When that event occurs, the PeopleSoftInput node generates a message tree that represents the business object with the new event details. The message tree is propagated to the Out terminal so that the rest of the message flow can use the data to update other systems, or audit the changes.

The PeopleSoftInput 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:

PeopleSoftInput node icon

Using this node in a message flow

To function correctly, the PeopleSoftInput 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 PeopleSoftInput 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 PeopleSoftInput node populates the route to label destination list with the name of the method binding. If you add a RouteToLabel node to the message flow after the PeopleSoftInput node, the RouteToLabel node can use the name of the method binding to route the message to the correct part of the message flow for processing.

You can deploy only one input node that uses a particular adapter component to an integration server, but you can deploy many input nodes that use different adapter components 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::PeopleSoftCustomerInbound.inadapter -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 PeopleSoftInput 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 PeopleSoftInput 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 PeopleSoftInput node terminals are described in the following table.

Terminal	Description
Out	Business object events from the adapter are sent to the Out terminal.
Failure	If an error happens in the PeopleSoftInput 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.
Catch	Business object events are sent to the Catch terminal if they cause an uncaught exception in the message flow. If the Catch terminal is not connected, the retry process is activated to handle the business object.

The following table describes the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk 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 PeopleSoftInput node Description properties are described in the following table.

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

Property	M	C	Default	Description	mqsiapplybaroverride command property
Primary adapter component	Yes	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 the PeopleSoftInput node receives data from the PeopleSoft system, it associates that data with a method name, depending on the service operation name that is assigned to that type of data when you run the Adapter Connection wizard. The PeopleSoftInput node attempts to handle methods that are defined in the primary adapter. If the type of data that is received does not correspond to any of the methods that are defined in the primary adapter, the node can handle 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	adapterComponent
Secondary adapter mode	No	Yes	None	Specifies whether the node can handle methods that are defined in secondary adapters. If you set the Secondary adapter mode property to None, the node handles only methods that are defined in the primary adapter. If the type of data that is received does not correspond to any of the methods that are defined in the primary adapter, a failure occurs. If you set this property to All adapters in application, the node can handle methods that are defined in any PeopleSoft inbound adapters that are 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 inbound adapter that is also deployed as an independent resource.	secondaryAdapterMode

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 the PeopleSoftInput node receives data from the PeopleSoft system, it associates that data with a method name, depending on the service operation name that is assigned to that type of data when you run the Adapter Connection wizard. The PeopleSoftInput node attempts to handle methods that are defined in the primary adapter. If the type of data that is received does not correspond to any of the methods that are defined in the primary adapter, the node can handle 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

adapterComponent

Secondary adapter mode

Yes

None

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

If you set the Secondary adapter mode property to None, the node handles only methods that are defined in the primary adapter. If the type of data that is received does not correspond to any of the methods that are defined in the primary adapter, a failure occurs.

If you set this property to All adapters in application, the node can handle methods that are defined in any PeopleSoft inbound adapters that are 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 inbound adapter that is also deployed as an independent resource.

secondaryAdapterMode

The PeopleSoftInput node Routing properties are described in the following table.

Property	M	C	Default	Description
Set destination list	No	No	Selected	This property specifies whether to add the method binding name to the route to label destination list. If you select this check box, the method binding name is added so that you can use a RouteToLabel node in the message flow after the PeopleSoftInput node.
Label prefix	No	No		The prefix to add to the method name when routing to label. Add a label prefix to avoid a clash of corresponding label nodes when you include multiple WebSphere® Adapters input nodes in the same message flow. By default, there is no label prefix, so the method name and label name are identical.

The PeopleSoftInput node Input 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 PeopleSoftInput 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 incoming 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 incoming 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 incoming message. You cannot set this property.

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

Property	M	C	Default	Description
Transaction mode	No		Yes	The transaction mode on this input node determines whether the rest of the nodes in the flow operate under sync point.

The Instances properties of the PeopleSoftInput node are described in the following table. For a full description of these properties, refer to Configurable properties in a BAR file.

Property	M	C	Default	Description	mqsiapplybaroverride command property
Additional instances pool	No	Yes	Use Pool Associated with Message Flow	The pool from which additional instances are obtained. If you select Use Pool Associated with Message Flow, additional instances are obtained from the message flow value. If you select Use Pool Associated with Node, additional instances are allocated from the node's additional instances based on the number specified in the Additional instances property.	componentLevel
Additional instances	No	Yes	0	The number of additional instances that the node can start if the Additional instances pool property is set to Use Pool Associated with Node. By default, no additional instances are given to the node.	additionalInstances

The PeopleSoftInput node Retry properties are described in the following table.

Property	M	C	Default	Description	mqsiapplybaroverride command property
Retry mechanism	No	No	Failure	This property specifies how retry processing is handled when a failure is rolled back to the PeopleSoftInput node. If you select Failure, retry processing is not performed so you cannot set the remaining properties. If you select Short and long retry, retry processing is performed first at the interval that is specified by the Short retry interval property, and if that is unsuccessful, it is then performed at the interval that is specified by the Long retry interval property.
Retry threshold	No	Yes	0	The maximum number of times that retry processing is performed for short retry.	retryThreshold
Short retry interval	No	Yes	0	The interval between short retry attempts.	shortRetryInterval
Long retry interval	No	Yes	0	The interval between long retry attempts.	longRetryInterval

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.