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