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