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