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     <pseudoconstant>
 133       <optionGroupName>recur_frequency_units</optionGroupName>
 134       <keyColumn>name</keyColumn>
 135     </pseudoconstant>
 136     <html>
 137       <type>Select</type>
 138       <multiple>1</multiple>
 139     </html>
 140     <serialize>SEPARATOR_TRIMMED</serialize>
 141     <add>2.1</add>
 142   </field>
 143   <field>
 144     <name>is_recur_interval</name>
 145     <title>Support Recurring Intervals</title>
 146     <type>boolean</type>
 147     <default>0</default>
 148     <comment>if true - supports recurring intervals</comment>
 149     <add>2.1</add>
 150   </field>
 151   <field>
 152     <name>is_recur_installments</name>
 153     <title>Recurring Installments?</title>
 154     <type>boolean</type>
 155     <default>0</default>
 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     <comment>if true - user is able to adjust payment start date</comment>
 165     <add>4.7</add>
 166   </field>
 167   <field>
 168     <name>is_pay_later</name>
 169     <title>Pay Later</title>
 170     <type>boolean</type>
 171     <default>0</default>
 172     <comment>if true - allows the user to send payment directly to the org later</comment>
 173     <add>2.0</add>
 174   </field>
 175   <field>
 176     <name>pay_later_text</name>
 177     <title>Pay Later Text</title>
 178     <type>text</type>
 179     <localizable>true</localizable>
 180     <comment>The text displayed to the user in the main form</comment>
 181     <add>2.0</add>
 182   </field>
 183   <field>
 184     <name>pay_later_receipt</name>
 185     <title>Pay Later Receipt</title>
 186     <type>text</type>
 187     <localizable>true</localizable>
 188     <comment>The receipt sent to the user instead of the normal receipt text</comment>
 189     <add>2.0</add>
 190   </field>
 191   <field>
 192     <name>is_partial_payment</name>
 193     <title>Allow Partial Payment</title>
 194     <type>boolean</type>
 195     <default>0</default>
 196     <comment>is partial payment enabled for this online contribution page</comment>
 197     <add>4.3</add>
 198   </field>
 199   <field>
 200     <name>initial_amount_label</name>
 201     <type>varchar</type>
 202     <length>255</length>
 203     <localizable>true</localizable>
 204     <comment>Initial amount label for partial payment</comment>
 205     <add>4.3</add>
 206   </field>
 207   <field>
 208     <name>initial_amount_help_text</name>
 209     <type>text</type>
 210     <localizable>true</localizable>
 211     <comment>Initial amount help text for partial payment</comment>
 212     <add>4.3</add>
 213   </field>
 214   <field>
 215     <name>min_initial_amount</name>
 216     <type>decimal</type>
 217     <comment>Minimum initial amount for partial payment</comment>
 218     <add>4.3</add>
 219   </field>
 220   <field>
 221     <name>is_allow_other_amount</name>
 222     <title>Allow Other Amounts</title>
 223     <type>boolean</type>
 224     <comment>if true, page will include an input text field where user can enter their own amount</comment>
 225     <default>0</default>
 226     <add>1.3</add>
 227   </field>
 228   <field>
 229     <name>default_amount_id</name>
 230     <title>Default Amount</title>
 231     <type>int unsigned</type>
 232     <comment>FK to civicrm_option_value.</comment>
 233     <add>1.7</add>
 234   </field>
 235   <field>
 236     <name>min_amount</name>
 237     <title>Minimum Amount</title>
 238     <type>decimal</type>
 239     <comment>if other amounts allowed, user can configure minimum allowed.</comment>
 240     <add>1.3</add>
 241   </field>
 242   <field>
 243     <name>max_amount</name>
 244     <title>Maximum Amount</title>
 245     <type>decimal</type>
 246     <comment>if other amounts allowed, user can configure maximum allowed.</comment>
 247     <add>1.3</add>
 248   </field>
 249   <field>
 250     <name>goal_amount</name>
 251     <type>decimal</type>
 252     <comment>The target goal for this page, allows people to build a goal meter</comment>
 253     <add>1.5</add>
 254   </field>
 255   <field>
 256     <name>thankyou_title</name>
 257     <title>Thank-you Title</title>
 258     <type>varchar</type>
 259     <length>255</length>
 260     <localizable>true</localizable>
 261     <comment>Title for Thank-you page (header title tag, and display at the top of the page).</comment>
 262     <add>1.3</add>
 263   </field>
 264   <field>
 265     <name>thankyou_text</name>
 266     <title>Thank-you Text</title>
 267     <type>text</type>
 268     <html>
 269       <type>RichTextEditor</type>
 270       <rows>8</rows>
 271       <cols>60</cols>
 272     </html>
 273     <localizable>true</localizable>
 274     <comment>text and html allowed. displayed above result on success page</comment>
 275     <add>1.3</add>
 276   </field>
 277   <field>
 278     <name>thankyou_footer</name>
 279     <title>Thank-you Footer</title>
 280     <type>text</type>
 281     <html>
 282       <type>RichTextEditor</type>
 283       <rows>8</rows>
 284       <cols>60</cols>
 285     </html>
 286     <localizable>true</localizable>
 287     <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>
 288     <add>1.3</add>
 289   </field>
 290   <field>
 291     <name>is_email_receipt</name>
 292     <title>Send email Receipt</title>
 293     <type>boolean</type>
 294     <comment>if true, receipt is automatically emailed to contact on success</comment>
 295     <default>0</default>
 296     <add>1.3</add>
 297   </field>
 298   <field>
 299     <name>receipt_from_name</name>
 300     <title>Receipt From</title>
 301     <type>varchar</type>
 302     <length>255</length>
 303     <localizable>true</localizable>
 304     <comment>FROM email name used for receipts generated by contributions to this contribution page.</comment>
 305     <add>1.3</add>
 306   </field>
 307   <field>
 308     <name>receipt_from_email</name>
 309     <title>Receipt From email</title>
 310     <type>varchar</type>
 311     <length>255</length>
 312     <comment>FROM email address used for receipts generated by contributions to this contribution page.</comment>
 313     <add>1.3</add>
 314   </field>
 315   <field>
 316     <name>cc_receipt</name>
 317     <title>Receipt cc</title>
 318     <type>varchar</type>
 319     <length>255</length>
 320     <comment>comma-separated list of email addresses to cc each time a receipt is sent</comment>
 321     <add>1.3</add>
 322   </field>
 323   <field>
 324     <name>bcc_receipt</name>
 325     <title>Receipt bcc</title>
 326     <type>varchar</type>
 327     <length>255</length>
 328     <comment>comma-separated list of email addresses to bcc each time a receipt is sent</comment>
 329     <add>1.3</add>
 330   </field>
 331   <field>
 332     <name>receipt_text</name>
 333     <title>Receipt Text</title>
 334     <type>text</type>
 335     <html>
 336       <type>TextArea</type>
 337       <rows>6</rows>
 338       <cols>50</cols>
 339     </html>
 340     <localizable>true</localizable>
 341     <comment>text to include above standard receipt info on receipt email. emails are text-only, so do not allow html for now</comment>
 342     <add>1.3</add>
 343   </field>
 344   <field>
 345     <name>is_active</name>
 346     <title>Is Page Active?</title>
 347     <type>boolean</type>
 348     <comment>Is this property active?</comment>
 349     <add>1.3</add>
 350   </field>
 351   <field>
 352     <name>footer_text</name>
 353     <title>Footer Text</title>
 354     <type>text</type>
 355     <html>
 356       <type>RichTextEditor</type>
 357       <rows>6</rows>
 358       <cols>50</cols>
 359     </html>
 360     <localizable>true</localizable>
 361     <comment>Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.</comment>
 362     <add>1.4</add>
 363   </field>
 364   <field>
 365     <name>amount_block_is_active</name>
 366     <title>Is Amount Block Active?</title>
 367     <type>boolean</type>
 368     <comment>Is this property active?</comment>
 369     <default>1</default>
 370     <add>1.5</add>
 371   </field>
 372   <field>
 373     <name>start_date</name>
 374     <title>Contribution Page Start Date</title>
 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     <title>Contribution Page Created By</title>
 390     <type>int unsigned</type>
 391     <comment>FK to civicrm_contact, who created this contribution page</comment>
 392     <add>3.0</add>
 393   </field>
 394   <foreignKey>
 395     <name>created_id</name>
 396     <table>civicrm_contact</table>
 397     <key>id</key>
 398     <add>3.0</add>
 399     <onDelete>SET NULL</onDelete>
 400   </foreignKey>
 401   <field>
 402     <name>created_date</name>
 403     <type>datetime</type>
 404     <title>Contribution Page Created Date</title>
 405     <comment>Date and time that contribution page was created.</comment>
 406     <add>3.0</add>
 407   </field>
 408   <field>
 409     <name>currency</name>
 410     <title>Contribution Page Currency</title>
 411     <type>varchar</type>
 412     <length>3</length>
 413     <default>NULL</default>
 414     <headerPattern>/cur(rency)?/i</headerPattern>
 415     <dataPattern>/^[A-Z]{3}$/i</dataPattern>
 416     <comment>3 character string, value from config setting or input via user.</comment>
 417     <add>3.3</add>
 418     <pseudoconstant>
 419       <table>civicrm_currency</table>
 420       <keyColumn>name</keyColumn>
 421       <labelColumn>full_name</labelColumn>
 422       <nameColumn>name</nameColumn>
 423       <abbrColumn>symbol</abbrColumn>
 424     </pseudoconstant>
 425     <html>
 426       <type>Select</type>
 427     </html>
 428   </field>
 429   <field>
 430     <name>campaign_id</name>
 431     <title>Contribution Page Campaign ID</title>
 432     <type>int unsigned</type>
 433     <comment>The campaign for which we are collecting contributions with this page.</comment>
 434     <pseudoconstant>
 435       <table>civicrm_campaign</table>
 436       <keyColumn>id</keyColumn>
 437       <labelColumn>title</labelColumn>
 438     </pseudoconstant>
 439     <add>3.4</add>
 440   </field>
 441   <foreignKey>
 442     <name>campaign_id</name>
 443     <table>civicrm_campaign</table>
 444     <key>id</key>
 445     <onDelete>SET NULL</onDelete>
 446   </foreignKey>
 447   <field>
 448     <name>is_share</name>
 449     <title>Is Contribution Page Shared?</title>
 450     <type>boolean</type>
 451     <default>1</default>
 452     <comment>Can people share the contribution page through social media?</comment>
 453     <add>4.1</add>
 454   </field>
 455   <field>
 456     <name>is_billing_required</name>
 457     <title>Is billing block required</title>
 458     <type>boolean</type>
 459     <default>0</default>
 460     <comment>if true - billing block is required for online contribution page</comment>
 461     <add>4.6</add>
 462   </field>
 463   <field>
 464     <name>frontend_title</name>
 465     <title>Public Title</title>
 466     <type>varchar</type>
 467     <length>255</length>
 468     <localizable>true</localizable>
 469     <default>NULL</default>
 470     <comment>Contribution Page Public title</comment>
 471     <html>
 472       <type>Text</type>
 473     </html>
 474     <add>5.20</add>
 475     <uniqueName>contribution_page_frontend_title</uniqueName>
 476   </field>
 477 </table>