Integration Broker Message Structures

IBRequest Header Section

The first part of a request message contains headers which describe the attributes of the whole message.

Message-ID: <-123.123.123.123@nowhere >
Mime-Version: 1.0
Content-Type: multipart/related; boundary="Integration_Server_MIME_Boundary"
Content-ID: PeopleSoft-Internal-Mime-Message
PeopleSoft-ToolsRelease: 8.55

--Integration_Server_MIME_Boundary
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID: IBInfo
Content-Disposition: inline

IBRequest IBInfo Section

The following example shows an IBInfo section for a request message that was sent from the application server to the integration gateway (formatted for easier reading):

<?xml version="1.0" ?> 
  <IBInfo>
   <TransactionID>
     <![CDATA[ caa3a040-bde5-11da-914c-ecaede80d83b]]> 
  </TransactionID>
  <ExternalOperationName>
  <![CDATA[ QE_FLIGHTPLAN_TRANSFORM.VERSION_1]]> 
  </ExternalOperationName>
  <OperationType>async</OperationType> 
  <From>
    <RequestingNode>
       <![CDATA[ QE_LOCAL]]> 
    </RequestingNode>
    <RequestingNodeDescription>
       <![CDATA[ ]]> 
    </RequestingNodeDescription>
    <NodePassword>
       <![CDATA[ password]]> 
    </NodePassword>
    <ExternalUserName>
    <![CDATA[ ]]> 
    </ExternalUserName>
    <ExternalUserPassword>
    <![CDATA[ ]]> 
    </ExternalUserPassword>
    <AuthToken>
       <![CDATA[ owAAAAQDAgEBAAAAvAIAAAAAAAAsAAAABABTaGRyAk4AbQg4AC4AMQ
        AwABTFZOonLEjJaPtR6v02oadvRUoSq2MAAAAFAFNkYXRhV3icHYhNDkAwGERfEQ
        srFyFN0cZSaGz8xAmcwA0dzug3yZv53gMUeWaM+s1IV11EFnZOysjBSv2bm01mZl
        L3Dqt4GrETHSHtQCs6cWBM2ybr9fMBbP0LSQ==]]> 
    </AuthToken>
    <WSA-ReplyTo>
       <![CDATA[ ]]> 
    </WSA-ReplyTo>
    <NodeDN>
       <![CDATA[ ]]> 
    </NodeDN>
    <OrigUser>
       <![CDATA[ QEDMO]]> 
    </OrigUser>
    <OrigNode>
       <![CDATA[ QE_LOCAL]]> 
    </OrigNode>
    <OrigProcess>
       <![CDATA[ QE_FLIGHTDATA]]> 
    </OrigProcess>
    <OrigTimeStamp>2006-03-27T15:02:39.280000-0800</OrigTimeStamp> 
    <DirectGatewayRequest /> 
    <SyncServiceTimeout /> 
    <ExternalMessageID>
       <![CDATA[ ]]> 
    </ExternalMessageID>
    <SegmentsUnOrder>N
    </SegmentsUnOrder> 
    <ConversationID>
       <![CDATA[ ]]> 
    </ConversationID>
    <WSA-MessageID>
       <![CDATA[ ]]> 
    </WSA-MessageID>
    <InReplyToID>
       <![CDATA[ ]]> 
    </InReplyToID>
    <DataChunk>
       <![CDATA[ ]]> 
    </DataChunk>
    <DataChunkCount>
       <![CDATA[ ]]> 
    </DataChunkCount>
    </From>
    <WS-Security>
      <WSTokenType>
         <![CDATA[ ]]> 
      </WSTokenType>
    </WS-Security>
    <To>
      <DestinationNode>
          <![CDATA[ QE_IBTGT]]> 
      </DestinationNode>
      <FinalDestinationNode>
         <![CDATA[ ]]> 
      </FinalDestinationNode>
      <AppServerDomain>
         <![CDATA[ ]]> 
      </AppServerDomain>
    </To>
    <Cookies>
       <![CDATA[ ]]> 
    </Cookies>
    <PathInfo>
       <![CDATA[ ]]> 
    </PathInfo>
    <HttpSession>
      <SessionID>
         <![CDATA[ ]]> 
      </SessionID>
    </HttpSession>
    <QStrArgs /> 
    <ContentSections>
       <ContentSection>
          <ID>ContentSection0</ID> 
          <NonRepudiation>N</NonRepudiation> 
          <Headers>
            <version>
               <![CDATA[ VERSION_1]]> 
            </version>
            <encoding>
               <![CDATA[ base64(deflate)]]> 
            </encoding>
            <encodedlength>
               <![CDATA[ 948(709)]]> 
            </encodedlength>
            <length>
               <![CDATA[ 2840]]> 
            </length>
          </Headers>
       </ContentSection>
     </ContentSections>
    <PublishNode>
       <![CDATA[ QE_LOCAL]]> 
    </PublishNode>
    <Queue>
       <![CDATA[ QE_FLIGHTPLAN_CHNL]]> 
    </Queue>
    <SubQueue>
       <![CDATA[ c9de8110-bde5-11da-be79-846b4e717ebf]]> 
    </SubQueue>
    <VisitedNodes>
       <![CDATA[ QE_LOCAL|]]> 
    </VisitedNodes>
    <Connector>
       <ConnectorName>
          <![CDATA[ PSFTTARGET]]> 
       </ConnectorName>
       <ConnectorClassName>
          <![CDATA[ PeopleSoftTargetConnector]]> 
       </ConnectorClassName>
       <RemoteFrameworkURL>
          <![CDATA[ ]]> 
       </RemoteFrameworkURL>
       <ConnectorParameters>
          <ConnectorParam>
             <Name>
               <![CDATA[ URL]]> 
             </Name>
             <Value>
                <![CDATA[ ]]> 
             </Value>
          </ConnectorParam>
       </ConnectorParameters>
      <ConnectorHeaders /> 
   </Connector>
  <AttachmentSection ResponseAsAttachment="N" /> 
