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