CRM-13497 - getting there on main tables
[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>
12 <type>int unsigned</type>
13 <required>true</required>
14 <comment>Contribution Id</comment>
15 <add>1.3</add>
16 </field>
17 <primaryKey>
18 <name>id</name>
19 <autoincrement>true</autoincrement>
20 </primaryKey>
21 <field>
22 <name>title</name>
23 <type>varchar</type>
24 <length>255</length>
25 <localizable>true</localizable>
26 <comment>Contribution Page title. For top of page display</comment>
27 <add>1.3</add>
28 </field>
29 <field>
30 <name>intro_text</name>
31 <type>text</type>
7deea513 32 <html>
33 <type>TextArea</type>
817807ab 34 <rows>6</rows>
35 <cols>50</cols>
7deea513 36 </html>
6a488035
TO
37 <localizable>true</localizable>
38 <comment>Text and html allowed. Displayed below title.</comment>
39 <add>1.3</add>
40 </field>
6d68a4cb
CW
41 <field>
42 <name>contribution_type_id</name>
43 <type>int unsigned</type>
44 <required>true</required>
45 <comment>default Contribution type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution</comment>
46 <add>1.3</add>
6a488035 47 <drop>4.3</drop>
6d68a4cb
CW
48 </field>
49 <foreignKey>
50 <name>contribution_type_id</name>
51 <table>civicrm_contribution_type</table>
52 <key>id</key>
6a488035
TO
53 <drop>4.3</drop>
54 </foreignKey>
6d68a4cb
CW
55 <field>
56 <name>financial_type_id</name>
57 <type>int unsigned</type>
58 <comment>default financial type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution</comment>
59 <pseudoconstant>
60 <table>civicrm_financial_type</table>
61 <keyColumn>id</keyColumn>
62 <labelColumn>name</labelColumn>
63 </pseudoconstant>
614d72ec 64 <html>
65 <type>Select></type>
66 </html>
6d68a4cb
CW
67 <add>4.3</add>
68 </field>
69 <foreignKey>
70 <name>financial_type_id</name>
71 <table>civicrm_financial_type</table>
72 <key>id</key>
6a488035 73 <add>4.3</add>
6a488035 74 </foreignKey>
6d68a4cb
CW
75 <field>
76 <name>payment_processor</name>
6a488035
TO
77 <type>varchar</type>
78 <length>128</length>
6d68a4cb
CW
79 <comment>Payment Processors configured for this contribution Page</comment>
80 <pseudoconstant>
81 <table>civicrm_payment_processor</table>
82 <keyColumn>id</keyColumn>
83 <labelColumn>name</labelColumn>
84 </pseudoconstant>
614d72ec 85 <html>
86 <type>Select></type>
87 </html>
6d68a4cb
CW
88 <add>1.8</add>
89 </field>
90 <field>
91 <name>is_credit_card_only</name>
92 <type>boolean</type>
93 <comment>if true - processing logic must reject transaction at confirmation stage if pay method != credit card</comment>
94 <default>0</default>
95 <add>1.3</add>
96 </field>
97 <field>
98 <name>is_monetary</name>
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>
106 <type>boolean</type>
6a488035 107 <default>0</default>
6d68a4cb
CW
108 <comment>if true - allows recurring contributions, valid only for PayPal_Standard</comment>
109 <add>1.6</add>
110 </field>
111 <field>
112 <name>is_confirm_enabled</name>
113 <type>boolean</type>
114 <default>1</default>
115 <comment>if false, the confirm page in contribution pages gets skipped</comment>
116 <add>4.2</add>
6a488035
TO
117 </field>
118 <field>
119 <name>recur_frequency_unit</name>
120 <type>varchar</type>
121 <length>128</length>
122 <comment>Supported recurring frequency units.</comment>
123 <add>2.1</add>
124 </field>
125 <field>
6d68a4cb
CW
126 <name>is_recur_interval</name>
127 <type>boolean</type>
128 <default>0</default>
129 <comment>if true - supports recurring intervals</comment>
130 <add>2.1</add>
6a488035
TO
131 </field>
132 <field>
6d68a4cb
CW
133 <name>is_recur_installments</name>
134 <type>boolean</type>
135 <default>0</default>
136 <comment>if true - asks user for recurring installments</comment>
137 <add>4.3</add>
6a488035 138 </field>
6d68a4cb
CW
139 <field>
140 <name>is_pay_later</name>
141 <type>boolean</type>
142 <default>0</default>
143 <comment>if true - allows the user to send payment directly to the org later</comment>
144 <add>2.0</add>
6a488035 145 </field>
6d68a4cb
CW
146 <field>
147 <name>pay_later_text</name>
148 <type>text</type>
6a488035 149 <localizable>true</localizable>
6d68a4cb
CW
150 <comment>The text displayed to the user in the main form</comment>
151 <add>2.0</add>
6a488035 152 </field>
6d68a4cb
CW
153 <field>
154 <name>pay_later_receipt</name>
155 <type>text</type>
6a488035 156 <localizable>true</localizable>
6d68a4cb
CW
157 <comment>The receipt sent to the user instead of the normal receipt text</comment>
158 <add>2.0</add>
159 </field>
160 <field>
161 <name>is_partial_payment</name>
162 <type>boolean</type>
163 <default>0</default>
164 <comment>is partial payment enabled for this online contribution page</comment>
165 <add>4.3</add>
166 </field>
167 <field>
168 <name>initial_amount_label</name>
169 <type>varchar</type>
170 <length>255</length>
6a488035 171 <localizable>true</localizable>
6d68a4cb
CW
172 <comment>Initial amount label for partial payment</comment>
173 <add>4.3</add>
6a488035 174 </field>
6d68a4cb
CW
175 <field>
176 <name>initial_amount_help_text</name>
177 <type>text</type>
6a488035 178 <localizable>true</localizable>
6d68a4cb
CW
179 <comment>Initial amount help text for partial payment</comment>
180 <add>4.3</add>
6a488035 181 </field>
6d68a4cb
CW
182 <field>
183 <name>min_initial_amount</name>
184 <type>decimal</type>
185 <comment>Minimum initial amount for partial payment</comment>
186 <add>4.3</add>
6a488035 187 </field>
6d68a4cb
CW
188 <field>
189 <name>is_allow_other_amount</name>
190 <type>boolean</type>
191 <comment>if true, page will include an input text field where user can enter their own amount</comment>
192 <default>0</default>
193 <add>1.3</add>
6a488035
TO
194 </field>
195 <field>
196 <name>default_amount_id</name>
197 <type>int unsigned</type>
198 <comment>FK to civicrm_option_value.</comment>
199 <add>1.7</add>
200 </field>
6d68a4cb
CW
201 <field>
202 <name>min_amount</name>
203 <type>decimal</type>
204 <comment>if other amounts allowed, user can configure minimum allowed.</comment>
205 <add>1.3</add>
206 </field>
207 <field>
208 <name>max_amount</name>
209 <type>decimal</type>
210 <comment>if other amounts allowed, user can configure maximum allowed.</comment>
211 <add>1.3</add>
212 </field>
213 <field>
214 <name>goal_amount</name>
215 <type>decimal</type>
216 <comment>The target goal for this page, allows people to build a goal meter</comment>
217 <add>1.5</add>
6a488035
TO
218 </field>
219 <field>
220 <name>thankyou_title</name>
221 <title>Thank-you Title</title>
222 <type>varchar</type>
223 <length>255</length>
224 <localizable>true</localizable>
225 <comment>Title for Thank-you page (header title tag, and display at the top of the page).</comment>
226 <add>1.3</add>
227 </field>
6d68a4cb
CW
228 <field>
229 <name>thankyou_text</name>
6a488035 230 <title>Thank-you Text</title>
6d68a4cb 231 <type>text</type>
7deea513 232 <html>
233 <type>TextArea</type>
817807ab 234 <rows>8</rows>
235 <cols>60</cols>
7deea513 236 </html>
6a488035 237 <localizable>true</localizable>
6d68a4cb
CW
238 <comment>text and html allowed. displayed above result on success page</comment>
239 <add>1.3</add>
240 </field>
241 <field>
242 <name>thankyou_footer</name>
6a488035 243 <title>Thank-you Footer</title>
6d68a4cb 244 <type>text</type>
7deea513 245 <html>
246 <type>TextArea</type>
817807ab 247 <rows>8</rows>
248 <cols>60</cols>
7deea513 249 </html>
6a488035 250 <localizable>true</localizable>
6d68a4cb
CW
251 <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>
252 <add>1.3</add>
253 </field>
254 <field>
255 <name>is_for_organization</name>
256 <type>boolean</type>
257 <comment>if true, signup is done on behalf of an organization</comment>
6a488035 258 <default>0</default>
6d68a4cb
CW
259 <add>2.1</add>
260 </field>
261 <field>
262 <name>for_organization</name>
6a488035 263 <title>On Behalf Of Organization</title>
6d68a4cb 264 <type>text</type>
7deea513 265 <html>
266 <type>TextArea</type>
817807ab 267 <rows>2</rows>
268 <cols>50</cols>
7deea513 269 </html>
6a488035 270 <localizable>true</localizable>
6d68a4cb
CW
271 <comment>This text field is shown when is_for_organization is checked. For example - I am contributing on behalf on an organization.</comment>
272 <add>2.1</add>
273 </field>
274 <field>
275 <name>is_email_receipt</name>
276 <type>boolean</type>
277 <comment>if true, receipt is automatically emailed to contact on success</comment>
6a488035 278 <default>0</default>
6d68a4cb
CW
279 <add>1.3</add>
280 </field>
281 <field>
6a488035 282 <name>receipt_from_name</name>
6d68a4cb 283 <type>varchar</type>
6a488035
TO
284 <length>255</length>
285 <localizable>true</localizable>
6d68a4cb
CW
286 <comment>FROM email name used for receipts generated by contributions to this contribution page.</comment>
287 <add>1.3</add>
288 </field>
289 <field>
290 <name>receipt_from_email</name>
291 <type>varchar</type>
6a488035 292 <length>255</length>
6d68a4cb
CW
293 <comment>FROM email address used for receipts generated by contributions to this contribution page.</comment>
294 <add>1.3</add>
295 </field>
296 <field>
297 <name>cc_receipt</name>
298 <type>varchar</type>
6a488035 299 <length>255</length>
6d68a4cb
CW
300 <comment>comma-separated list of email addresses to cc each time a receipt is sent</comment>
301 <add>1.3</add>
302 </field>
303 <field>
304 <name>bcc_receipt</name>
305 <type>varchar</type>
6a488035 306 <length>255</length>
6d68a4cb
CW
307 <comment>comma-separated list of email addresses to bcc each time a receipt is sent</comment>
308 <add>1.3</add>
309 </field>
310 <field>
311 <name>receipt_text</name>
6a488035 312 <type>text</type>
7deea513 313 <html>
314 <type>TextArea</type>
817807ab 315 <rows>6</rows>
316 <cols>50</cols>
7deea513 317 </html>
6a488035
TO
318 <localizable>true</localizable>
319 <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
320 <add>1.3</add>
321 </field>
6a488035
TO
322 <field>
323 <name>is_active</name>
324 <type>boolean</type>
325 <comment>Is this property active?</comment>
326 <add>1.3</add>
327 </field>
328 <field>
329 <name>footer_text</name>
330 <type>text</type>
7deea513 331 <html>
332 <type>TextArea</type>
817807ab 333 <rows>6</rows>
334 <cols>50</cols>
7deea513 335 </html>
6a488035
TO
336 <localizable>true</localizable>
337 <comment>Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.</comment>
338 <add>1.4</add>
339 </field>
340 <field>
341 <name>amount_block_is_active</name>
342 <type>boolean</type>
343 <comment>Is this property active?</comment>
344 <default>1</default>
345 <add>1.5</add>
346 </field>
6d68a4cb
CW
347 <field>
348 <name>honor_block_is_active</name>
349 <type>boolean</type>
350 <comment>Should this contribution have the honor block enabled?</comment>
351 <add>1.6</add>
6a488035 352 </field>
6d68a4cb
CW
353 <field>
354 <name>honor_block_title</name>
355 <type>varchar</type>
6a488035
TO
356 <length>255</length>
357 <localizable>true</localizable>
6d68a4cb
CW
358 <comment>Title for honor block.</comment>
359 <add>1.5</add>
6a488035 360 </field>
6d68a4cb
CW
361 <field>
362 <name>honor_block_text</name>
363 <type>text</type>
7deea513 364 <html>
365 <type>TextArea</type>
817807ab 366 <rows>2</rows>
367 <cols>50</cols>
7deea513 368 </html>
6a488035 369 <localizable>true</localizable>
6d68a4cb
CW
370 <comment>text for honor block.</comment>
371 <add>1.5</add>
6a488035
TO
372 </field>
373 <field>
374 <name>start_date</name>
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>
389 <type>int unsigned</type>
390 <comment>FK to civicrm_contact, who created this contribution page</comment>
391 <add>3.0</add>
392 </field>
393 <foreignKey>
394 <name>created_id</name>
395 <table>civicrm_contact</table>
396 <key>id</key>
397 <add>3.0</add>
398 <onDelete>SET NULL</onDelete>
399 </foreignKey>
400 <field>
401 <name>created_date</name>
402 <type>datetime</type>
403 <title>Contribution Page Created Date</title>
404 <comment>Date and time that contribution page was created.</comment>
405 <add>3.0</add>
406 </field>
6d68a4cb
CW
407 <field>
408 <name>currency</name>
409 <type>varchar</type>
6a488035
TO
410 <length>3</length>
411 <default>NULL</default>
412 <headerPattern>/cur(rency)?/i</headerPattern>
413 <dataPattern>/^[A-Z]{3}$/i</dataPattern>
414 <comment>3 character string, value from config setting or input via user.</comment>
bd44e0df
AS
415 <add>3.3</add>
416 <pseudoconstant>
417 <table>civicrm_currency</table>
418 <keyColumn>name</keyColumn>
a38a89fc
CW
419 <labelColumn>full_name</labelColumn>
420 <nameColumn>numeric_code</nameColumn>
bd44e0df 421 </pseudoconstant>
614d72ec 422 <html>
423 <type>Select></type>
424 </html>
6d68a4cb
CW
425 </field>
426 <field>
427 <name>campaign_id</name>
428 <type>int unsigned</type>
429 <comment>The campaign for which we are collecting contributions with this page.</comment>
430 <add>3.4</add>
431 </field>
432 <foreignKey>
433 <name>campaign_id</name>
434 <table>civicrm_campaign</table>
435 <key>id</key>
6a488035
TO
436 <onDelete>SET NULL</onDelete>
437 </foreignKey>
6d68a4cb
CW
438 <field>
439 <name>is_share</name>
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>
445</table>