Commit | Line | Data |
---|---|---|
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> | |
c1e814c7 | 94 | <required>true</required> |
6d68a4cb CW |
95 | <add>1.3</add> |
96 | </field> | |
97 | <field> | |
98 | <name>is_monetary</name> | |
53780a9b | 99 | <title>Is Monetary</title> |
6d68a4cb CW |
100 | <type>boolean</type> |
101 | <default>1</default> | |
c1e814c7 | 102 | <required>true</required> |
6d68a4cb CW |
103 | <comment>if true - allows real-time monetary transactions otherwise non-monetary transactions</comment> |
104 | <add>1.6</add> | |
105 | </field> | |
106 | <field> | |
107 | <name>is_recur</name> | |
53780a9b | 108 | <title>Is Recurring</title> |
6d68a4cb | 109 | <type>boolean</type> |
6a488035 | 110 | <default>0</default> |
c1e814c7 | 111 | <required>true</required> |
6d68a4cb CW |
112 | <comment>if true - allows recurring contributions, valid only for PayPal_Standard</comment> |
113 | <add>1.6</add> | |
114 | </field> | |
115 | <field> | |
116 | <name>is_confirm_enabled</name> | |
a3a35a7b | 117 | <title>Confirmation Page?</title> |
6d68a4cb CW |
118 | <type>boolean</type> |
119 | <default>1</default> | |
c1e814c7 | 120 | <required>true</required> |
6d68a4cb CW |
121 | <comment>if false, the confirm page in contribution pages gets skipped</comment> |
122 | <add>4.2</add> | |
6a488035 TO |
123 | </field> |
124 | <field> | |
125 | <name>recur_frequency_unit</name> | |
a3a35a7b | 126 | <title>Recurring Frequency</title> |
6a488035 TO |
127 | <type>varchar</type> |
128 | <length>128</length> | |
129 | <comment>Supported recurring frequency units.</comment> | |
2a5c9b4d CW |
130 | <pseudoconstant> |
131 | <optionGroupName>recur_frequency_units</optionGroupName> | |
132 | <keyColumn>name</keyColumn> | |
133 | </pseudoconstant> | |
134 | <html> | |
135 | <type>Select</type> | |
136 | <multiple>1</multiple> | |
137 | </html> | |
138 | <serialize>SEPARATOR_TRIMMED</serialize> | |
6a488035 TO |
139 | <add>2.1</add> |
140 | </field> | |
141 | <field> | |
6d68a4cb | 142 | <name>is_recur_interval</name> |
a3a35a7b | 143 | <title>Support Recurring Intervals</title> |
6d68a4cb CW |
144 | <type>boolean</type> |
145 | <default>0</default> | |
c1e814c7 | 146 | <required>true</required> |
6d68a4cb CW |
147 | <comment>if true - supports recurring intervals</comment> |
148 | <add>2.1</add> | |
6a488035 TO |
149 | </field> |
150 | <field> | |
6d68a4cb | 151 | <name>is_recur_installments</name> |
a3a35a7b | 152 | <title>Recurring Installments?</title> |
6d68a4cb CW |
153 | <type>boolean</type> |
154 | <default>0</default> | |
c1e814c7 | 155 | <required>true</required> |
6d68a4cb CW |
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> | |
c1e814c7 | 164 | <required>true</required> |
dccd9f4f ERL |
165 | <comment>if true - user is able to adjust payment start date</comment> |
166 | <add>4.7</add> | |
167 | </field> | |
6d68a4cb CW |
168 | <field> |
169 | <name>is_pay_later</name> | |
a3a35a7b | 170 | <title>Pay Later</title> |
6d68a4cb CW |
171 | <type>boolean</type> |
172 | <default>0</default> | |
c1e814c7 | 173 | <required>true</required> |
6d68a4cb CW |
174 | <comment>if true - allows the user to send payment directly to the org later</comment> |
175 | <add>2.0</add> | |
6a488035 | 176 | </field> |
6d68a4cb CW |
177 | <field> |
178 | <name>pay_later_text</name> | |
a3a35a7b | 179 | <title>Pay Later Text</title> |
6d68a4cb | 180 | <type>text</type> |
6a488035 | 181 | <localizable>true</localizable> |
6d68a4cb CW |
182 | <comment>The text displayed to the user in the main form</comment> |
183 | <add>2.0</add> | |
6a488035 | 184 | </field> |
6d68a4cb CW |
185 | <field> |
186 | <name>pay_later_receipt</name> | |
a3a35a7b | 187 | <title>Pay Later Receipt</title> |
6d68a4cb | 188 | <type>text</type> |
6a488035 | 189 | <localizable>true</localizable> |
6d68a4cb CW |
190 | <comment>The receipt sent to the user instead of the normal receipt text</comment> |
191 | <add>2.0</add> | |
192 | </field> | |
193 | <field> | |
194 | <name>is_partial_payment</name> | |
a3a35a7b | 195 | <title>Allow Partial Payment</title> |
6d68a4cb CW |
196 | <type>boolean</type> |
197 | <default>0</default> | |
198 | <comment>is partial payment enabled for this online contribution page</comment> | |
199 | <add>4.3</add> | |
200 | </field> | |
201 | <field> | |
202 | <name>initial_amount_label</name> | |
203 | <type>varchar</type> | |
204 | <length>255</length> | |
6a488035 | 205 | <localizable>true</localizable> |
6d68a4cb | 206 | <comment>Initial amount label for partial payment</comment> |
1662d426 A |
207 | <html> |
208 | <label>Initial Amount Label</label> | |
209 | </html> | |
6d68a4cb | 210 | <add>4.3</add> |
6a488035 | 211 | </field> |
6d68a4cb CW |
212 | <field> |
213 | <name>initial_amount_help_text</name> | |
214 | <type>text</type> | |
6a488035 | 215 | <localizable>true</localizable> |
6d68a4cb | 216 | <comment>Initial amount help text for partial payment</comment> |
1662d426 A |
217 | <html> |
218 | <label>Initial Amount Help Text</label> | |
219 | </html> | |
6d68a4cb | 220 | <add>4.3</add> |
6a488035 | 221 | </field> |
6d68a4cb CW |
222 | <field> |
223 | <name>min_initial_amount</name> | |
224 | <type>decimal</type> | |
225 | <comment>Minimum initial amount for partial payment</comment> | |
1662d426 A |
226 | <html> |
227 | <label>Min. Initial Amount</label> | |
228 | </html> | |
6d68a4cb | 229 | <add>4.3</add> |
6a488035 | 230 | </field> |
6d68a4cb CW |
231 | <field> |
232 | <name>is_allow_other_amount</name> | |
56da4f19 | 233 | <title>Allow Other Amounts</title> |
6d68a4cb CW |
234 | <type>boolean</type> |
235 | <comment>if true, page will include an input text field where user can enter their own amount</comment> | |
236 | <default>0</default> | |
c1e814c7 | 237 | <required>true</required> |
6d68a4cb | 238 | <add>1.3</add> |
6a488035 TO |
239 | </field> |
240 | <field> | |
241 | <name>default_amount_id</name> | |
56da4f19 | 242 | <title>Default Amount</title> |
6a488035 TO |
243 | <type>int unsigned</type> |
244 | <comment>FK to civicrm_option_value.</comment> | |
245 | <add>1.7</add> | |
246 | </field> | |
6d68a4cb CW |
247 | <field> |
248 | <name>min_amount</name> | |
56da4f19 | 249 | <title>Minimum Amount</title> |
6d68a4cb CW |
250 | <type>decimal</type> |
251 | <comment>if other amounts allowed, user can configure minimum allowed.</comment> | |
252 | <add>1.3</add> | |
253 | </field> | |
254 | <field> | |
255 | <name>max_amount</name> | |
56da4f19 | 256 | <title>Maximum Amount</title> |
6d68a4cb CW |
257 | <type>decimal</type> |
258 | <comment>if other amounts allowed, user can configure maximum allowed.</comment> | |
259 | <add>1.3</add> | |
260 | </field> | |
261 | <field> | |
262 | <name>goal_amount</name> | |
263 | <type>decimal</type> | |
264 | <comment>The target goal for this page, allows people to build a goal meter</comment> | |
1662d426 A |
265 | <html> |
266 | <label>Goal Amount</label> | |
267 | </html> | |
6d68a4cb | 268 | <add>1.5</add> |
6a488035 TO |
269 | </field> |
270 | <field> | |
271 | <name>thankyou_title</name> | |
272 | <title>Thank-you Title</title> | |
273 | <type>varchar</type> | |
274 | <length>255</length> | |
275 | <localizable>true</localizable> | |
276 | <comment>Title for Thank-you page (header title tag, and display at the top of the page).</comment> | |
277 | <add>1.3</add> | |
278 | </field> | |
6d68a4cb CW |
279 | <field> |
280 | <name>thankyou_text</name> | |
6a488035 | 281 | <title>Thank-you Text</title> |
6d68a4cb | 282 | <type>text</type> |
7deea513 | 283 | <html> |
313df5ee | 284 | <type>RichTextEditor</type> |
817807ab | 285 | <rows>8</rows> |
286 | <cols>60</cols> | |
7deea513 | 287 | </html> |
6a488035 | 288 | <localizable>true</localizable> |
6d68a4cb CW |
289 | <comment>text and html allowed. displayed above result on success page</comment> |
290 | <add>1.3</add> | |
291 | </field> | |
292 | <field> | |
293 | <name>thankyou_footer</name> | |
6a488035 | 294 | <title>Thank-you Footer</title> |
6d68a4cb | 295 | <type>text</type> |
7deea513 | 296 | <html> |
313df5ee | 297 | <type>RichTextEditor</type> |
817807ab | 298 | <rows>8</rows> |
299 | <cols>60</cols> | |
7deea513 | 300 | </html> |
6a488035 | 301 | <localizable>true</localizable> |
6d68a4cb CW |
302 | <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> |
303 | <add>1.3</add> | |
304 | </field> | |
6d68a4cb CW |
305 | <field> |
306 | <name>is_email_receipt</name> | |
56da4f19 | 307 | <title>Send email Receipt</title> |
6d68a4cb CW |
308 | <type>boolean</type> |
309 | <comment>if true, receipt is automatically emailed to contact on success</comment> | |
6a488035 | 310 | <default>0</default> |
c1e814c7 | 311 | <required>true</required> |
6d68a4cb CW |
312 | <add>1.3</add> |
313 | </field> | |
314 | <field> | |
6a488035 | 315 | <name>receipt_from_name</name> |
56da4f19 | 316 | <title>Receipt From</title> |
6d68a4cb | 317 | <type>varchar</type> |
6a488035 TO |
318 | <length>255</length> |
319 | <localizable>true</localizable> | |
6d68a4cb CW |
320 | <comment>FROM email name used for receipts generated by contributions to this contribution page.</comment> |
321 | <add>1.3</add> | |
322 | </field> | |
323 | <field> | |
324 | <name>receipt_from_email</name> | |
56da4f19 | 325 | <title>Receipt From email</title> |
6d68a4cb | 326 | <type>varchar</type> |
6a488035 | 327 | <length>255</length> |
6d68a4cb CW |
328 | <comment>FROM email address used for receipts generated by contributions to this contribution page.</comment> |
329 | <add>1.3</add> | |
330 | </field> | |
331 | <field> | |
332 | <name>cc_receipt</name> | |
56da4f19 | 333 | <title>Receipt cc</title> |
6d68a4cb | 334 | <type>varchar</type> |
6a488035 | 335 | <length>255</length> |
6d68a4cb CW |
336 | <comment>comma-separated list of email addresses to cc each time a receipt is sent</comment> |
337 | <add>1.3</add> | |
338 | </field> | |
339 | <field> | |
340 | <name>bcc_receipt</name> | |
56da4f19 | 341 | <title>Receipt bcc</title> |
6d68a4cb | 342 | <type>varchar</type> |
6a488035 | 343 | <length>255</length> |
6d68a4cb CW |
344 | <comment>comma-separated list of email addresses to bcc each time a receipt is sent</comment> |
345 | <add>1.3</add> | |
346 | </field> | |
347 | <field> | |
348 | <name>receipt_text</name> | |
56da4f19 | 349 | <title>Receipt Text</title> |
6a488035 | 350 | <type>text</type> |
7deea513 | 351 | <html> |
352 | <type>TextArea</type> | |
817807ab | 353 | <rows>6</rows> |
354 | <cols>50</cols> | |
7deea513 | 355 | </html> |
6a488035 TO |
356 | <localizable>true</localizable> |
357 | <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 |
358 | <add>1.3</add> |
359 | </field> | |
6a488035 TO |
360 | <field> |
361 | <name>is_active</name> | |
4cc2ccac | 362 | <title>Is Page Active?</title> |
6a488035 | 363 | <type>boolean</type> |
c1e814c7 MD |
364 | <default>1</default> |
365 | <required>true</required> | |
6a488035 TO |
366 | <comment>Is this property active?</comment> |
367 | <add>1.3</add> | |
368 | </field> | |
369 | <field> | |
370 | <name>footer_text</name> | |
4cc2ccac | 371 | <title>Footer Text</title> |
6a488035 | 372 | <type>text</type> |
7deea513 | 373 | <html> |
313df5ee | 374 | <type>RichTextEditor</type> |
817807ab | 375 | <rows>6</rows> |
376 | <cols>50</cols> | |
7deea513 | 377 | </html> |
6a488035 TO |
378 | <localizable>true</localizable> |
379 | <comment>Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.</comment> | |
380 | <add>1.4</add> | |
381 | </field> | |
382 | <field> | |
383 | <name>amount_block_is_active</name> | |
4cc2ccac | 384 | <title>Is Amount Block Active?</title> |
6a488035 TO |
385 | <type>boolean</type> |
386 | <comment>Is this property active?</comment> | |
387 | <default>1</default> | |
c1e814c7 | 388 | <required>true</required> |
6a488035 TO |
389 | <add>1.5</add> |
390 | </field> | |
6a488035 TO |
391 | <field> |
392 | <name>start_date</name> | |
4cc2ccac | 393 | <title>Contribution Page Start Date</title> |
6a488035 | 394 | <type>datetime</type> |
6a488035 TO |
395 | <comment>Date and time that this page starts.</comment> |
396 | <add>1.8</add> | |
397 | </field> | |
398 | <field> | |
399 | <name>end_date</name> | |
400 | <type>datetime</type> | |
401 | <title>Contribution Page End Date</title> | |
402 | <comment>Date and time that this page ends. May be NULL if no defined end date/time</comment> | |
403 | <add>1.8</add> | |
404 | </field> | |
405 | <field> | |
406 | <name>created_id</name> | |
047c5009 | 407 | <title>Created By Contact ID</title> |
6a488035 TO |
408 | <type>int unsigned</type> |
409 | <comment>FK to civicrm_contact, who created this contribution page</comment> | |
57e94608 | 410 | <html> |
047c5009 | 411 | <label>Created By</label> |
57e94608 | 412 | </html> |
6a488035 TO |
413 | <add>3.0</add> |
414 | </field> | |
415 | <foreignKey> | |
416 | <name>created_id</name> | |
417 | <table>civicrm_contact</table> | |
418 | <key>id</key> | |
419 | <add>3.0</add> | |
420 | <onDelete>SET NULL</onDelete> | |
421 | </foreignKey> | |
422 | <field> | |
423 | <name>created_date</name> | |
424 | <type>datetime</type> | |
425 | <title>Contribution Page Created Date</title> | |
426 | <comment>Date and time that contribution page was created.</comment> | |
427 | <add>3.0</add> | |
428 | </field> | |
6d68a4cb CW |
429 | <field> |
430 | <name>currency</name> | |
f389e500 | 431 | <title>Contribution Page Currency</title> |
6d68a4cb | 432 | <type>varchar</type> |
6a488035 TO |
433 | <length>3</length> |
434 | <default>NULL</default> | |
435 | <headerPattern>/cur(rency)?/i</headerPattern> | |
436 | <dataPattern>/^[A-Z]{3}$/i</dataPattern> | |
437 | <comment>3 character string, value from config setting or input via user.</comment> | |
bd44e0df AS |
438 | <add>3.3</add> |
439 | <pseudoconstant> | |
440 | <table>civicrm_currency</table> | |
441 | <keyColumn>name</keyColumn> | |
a38a89fc | 442 | <labelColumn>full_name</labelColumn> |
c3de5c5a | 443 | <nameColumn>name</nameColumn> |
a8fdb24e | 444 | <abbrColumn>symbol</abbrColumn> |
bd44e0df | 445 | </pseudoconstant> |
614d72ec | 446 | <html> |
e0991796 | 447 | <type>Select</type> |
614d72ec | 448 | </html> |
6d68a4cb CW |
449 | </field> |
450 | <field> | |
451 | <name>campaign_id</name> | |
88c31c05 | 452 | <component>CiviCampaign</component> |
047c5009 | 453 | <title>Campaign ID</title> |
6d68a4cb CW |
454 | <type>int unsigned</type> |
455 | <comment>The campaign for which we are collecting contributions with this page.</comment> | |
57e94608 | 456 | <html> |
8813f972 | 457 | <type>EntityRef</type> |
047c5009 | 458 | <label>Campaign</label> |
57e94608 | 459 | </html> |
6d68a4cb | 460 | <add>3.4</add> |
25ad69f2 CW |
461 | <pseudoconstant> |
462 | <table>civicrm_campaign</table> | |
463 | <keyColumn>id</keyColumn> | |
464 | <labelColumn>title</labelColumn> | |
465 | <prefetch>FALSE</prefetch> | |
466 | </pseudoconstant> | |
6d68a4cb CW |
467 | </field> |
468 | <foreignKey> | |
469 | <name>campaign_id</name> | |
470 | <table>civicrm_campaign</table> | |
471 | <key>id</key> | |
6a488035 TO |
472 | <onDelete>SET NULL</onDelete> |
473 | </foreignKey> | |
6d68a4cb CW |
474 | <field> |
475 | <name>is_share</name> | |
f389e500 | 476 | <title>Is Contribution Page Shared?</title> |
6a488035 | 477 | <type>boolean</type> |
6d68a4cb | 478 | <default>1</default> |
c1e814c7 | 479 | <required>true</required> |
6d68a4cb | 480 | <comment>Can people share the contribution page through social media?</comment> |
6a488035 TO |
481 | <add>4.1</add> |
482 | </field> | |
e45f6ab0 PB |
483 | <field> |
484 | <name>is_billing_required</name> | |
115fa278 | 485 | <title>Is billing block required</title> |
e45f6ab0 PB |
486 | <type>boolean</type> |
487 | <default>0</default> | |
c1e814c7 | 488 | <required>true</required> |
115fa278 | 489 | <comment>if true - billing block is required for online contribution page</comment> |
490 | <add>4.6</add> | |
e45f6ab0 | 491 | </field> |
6489e3de SL |
492 | <field> |
493 | <name>frontend_title</name> | |
494 | <title>Public Title</title> | |
495 | <type>varchar</type> | |
496 | <length>255</length> | |
497 | <localizable>true</localizable> | |
498 | <default>NULL</default> | |
499 | <comment>Contribution Page Public title</comment> | |
500 | <html> | |
501 | <type>Text</type> | |
502 | </html> | |
503 | <add>5.20</add> | |
504 | <uniqueName>contribution_page_frontend_title</uniqueName> | |
505 | </field> | |
6a488035 | 506 | </table> |