IBInfo Class Properties
In this section, we discuss the IBInfo class properties. The properties are discussed in alphabetical order.
Important! Depending on the type of transaction and how it is executed by Integration Broker, certain properties may or may not be set on the IBInfo object. To determine which properties are available on the IBInfo object, check the Service Monitor first. If the information is not available there, it will not be available in the IBInfo object.
Description
This property can be used to set the application server domain for the connector, as a string.
This property is read/write.
Description
This property can be used to set a compression override for the transaction. This property takes three system constants to set the compression override:
|
Constant Value |
Description |
|---|---|
|
%IntBroker_Compress |
Turns compression on for this transaction. |
|
%IntBroker_UnCompress |
Turns compression off for this transaction. |
|
%IntBroker_Compress_Reset |
Resets compression to use the threshold specified by PSADMIN. |
The integration engine compresses and base64-encodes messages destined for the PeopleSoft listening connector on its local integration gateway.
Asynchronous messages are always compressed and base64 encoded when sent to the integration gateway.
For synchronous messages, in PSADMIN you can set a threshold message size above which messages are compressed. With the CompressionOverride property, you can override the message compression setting specified in PSADMIN at the transaction level.
Warning! Turning compression off can negatively impact system performance when transporting synchronous messages greater than 1 MB. As a result, you should turn off compression only during integration development and testing.
Note: This property does not affect the compression of messages that the integration gateway sends using its target connectors.
This property is read/write.
Example
&MSG.IBInfo.CompressionOverride = %IntBroker_UnCompress;Description
This property specifies whether the connector override is specified for the transaction. This property takes a Boolean value: true, override the connector properties, false otherwise.
For REST-based service operations, the LoadRESTHeaders method can be used without the need to explicitly set this property.
This property is read/write.
Description
This property returns the conversation ID associated with the request/response message transaction.
This property is read/write.
Description
This property sets or returns the delivery mode override for the connector as an integer. This property takes one of three system constants to set the delivery mode override:
|
Constant Value |
Description |
|---|---|
|
%IB_DM_BestEffort |
Sets the delivery mode to best effort. If the delivery mode is set to best effort, then only one attempt is made to send the message to the destination; there is no attempt to retry the message. |
|
%IB_DM_Guarantee |
Sets the delivery mode to guaranteed. This mode automatically invokes retry logic to ensure that the message is successfully sent to a destination. This is the default delivery mode. |
|
%IB_DM_Reset |
Resets the delivery mode to the value defined outside the PeopleCode program. |
This property is read/write.
Example
&int = &MSG.IBInfo.DeliveryMode = %IB_DM_BestEffort;Description
This property returns the name of the destination node that the request was sent to, as a string.
This property is read-only.
Description
This property returns the external ID of the message. This property is used in testing, and to resolve duplicate message issues from third-party systems.
This property is read-only.
Example
&str = &MSG.IBInfo.ExternalMessageID;Description
This property returns the external operation name of the message. This property is used in testing, and to resolve duplicate message issues from third-party systems.
This property is read/write.
Description
This property returns the external user name associated with the message. This property is used in testing, and to resolve duplicate message issues from third-party systems.
This property is read/write.
Description
This property returns the external user password associated with the message. This property is used in testing, and to resolve duplicate message issues from third-party systems.
This property is read/write.
Description
When the message is passed across several nodes, this property specifies the ultimate target of the message, as a string.
This property is read-only.
Description
Use this property to specify when, as a DateTime value, an actual publish of the transaction is to occur.
This property is for use with asynchronous transactions. If a null value or an invalid future date and time is specified, the publish will occur immediately.
This property is read/write.
Description
Use the HTTPSessionId property to specify the HTTP session ID, as a string.
This property is read/write.
Description
This property returns a reference to a IBConnectorInfo collection object.
This property is read-only.
Description
Use the InReplyToID property to specify the reply to ID contained in the message.
This property is read/write.
Description
This property references the name of the channel associated with the message definition, as a string.
Note: This property has been deprecated and remains for backward compatibility only. Use the IBInfo class MessageQueue property instead.
This property is set in when the message is created.
This property is read-only.
Related Links
Description
This property returns the name of the message, as a string.
This property is read-only.
Description
This property returns the name of the queue associated with the message, as a string.
This property is read-only.
Description
This property returns the type of the message, as a string.
Note: This property has been deprecated and remains for backward compatibility only. Use the IBInfo class OperationType property instead.
See OperationType.
Valid types are:
|
Value |
Description |
|---|---|
|
Sync |
Indicates that the message is synchronous. |
|
Async |
Indicates that the message is asynchronous. |
|
Ping |
Indicates that the message is used to test the application server to make sure it is available and accepting requests. |
This property is read-only.
Description
This property returns the message version as a number.
This property is read-only.
Description
For incoming requests, this property gives the distinguished name (DN) extracted from the certificate authentication process, as a string.
This property is read/write.
Description
This property returns the non-repudiation ID as a string. This property is populated with a unique string when the message is published.
This property is only valid with messages that use non-repudiation.
This property is read-only.
Related Links
Description
This property returns the number of attachments associated with a message.
This property is read-only.
Description
This property returns the type of the operation, as a string.
This property is read-only.
Description
This property returns the version of the operation, as a string.
This property is read-only.
Description
For requests that cross multiple nodes, this property identifies the node that initiated the request as a string.
The OrigNode property returns the originating node of the message. If the message is not going across nodes, the OrigNode and SoureNode properties return the same value. However, if the message is going across nodes, the source node is the node that most recently published the message.
For example, if A publishes to B, then B publishes the message to C, from C's perspective, A is the original node and B is the source node.
This property is read-only.
Description
This property returns the name of the process where the publish originated, as a string. For example, a message published from the Inventory definitions page would have a process name of INVENTORY DEFIN.
This property is read-only.
Description
This property returns the time stamp that corresponds to the time that the request was created, as a string. For requests that cross nodes, this is the time that the first request was created.
This property is read-only.
Description
This property returns the user ID login where the message was initially generated, as a string.
This property is read-only.
Description
This property returns the unique identifier for the message, as a string.
Note: This property has been deprecated. It is no longer supported.
Description
This property returns the name of the node making the request, as a string.
This property is read/write.
Description
This property returns the description of the node making the request, as a string.
This property is read/write.
Description
Use the ResponseAsAttachment property to specify whether the response should be returned as an attachment or inline.
This property is read/write.
Description
The SegmentUnOrder property is only applicable for asynchronous messages. If you specify the SegmentUnOrder property as true, the receiving node processes the segments in parallel.
This property is read/write.
Description
This property returns the name of the publishing node as a string.
The OrigNode property returns the originating node of the message. If the message is not going across nodes, the OrigNode and SoureNode properties return the same value. However, if the message is going across nodes, the source node is the node that most recently published the message.
For example, if A publishes to B, then B publishes the message to C, from C's perspective, A is the original node and B is the source node.
This property is read-only.
Description
This property takes a time (in seconds). This time overrides the default HTTP timeout that is used for all requests. If you set this property, you can use this to read back the time, that is, set the time before the SyncRequest is executed, then see when it is changed in an implementation of the OnSend method.
Note: This property is only for synchronous requests.
Generally, you use SyncServiceTimeout to dynamically set the timeout value for a specific transaction. The http header file is modified to take this new parameter. In addition this value is sent to the gateway to be used for the http timeout. Use this so that a long running transaction will not timeout. In addition, you don't have to wait through the default period for a specific transaction to timeout.
The following is a typical example of using this property:
&MSG.SetXmlDoc(&xmlReq);
&MSG.IBInfo.LoadConnectorPropFromNode(Node.EAI)
&MSG.IBInfo.SyncServiceTimeout = 360000;
&MSG.IBInfo.ConnectorOverride = true;
&MSG_Resp = SyncRequest(&MSG, Node.EAI);
&xmlResponseDoc = &MSG.GetXmlDoc();
Setting the XML directly is not valid. You need to use the message object to set the value. In order for this to work you must override the connector properties, which means you must set up the connector properties for this transaction, using one of the load methods (such as LoadConnectorPropFromNode, LoadConnectorPropFromTrx, and so on.)
This property is read/write.
Description
This property returns the transaction ID as a string. This is used to uniquely identify a request.
This property is read-only.
Description
This property returns the user name associated with the message, as a string.
This property is read-only.
Description
This property returns an array of string containing the names of all the nodes visited by the message. This is useful when a message is being propagated across multiple nodes.
This property is read-only.
Description
Use this property to specify the Web Services Addressing (WS-Addressing) action for the message. The WS-Addressing action is defined as a string.
This property is read/write.
Description
Use this property to specify the WS-Addressing fault end point for the message. The WS-Addressing fault end point is defined as a string.
If this property is not null, a message ID (the WSA_MessageID property) must also be defined.
This property is read/write.
Description
Use this property to specify the WS-Addressing message ID for the message. The WS-Addressing message ID is defined as a string.
This property is read/write.
Description
Use this property to specify the WS-Addressing reply-to address for the message. The WS-Addressing reply-to address is defined as a string.
This property is read/write.
Description
Use this property to specify the WS-Addressing destination for the message. The WS-Addressing destination is defined as a string.
This property is read/write.