Merge pull request #8677 from eileenmcnaughton/logging
[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>
132 <add>2.1</add>
133 </field>
134 <field>
6d68a4cb 135 <name>is_recur_interval</name>
a3a35a7b 136 <title>Support Recurring Intervals</title>
6d68a4cb
CW
137 <type>boolean</type>
138 <default>0</default>
139 <comment>if true - supports recurring intervals</comment>
140 <add>2.1</add>
6a488035
TO
141 </field>
142 <field>
6d68a4cb 143 <name>is_recur_installments</name>
a3a35a7b 144 <title>Recurring Installments?</title>
6d68a4cb
CW
145 <type>boolean</type>
146 <default>0</default>
147 <comment>if true - asks user for recurring installments</comment>
148 <add>4.3</add>
6a488035 149 </field>
dccd9f4f
ERL
150 <field>
151 <name>adjust_recur_start_date</name>
152 <title>Adjust Recurring Start Date</title>
153 <type>boolean</type>
154 <default>0</default>
155 <comment>if true - user is able to adjust payment start date</comment>
156 <add>4.7</add>
157 </field>
6d68a4cb
CW
158 <field>
159 <name>is_pay_later</name>
a3a35a7b 160 <title>Pay Later</title>
6d68a4cb
CW
161 <type>boolean</type>
162 <default>0</default>
163 <comment>if true - allows the user to send payment directly to the org later</comment>
164 <add>2.0</add>
6a488035 165 </field>
6d68a4cb
CW
166 <field>
167 <name>pay_later_text</name>
a3a35a7b 168 <title>Pay Later Text</title>
6d68a4cb 169 <type>text</type>
6a488035 170 <localizable>true</localizable>
6d68a4cb
CW
171 <comment>The text displayed to the user in the main form</comment>
172 <add>2.0</add>
6a488035 173 </field>
6d68a4cb
CW
174 <field>
175 <name>pay_later_receipt</name>
a3a35a7b 176 <title>Pay Later Receipt</title>
6d68a4cb 177 <type>text</type>
6a488035 178 <localizable>true</localizable>
6d68a4cb
CW
179 <comment>The receipt sent to the user instead of the normal receipt text</comment>
180 <add>2.0</add>
181 </field>
182 <field>
183 <name>is_partial_payment</name>
a3a35a7b 184 <title>Allow Partial Payment</title>
6d68a4cb
CW
185 <type>boolean</type>
186 <default>0</default>
187 <comment>is partial payment enabled for this online contribution page</comment>
188 <add>4.3</add>
189 </field>
190 <field>
191 <name>initial_amount_label</name>
192 <type>varchar</type>
193 <length>255</length>
6a488035 194 <localizable>true</localizable>
6d68a4cb
CW
195 <comment>Initial amount label for partial payment</comment>
196 <add>4.3</add>
6a488035 197 </field>
6d68a4cb
CW
198 <field>
199 <name>initial_amount_help_text</name>
200 <type>text</type>
6a488035 201 <localizable>true</localizable>
6d68a4cb
CW
202 <comment>Initial amount help text for partial payment</comment>
203 <add>4.3</add>
6a488035 204 </field>
6d68a4cb
CW
205 <field>
206 <name>min_initial_amount</name>
207 <type>decimal</type>
208 <comment>Minimum initial amount for partial payment</comment>
209 <add>4.3</add>
6a488035 210 </field>
6d68a4cb
CW
211 <field>
212 <name>is_allow_other_amount</name>
56da4f19 213 <title>Allow Other Amounts</title>
6d68a4cb
CW
214 <type>boolean</type>
215 <comment>if true, page will include an input text field where user can enter their own amount</comment>
216 <default>0</default>
217 <add>1.3</add>
6a488035
TO
218 </field>
219 <field>
220 <name>default_amount_id</name>
56da4f19 221 <title>Default Amount</title>
6a488035
TO
222 <type>int unsigned</type>
223 <comment>FK to civicrm_option_value.</comment>
224 <add>1.7</add>
225 </field>
6d68a4cb
CW
226 <field>
227 <name>min_amount</name>
56da4f19 228 <title>Minimum Amount</title>
6d68a4cb
CW
229 <type>decimal</type>
230 <comment>if other amounts allowed, user can configure minimum allowed.</comment>
231 <add>1.3</add>
232 </field>
233 <field>
234 <name>max_amount</name>
56da4f19 235 <title>Maximum Amount</title>
6d68a4cb
CW
236 <type>decimal</type>
237 <comment>if other amounts allowed, user can configure maximum allowed.</comment>
238 <add>1.3</add>
239 </field>
240 <field>
241 <name>goal_amount</name>
242 <type>decimal</type>
243 <comment>The target goal for this page, allows people to build a goal meter</comment>
244 <add>1.5</add>
6a488035
TO
245 </field>
246 <field>
247 <name>thankyou_title</name>
248 <title>Thank-you Title</title>
249 <type>varchar</type>
250 <length>255</length>
251 <localizable>true</localizable>
252 <comment>Title for Thank-you page (header title tag, and display at the top of the page).</comment>
253 <add>1.3</add>
254 </field>
6d68a4cb
CW
255 <field>
256 <name>thankyou_text</name>
6a488035 257 <title>Thank-you Text</title>
6d68a4cb 258 <type>text</type>
7deea513 259 <html>
313df5ee 260 <type>RichTextEditor</type>
817807ab 261 <rows>8</rows>
262 <cols>60</cols>
7deea513 263 </html>
6a488035 264 <localizable>true</localizable>
6d68a4cb
CW
265 <comment>text and html allowed. displayed above result on success page</comment>
266 <add>1.3</add>
267 </field>
268 <field>
269 <name>thankyou_footer</name>
6a488035 270 <title>Thank-you Footer</title>
6d68a4cb 271 <type>text</type>
7deea513 272 <html>
313df5ee 273 <type>RichTextEditor</type>
817807ab 274 <rows>8</rows>
275 <cols>60</cols>
7deea513 276 </html>
6a488035 277 <localizable>true</localizable>
6d68a4cb
CW
278 <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>
279 <add>1.3</add>
280 </field>
6d68a4cb
CW
281 <field>
282 <name>is_email_receipt</name>
56da4f19 283 <title>Send email Receipt</title>
6d68a4cb
CW
284 <type>boolean</type>
285 <comment>if true, receipt is automatically emailed to contact on success</comment>
6a488035 286 <default>0</default>
6d68a4cb
CW
287 <add>1.3</add>
288 </field>
289 <field>
6a488035 290 <name>receipt_from_name</name>
56da4f19 291 <title>Receipt From</title>
6d68a4cb 292 <type>varchar</type>
6a488035
TO
293 <length>255</length>
294 <localizable>true</localizable>
6d68a4cb
CW
295 <comment>FROM email name used for receipts generated by contributions to this contribution page.</comment>
296 <add>1.3</add>
297 </field>
298 <field>
299 <name>receipt_from_email</name>
56da4f19 300 <title>Receipt From email</title>
6d68a4cb 301 <type>varchar</type>
6a488035 302 <length>255</length>
6d68a4cb
CW
303 <comment>FROM email address used for receipts generated by contributions to this contribution page.</comment>
304 <add>1.3</add>
305 </field>
306 <field>
307 <name>cc_receipt</name>
56da4f19 308 <title>Receipt cc</title>
6d68a4cb 309 <type>varchar</type>
6a488035 310 <length>255</length>
6d68a4cb
CW
311 <comment>comma-separated list of email addresses to cc each time a receipt is sent</comment>
312 <add>1.3</add>
313 </field>
314 <field>
315 <name>bcc_receipt</name>
56da4f19 316 <title>Receipt bcc</title>
6d68a4cb 317 <type>varchar</type>
6a488035 318 <length>255</length>
6d68a4cb
CW
319 <comment>comma-separated list of email addresses to bcc each time a receipt is sent</comment>
320 <add>1.3</add>
321 </field>
322 <field>
323 <name>receipt_text</name>
56da4f19 324 <title>Receipt Text</title>
6a488035 325 <type>text</type>
7deea513 326 <html>
327 <type>TextArea</type>
817807ab 328 <rows>6</rows>
329 <cols>50</cols>
7deea513 330 </html>
6a488035
TO
331 <localizable>true</localizable>
332 <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
333 <add>1.3</add>
334 </field>
6a488035
TO
335 <field>
336 <name>is_active</name>
4cc2ccac 337 <title>Is Page Active?</title>
6a488035
TO
338 <type>boolean</type>
339 <comment>Is this property active?</comment>
340 <add>1.3</add>
341 </field>
342 <field>
343 <name>footer_text</name>
4cc2ccac 344 <title>Footer Text</title>
6a488035 345 <type>text</type>
7deea513 346 <html>
313df5ee 347 <type>RichTextEditor</type>
817807ab 348 <rows>6</rows>
349 <cols>50</cols>
7deea513 350 </html>
6a488035
TO
351 <localizable>true</localizable>
352 <comment>Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.</comment>
353 <add>1.4</add>
354 </field>
355 <field>
356 <name>amount_block_is_active</name>
4cc2ccac 357 <title>Is Amount Block Active?</title>
6a488035
TO
358 <type>boolean</type>
359 <comment>Is this property active?</comment>
360 <default>1</default>
361 <add>1.5</add>
362 </field>
6a488035
TO
363 <field>
364 <name>start_date</name>
4cc2ccac 365 <title>Contribution Page Start Date</title>
6a488035
TO
366 <type>datetime</type>
367 <title>Contribution Page Start Date</title>
368 <comment>Date and time that this page starts.</comment>
369 <add>1.8</add>
370 </field>
371 <field>
372 <name>end_date</name>
373 <type>datetime</type>
374 <title>Contribution Page End Date</title>
375 <comment>Date and time that this page ends. May be NULL if no defined end date/time</comment>
376 <add>1.8</add>
377 </field>
378 <field>
379 <name>created_id</name>
f389e500 380 <title>Contribution Page Created By</title>
6a488035
TO
381 <type>int unsigned</type>
382 <comment>FK to civicrm_contact, who created this contribution page</comment>
383 <add>3.0</add>
384 </field>
385 <foreignKey>
386 <name>created_id</name>
387 <table>civicrm_contact</table>
388 <key>id</key>
389 <add>3.0</add>
390 <onDelete>SET NULL</onDelete>
391 </foreignKey>
392 <field>
393 <name>created_date</name>
394 <type>datetime</type>
395 <title>Contribution Page Created Date</title>
396 <comment>Date and time that contribution page was created.</comment>
397 <add>3.0</add>
398 </field>
6d68a4cb
CW
399 <field>
400 <name>currency</name>
f389e500 401 <title>Contribution Page Currency</title>
6d68a4cb 402 <type>varchar</type>
6a488035
TO
403 <length>3</length>
404 <default>NULL</default>
405 <headerPattern>/cur(rency)?/i</headerPattern>
406 <dataPattern>/^[A-Z]{3}$/i</dataPattern>
407 <comment>3 character string, value from config setting or input via user.</comment>
bd44e0df
AS
408 <add>3.3</add>
409 <pseudoconstant>
410 <table>civicrm_currency</table>
411 <keyColumn>name</keyColumn>
a38a89fc 412 <labelColumn>full_name</labelColumn>
c3de5c5a 413 <nameColumn>name</nameColumn>
bd44e0df 414 </pseudoconstant>
614d72ec 415 <html>
e0991796 416 <type>Select</type>
614d72ec 417 </html>
6d68a4cb
CW
418 </field>
419 <field>
420 <name>campaign_id</name>
f389e500 421 <title>Contribution Page Campaign ID</title>
6d68a4cb
CW
422 <type>int unsigned</type>
423 <comment>The campaign for which we are collecting contributions with this page.</comment>
3e3eacd0
CW
424 <pseudoconstant>
425 <table>civicrm_campaign</table>
426 <keyColumn>id</keyColumn>
427 <labelColumn>title</labelColumn>
3e3eacd0 428 </pseudoconstant>
6d68a4cb
CW
429 <add>3.4</add>
430 </field>
431 <foreignKey>
432 <name>campaign_id</name>
433 <table>civicrm_campaign</table>
434 <key>id</key>
6a488035
TO
435 <onDelete>SET NULL</onDelete>
436 </foreignKey>
6d68a4cb
CW
437 <field>
438 <name>is_share</name>
f389e500 439 <title>Is Contribution Page Shared?</title>
6a488035 440 <type>boolean</type>
6d68a4cb
CW
441 <default>1</default>
442 <comment>Can people share the contribution page through social media?</comment>
6a488035
TO
443 <add>4.1</add>
444 </field>
e45f6ab0
PB
445 <field>
446 <name>is_billing_required</name>
115fa278 447 <title>Is billing block required</title>
e45f6ab0
PB
448 <type>boolean</type>
449 <default>0</default>
115fa278 450 <comment>if true - billing block is required for online contribution page</comment>
451 <add>4.6</add>
e45f6ab0 452 </field>
6a488035 453</table>