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