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