Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel6
outlinefalse
typelist
printablefalse
Info

We also have BDE and Quick Donate configuration guides available.

Hide Unused/Deprecated Components

...

o   ProntoPayments Settings>Set as the maximum Donation Retries for credit card transactions

BDE

Ensure Type field picklist values are: Offline Donation, Direct Debit and Credit Card.

Go to Setup > Object Manager > BDE Templates > Fields & Relationships > Type. Picklist values should only be Offline Donation, Direct Debit and Credit Card.

Set Approval Process (If the client org opt to use Approval)

  1. Enable record locking and unlocking in Apex.

a.     Go to Setup > Process Automation > Process Automation Settings.

Create Approval Process

  1. Go to Setup > Process Automation > Approval Process. 

  2. Create new Approval Process for

Batch Donation Entry (if not yet created).

  1. In

Manage Approval Process For picklist, select the Batch Donation Entry and select the Use Standard Setup Wizard option.

Process Name should be “Batch Donation Entry Approval Process”. Click Next to proceed.

  1. Under the

Use this approval process of the following picklist select “formula evaluates              to true” and copy the formula below. Click Next  to proceed.

Formula: 

AND($Setup.ASPHPPADDON__ProntoGiving_Settings__c.ASPHPPADDON__Use_Approval_Process_for_Batches__c = true,   NOT(ISPICKVAL(ASPHPPADDON__Bulk_Donation_Status__c, 'Processed')), NOT(ISPICKVAL(ASPHPPADDON__Bulk_Donation_Status__c, 'Done')), NOT(ISPICKVAL(ASPHPPADDON__Bulk_Donation_Status__c, 'Approved')) )

  1. In the

Record Editability Properties section, choose the “Admins ONLY can edit records            during the approval process”. Click Next to proceed. 

  1. Choose the

BDE Approval Process Template (BDE 2.0). Click Next to proceed.

  1. Choose the fields to display in the Approval Request page. Click

Next to proceed.

  1. Select

Record Creator as the "Allowed Submitters”.  Click Save to finish.

10.  After saving, you will be redirected in this page. 

11.  Create Initial Submission Actions  for Update Batch Status Awaiting Approval.

a.     Click the “Add Existing” button and select “Field Update”.

12.  Create Approval Steps 

a.     Click the “New Approval Step” button.

.        b.  Enter Name and Description, click next.

Name

Unique Name

Step 1: User Approval

Step_1_User_Approval

.        c.  Specify Step Criteria

.        Select “Enter this step if the following” criteria are met, else reject record and copy the values below.

Field

Operator

Value

Batch Donation Entry: Bulk Donation Status

equals 

To Be Processed,Awaiting Approval

.        d.  Select Approver step.

.        e.  Click Save when done.

.       

13.  Create Final Approval Actions - for Update Batch Status Approved.

a.     Click the “Add Existing” button and select “Field Update” .

14.  Create Final Rejection Actions - for Update Batch Status To Be Processed.

a.     Click the “Add Existing” button and select “Field Update”.

15.  After completing the setup. Click the “Activate” button to activate the Approval Process.

Enable Approval Process in ProntoGiving Settings

Enabling the Approval Process toggle will prevent the Batch Donation Entry records without approval to proceed. This will help the Admin to receive an “Approval Request” and approve or reject the BDE records. Only those Approved BDE records will be processed.

  1. Navigate to ProntoGiving Settings > Batch Donation Entry > BDE 2.0 > Settings > Use Approval Process for Batch Donation Entries.

Enabling the toggle will allow processing of Batch Donation Entry records if status is marked as “Approved” only.

If the toggle is enabled (ASPHPPADDON__Use_Approval_Process_for_Batches__c  = true), the user needs to click the Submit for Approval button to get approval before processing the BDE record, or else an error notification message will pop-up that the criteria is not met, because it is not yet approved. Only “Approved” BDE status will be processed.

Disabling the toggle will allow processing of Batch Donation Entry records even though the status is  “To Be Processed”.

If the toggle is disabled (ASPHPPADDON__Use_Approval_Process_for_Batches__c  = false), the user can process the BDE record bypassing the Approval stage by clicking directly the Process Batch button.

BDE Components

Setup Settings

  1. Go to Setup | Session Settings | Enable Content Delivery Network (CDN) = tick

 

User Interface

If some of the components in the Batch Donation Entries are not showing, you can show them by following these steps.

  1. Go to Batch Donation Entries tab.

  2. Select any records in the list.

  3. Click the settings icon and select “Edit Page” option.

  1. It will redirect to another page. Then, you can see the

Lightning Components that are available to use.

  1. To find the components that you want to show, just search it in the

Search Components field.

  1. Components that needs to be shown in the Batch Donation Entries tab are: 

a.     New BDE Item Form

b.     BDE Items Summary

.        c.  BDE Items Related List

  1. Search for the components in the search bar and drag it in the center. 

  1. Click the

Save button when done. 

Show BDE Barcode Field in BDE UI

The BDE Barcode will only visible if the toggle is enabled in the settings. Go to ProntoGiving Settings | Donation | Settings | Barcode 

a.     Enable the toggle

Required Custom Fields

