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