DownstreamMessagePushDefinition for SOAP

DownstreamMessagePushDefinition allows to define message delivery using SOAP protocol. The rule can be configured to construct the Message Header and define the Events to push downstream messages through SOAP.

DownstreamMessagePushDefinition rule supports to configure asynchronous SOAP calls.

Note: When the messages are pushed using a SOAP protocol to the downstream, the system will not wait for the response (it is just fire and forget).

If the property InvokeOneWay is set to True, push notifications are sent in asynchronous mode to downstream. For asynchronous SOAP calls, OIPA pushes the message and will not wait for acknowledgment from the downstream. Activity processing completes after successfully pushing the message to downstream and the acknowledgment from downstream will not change the status of activity.

Note: The exceptions like unable to make service call or server unavailable are considered as push failure for asynchronous SOAP calls.

To send messages using SOAP protocol, DownstreamMessagePushDefinition requires the following details:

  • WSDLLocation
  • Service Name
  • PortName
  • invokeOneWay (TRUE | FALSE, default: TRUE)
DownstreamMessagePush Elements and Attributes
Element/Tag Parent Element Definition Attribute Element/Attribute Value and Description
<DownstreamMessagePushDefinition>
Opening and closing tag for DownstreamMessagePushDefinition rule
 
<Event> <DownstreamMessagePushDefinition> Required and Repeatable element: Specifies required event details. Event is repeatable for different event environments.
 

<Event> Name of the event EVENTNAME Required:

Note: If the EVENT value in PushNotifications does not match with any EVENT NAME value in DownstreamMessagePushDefinition, system displays an error message.

<Event>
EVENTMETHOD Required: EventMethod can be SOAP

<Event>
ENV

Required:

For example, ENV can be Test/Prod/Dev to support SDLC. For the same event there can be multiple destination addresses to support different environments.

Note: If messages from multiple events in the PushNotifications fails due to ENV value mismatch between PAS properties and DownstreamMessagePushDefinition, multiple errors one for each EVENT will be displayed.
<SoapConfiguration> <DownstreamMessagPushDefinition> Opening tag for Address details. Contains required details to make service calls
 
<WSDLLocation> <SoapConfiguration> Required: This element identifies WSDL location.
 
<ServiceName> <SoapConfiguration> Required: Identifies the service name.
 
<PortName> <SoapConfiguration> Required: Identifies the port name.
 
<InvokeOneWay> <SoapConfiguration> Optional: It indicates the type of SOAP call (Sychronous/Asynchronous).

Values:

True - indicates synchronous calls. This is the default type.

False- indicates asynchronous calls.
<MaxTimeOut> <SoapConfiguration> Required: This is the time an activity waits before timeout and the recommended time is 100ms. Value entered should be in milliseconds.

Value: Recommended timeout period is 100ms.
<Security> <DownstreamMessagePushDefinition> Defines security details.
 

<Security> Name of the security type. TYPE

Required

Values: HTTP, WSS
<UserName> <Security> Required: Includes user details for authentication
 
<Password> <Security> Required: Includes password details for authentication

XML Schema

<DownstreamMessagPushDefinition>
   <Event EVENTNAME=" " EVENTMETHOD="SOAP" ENV=" ">
   <SoapConfiguration>
        <WsdlLocation> </WsdlLocation>
        <ServiceName> </ServiceName>
        <PortName> </PortName>
        <InvokeOneWay> </InvokeOneWay>
        <MaxTimeOut>100<MaxTimeOut>
   </SoapConfiguration>
   <Security>
       <UserName> </UserName>
       <Password> </Password>
    </Security>
  </DownstreamMessagePushDefinition>

XML Example

<DownstreamMessagPushDefinition>
    <Event EVENTNAME="Event two" EVENTMETHOD="SOAP" ENV="Test">
        <SoapConfiguration>
             <WsdlLocation> </WsdlLocation>
             <ServiceName> </ServiceName>
             <PortName> </PortName>
            <InvokeOneWay> </InvokeOneWay>
            <MaxTimeOut>100<MaxTimemOut>
        </SoapConfiguration>
        <Security>
           <UserNameToken>  </UserNameToken>
           <User> </User>
           <Password> </Password>
       </Security>
    </Event>
    <EVENT EventNAME="Event two" EVENTMETHOD="SOAP" ENV="Prod">
          <SoapConfiguration>
                 <WsdlLocation> </WsdlLocation>
                  <ServiceName> </ServiceName>
                  <PortName> </PortName>
                  <InvokeOneWay> </InvokeOneWay>
                  <MaxTimeOut>100<MaxTimemOut>
          </SoapConfiguration>
          <Security>
                   <UserNameToken> </UserNameToken>
                   <User> </User>
                   <Password> </Password>
          </Security>
     </Event>
<DownstreamMessagePushDefinition>