How to add a payment field (Copy of LB Help Site)

Payment

The Payment Data Type allows you to require a user to make a payment as part of completing a workflow step.  This is useful if people need to pay to have activities reviewed (include it on a step on a Create Activity Workflow) or when taking courses (include it on a step on a Complete Activity Workflow).

To create a Payment data type:

1. Add a New Extrinsic Field

2. Select "Payment" as the Data Type.

3. Enter a Data Field name.

4. Select a source field for the Payment Title or enter static text.

   • When creating a payment on the Complete Activity Workflow, you may want to use the Activity Title as the source field.

5. Select a source field for the Payment Amount or enter a static amount.

   • When creating a payment on the Complete Activity Workflow, if each activity has a different price, you may want to use a numeric field from the Activity as the source field.

6. Optionally select a source field for the GL Code or enter a static code.

   • (New in Release 7.21) This is the General Ledger code for the transaction. If the payment is processed through PayFlowPro, the GL Code will be passed into the comments field in PayFlowPro. This field will not be visible to the practitioner.
     
     

7. Optionally select a source field for the Terms and Conditions or enter static terms and conditions.

   • The Terms and Conditions will be displayed in the field as part of the check-out process.

8. Optionally enter a Success Message. (New in Release 7.30)

   • The Success Message will be displayed on the payment confirmation page.

   • Note: The Success Message can include HTML.  If the HTML is malformed, it may cause errors on the Payment Success page.

Note: When choosing a source field, there is a known issue / limitation if you choose an extrinsic field from the reference object or choose a template that references a field.  The work-around is to default the field from the reference object into a field on the write-to object and use the field from the write-to object in the Payment Attribute. See case 19337.

You should use Short Text data types when you want to encourage the user of the workflow to enter brief data, like a name or title. Long Text data types will more easily display larger amounts of text. 

When a Payment Data type is included on a workflow step, (and if the field is marked required or a validation rule is created that states that the Payment field must not be empty), the user will have to make a payment before completing the workflow step.  The user is presented with a "Make Payment" button, which, when clicked, takes them to the E-Commerce payment page using the Payment Title, Amount, GL Code, and Terms and Conditions configured for the payment.  When the payment is complete, the user is returned to the associated workflow step and is shown the completed payment and transaction ID.  At this point, if all other requirements are met for the workflow step, the step can be submitted by the user.

(New in Release 7.23) To configure a workflow step action to be executed automatically after successfully making a payment on a workflow:

1. Navigate to the associated Workflow Step and Edit the Payment attribute

2. Locate the configuration option "On Success Execute Step:" 

3. Select the Step that will be executed upon the user's making the payment (by default, 'No Action' is selected, which will return the User back to the workflow step after a payment is made)

4. Save 

NOTE: When a user clicks the Pay Fees button, the system will automatically execute the first save action on the workflow.  This will also trigger any behavior assisted with this action.