Please create the following fields under the BDE Item object before creating the BDE Templates and Item Record Mapping.

Field Label

Field API Name

Data Type

BSB

Cheque_Bank_Number_BSB__c

Text(80)

Cheque Account Number

Cheque_Account_Number__c

Text(80)

Cheque Bank Name  

Cheque_Bank_Name__c

Text(255)

Cheque Date

Cheque_Date__c

Date

Cheque Drawers Name

Cheque_Drawers_Name__c

Text Area(255)

Cheque Number

Cheque_Number__c

Text(80)

Cheque Transit Number

Cheque_Transit_Number__c

Text(80)

Description

Description__c

Long Text Area(32000)

Payment ID

Payment_ID__c

Text(80)

Payment Type

Payment_Type__c

Picklist

·       Cash

·       Cheque

·       Credit Card

·       Tokenisation

·       Bank Account

·       Direct Deposit

Payment Type 2

Payment_Type_2__c

Picklist

·       Cash

·       Cheque

·       Credit Card

·       BPay

·       eWallet

·       Direct Deposit

Receipt Actionhttps://ap16.lightning.force.com/lightning/setup/ObjectManager/01I2w000000MmGZ/FieldsAndRelationships/00N2w000005z85C/view(PPlus)

Receipt_Action__c

Picklist

·       Default

·       Email

·       Post

·       Do Not Receipt

Receipt Templatehttps://ap16.lightning.force.com/lightning/setup/ObjectManager/01I2w000000MmGZ/FieldsAndRelationships/00N2w000005z85H/view(PPlus)

Receipt_Template__c

Lookup(Receipt Template (PPlus))

Billing State

Billing_State__c

Text(80)

Billing Country

Billing_Country__c

Text(25)

Billing Street

Billing_Street__c

Text(80)

Billing City

Billing_City__c

Text(80)

Billing Postal Code

Billing_Postal_Code__c

Text(18)

Open Ended Status

Open_Ended_Status__c

Picklist

·       Open

·       None

Add the following fields if not yet added/deprecated.

Object

Field Label

Field API Name

Data Type

Opportunity

Soft Credit Contact

Soft_Credit_Contact__c

(contact lookup)

Opportunity

Soft Credit Account

Soft_Credit_Account__c

(account lookup)

Recurring Donation

Soft Credit Contact

Soft_Credit_Contact__c

(contact lookup)

Recurring Donation

Soft Credit Account

Soft_Credit_Account__c

(account lookup)

BDE Item Fields to be Manually Deleted

Object

Field Label

Field API Name

Data Type

BDE Item

Create BDE Item Only

Create_BDE_Item_Only__c

Checkbox

BDE Item

RD Status

Revised_RD_Status__c

Picklist

BDE Item

Next Donation

Revised_Next_Donation_Date__c

Date

BDE Item

Revised Frequency

Revised_Frequency__c

Picklist

BDE Item

Revised Campaign

Revised_Campaign__c

Lookup(Campaign)

BDE Item

Revised Amount

Revised_Amount__c

Currency

BDE Item

RDA Comments

RDA_Comments__c

Long Text Area

BDE Item

Cheque Account Number

ASPHPPADDON__Cheque_Account_Number__c

Text(80)

BDE Item

Cheque Account Number

ASPHPPADDON__Cheque_Account_Number_2__c

Text(80)

BDE Item

Cheque Bank Name

ASPHPPADDON__Cheque_Bank_Name__c

Text(255)

BDE Item

Cheque Date

ASPHPPADDON__Cheque_Date__c

Date

BDE Item

Cheque Drawers Name

ASPHPPADDON__Cheque_Drawers_Name__c

Text Area(255)

BDE Item

Cheque Number

ASPHPPADDON__Cheque_Number__c

Text(80)

BDE Item

Cheque Transit Number

ASPHPPADDON__Cheque_Transit_Number__c

Text(80)

Batch Donation Entry Balancing

Go to ProntoGiving  Settings > Batch Donation Entry > BDE 2.0 > Settings User Interface, on the “Batch Donation Entry Total Match Default” field click the dropdown besides to select “Unchecked”, “Checked”, and “Checked and Locked” then click “Save”.

·       If Unchecked - The Require Expected Total Match checkbox is unchecked and editable.

·       If Checked - The Require Expected Total Match checkbox is checked and editable.

·       If Checked and Locked - The Require Expected Total Match checkbox is checked and this field is read-only.

BDE Templates

Sync BDE Item Fields 

Item Record Mapping

BDE Matching Criteria

BDE Settings

On the Batch Donation Entry > BDE 2.0 > Settings, 

 

·       if the “Use Approval Processs for Batch Donation Entries” toggle is Enabled, it requires that the Batch Donation Entry needs an approval before processing. 

·       if the “Process  Payment Immediately” toggle is Enabled, the payment will be processed immediately. 

·       if the “Include BDE Items linked to a BDE” toggle is Enabled, when creating a Batch Donation Entry record it allows to linked a BDE item. 

·       if the “Allow Changes to Processed Batch Donation Entries” is Enabled, it allow changes on the processed Batch Donation Entry records like deleting or editing it.