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