</IBInfo>

While the basic structure is the same for all requests, not all elements are always required. An example of this is the Connector section. The Connector XML is used to tell the integration gateway to route a message to the named target connector. It also lists configuration parameters for the outbound request. This XML would only be seen in requests sent from the application server to the integration gateway. For requests going in the other direction, the section would be empty.

The following is a list of the most important elements that may appear in the IBInfo section of a request message:

IBRequest Content Section

The content section of a request message features the message body.

--Integration_Server_MIME_Boundary
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID: ContentSection0
Content-Disposition: inline
eJydll1P2zAUhu8n7T+g/gAKFdt6UYxOHCe1FH9gO1RwE1UMTUiMTRRN27+fk7SpvwItd/F5
eJydll1P2zAUhu8n7T+7c TvG+c5WVz9/fl08ufhZfP46/lycn56NrlCnz8trklTVLRcGlkBb
4wCrguhGFoUjw9P382/3w TvG+8btJ+Ug4GT+6f1ZnM5UZNOAMxrlhF18mrnXk76wWTaaUzTRh
OuxU7FS9hpopBxEbC5lSSuY6gqtJ+Ug4GT+TUseK/q6hlyJhIIFY+fp8iwuE8yCYk40VpXgZVC
feml0i1eSN1IRTYw+Ih1twFDBG569KUuhU/KKgBQ8HVdR37VGeUHDzW9FIdtbx9oK1JJAnnDsWO
xmcrihZbfBIxyv4FYKys2Y5YyAolHgVrDHskz4hMpQU+cJpYJRxb7REam1nnz8DakEpoYSHWs2i
PakJCLbR7T1kIPaZnhEZv0yTSqCnXcWT2z4hMpQU+EiZalfLSQZ0TNQGkPiJHQLR2I3pYFU3V5y
TqrWX/yq7iirzTIWpCoS2blh9esVA0b4Mcm9831BORIJTWy//9q0JDg8AlNnc2ghbZrMQ6TFalnb
uBocflZQ59S0yAvjz0C3J3hsHdOlPQ/XFkLhUZVKYKJ1Q7n1zjGJbMs6q6heNqquSEMTN+Y2Em69
hCZ7X/bCbQts8yNfv67Rwrysnzfr+1fbWg5rFmj1Q7n1zjGJbMs6q6heNqquSEMTN++bT
7ro9tV/H6B7C1UN8GpbdsGmp9eXHRaO9i3DVScz7f37IZue0Bfv1z0DxwqQ49AGXRKPxh6BMrwU
J7tegSyiRRduR3se8TAgrehiBKmXSh6GHTQ5+POR1yANQ9lIb48ZH0YUykXAaYCMKVg5AEoh
J7tegSyiRRduR3se8TAgrehiBKmXSh6GHTQ5+I4LmhAuHlAGiHwQHCkvDjhcVAx4iJAwPfAv4KCHOX0
/7PRRdw87utfFU53bp1X4K/MmvRDh5WLqFhyCJajVz4+qLr4SyEJnFjZhLeSWzyqPTx6KpgOh9k6D
/9z/1gQ1Ww==

