This task describes how to set the environment map properties of the PeopleSoft Adapter.
The PeopleSoft HTTP Client Adapter properties, accessed from the Environment Explorer tree, are organized into the following sections:
The HTTP Settings section of the PeopleSoft HTTP Client Adapter Environment properties contains the top-level parameters displayed in the following table.
Table 5 Environment Configuration - HTTP Settings
The Proxy configuration section of the PeopleSoft HTTP Client Adapter Environment properties contains the top-level parameters displayed in the following table.
Table 6 Environment Configuration - Proxy configuration
Name |
Description |
Required Value |
---|---|---|
Proxy host |
Specifies the hostname of the HTTP proxy server. |
The hostname (string) of the HTTP proxy server. |
Proxy port |
Specifies the port of the HTTP proxy host. |
The port number of the HTTP proxy server. The configured default is 8080. |
Proxy username |
Specifies the username for accessing the HTTP proxy server. |
A user name (login) for the HTTP proxy server. |
Proxy password |
Specifies the password required for accessing the HTTP proxy host. |
A password for the HTTP proxy server. |
The Security and Authentication section of the PeopleSoft HTTP Client Adapter Environment properties contains the top-level parameters displayed in the following table.
Table 7 Environment Configuration - Security and Authentication
Name |
Description |
Required Value |
---|---|---|
Http username |
Specifies the username used to authenticate the Web site specified by the URL. |
A user name with access permission. |
Http password |
Specifies the password used to authenticate the Web site specified by the URL. |
A password linked to the user name. |
The Security and SSL section of the PeopleSoft HTTP Client Adapter Environment properties contains the top-level parameters displayed in the following table.
SSL is not currently supported for the PeopleSoft Adapter. This section is reserved for future product enhancement.
Name |
Description |
Required Value |
---|---|---|
Protocol SSL |
Specifies the Secure Sockets Layer (SSL) or Transport Layer Security (TLS) protocol used when establishing an SSL connection with the server. |
Select the appropriate protocol. The options are:
The configured default is No SSL. |
JSSE Provider Class |
Specifies the fully qualified name of the JSSE provider class. |
The name of the JSSE provider class. The configured default value is com.sun.net.ssl.internal.ssl.Provider. |
X509 Algorithm Name |
Specifies the X509 algorithm name to use for the trust and key manager factories. |
The X509 algorithm name to use for the trust and key manager factories. The configured default is SunX509. |
Verify hostname |
Specifies whether hostname verification is done on the server certificate during the SSL handshake. |
True or False. True indicates that hostname verification is performed on the server certificate during the SSL handshake. The configured default is False. |
KeyStore type |
Specifies the keystore type for the keystore used for key/certificate management when establishing SSL connections. |
The keystore type. The configured default is JKS. |
KeyStore |
Specifies the keystore used for key/certificate management when establishing SSL connections. |
The keystore used for key/certificate management. |
Keystore username |
Specifies a username for accessing the keystore used for key/certificate management when establishing SSL connections. |
A user name (login) with permission to access the keystore. |
Keystore password |
Specifies the password for accessing the keystore used for key/certificate management when establishing SSL connections. |
A password associated with the KeyStore username to access the keystore. |
TrustStore type |
Specifies the truststore type of the truststore used for CA certificate management when establishing SSL connections. |
The truststore type. The configured default is JKS. |
TrustStore |
Specifies the truststore used for CA certificate management when establishing SSL connections. |
The name of the truststore. |
TrustStore password |
Specifies the password for accessing the truststore used for CA certificate management when establishing SSL connections. |
A password that permits access to the truststore. |
The PeopleSoft Settings section of the PeopleSoft HTTP Client Adapter Environment properties contains the top-level parameters displayed in the following table.
Table 9 Environment Configuration - PeopleSoft Settings
Name |
Description |
Required Value |
---|---|---|
PeopleTools Version |
Specifies the version of PeopleTools installed. The value options are:
|
Select 8.13 or 8.42. The configured default is 8.42. |
The PeopleSoft Settings and PeopleTools 8.42 Settings section of the PeopleSoft HTTP Client Adapter Environment properties contains the top-level parameters displayed in the following table.
The PeopleTools settings must match the configurations for the PeopleSoft server.
At minimum, you must specify the following properties:
MessageName
DestinationNode
RequestingNode
MessageVersion
Name |
Description |
Required Value |
---|---|---|
MessageName |
Specifies the name of the message. |
The name of the message. |
MessageType |
Specifies the type of message being sent. The type options are:
|
Select sync, async, or ping. |
RequestingNode |
Specifies the name of the node sending the request. |
The name of the node sending the request. |
DestinationNode |
Specifies the name of the node that receives the message. This parameter is optional when you specified a default target node using the Default Application Server Jolt connect string properties in the integrationGateway.properties file. |
The name of the node that receives the message. |
FinalDestina-tion |
Specifies the name of the node that ultimately receives the message. This is common when a PeopleSoft Integration Broker hub is used. |
The name of the node that ultimately receives the message. |
MessageVersion |
Specifies the message version. |
The message version. |
NonRepudiation |
Specifies whether the message content in the request should be processed using nonrepudiation logic. |
True or False. True indicates that nonrepudiation logic will be used to process the message content of the request. |
OrigNode |
Specifies the name of the node that started the process. This property is optional. |
The name of the node that started the process. |
OrigProcess |
Specifies the originating process by which the message was initially generated. |
The originating process by which the message was initially generated. |
OrigUser |
Specifies the user ID for the user from which the message was initially generated. This property is optional. |
The user ID for the user from which the message was initially generated. |
Password |
Specifies the password as entered in the target node’s definition for the source node. The target node authenticates the password when it receives the message. This parameter is only required if password authentication is enabled for the source node definition in the target database. |
The password, as it is presented in the target node’s definition for the source node. |
The PeopleSoft Settings and PeopleTools 8.13 Settings section of the PeopleSoft HTTP Client Adapter Environment properties contains the top-level parameters displayed in the following table.
The PeopleTools settings must match the configurations for the PeopleSoft server.
At minimum, you must specify the following properties:
MessageVersion
FromNode
ToNode
Channel
PublicationProcess
Subject
Name |
Description |
Required Value |
---|---|---|
MessageVersion |
Specifies the message version. |
The message version. |
ToNode |
Specifies the name of the node for which the message is intended. This must correspond to an entry in the node lookup table on the gateway servlet, and the name of the local node (node definition) on the receiving PeopleSoft system. |
The name of the node for which the message is intended. |
FromNode |
Specifies the name of the node from which messages originate. The node name must match the node definition for the third party system as defined in the receiving PeopleSoft system. |
The name of the node from which the messages originate. |
Channel |
Specifies the name of the message channel containing the message. |
The name of the message channel. |
PublicationProcess |
Specifies the application-defined name of the program that generated the message. This may be required by the application. |
The application-defined name of the program that generated the message. |
Password |
Specifies the password associated with the destination node. This value is stored in the PeopleSoft database and must be communicated to the system administrators for the publishing system. If the node definition on the sending system has a node group defined, the password will be present. If the node definition on the receiving system has a node group defined, the password must be present and must match the node group password. |
The password associated with the destination node. |
DefaultDataVersion |
Specifies the default message version for the sending system. |
The default message version. |
OriginatingNode |
Specifies the name of the node that originally published the message. This property is used to prevent circular publishing. If not in the XML file, the system sets it to the publishing node name. |
The name of the node that originally published the message. |
PublicationID |
Specifies the system generated identifier for the publication. The fields, FromNode, Channel, and PublicationID, uniquely identify the publication. If the FromNode is specified and the Publication ID is omitted, the publication ID is set to the next available publication ID on that channel within the subscribing PeopleSoft database. |
The system generated identifier for the publication. |
Publisher |
Specifies the application-defined operator ID class that published the message. This may be required by the application. |
The application-defined operator ID class that published the message. |
SubChannel |
Specifies the name of the subchannel that contains the message. Messages in the same channel, but in different subchannels, are assumed to refer to distinct objects (for example, different POs or different employees), and are processed in parallel if possible. This field contains the concatenated values that represent the subchannel. For example, if the subchannel is Business Unit, Journal ID, then the value of this field is M04123456789 where Business Unit = M04 and Journal ID = 123456789. Include this field if the subscribing PeopleSoft system has a defined subchannel, otherwise, it may be omitted. |
The name of the subchannel that contains the message. See the description for the naming format. |
Subject |
Specifies the name of the message as defined in the PeopleSoft system. |
The name of the message as defined in the PeopleSoft system. |
SubjectDetail |
Specifies the application defined subtype of the message name. |
The application defined subtype of the message name. |