Merge pull request #15370 from JMAConsulting/core-692-2
[civicrm-core.git] / xml / schema / Contribute / ContributionPage.xml
CommitLineData
6a488035
TO
1<?xml version="1.0" encoding="iso-8859-1" ?>
2
3<table>
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>
8 <add>1.3</add>
9 <log>true</log>
10 <field>
11 <name>id</name>
455cfd16 12 <title>Contribution Page ID</title>
6a488035
TO
13 <type>int unsigned</type>
14 <required>true</required>
15 <comment>Contribution Id</comment>
16 <add>1.3</add>
17 </field>
18 <primaryKey>
19 <name>id</name>
20 <autoincrement>true</autoincrement>
21 </primaryKey>
22 <field>
23 <name>title</name>
f389e500 24 <title>Contribution Page Title</title>
6a488035
TO
25 <type>varchar</type>
26 <length>255</length>
27 <localizable>true</localizable>
28 <comment>Contribution Page title. For top of page display</comment>
29 <add>1.3</add>
30 </field>
31 <field>
32 <name>intro_text</name>
f389e500 33 <title>Contribution Page Introduction Text</title>
6a488035 34 <type>text</type>
7deea513 35 <html>
313df5ee 36 <type>RichTextEditor</type>
817807ab 37 <rows>6</rows>
38 <cols>50</cols>
7deea513 39 </html>
6a488035
TO
40 <localizable>true</localizable>
41 <comment>Text and html allowed. Displayed below title.</comment>
42 <add>1.3</add>
43 </field>
6d68a4cb
CW
44 <field>
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>
49 <add>1.3</add>
6a488035 50 <drop>4.3</drop>
6d68a4cb
CW
51 </field>
52 <foreignKey>
53 <name>contribution_type_id</name>
54 <table>civicrm_contribution_type</table>
55 <key>id</key>
6a488035
TO
56 <drop>4.3</drop>
57 </foreignKey>
6d68a4cb
CW
58 <field>
59 <name>financial_type_id</name>
7c759b5e 60 <title>Financial Type</title>
6d68a4cb
CW
61 <type>int unsigned</type>
62 <comment>default financial type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution</comment>
63 <pseudoconstant>
64 <table>civicrm_financial_type</table>
65 <keyColumn>id</keyColumn>
66 <labelColumn>name</labelColumn>
67 </pseudoconstant>
614d72ec 68 <html>
e0991796 69 <type>Select</type>
614d72ec 70 </html>
6d68a4cb
CW
71 <add>4.3</add>
72 </field>
73 <foreignKey>
74 <name>financial_type_id</name>
75 <table>civicrm_financial_type</table>
76 <key>id</key>
6a488035 77 <add>4.3</add>
6a488035 78 </foreignKey>
6d68a4cb
CW
79 <field>
80 <name>payment_processor</name>
6a488035
TO
81 <type>varchar</type>
82 <length>128</length>
6d68a4cb
CW
83 <comment>Payment Processors configured for this contribution Page</comment>
84 <pseudoconstant>
85 <table>civicrm_payment_processor</table>
86 <keyColumn>id</keyColumn>
87 <labelColumn>name</labelColumn>
88 </pseudoconstant>
614d72ec 89 <html>
e0991796 90 <type>Select</type>
614d72ec 91 </html>
6d68a4cb
CW
92 <add>1.8</add>
93 </field>
94 <field>
95 <name>is_credit_card_only</name>
53780a9b 96 <title>Is Credit Card Only?</title>
6d68a4cb
CW
97 <type>boolean</type>
98 <comment>if true - processing logic must reject transaction at confirmation stage if pay method != credit card</comment>
99 <default>0</default>
100 <add>1.3</add>
101 </field>
102 <field>
103 <name>is_monetary</name>
53780a9b 104 <title>Is Monetary</title>
6d68a4cb
CW
105 <type>boolean</type>
106 <default>1</default>
107 <comment>if true - allows real-time monetary transactions otherwise non-monetary transactions</comment>
108 <add>1.6</add>
109 </field>
110 <field>
111 <name>is_recur</name>
53780a9b 112 <title>Is Recurring</title>
6d68a4cb 113 <type>boolean</type>
6a488035 114 <default>0</default>
6d68a4cb
CW
115 <comment>if true - allows recurring contributions, valid only for PayPal_Standard</comment>
116 <add>1.6</add>
117 </field>
118 <field>
119 <name>is_confirm_enabled</name>
a3a35a7b 120 <title>Confirmation Page?</title>
6d68a4cb
CW
121 <type>boolean</type>
122 <default>1</default>
123 <comment>if false, the confirm page in contribution pages gets skipped</comment>
124 <add>4.2</add>
6a488035
TO
125 </field>
126 <field>
127 <name>recur_frequency_unit</name>
a3a35a7b 128 <title>Recurring Frequency</title>
6a488035
TO
129 <type>varchar</type>
130 <length>128</length>
131 <comment>Supported recurring frequency units.</comment>
2a5c9b4d
CW
132 <pseudoconstant>
133 <optionGroupName>recur_frequency_units</optionGroupName>
134 <keyColumn>name</keyColumn>
135 </pseudoconstant>
136 <html>
137 <type>Select</type>
138 <multiple>1</multiple>
139 </html>
140 <serialize>SEPARATOR_TRIMMED</serialize>
6a488035
TO
141 <add>2.1</add>
142 </field>
143 <field>
6d68a4cb 144 <name>is_recur_interval</name>
a3a35a7b 145 <title>Support Recurring Intervals</title>
6d68a4cb
CW
146 <type>boolean</type>
147 <default>0</default>
148 <comment>if true - supports recurring intervals</comment>
149 <add>2.1</add>
6a488035
TO
150 </field>
151 <field>
6d68a4cb 152 <name>is_recur_installments</name>
a3a35a7b 153 <title>Recurring Installments?</title>
6d68a4cb
CW
154 <type>boolean</type>
155 <default>0</default>
156 <comment>if true - asks user for recurring installments</comment>
157 <add>4.3</add>
6a488035 158 </field>
dccd9f4f
ERL
159 <field>
160 <name>adjust_recur_start_date</name>
161 <title>Adjust Recurring Start Date</title>
162 <type>boolean</type>
163 <default>0</default>
164 <comment>if true - user is able to adjust payment start date</comment>
165 <add>4.7</add>
166 </field>
6d68a4cb
CW
167 <field>
168 <name>is_pay_later</name>
a3a35a7b 169 <title>Pay Later</title>
6d68a4cb
CW
170 <type>boolean</type>
171 <default>0</default>
172 <comment>if true - allows the user to send payment directly to the org later</comment>
173 <add>2.0</add>
6a488035 174 </field>
6d68a4cb
CW
175 <field>
176 <name>pay_later_text</name>
a3a35a7b 177 <title>Pay Later Text</title>
6d68a4cb 178 <type>text</type>
6a488035 179 <localizable>true</localizable>
6d68a4cb
CW
180 <comment>The text displayed to the user in the main form</comment>
181 <add>2.0</add>
6a488035 182 </field>
6d68a4cb
CW
183 <field>
184 <name>pay_later_receipt</name>
a3a35a7b 185 <title>Pay Later Receipt</title>
6d68a4cb 186 <type>text</type>
6a488035 187 <localizable>true</localizable>
6d68a4cb
CW
188 <comment>The receipt sent to the user instead of the normal receipt text</comment>
189 <add>2.0</add>
190 </field>
191 <field>
192 <name>is_partial_payment</name>
a3a35a7b 193 <title>Allow Partial Payment</title>
6d68a4cb
CW
194 <type>boolean</type>
195 <default>0</default>
196 <comment>is partial payment enabled for this online contribution page</comment>
197 <add>4.3</add>
198 </field>
199 <field>
200 <name>initial_amount_label</name>
201 <type>varchar</type>
202 <length>255</length>
6a488035 203 <localizable>true</localizable>
6d68a4cb
CW
204 <comment>Initial amount label for partial payment</comment>
205 <add>4.3</add>
6a488035 206 </field>
6d68a4cb
CW
207 <field>
208 <name>initial_amount_help_text</name>
209 <type>text</type>
6a488035 210 <localizable>true</localizable>
6d68a4cb
CW
211 <comment>Initial amount help text for partial payment</comment>
212 <add>4.3</add>
6a488035 213 </field>
6d68a4cb
CW
214 <field>
215 <name>min_initial_amount</name>
216 <type>decimal</type>
217 <comment>Minimum initial amount for partial payment</comment>
218 <add>4.3</add>
6a488035 219 </field>
6d68a4cb
CW
220 <field>
221 <name>is_allow_other_amount</name>
56da4f19 222 <title>Allow Other Amounts</title>
6d68a4cb
CW
223 <type>boolean</type>
224 <comment>if true, page will include an input text field where user can enter their own amount</comment>
225 <default>0</default>
226 <add>1.3</add>
6a488035
TO
227 </field>
228 <field>
229 <name>default_amount_id</name>
56da4f19 230 <title>Default Amount</title>
6a488035
TO
231 <type>int unsigned</type>
232 <comment>FK to civicrm_option_value.</comment>
233 <add>1.7</add>
234 </field>
6d68a4cb
CW
235 <field>
236 <name>min_amount</name>
56da4f19 237 <title>Minimum Amount</title>
6d68a4cb
CW
238 <type>decimal</type>
239 <comment>if other amounts allowed, user can configure minimum allowed.</comment>
240 <add>1.3</add>
241 </field>
242 <field>
243 <name>max_amount</name>
56da4f19 244 <title>Maximum Amount</title>
6d68a4cb
CW
245 <type>decimal</type>
246 <comment>if other amounts allowed, user can configure maximum allowed.</comment>
247 <add>1.3</add>
248 </field>
249 <field>
250 <name>goal_amount</name>
251 <type>decimal</type>
252 <comment>The target goal for this page, allows people to build a goal meter</comment>
253 <add>1.5</add>
6a488035
TO
254 </field>
255 <field>
256 <name>thankyou_title</name>
257 <title>Thank-you Title</title>
258 <type>varchar</type>
259 <length>255</length>
260 <localizable>true</localizable>
261 <comment>Title for Thank-you page (header title tag, and display at the top of the page).</comment>
262 <add>1.3</add>
263 </field>
6d68a4cb
CW
264 <field>
265 <name>thankyou_text</name>
6a488035 266 <title>Thank-you Text</title>
6d68a4cb 267 <type>text</type>
7deea513 268 <html>
313df5ee 269 <type>RichTextEditor</type>
817807ab 270 <rows>8</rows>
271 <cols>60</cols>
7deea513 272 </html>
6a488035 273 <localizable>true</localizable>
6d68a4cb
CW
274 <comment>text and html allowed. displayed above result on success page</comment>
275 <add>1.3</add>
276 </field>
277 <field>
278 <name>thankyou_footer</name>
6a488035 279 <title>Thank-you Footer</title>
6d68a4cb 280 <type>text</type>
7deea513 281 <html>
313df5ee 282 <type>RichTextEditor</type>
817807ab 283 <rows>8</rows>
284 <cols>60</cols>
7deea513 285 </html>
6a488035 286 <localizable>true</localizable>
6d68a4cb
CW
287 <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>
288 <add>1.3</add>
289 </field>
6d68a4cb
CW
290 <field>
291 <name>is_email_receipt</name>
56da4f19 292 <title>Send email Receipt</title>
6d68a4cb
CW
293 <type>boolean</type>
294 <comment>if true, receipt is automatically emailed to contact on success</comment>
6a488035 295 <default>0</default>
6d68a4cb
CW
296 <add>1.3</add>
297 </field>
298 <field>
6a488035 299 <name>receipt_from_name</name>
56da4f19 300 <title>Receipt From</title>
6d68a4cb 301 <type>varchar</type>
6a488035
TO
302 <length>255</length>
303 <localizable>true</localizable>
6d68a4cb
CW
304 <comment>FROM email name used for receipts generated by contributions to this contribution page.</comment>
305 <add>1.3</add>
306 </field>
307 <field>
308 <name>receipt_from_email</name>
56da4f19 309 <title>Receipt From email</title>
6d68a4cb 310 <type>varchar</type>
6a488035 311 <length>255</length>
6d68a4cb
CW
312 <comment>FROM email address used for receipts generated by contributions to this contribution page.</comment>
313 <add>1.3</add>
314 </field>
315 <field>
316 <name>cc_receipt</name>
56da4f19 317 <title>Receipt cc</title>
6d68a4cb 318 <type>varchar</type>
6a488035 319 <length>255</length>
6d68a4cb
CW
320 <comment>comma-separated list of email addresses to cc each time a receipt is sent</comment>
321 <add>1.3</add>
322 </field>
323 <field>
324 <name>bcc_receipt</name>
56da4f19 325 <title>Receipt bcc</title>
6d68a4cb 326 <type>varchar</type>
6a488035 327 <length>255</length>
6d68a4cb
CW
328 <comment>comma-separated list of email addresses to bcc each time a receipt is sent</comment>
329 <add>1.3</add>
330 </field>
331 <field>
332 <name>receipt_text</name>
56da4f19 333 <title>Receipt Text</title>
6a488035 334 <type>text</type>
7deea513 335 <html>
336 <type>TextArea</type>
817807ab 337 <rows>6</rows>
338 <cols>50</cols>
7deea513 339 </html>
6a488035
TO
340 <localizable>true</localizable>
341 <comment>text to include above standard receipt info on receipt email. emails are text-only, so do not allow html for now</comment>
6d68a4cb
CW
342 <add>1.3</add>
343 </field>
6a488035
TO
344 <field>
345 <name>is_active</name>
4cc2ccac 346 <title>Is Page Active?</title>
6a488035
TO
347 <type>boolean</type>
348 <comment>Is this property active?</comment>
349 <add>1.3</add>
350 </field>
351 <field>
352 <name>footer_text</name>
4cc2ccac 353 <title>Footer Text</title>
6a488035 354 <type>text</type>
7deea513 355 <html>
313df5ee 356 <type>RichTextEditor</type>
817807ab 357 <rows>6</rows>
358 <cols>50</cols>
7deea513 359 </html>
6a488035
TO
360 <localizable>true</localizable>
361 <comment>Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.</comment>
362 <add>1.4</add>
363 </field>
364 <field>
365 <name>amount_block_is_active</name>
4cc2ccac 366 <title>Is Amount Block Active?</title>
6a488035
TO
367 <type>boolean</type>
368 <comment>Is this property active?</comment>
369 <default>1</default>
370 <add>1.5</add>
371 </field>
6a488035
TO
372 <field>
373 <name>start_date</name>
4cc2ccac 374 <title>Contribution Page Start Date</title>
6a488035
TO
375 <type>datetime</type>
376 <title>Contribution Page Start Date</title>
377 <comment>Date and time that this page starts.</comment>
378 <add>1.8</add>
379 </field>
380 <field>
381 <name>end_date</name>
382 <type>datetime</type>
383 <title>Contribution Page End Date</title>
384 <comment>Date and time that this page ends. May be NULL if no defined end date/time</comment>
385 <add>1.8</add>
386 </field>
387 <field>
388 <name>created_id</name>
f389e500 389 <title>Contribution Page Created By</title>
6a488035
TO
390 <type>int unsigned</type>
391 <comment>FK to civicrm_contact, who created this contribution page</comment>
392 <add>3.0</add>
393 </field>
394 <foreignKey>
395 <name>created_id</name>
396 <table>civicrm_contact</table>
397 <key>id</key>
398 <add>3.0</add>
399 <onDelete>SET NULL</onDelete>
400 </foreignKey>
401 <field>
402 <name>created_date</name>
403 <type>datetime</type>
404 <title>Contribution Page Created Date</title>
405 <comment>Date and time that contribution page was created.</comment>
406 <add>3.0</add>
407 </field>
6d68a4cb
CW
408 <field>
409 <name>currency</name>
f389e500 410 <title>Contribution Page Currency</title>
6d68a4cb 411 <type>varchar</type>
6a488035
TO
412 <length>3</length>
413 <default>NULL</default>
414 <headerPattern>/cur(rency)?/i</headerPattern>
415 <dataPattern>/^[A-Z]{3}$/i</dataPattern>
416 <comment>3 character string, value from config setting or input via user.</comment>
bd44e0df
AS
417 <add>3.3</add>
418 <pseudoconstant>
419 <table>civicrm_currency</table>
420 <keyColumn>name</keyColumn>
a38a89fc 421 <labelColumn>full_name</labelColumn>
c3de5c5a 422 <nameColumn>name</nameColumn>
a8fdb24e 423 <abbrColumn>symbol</abbrColumn>
bd44e0df 424 </pseudoconstant>
614d72ec 425 <html>
e0991796 426 <type>Select</type>
614d72ec 427 </html>
6d68a4cb
CW
428 </field>
429 <field>
430 <name>campaign_id</name>
f389e500 431 <title>Contribution Page Campaign ID</title>
6d68a4cb
CW
432 <type>int unsigned</type>
433 <comment>The campaign for which we are collecting contributions with this page.</comment>
3e3eacd0
CW
434 <pseudoconstant>
435 <table>civicrm_campaign</table>
436 <keyColumn>id</keyColumn>
437 <labelColumn>title</labelColumn>
3e3eacd0 438 </pseudoconstant>
6d68a4cb
CW
439 <add>3.4</add>
440 </field>
441 <foreignKey>
442 <name>campaign_id</name>
443 <table>civicrm_campaign</table>
444 <key>id</key>
6a488035
TO
445 <onDelete>SET NULL</onDelete>
446 </foreignKey>
6d68a4cb
CW
447 <field>
448 <name>is_share</name>
f389e500 449 <title>Is Contribution Page Shared?</title>
6a488035 450 <type>boolean</type>
6d68a4cb
CW
451 <default>1</default>
452 <comment>Can people share the contribution page through social media?</comment>
6a488035
TO
453 <add>4.1</add>
454 </field>
e45f6ab0
PB
455 <field>
456 <name>is_billing_required</name>
115fa278 457 <title>Is billing block required</title>
e45f6ab0
PB
458 <type>boolean</type>
459 <default>0</default>
115fa278 460 <comment>if true - billing block is required for online contribution page</comment>
461 <add>4.6</add>
e45f6ab0 462 </field>
6489e3de
SL
463 <field>
464 <name>frontend_title</name>
465 <title>Public Title</title>
466 <type>varchar</type>
467 <length>255</length>
468 <localizable>true</localizable>
469 <default>NULL</default>
470 <comment>Contribution Page Public title</comment>
471 <html>
472 <type>Text</type>
473 </html>
474 <add>5.20</add>
475 <uniqueName>contribution_page_frontend_title</uniqueName>
476 </field>
6a488035 477</table>