Introduction
ShulCloud Forms features two "payment selection" field types: Pulldown Selection and Radio Selection (Choose 1). These fields present users with options that result in a transaction against the Charge Type associated with the selected option. The two types are functionally the same, differing namely in the layout of how their respective options are displayed, as indicated in their names.
Pulldown version is on the left and the radio version is on the right:
General Settings
These field types have these settings in common with other field types:
- Label - shown to the user to identify the information requested
- Width - the horizontal size of the field on the page
- Group - optional assignment used for Form Logic to show/hide the field
- Description - addition text shown with the field to provide more information
These field types also feature a special General setting that is optional: the Enter in an Amount field setting. This setting allows you to extend the functionality of a payment selection field by associating an "Enter in amount" field. Sample uses are discussed below. For now, note the following:
- Only Enter in an Amount fields that have be saved before the field editor page was last loaded and have not previously been associated with one of these payment selection fields, will be shown in the list. So if your Enter in an Amount field is new and therefore not listed, save the entire form (versus just the form field), refresh the page, and edit the payment selection field again.
- Because you might have more than one Enter in an Amount field on the form with the same name, the internal ID is appended to the field name in the dropdown list options presented to you. You can see the ID on the main field editor page.
The IDs highlighted above show in the Enter in an Amount field dropdown list like this:
You would choose Donation_Amount_10382741 for the pulldown field and Donation_Amount_10382742 for the radio field.
Regarding configuration of Enter in an Amount fields associated with Payment Selection fields:
- Charge Type setting of the Enter in an Amount is required still but ignored (the payment selection field's options govern)
- Group and visibility settings should mirror what you set for the payment selection field
Options Settings
The heart of these fields are the options. For each option you specify:
- Label - shown to the user to describe this option
- Name - represents this choice in form submissions (must be unique, spaces replaced with "_")
- Value - the amount used in the transaction created by making this choice
- Amount is - the rule applied to Value
- Fixed - the user cannot change this amount (the default setting)
- Suggested - the user can enter a different amount; a Value other than is presented as the suggested amount
NOTE: Suggested amount works only if you have associated an Enter in an Amount field in the General settings. Without such as association, a suggested option amount will be treated as fixed.
- Charge Type - the Charge Type used for the transaction created by making this choice
Is Required?
Notice that above the first option is a checkbox Is Required? Checking this box results in the following:
- The name becomes read only and is set as -1
- You still need to select a Charge Type
- If no label is provided if will show as "Please Select One"
IMPORTANT: the Is Required? checkbox refers only to the fact that the option is not an actual choice. It gives you the means of setting a different label for the first choice (for example, "Pick your favorite!"). Use this checkbox in conjunction with the Required For field settings to actually require a user to make a choice in order to submit the form.
Examples of How to Use the Linked Enter in an Amount Field Feature
Background
You may be familiar with the Donation Dropdown field that presents a list of options based on Charge Types set in My Lists to appear in the donation dropdown. It presents a dropdown and an amount box. However, you do not have control over the options shown -- you get the entire list.
Originally, Pulldown Selection and Radio Selection payment fields only treated the amount as fixed. Pulldown Selection and Radio Selection payment fields have since been enhanced to combine the best of those fields and the the Donation Dropdown field. You control the options and can allow users to enter variable amounts.
Below are some examples of how you can put this to use!
Example 1: Show Selected Fixed Amount
In this example, the user sees the value in a "Donation Amount" field so the form designer need not put the values in the option names themselves (a common practice with the previous version of these payment selection fields). Here all options have fixed amounts. Because an Enter in an Amount field is associated with each Payment Selection field, the Enter in an Amount fields show as read-only with a notation below that the amount is fixed.
Example 2: Other Amount
In this example, the user is presented with set of fixed options plus the ability to enter a different or "other" amount. For the last option, labelled "Other," Value Is is set to Suggested and the value is set to $0. Options would typically be set to the same Charge Type (think same destination Charge Type with tiered amounts plus the ability to enter some other amount).
Want to suggest an amount? Just enter the suggested amount as the option's value. It will be shown to the user when that option is chosen and the user can change it.
Example 3: Any Amount
Suppose you want to offer a choice of donations options and allow the donor to donate any amount . In this example, all amounts are Suggested with $0. Typically, each option would be assigned a different Charge Type. This is a great solution for a Donation form where you want to group like founds together.
Example 4: Suggested Amount
This is the same as the example immediately above, but this time we have set suggested values.
Example 5: Minimum Amount
This is not yet available but is on our radar to implement!