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