IBResponse Header

The first part of a response message contains headers which describe the attributes of the whole message.

Message-ID: <32004392.1143500580241.JavaMail.KCOLLIN2@PLE-KCOLLIN2>
Date: Mon, 27 Mar 2006 15:03:00 -0800 (PST)
Mime-Version: 1.0
Content-Type: multipart/related; 
	boundary="----=_Part_4_9069393.1143500580221"
Content-ID: PeopleSoft-Integration-Broker-Internal-Mime-Message
PeopleSoft-ToolsRelease: 8.55

IBResponse IBInfo Section

The format for the XML for the IBInfo for a response message is different than that for the request message. The following is a sample (formatted for easier reading):

<?xml version="1.0"?>
<IBInfo>
   <Status>
      <StatusCode>0</StatusCode>
      <MsgSet>158</MsgSet>
      <MsgID>10000</MsgID>
      <DefaultMsg>OK</DefaultMsg>
      <DefaultTitle>Integration Broker Response Message</DefaultTitle>  
   </Status>  
   <ContentSections>
      <ContentSection>
      <ID>ContentSection0</ID>
      <NonRepudiation>N</NonRepudiation>
      </ContentSection>
   </ContentSections>
</IBInfo>

The following is the list of all the elements that may be present in the IBInfo for a response message:

IBResponse Content Section

The content section of a response message features the message body only when working with SyncRequests

<?xml version="1.0"?>
<TestXml>This is a sample response message.</TestXml>

Error Codes and Message Catalog Entries

A response message may contain data relating to the processing of the request message, or it may contain error information if there were problems in fulfilling the request.

The status code describes the nature of the response message. The following table describes possible request message status codes and their meaning.

All PeopleSoft Integration Broker error messages are stored in the message catalog. A short and long description for every error can be found there. Catalog entries are given a number, and this number is used in the response messages.

Here is a sample error message:

Message-ID: <32004392.1143500580241.JavaMail.KCOLLIN2@PLE-KCOLLIN2>
Date: Mon, 27 Mar 2006 15:03:00 -0800 (PST)
Mime-Version: 1.0
Content-Type: multipart/related; 
	boundary="----=_Part_4_9069393.1143500580221"
Content-ID: PeopleSoft-Integration-Broker-Internal-Mime-Message
PeopleSoft-ToolsRelease: 8.55

------=_Part_25_2235074.1008270392277
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-Disposition: inline
Content-ID: IBInfo

<?xml version="1.0"?><IBInfo><Status><StatusCode>10</StatusCode>
<MsgSet>158</MsgSet><MsgID>10721</MsgID><Parameters count="1"><Parm>404</Parm></Parameters>
<DefaultTitle>Integration Gateway Error</DefaultTitle></Status></IBInfo>
------=_Part_25_2235074.1008270392277--

All PeopleSoft Integration Broker errors use message set 158. The actual error seen here is 10721. Going to the message catalog, the description for message set 158, error 10721 is:

Message Text: Integration Gateway - External System Contact Error

Explanation: Integration Gateway was not able to contact the external system.  
The network location specified may be incorrect, or the site is permanently 
or temporarily down.

Therefore this error was created by the integration gateway when it tried to send a request message to an external system.

Understanding Local Compression

The integration engine compresses and base64–encodes messages destined for the PeopleSoft listening connector on its local integration gateway.

Setting Local Compression for Asynchronous Messages

Asynchronous messages are always compressed and base64 encoded when sent to the integration gateway. There are no settings you need to make.

Setting Local Compression for Synchronous Messages

In PSAdmin you can set a threshold message size above which the system compresses synchronous messages. The setting is shown here:

Values for config section - Integration Broker
    Min Message Size For Compression=10000

Do you want to change any values (y/n)? [n]:

The value is the message size in bytes; the default value is 10000 (10 kilobytes). You can specify a setting of 0 to compress all messages.

To turn off compression, set the value to -1.

Overridding Local Compression for Synchronous Messages

You can override the PSAdmin message compression setting for synchronous messages at the transaction level. The following method on the IBInfo object in the Message class is provided for this purpose:

&MSG.IBInfo.CompressionOverride

The valid parameters for this method are: %IntBroker_Compress, %IntBroker_UnCompress, and %IntBroker_Compress_Reset.

See .Understanding Message Classes