xml/schema/Contribute/ContributionPage.xml

   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   <component>CiviContribute</component>
  11   <labelField>title</labelField>
  12   <field>
  13     <name>id</name>
  14     <title>Contribution Page ID</title>
  15     <type>int unsigned</type>
  16     <required>true</required>
  17     <comment>Contribution ID</comment>
  18     <html>
  19       <type>Number</type>
  20     </html>
  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>
  29     <title>Contribution Page Title</title>
  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>
  38     <title>Contribution Page Introduction Text</title>
  39     <type>text</type>
  40     <html>
  41       <type>RichTextEditor</type>
  42       <rows>6</rows>
  43       <cols>50</cols>
  44     </html>
  45     <localizable>true</localizable>
  46     <comment>Text and html allowed. Displayed below title.</comment>
  47     <add>1.3</add>
  48   </field>
  49   <field>
  50     <name>financial_type_id</name>
  51     <title>Financial Type ID</title>
  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>
  59     <html>
  60       <type>Select</type>
  61       <label>Financial Type</label>
  62     </html>
  63     <add>4.3</add>
  64   </field>
  65   <foreignKey>
  66     <name>financial_type_id</name>
  67     <table>civicrm_financial_type</table>
  68     <key>id</key>
  69     <add>4.3</add>
  70   </foreignKey>
  71   <field>
  72     <name>payment_processor</name>
  73     <type>varchar</type>
  74     <length>128</length>
  75     <serialize>SEPARATOR_TRIMMED</serialize>
  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     <html>
  83       <type>Select</type>
  84       <label>Payment Processors</label>
  85     </html>
  86     <add>1.8</add>
  87   </field>
  88   <field>
  89     <name>is_credit_card_only</name>
  90     <title>Is Credit Card Only?</title>
  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>
  94     <required>true</required>
  95     <add>1.3</add>
  96   </field>
  97   <field>
  98     <name>is_monetary</name>
  99     <title>Is Monetary</title>
 100     <type>boolean</type>
 101     <default>1</default>
 102     <required>true</required>
 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>
 108     <title>Is Recurring</title>
 109     <type>boolean</type>
 110     <default>0</default>
 111     <required>true</required>
 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>
 117     <title>Confirmation Page?</title>
 118     <type>boolean</type>
 119     <default>1</default>
 120     <required>true</required>
 121     <comment>if false, the confirm page in contribution pages gets skipped</comment>
 122     <add>4.2</add>
 123   </field>
 124   <field>
 125     <name>recur_frequency_unit</name>
 126     <title>Recurring Frequency</title>
 127     <type>varchar</type>
 128     <length>128</length>
 129     <comment>Supported recurring frequency units.</comment>
 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>
 139     <add>2.1</add>
 140   </field>
 141   <field>
 142     <name>is_recur_interval</name>
 143     <title>Support Recurring Intervals</title>
 144     <type>boolean</type>
 145     <default>0</default>
 146     <required>true</required>
 147     <comment>if true - supports recurring intervals</comment>
 148     <add>2.1</add>
 149   </field>
 150   <field>
 151     <name>is_recur_installments</name>
 152     <title>Recurring Installments?</title>
 153     <type>boolean</type>
 154     <default>0</default>
 155     <required>true</required>
 156     <comment>if true - asks user for recurring installments</comment>
 157     <add>4.3</add>
 158   </field>
 159   <field>
 160     <name>adjust_recur_start_date</name>
 161     <title>Adjust Recurring Start Date</title>
 162     <type>boolean</type>
 163     <default>0</default>
 164     <required>true</required>
 165     <comment>if true - user is able to adjust payment start date</comment>
 166     <add>4.7</add>
 167   </field>
 168   <field>
 169     <name>is_pay_later</name>
 170     <title>Pay Later</title>
 171     <type>boolean</type>
 172     <default>0</default>
 173     <required>true</required>
 174     <comment>if true - allows the user to send payment directly to the org later</comment>
 175     <add>2.0</add>
 176   </field>
 177   <field>
 178     <name>pay_later_text</name>
 179     <title>Pay Later Text</title>
 180     <type>text</type>
 181     <localizable>true</localizable>
 182     <comment>The text displayed to the user in the main form</comment>
 183     <add>2.0</add>
 184   </field>
 185   <field>
 186     <name>pay_later_receipt</name>
 187     <title>Pay Later Receipt</title>
 188     <type>text</type>
 189     <localizable>true</localizable>
 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>
 195     <title>Allow Partial Payment</title>
 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>
 205     <localizable>true</localizable>
 206     <comment>Initial amount label for partial payment</comment>
 207     <html>
 208       <label>Initial Amount Label</label>
 209     </html>
 210     <add>4.3</add>
 211   </field>
 212   <field>
 213     <name>initial_amount_help_text</name>
 214     <type>text</type>
 215     <localizable>true</localizable>
 216     <comment>Initial amount help text for partial payment</comment>
 217     <html>
 218       <label>Initial Amount Help Text</label>
 219     </html>
 220     <add>4.3</add>
 221   </field>
 222   <field>
 223     <name>min_initial_amount</name>
 224     <type>decimal</type>
 225     <comment>Minimum initial amount for partial payment</comment>
 226     <html>
 227       <label>Min. Initial Amount</label>
 228     </html>
 229     <add>4.3</add>
 230   </field>
 231   <field>
 232     <name>is_allow_other_amount</name>
 233     <title>Allow Other Amounts</title>
 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>
 237     <required>true</required>
 238     <add>1.3</add>
 239   </field>
 240   <field>
 241     <name>default_amount_id</name>
 242     <title>Default Amount</title>
 243     <type>int unsigned</type>
 244     <comment>FK to civicrm_option_value.</comment>
 245     <add>1.7</add>
 246   </field>
 247   <field>
 248     <name>min_amount</name>
 249     <title>Minimum Amount</title>
 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>
 256     <title>Maximum Amount</title>
 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>
 265     <html>
 266       <label>Goal Amount</label>
 267     </html>
 268     <add>1.5</add>
 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>
 279   <field>
 280     <name>thankyou_text</name>
 281     <title>Thank-you Text</title>
 282     <type>text</type>
 283     <html>
 284       <type>RichTextEditor</type>
 285       <rows>8</rows>
 286       <cols>60</cols>
 287     </html>
 288     <localizable>true</localizable>
 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>
 294     <title>Thank-you Footer</title>
 295     <type>text</type>
 296     <html>
 297       <type>RichTextEditor</type>
 298       <rows>8</rows>
 299       <cols>60</cols>
 300     </html>
 301     <localizable>true</localizable>
 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>
 305   <field>
 306     <name>is_email_receipt</name>
 307     <title>Send email Receipt</title>
 308     <type>boolean</type>
 309     <comment>if true, receipt is automatically emailed to contact on success</comment>
 310     <default>0</default>
 311     <required>true</required>
 312     <add>1.3</add>
 313   </field>
 314   <field>
 315     <name>receipt_from_name</name>
 316     <title>Receipt From</title>
 317     <type>varchar</type>
 318     <length>255</length>
 319     <localizable>true</localizable>
 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>
 325     <title>Receipt From email</title>
 326     <type>varchar</type>
 327     <length>255</length>
 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>
 333     <title>Receipt cc</title>
 334     <type>varchar</type>
 335     <length>255</length>
 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>
 341     <title>Receipt bcc</title>
 342     <type>varchar</type>
 343     <length>255</length>
 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>
 349     <title>Receipt Text</title>
 350     <type>text</type>
 351     <html>
 352       <type>TextArea</type>
 353       <rows>6</rows>
 354       <cols>50</cols>
 355     </html>
 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>
 358     <add>1.3</add>
 359   </field>
 360   <field>
 361     <name>is_active</name>
 362     <title>Is Page Active?</title>
 363     <type>boolean</type>
 364     <default>1</default>
 365     <required>true</required>
 366     <comment>Is this property active?</comment>
 367     <add>1.3</add>
 368   </field>
 369   <field>
 370     <name>footer_text</name>
 371     <title>Footer Text</title>
 372     <type>text</type>
 373     <html>
 374       <type>RichTextEditor</type>
 375       <rows>6</rows>
 376       <cols>50</cols>
 377     </html>
 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>
 384     <title>Is Amount Block Active?</title>
 385     <type>boolean</type>
 386     <comment>Is this property active?</comment>
 387     <default>1</default>
 388     <required>true</required>
 389     <add>1.5</add>
 390   </field>
 391   <field>
 392     <name>start_date</name>
 393     <title>Contribution Page Start Date</title>
 394     <type>datetime</type>
 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>
 407     <title>Created By Contact ID</title>
 408     <type>int unsigned</type>
 409     <comment>FK to civicrm_contact, who created this contribution page</comment>
 410     <html>
 411       <label>Created By</label>
 412     </html>
 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>
 429   <field>
 430     <name>currency</name>
 431     <title>Contribution Page Currency</title>
 432     <type>varchar</type>
 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>
 438     <add>3.3</add>
 439     <pseudoconstant>
 440       <table>civicrm_currency</table>
 441       <keyColumn>name</keyColumn>
 442       <labelColumn>full_name</labelColumn>
 443       <nameColumn>name</nameColumn>
 444       <abbrColumn>symbol</abbrColumn>
 445     </pseudoconstant>
 446     <html>
 447       <type>Select</type>
 448     </html>
 449   </field>
 450   <field>
 451     <name>campaign_id</name>
 452     <component>CiviCampaign</component>
 453     <title>Campaign ID</title>
 454     <type>int unsigned</type>
 455     <comment>The campaign for which we are collecting contributions with this page.</comment>
 456     <html>
 457       <type>EntityRef</type>
 458       <label>Campaign</label>
 459     </html>
 460     <add>3.4</add>
 461     <pseudoconstant>
 462       <table>civicrm_campaign</table>
 463       <keyColumn>id</keyColumn>
 464       <labelColumn>title</labelColumn>
 465       <prefetch>FALSE</prefetch>
 466     </pseudoconstant>
 467   </field>
 468   <foreignKey>
 469     <name>campaign_id</name>
 470     <table>civicrm_campaign</table>
 471     <key>id</key>
 472     <onDelete>SET NULL</onDelete>
 473   </foreignKey>
 474   <field>
 475     <name>is_share</name>
 476     <title>Is Contribution Page Shared?</title>
 477     <type>boolean</type>
 478     <default>1</default>
 479     <required>true</required>
 480     <comment>Can people share the contribution page through social media?</comment>
 481     <add>4.1</add>
 482   </field>
 483   <field>
 484     <name>is_billing_required</name>
 485     <title>Is billing block required</title>
 486     <type>boolean</type>
 487     <default>0</default>
 488     <required>true</required>
 489     <comment>if true - billing block is required for online contribution page</comment>
 490     <add>4.6</add>
 491   </field>
 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>
 506 </table>