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>
10 <component>CiviContribute
</component>
11 <labelField>title
</labelField>
14 <title>Contribution Page ID
</title>
15 <type>int unsigned
</type>
16 <required>true
</required>
17 <comment>Contribution ID
</comment>
25 <autoincrement>true
</autoincrement>
29 <title>Contribution Page Title
</title>
32 <localizable>true
</localizable>
33 <comment>Contribution Page title. For top of page display
</comment>
37 <name>intro_text
</name>
38 <title>Contribution Page Introduction Text
</title>
41 <type>RichTextEditor
</type>
45 <localizable>true
</localizable>
46 <comment>Text and html allowed. Displayed below title.
</comment>
50 <name>financial_type_id
</name>
51 <title>Financial Type ID
</title>
52 <type>int unsigned
</type>
53 <comment>default financial type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution
</comment>
55 <table>civicrm_financial_type
</table>
56 <keyColumn>id
</keyColumn>
57 <labelColumn>name
</labelColumn>
61 <label>Financial Type
</label>
66 <name>financial_type_id
</name>
67 <table>civicrm_financial_type
</table>
72 <name>payment_processor
</name>
75 <serialize>SEPARATOR_TRIMMED
</serialize>
76 <comment>Payment Processors configured for this contribution Page
</comment>
78 <table>civicrm_payment_processor
</table>
79 <keyColumn>id
</keyColumn>
80 <labelColumn>name
</labelColumn>
84 <label>Payment Processors
</label>
89 <name>is_credit_card_only
</name>
90 <title>Is Credit Card Only?
</title>
92 <comment>if true - processing logic must reject transaction at confirmation stage if pay method != credit card
</comment>
97 <name>is_monetary
</name>
98 <title>Is Monetary
</title>
101 <comment>if true - allows real-time monetary transactions otherwise non-monetary transactions
</comment>
105 <name>is_recur
</name>
106 <title>Is Recurring
</title>
109 <comment>if true - allows recurring contributions, valid only for PayPal_Standard
</comment>
113 <name>is_confirm_enabled
</name>
114 <title>Confirmation Page?
</title>
117 <comment>if false, the confirm page in contribution pages gets skipped
</comment>
121 <name>recur_frequency_unit
</name>
122 <title>Recurring Frequency
</title>
125 <comment>Supported recurring frequency units.
</comment>
127 <optionGroupName>recur_frequency_units
</optionGroupName>
128 <keyColumn>name
</keyColumn>
132 <multiple>1</multiple>
134 <serialize>SEPARATOR_TRIMMED
</serialize>
138 <name>is_recur_interval
</name>
139 <title>Support Recurring Intervals
</title>
142 <comment>if true - supports recurring intervals
</comment>
146 <name>is_recur_installments
</name>
147 <title>Recurring Installments?
</title>
150 <comment>if true - asks user for recurring installments
</comment>
154 <name>adjust_recur_start_date
</name>
155 <title>Adjust Recurring Start Date
</title>
158 <comment>if true - user is able to adjust payment start date
</comment>
162 <name>is_pay_later
</name>
163 <title>Pay Later
</title>
166 <comment>if true - allows the user to send payment directly to the org later
</comment>
170 <name>pay_later_text
</name>
171 <title>Pay Later Text
</title>
173 <localizable>true
</localizable>
174 <comment>The text displayed to the user in the main form
</comment>
178 <name>pay_later_receipt
</name>
179 <title>Pay Later Receipt
</title>
181 <localizable>true
</localizable>
182 <comment>The receipt sent to the user instead of the normal receipt text
</comment>
186 <name>is_partial_payment
</name>
187 <title>Allow Partial Payment
</title>
190 <comment>is partial payment enabled for this online contribution page
</comment>
194 <name>initial_amount_label
</name>
197 <localizable>true
</localizable>
198 <comment>Initial amount label for partial payment
</comment>
200 <label>Initial Amount Label
</label>
205 <name>initial_amount_help_text
</name>
207 <localizable>true
</localizable>
208 <comment>Initial amount help text for partial payment
</comment>
210 <label>Initial Amount Help Text
</label>
215 <name>min_initial_amount
</name>
217 <comment>Minimum initial amount for partial payment
</comment>
219 <label>Min. Initial Amount
</label>
224 <name>is_allow_other_amount
</name>
225 <title>Allow Other Amounts
</title>
227 <comment>if true, page will include an input text field where user can enter their own amount
</comment>
232 <name>default_amount_id
</name>
233 <title>Default Amount
</title>
234 <type>int unsigned
</type>
235 <comment>FK to civicrm_option_value.
</comment>
239 <name>min_amount
</name>
240 <title>Minimum Amount
</title>
242 <comment>if other amounts allowed, user can configure minimum allowed.
</comment>
246 <name>max_amount
</name>
247 <title>Maximum Amount
</title>
249 <comment>if other amounts allowed, user can configure maximum allowed.
</comment>
253 <name>goal_amount
</name>
255 <comment>The target goal for this page, allows people to build a goal meter
</comment>
257 <label>Goal Amount
</label>
262 <name>thankyou_title
</name>
263 <title>Thank-you Title
</title>
266 <localizable>true
</localizable>
267 <comment>Title for Thank-you page (header title tag, and display at the top of the page).
</comment>
271 <name>thankyou_text
</name>
272 <title>Thank-you Text
</title>
275 <type>RichTextEditor
</type>
279 <localizable>true
</localizable>
280 <comment>text and html allowed. displayed above result on success page
</comment>
284 <name>thankyou_footer
</name>
285 <title>Thank-you Footer
</title>
288 <type>RichTextEditor
</type>
292 <localizable>true
</localizable>
293 <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>
297 <name>is_email_receipt
</name>
298 <title>Send email Receipt
</title>
300 <comment>if true, receipt is automatically emailed to contact on success
</comment>
305 <name>receipt_from_name
</name>
306 <title>Receipt From
</title>
309 <localizable>true
</localizable>
310 <comment>FROM email name used for receipts generated by contributions to this contribution page.
</comment>
314 <name>receipt_from_email
</name>
315 <title>Receipt From email
</title>
318 <comment>FROM email address used for receipts generated by contributions to this contribution page.
</comment>
322 <name>cc_receipt
</name>
323 <title>Receipt cc
</title>
326 <comment>comma-separated list of email addresses to cc each time a receipt is sent
</comment>
330 <name>bcc_receipt
</name>
331 <title>Receipt bcc
</title>
334 <comment>comma-separated list of email addresses to bcc each time a receipt is sent
</comment>
338 <name>receipt_text
</name>
339 <title>Receipt Text
</title>
342 <type>TextArea
</type>
346 <localizable>true
</localizable>
347 <comment>text to include above standard receipt info on receipt email. emails are text-only, so do not allow html for now
</comment>
351 <name>is_active
</name>
352 <title>Is Page Active?
</title>
354 <comment>Is this property active?
</comment>
358 <name>footer_text
</name>
359 <title>Footer Text
</title>
362 <type>RichTextEditor
</type>
366 <localizable>true
</localizable>
367 <comment>Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.
</comment>
371 <name>amount_block_is_active
</name>
372 <title>Is Amount Block Active?
</title>
374 <comment>Is this property active?
</comment>
379 <name>start_date
</name>
380 <title>Contribution Page Start Date
</title>
381 <type>datetime
</type>
382 <comment>Date and time that this page starts.
</comment>
386 <name>end_date
</name>
387 <type>datetime
</type>
388 <title>Contribution Page End Date
</title>
389 <comment>Date and time that this page ends. May be NULL if no defined end date/time
</comment>
393 <name>created_id
</name>
394 <title>Created By Contact ID
</title>
395 <type>int unsigned
</type>
396 <comment>FK to civicrm_contact, who created this contribution page
</comment>
398 <label>Created By
</label>
403 <name>created_id
</name>
404 <table>civicrm_contact
</table>
407 <onDelete>SET NULL
</onDelete>
410 <name>created_date
</name>
411 <type>datetime
</type>
412 <title>Contribution Page Created Date
</title>
413 <comment>Date and time that contribution page was created.
</comment>
417 <name>currency
</name>
418 <title>Contribution Page Currency
</title>
421 <default>NULL
</default>
422 <headerPattern>/cur(rency)?/i
</headerPattern>
423 <dataPattern>/^[A-Z]{
3}$/i
</dataPattern>
424 <comment>3 character string, value from config setting or input via user.
</comment>
427 <table>civicrm_currency
</table>
428 <keyColumn>name
</keyColumn>
429 <labelColumn>full_name
</labelColumn>
430 <nameColumn>name
</nameColumn>
431 <abbrColumn>symbol
</abbrColumn>
438 <name>campaign_id
</name>
439 <component>CiviCampaign
</component>
440 <title>Campaign ID
</title>
441 <type>int unsigned
</type>
442 <comment>The campaign for which we are collecting contributions with this page.
</comment>
444 <type>EntityRef
</type>
445 <label>Campaign
</label>
450 <name>campaign_id
</name>
451 <table>civicrm_campaign
</table>
453 <onDelete>SET NULL
</onDelete>
456 <name>is_share
</name>
457 <title>Is Contribution Page Shared?
</title>
460 <comment>Can people share the contribution page through social media?
</comment>
464 <name>is_billing_required
</name>
465 <title>Is billing block required
</title>
468 <comment>if true - billing block is required for online contribution page
</comment>
472 <name>frontend_title
</name>
473 <title>Public Title
</title>
476 <localizable>true
</localizable>
477 <default>NULL
</default>
478 <comment>Contribution Page Public title
</comment>
483 <uniqueName>contribution_page_frontend_title
</uniqueName>