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>contribution_type_id
</name>
46 <type>int unsigned
</type>
47 <required>true
</required>
48 <comment>default Contribution type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution
</comment>
53 <name>contribution_type_id
</name>
54 <table>civicrm_contribution_type
</table>
59 <name>financial_type_id
</name>
60 <title>Financial Type
</title>
61 <type>int unsigned
</type>
62 <comment>default financial type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution
</comment>
64 <table>civicrm_financial_type
</table>
65 <keyColumn>id
</keyColumn>
66 <labelColumn>name
</labelColumn>
74 <name>financial_type_id
</name>
75 <table>civicrm_financial_type
</table>
80 <name>payment_processor
</name>
83 <comment>Payment Processors configured for this contribution Page
</comment>
85 <table>civicrm_payment_processor
</table>
86 <keyColumn>id
</keyColumn>
87 <labelColumn>name
</labelColumn>
95 <name>is_credit_card_only
</name>
96 <title>Is Credit Card Only?
</title>
98 <comment>if true - processing logic must reject transaction at confirmation stage if pay method != credit card
</comment>
103 <name>is_monetary
</name>
104 <title>Is Monetary
</title>
107 <comment>if true - allows real-time monetary transactions otherwise non-monetary transactions
</comment>
111 <name>is_recur
</name>
112 <title>Is Recurring
</title>
115 <comment>if true - allows recurring contributions, valid only for PayPal_Standard
</comment>
119 <name>is_confirm_enabled
</name>
120 <title>Confirmation Page?
</title>
123 <comment>if false, the confirm page in contribution pages gets skipped
</comment>
127 <name>recur_frequency_unit
</name>
128 <title>Recurring Frequency
</title>
131 <comment>Supported recurring frequency units.
</comment>
135 <name>is_recur_interval
</name>
136 <title>Support Recurring Intervals
</title>
139 <comment>if true - supports recurring intervals
</comment>
143 <name>is_recur_installments
</name>
144 <title>Recurring Installments?
</title>
147 <comment>if true - asks user for recurring installments
</comment>
151 <name>is_pay_later
</name>
152 <title>Pay Later
</title>
155 <comment>if true - allows the user to send payment directly to the org later
</comment>
159 <name>pay_later_text
</name>
160 <title>Pay Later Text
</title>
162 <localizable>true
</localizable>
163 <comment>The text displayed to the user in the main form
</comment>
167 <name>pay_later_receipt
</name>
168 <title>Pay Later Receipt
</title>
170 <localizable>true
</localizable>
171 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
175 <name>is_partial_payment
</name>
176 <title>Allow Partial Payment
</title>
179 <comment>is partial payment enabled for this online contribution page
</comment>
183 <name>initial_amount_label
</name>
186 <localizable>true
</localizable>
187 <comment>Initial amount label for partial payment
</comment>
191 <name>initial_amount_help_text
</name>
193 <localizable>true
</localizable>
194 <comment>Initial amount help text for partial payment
</comment>
198 <name>min_initial_amount
</name>
200 <comment>Minimum initial amount for partial payment
</comment>
204 <name>is_allow_other_amount
</name>
205 <title>Allow Other Amounts
</title>
207 <comment>if true, page will include an input text field where user can enter their own amount
</comment>
212 <name>default_amount_id
</name>
213 <title>Default Amount
</title>
214 <type>int unsigned
</type>
215 <comment>FK to civicrm_option_value.
</comment>
219 <name>min_amount
</name>
220 <title>Minimum Amount
</title>
222 <comment>if other amounts allowed, user can configure minimum allowed.
</comment>
226 <name>max_amount
</name>
227 <title>Maximum Amount
</title>
229 <comment>if other amounts allowed, user can configure maximum allowed.
</comment>
233 <name>goal_amount
</name>
235 <comment>The target goal for this page, allows people to build a goal meter
</comment>
239 <name>thankyou_title
</name>
240 <title>Thank-you Title
</title>
243 <localizable>true
</localizable>
244 <comment>Title for Thank-you page (header title tag, and display at the top of the page).
</comment>
248 <name>thankyou_text
</name>
249 <title>Thank-you Text
</title>
252 <type>RichTextEditor
</type>
256 <localizable>true
</localizable>
257 <comment>text and html allowed. displayed above result on success page
</comment>
261 <name>thankyou_footer
</name>
262 <title>Thank-you Footer
</title>
265 <type>RichTextEditor
</type>
269 <localizable>true
</localizable>
270 <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>
274 <name>is_email_receipt
</name>
275 <title>Send email Receipt
</title>
277 <comment>if true, receipt is automatically emailed to contact on success
</comment>
282 <name>receipt_from_name
</name>
283 <title>Receipt From
</title>
286 <localizable>true
</localizable>
287 <comment>FROM email name used for receipts generated by contributions to this contribution page.
</comment>
291 <name>receipt_from_email
</name>
292 <title>Receipt From email
</title>
295 <comment>FROM email address used for receipts generated by contributions to this contribution page.
</comment>
299 <name>cc_receipt
</name>
300 <title>Receipt cc
</title>
303 <comment>comma-separated list of email addresses to cc each time a receipt is sent
</comment>
307 <name>bcc_receipt
</name>
308 <title>Receipt bcc
</title>
311 <comment>comma-separated list of email addresses to bcc each time a receipt is sent
</comment>
315 <name>receipt_text
</name>
316 <title>Receipt Text
</title>
319 <type>TextArea
</type>
323 <localizable>true
</localizable>
324 <comment>text to include above standard receipt info on receipt email. emails are text-only, so do not allow html for now
</comment>
328 <name>is_active
</name>
329 <title>Is Page Active?
</title>
331 <comment>Is this property active?
</comment>
335 <name>footer_text
</name>
336 <title>Footer Text
</title>
339 <type>RichTextEditor
</type>
343 <localizable>true
</localizable>
344 <comment>Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.
</comment>
348 <name>amount_block_is_active
</name>
349 <title>Is Amount Block Active?
</title>
351 <comment>Is this property active?
</comment>
356 <name>start_date
</name>
357 <title>Contribution Page Start Date
</title>
358 <type>datetime
</type>
359 <title>Contribution Page Start Date
</title>
360 <comment>Date and time that this page starts.
</comment>
364 <name>end_date
</name>
365 <type>datetime
</type>
366 <title>Contribution Page End Date
</title>
367 <comment>Date and time that this page ends. May be NULL if no defined end date/time
</comment>
371 <name>created_id
</name>
372 <title>Contribution Page Created By
</title>
373 <type>int unsigned
</type>
374 <comment>FK to civicrm_contact, who created this contribution page
</comment>
378 <name>created_id
</name>
379 <table>civicrm_contact
</table>
382 <onDelete>SET NULL
</onDelete>
385 <name>created_date
</name>
386 <type>datetime
</type>
387 <title>Contribution Page Created Date
</title>
388 <comment>Date and time that contribution page was created.
</comment>
392 <name>currency
</name>
393 <title>Contribution Page Currency
</title>
396 <default>NULL
</default>
397 <headerPattern>/cur(rency)?/i
</headerPattern>
398 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
399 <comment>3 character string, value from config setting or input via user.
</comment>
402 <table>civicrm_currency
</table>
403 <keyColumn>name
</keyColumn>
404 <labelColumn>full_name
</labelColumn>
405 <nameColumn>numeric_code
</nameColumn>
412 <name>campaign_id
</name>
413 <title>Contribution Page Campaign ID
</title>
414 <type>int unsigned
</type>
415 <comment>The campaign for which we are collecting contributions with this page.
</comment>
417 <table>civicrm_campaign
</table>
418 <keyColumn>id
</keyColumn>
419 <labelColumn>title
</labelColumn>
424 <name>campaign_id
</name>
425 <table>civicrm_campaign
</table>
427 <onDelete>SET NULL
</onDelete>
430 <name>is_share
</name>
431 <title>Is Contribution Page Shared?
</title>
434 <comment>Can people share the contribution page through social media?
</comment>
438 <name>is_billing_required
</name>
439 <title>Is billing block required
</title>
442 <comment>if true - billing block is required for online contribution page
</comment>