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