1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
4 <base>CRM/Contribute
</base>
5 <class>ContributionPage
</class>
6 <name>civicrm_contribution_page
</name>
7 <comment>A Contribution object store meta information about a single customized contribution page
</comment>
12 <title>Contribution Page ID
</title>
13 <type>int unsigned
</type>
14 <required>true
</required>
15 <comment>Contribution Id
</comment>
20 <autoincrement>true
</autoincrement>
24 <title>Contribution Page Title
</title>
27 <localizable>true
</localizable>
28 <comment>Contribution Page title. For top of page display
</comment>
32 <name>intro_text
</name>
33 <title>Contribution Page Introduction Text
</title>
36 <type>RichTextEditor
</type>
40 <localizable>true
</localizable>
41 <comment>Text and html allowed. Displayed below title.
</comment>
45 <name>financial_type_id
</name>
46 <title>Financial Type
</title>
47 <type>int unsigned
</type>
48 <comment>default financial type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution
</comment>
50 <table>civicrm_financial_type
</table>
51 <keyColumn>id
</keyColumn>
52 <labelColumn>name
</labelColumn>
60 <name>financial_type_id
</name>
61 <table>civicrm_financial_type
</table>
66 <name>payment_processor
</name>
69 <serialize>SEPARATOR_TRIMMED
</serialize>
70 <comment>Payment Processors configured for this contribution Page
</comment>
72 <table>civicrm_payment_processor
</table>
73 <keyColumn>id
</keyColumn>
74 <labelColumn>name
</labelColumn>
82 <name>is_credit_card_only
</name>
83 <title>Is Credit Card Only?
</title>
85 <comment>if true - processing logic must reject transaction at confirmation stage if pay method != credit card
</comment>
90 <name>is_monetary
</name>
91 <title>Is Monetary
</title>
94 <comment>if true - allows real-time monetary transactions otherwise non-monetary transactions
</comment>
99 <title>Is Recurring
</title>
102 <comment>if true - allows recurring contributions, valid only for PayPal_Standard
</comment>
106 <name>is_confirm_enabled
</name>
107 <title>Confirmation Page?
</title>
110 <comment>if false, the confirm page in contribution pages gets skipped
</comment>
114 <name>recur_frequency_unit
</name>
115 <title>Recurring Frequency
</title>
118 <comment>Supported recurring frequency units.
</comment>
120 <optionGroupName>recur_frequency_units
</optionGroupName>
121 <keyColumn>name
</keyColumn>
125 <multiple>1</multiple>
127 <serialize>SEPARATOR_TRIMMED
</serialize>
131 <name>is_recur_interval
</name>
132 <title>Support Recurring Intervals
</title>
135 <comment>if true - supports recurring intervals
</comment>
139 <name>is_recur_installments
</name>
140 <title>Recurring Installments?
</title>
143 <comment>if true - asks user for recurring installments
</comment>
147 <name>adjust_recur_start_date
</name>
148 <title>Adjust Recurring Start Date
</title>
151 <comment>if true - user is able to adjust payment start date
</comment>
155 <name>is_pay_later
</name>
156 <title>Pay Later
</title>
159 <comment>if true - allows the user to send payment directly to the org later
</comment>
163 <name>pay_later_text
</name>
164 <title>Pay Later Text
</title>
166 <localizable>true
</localizable>
167 <comment>The text displayed to the user in the main form
</comment>
171 <name>pay_later_receipt
</name>
172 <title>Pay Later Receipt
</title>
174 <localizable>true
</localizable>
175 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
179 <name>is_partial_payment
</name>
180 <title>Allow Partial Payment
</title>
183 <comment>is partial payment enabled for this online contribution page
</comment>
187 <name>initial_amount_label
</name>
190 <localizable>true
</localizable>
191 <comment>Initial amount label for partial payment
</comment>
195 <name>initial_amount_help_text
</name>
197 <localizable>true
</localizable>
198 <comment>Initial amount help text for partial payment
</comment>
202 <name>min_initial_amount
</name>
204 <comment>Minimum initial amount for partial payment
</comment>
208 <name>is_allow_other_amount
</name>
209 <title>Allow Other Amounts
</title>
211 <comment>if true, page will include an input text field where user can enter their own amount
</comment>
216 <name>default_amount_id
</name>
217 <title>Default Amount
</title>
218 <type>int unsigned
</type>
219 <comment>FK to civicrm_option_value.
</comment>
223 <name>min_amount
</name>
224 <title>Minimum Amount
</title>
226 <comment>if other amounts allowed, user can configure minimum allowed.
</comment>
230 <name>max_amount
</name>
231 <title>Maximum Amount
</title>
233 <comment>if other amounts allowed, user can configure maximum allowed.
</comment>
237 <name>goal_amount
</name>
239 <comment>The target goal for this page, allows people to build a goal meter
</comment>
243 <name>thankyou_title
</name>
244 <title>Thank-you Title
</title>
247 <localizable>true
</localizable>
248 <comment>Title for Thank-you page (header title tag, and display at the top of the page).
</comment>
252 <name>thankyou_text
</name>
253 <title>Thank-you Text
</title>
256 <type>RichTextEditor
</type>
260 <localizable>true
</localizable>
261 <comment>text and html allowed. displayed above result on success page
</comment>
265 <name>thankyou_footer
</name>
266 <title>Thank-you Footer
</title>
269 <type>RichTextEditor
</type>
273 <localizable>true
</localizable>
274 <comment>Text and html allowed. displayed at the bottom of the success page. Common usage is to include link(s) to other pages such as tell-a-friend, etc.
</comment>
278 <name>is_email_receipt
</name>
279 <title>Send email Receipt
</title>
281 <comment>if true, receipt is automatically emailed to contact on success
</comment>
286 <name>receipt_from_name
</name>
287 <title>Receipt From
</title>
290 <localizable>true
</localizable>
291 <comment>FROM email name used for receipts generated by contributions to this contribution page.
</comment>
295 <name>receipt_from_email
</name>
296 <title>Receipt From email
</title>
299 <comment>FROM email address used for receipts generated by contributions to this contribution page.
</comment>
303 <name>cc_receipt
</name>
304 <title>Receipt cc
</title>
307 <comment>comma-separated list of email addresses to cc each time a receipt is sent
</comment>
311 <name>bcc_receipt
</name>
312 <title>Receipt bcc
</title>
315 <comment>comma-separated list of email addresses to bcc each time a receipt is sent
</comment>
319 <name>receipt_text
</name>
320 <title>Receipt Text
</title>
323 <type>TextArea
</type>
327 <localizable>true
</localizable>
328 <comment>text to include above standard receipt info on receipt email. emails are text-only, so do not allow html for now
</comment>
332 <name>is_active
</name>
333 <title>Is Page Active?
</title>
335 <comment>Is this property active?
</comment>
339 <name>footer_text
</name>
340 <title>Footer Text
</title>
343 <type>RichTextEditor
</type>
347 <localizable>true
</localizable>
348 <comment>Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.
</comment>
352 <name>amount_block_is_active
</name>
353 <title>Is Amount Block Active?
</title>
355 <comment>Is this property active?
</comment>
360 <name>start_date
</name>
361 <title>Contribution Page Start Date
</title>
362 <type>datetime
</type>
363 <title>Contribution Page Start Date
</title>
364 <comment>Date and time that this page starts.
</comment>
368 <name>end_date
</name>
369 <type>datetime
</type>
370 <title>Contribution Page End Date
</title>
371 <comment>Date and time that this page ends. May be NULL if no defined end date/time
</comment>
375 <name>created_id
</name>
376 <title>Contribution Page Created By
</title>
377 <type>int unsigned
</type>
378 <comment>FK to civicrm_contact, who created this contribution page
</comment>
382 <name>created_id
</name>
383 <table>civicrm_contact
</table>
386 <onDelete>SET NULL
</onDelete>
389 <name>created_date
</name>
390 <type>datetime
</type>
391 <title>Contribution Page Created Date
</title>
392 <comment>Date and time that contribution page was created.
</comment>
396 <name>currency
</name>
397 <title>Contribution Page Currency
</title>
400 <default>NULL
</default>
401 <headerPattern>/cur(rency)?/i
</headerPattern>
402 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
403 <comment>3 character string, value from config setting or input via user.
</comment>
406 <table>civicrm_currency
</table>
407 <keyColumn>name
</keyColumn>
408 <labelColumn>full_name
</labelColumn>
409 <nameColumn>name
</nameColumn>
410 <abbrColumn>symbol
</abbrColumn>
417 <name>campaign_id
</name>
418 <title>Contribution Page Campaign ID
</title>
419 <type>int unsigned
</type>
420 <comment>The campaign for which we are collecting contributions with this page.
</comment>
422 <table>civicrm_campaign
</table>
423 <keyColumn>id
</keyColumn>
424 <labelColumn>title
</labelColumn>
429 <name>campaign_id
</name>
430 <table>civicrm_campaign
</table>
432 <onDelete>SET NULL
</onDelete>
435 <name>is_share
</name>
436 <title>Is Contribution Page Shared?
</title>
439 <comment>Can people share the contribution page through social media?
</comment>
443 <name>is_billing_required
</name>
444 <title>Is billing block required
</title>
447 <comment>if true - billing block is required for online contribution page
</comment>
451 <name>frontend_title
</name>
452 <title>Public Title
</title>
455 <localizable>true
</localizable>
456 <default>NULL
</default>
457 <comment>Contribution Page Public title
</comment>
462 <uniqueName>contribution_page_frontend_title
</uniqueName>