ipdFwdWorkflow

ipdFwdWorkflow shows how to call a user exit from a workflow. It calls the SampleOnUsCreditUserExit user exit, which demonstrates how to mark item records as on-us credits. By default, the reference to the SampleOnUsCreditUserExit user exit in ipdFwdWorkflow is commented out. To use this user exit, remove the comments.

<?xml version="1.0" ?>
<workflowDescriptor name="ipdFwdWorkflow">
<!--
     Each node is followed by a comment that indicates which Payment Feature Services
     component it is associated with.  The nodes that are not labeled are provided
     as part of Business Rules itself. If all of the components are not being used,
     the nodes that are associated with the unused components must be removed from the
     Workflow, and the 'connection' entries for those nodes must be updated to
     flow around the removed nodes. Sample connection changes with 
     Settlement removed. are shown
 -->
  <nodes>
    <node name="ValContextEnvelopeNode"/>
    <node name="ValContextExclusiveNode"/>
    <node name="ValContextNode"/>
    <node name="ValContentNode"/>
    <node name="ValCollectorsNode"/>
    <node name="ValFwdEndpointNode"/>       <!-- Distribution (note 1) -->
    <node name="ValFwdOutsortNode"/>        <!-- Distribution          -->
    <node name="ValMICRValNode"/>
    <node name="ValFwdEndpointErrorNode"/>  <!-- Distribution          -->
    <node name="AdminReturnsNode"/>         <!-- Distribution          -->
    <node name="SettlementNode"/>           <!-- Settlement           -->
  </nodes>
  <connections>
    <connection srcName="ValContextEnvelopeNode"   dstName="ValContextExclusiveNode"/>
    <connection srcName="ValContextExclusiveNode"  dstName="ValContextNode"/>
    <connection srcName="ValContextNode"           dstName="ValContentNode"/>
    <connection srcName="ValContentNode"           dstName="ValCollectorsNode"/>
    <connection srcName="ValCollectorsNode"        dstName="ValFwdEndpointNode">
      <paymentCheck field="ibmValIsItem" operator="EQ" value="Y"/>
    </connection>
    <connection srcName="ValFwdEndpointNode"       dstName="ValFwdOutsortNode" 
                results="SUCCESS"/>
    <connection srcName="ValFwdEndpointNode"       dstName="ValFwdEndpointErrorNode"/>
    <connection srcName="ValFwdOutsortNode"        dstName="ValMICRValNode"/>
    <connection srcName="ValMICRValNode"           dstName="AdminReturnsNode"/>
    <connection srcName="ValFwdEndpointErrorNode"  dstName="AdminReturnsNode"/>
    <connection srcName="AdminReturnsNode"         dstName="SettlementNode"/>
    <!--
         If the Business Rules component of Settlement is not installed, the previous
         connection needs to be removed.
     -->
  </connections>

   <!--
   The following user exit demonstrates how to run a Business Rules user exit
   from a workflow. This particular user exit can be used to mark items as on-us credits
   by using the RT values and PC values. To use this user exit, uncomment it.
   -->

   <!--
  <userExitClass>com.ibm.paydir.server.samples.OnUsCreditUserExit</userExitClass>
   -->
</workflowDescriptor>

<!--
     To run Accounting and Billing, uncomment the following workflow descriptor and 
     either comment out or delete the previous workflow descriptor.
 -->

<!--
<?xml version="1.0" ?>
<workflowDescriptor name="ipdFwdWorkflow">
  <nodes>
    <node name="ValContextEnvelopeNode"/>
    <node name="ValContextExclusiveNode"/>
    <node name="ValContextNode"/>
    <node name="ValContentNode"/>
    <node name="ValCollectorsNode"/>
    <node name="ValFwdEndpointNode"/>
    <node name="ValFwdOutsortNode"/>
    <node name="ValMICRValNode"/>
    <node name="ValFwdEndpointErrorNode"/>
    <node name="AdminReturnsNode"/>
    <node name="DepositProdAvailNode"/>
    <node name="SettlementNode"/>
    <node name="CreditAvailabilityDaysNode"/>
    <node name="CreditAvailabilityNode"/>
    <node name="BillingNode"/>
    <node name="DebitAvailabilityDaysNode"/>
  </nodes>
  <connections>
    <connection srcName="ValContextEnvelopeNode"   dstName="ValContextExclusiveNode"/>
    <connection srcName="ValContextExclusiveNode"  dstName="ValContextNode"/>
    <connection srcName="ValContextNode"           dstName="ValContentNode"/>
    <connection srcName="ValContentNode"           dstName="ValCollectorsNode"/>
    <connection srcName="ValCollectorsNode"        dstName="ValFwdEndpointNode">
      <paymentCheck field="ibmValIsItem" operator="EQ" value="Y"/>
    </connection>
    <connection srcName="ValFwdEndpointNode"       dstName="ValFwdOutsortNode" 
                results="SUCCESS"/>
    <connection srcName="ValFwdEndpointNode"       dstName="ValFwdEndpointErrorNode"/>
    <connection srcName="ValFwdOutsortNode"        dstName="ValMICRValNode"/>
    <connection srcName="ValMICRValNode"           dstName="AdminReturnsNode"/>
    <connection srcName="ValFwdEndpointErrorNode"  dstName="AdminReturnsNode"/>
    <connection srcName="AdminReturnsNode"         dstName="SettlementNode"/>
    <connection srcName="SettlementNode"           dstName="DepositProdAvailNode">
      <paymentCheck field="ibmNprValidRT" operator="EQ" value="1"/>
    </connection>
    <connection srcName="DepositProdAvailNode"     dstName="CreditAvailabilityDaysNode">
      <paymentCheck field="ibmClientType" operator="EQ" value="Gateway"/>
    </connection>
    <connection srcName="CreditAvailabilityDaysNode" dstName="CreditAvailabilityNode"/>
    <connection srcName="CreditAvailabilityNode"     dstName="BillingNode"/>
    <connection srcName="BillingNode"                dstName="DebitAvailabilityDaysNode">
      <paymentCheck field="ibmNprEndpoint" operator="CurrentNotNull"/>
    </connection>
  </connections>
  <responses>
    <response>
      <responseFields>
        <responseField name="ibmCLBillingCode"  message="decision"/>
      </responseFields>
    </response>
  </responses>
</workflowDescriptor>
 -->


<!--
     Note 1: In addition to MICR Validation, the Accounting, Billing, and Settlement
             components of Business Rules are dependent on the endpoint assignment
             that is done as part of the Business Rules component of Distribution.
             If Distribution is not installed, none of those other components' nodes can
             be used by the default installation. However, you can modify the workflow to use
             MICR Validation and Settlement without Distribution, but no sample is
             provided. Accounting and Billing have a prerequisite of Distribution, so
             you cannot modify those components to work without Distribution.
 -->
Table 1. ipdFwdWorkflow nodes and related components
Node Related component
ValContextEnvelopeNode Business Rules
ValContextExclusiveNode Business Rules
ValContextNode Business Rules
ValContentNode Business Rules
ValCollectorsNode Business Rules
ValFwdEndpointNode Distribution
ValFwdOutsortNode Distribution
ValMICRValNode Business Rules
ValFwdEndpointErrorNode Distribution
AdminReturnsNode Distribution
DepositProdAvailNode Accounting
SettlementNode Settlement
CreditAvailabilityDaysNode Accounting
CreditAvailabilityNode Accounting
BillingNode Billing
DebitAvailabilityDaysNode Accounting
AdminReturnsNode Distribution