xml/schema/Pledge/Pledge.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2 <table>
   3   <base>CRM/Pledge</base>
   4   <class>Pledge</class>
   5   <name>civicrm_pledge</name>
   6   <add>2.1</add>
   7   <log>true</log>
   8   <field>
   9     <name>id</name>
  10     <uniqueName>pledge_id</uniqueName>
  11     <title>Pledge ID</title>
  12     <type>int unsigned</type>
  13     <required>true</required>
  14     <comment>Pledge ID</comment>
  15     <import>true</import>
  16     <add>2.1</add>
  17   </field>
  18   <primaryKey>
  19     <name>id</name>
  20     <autoincrement>true</autoincrement>
  21   </primaryKey>
  22   <field>
  23     <name>contact_id</name>
  24     <uniqueName>pledge_contact_id</uniqueName>
  25     <title>Contact ID</title>
  26     <import>true</import>
  27     <type>int unsigned</type>
  28     <required>true</required>
  29     <comment>Foreign key to civicrm_contact.id .</comment>
  30     <add>2.1</add>
  31     <html>
  32        <type>EntityRef</type>
  33      </html>
  34   </field>
  35   <foreignKey>
  36     <name>contact_id</name>
  37     <table>civicrm_contact</table>
  38     <key>id</key>
  39     <add>2.1</add>
  40     <onDelete>CASCADE</onDelete>
  41   </foreignKey>
  42   <field>
  43     <name>contribution_type_id</name>
  44     <uniqueName>pledge_contribution_type_id</uniqueName>
  45     <export>false</export>
  46     <type>int unsigned</type>
  47     <comment>FK to Contribution Type. This is propagated to contribution record when pledge payments are made.</comment>
  48     <add>2.1</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     <add>2.1</add>
  56     <drop>4.3</drop>
  57     <onDelete>SET NULL</onDelete>
  58   </foreignKey>
  59   <field>
  60     <name>financial_type_id</name>
  61     <title>Type</title>
  62     <uniqueName>pledge_financial_type_id</uniqueName>
  63     <type>int unsigned</type>
  64     <comment>FK to Financial Type</comment>
  65     <pseudoconstant>
  66       <table>civicrm_financial_type</table>
  67       <keyColumn>id</keyColumn>
  68       <labelColumn>name</labelColumn>
  69     </pseudoconstant>
  70     <add>4.3</add>
  71     <html>
  72       <type>Select</type>
  73     </html>
  74   </field>
  75   <foreignKey>
  76     <name>financial_type_id</name>
  77     <table>civicrm_financial_type</table>
  78     <key>id</key>
  79     <add>4.3</add>
  80   </foreignKey>
  81   <field>
  82     <name>contribution_page_id</name>
  83     <uniqueName>pledge_contribution_page_id</uniqueName>
  84     <title>Pledge Contribution Page</title>
  85     <type>int unsigned</type>
  86     <comment>The Contribution Page which triggered this contribution</comment>
  87     <add>2.1</add>
  88   </field>
  89   <foreignKey>
  90     <name>contribution_page_id</name>
  91     <table>civicrm_contribution_page</table>
  92     <key>id</key>
  93     <onDelete>SET NULL</onDelete>
  94   </foreignKey>
  95   <field>
  96     <name>amount</name>
  97     <uniqueName>pledge_amount</uniqueName>
  98     <title>Total Pledged</title>
  99     <type>decimal</type>
 100     <required>true</required>
 101     <import>true</import>
 102     <comment>Total pledged amount.</comment>
 103     <add>2.1</add>
 104     <html>
 105      <type>Text</type>
 106    </html>
 107   </field>
 108   <field>
 109     <name>original_installment_amount</name>
 110     <uniqueName>pledge_original_installment_amount</uniqueName>
 111     <title>Original Installment Amount</title>
 112     <type>decimal</type>
 113     <required>true</required>
 114     <comment>Original amount for each of the installments.</comment>
 115     <add>3.2</add>
 116     <html>
 117       <type>Text</type>
 118     </html>
 119   </field>
 120   <field>
 121     <name>currency</name>
 122     <type>varchar</type>
 123     <title>Pledge Currency</title>
 124     <length>3</length>
 125     <default>NULL</default>
 126     <comment>3 character string, value from config setting or input via user.</comment>
 127     <add>3.2</add>
 128     <pseudoconstant>
 129       <table>civicrm_currency</table>
 130       <keyColumn>name</keyColumn>
 131       <labelColumn>full_name</labelColumn>
 132       <nameColumn>numeric_code</nameColumn>
 133     </pseudoconstant>
 134     <html>
 135       <type>Select</type>
 136     </html>
 137   </field>
 138   <field>
 139     <name>frequency_unit</name>
 140     <uniqueName>pledge_frequency_unit</uniqueName>
 141     <title>Pledge Frequency Unit</title>
 142     <type>varchar</type>
 143     <length>8</length>
 144     <default>'month'</default>
 145     <comment>Time units for recurrence of pledge payments.</comment>
 146     <pseudoconstant>
 147       <optionGroupName>recur_frequency_units</optionGroupName>
 148       <keyColumn>name</keyColumn>
 149     </pseudoconstant>
 150     <add>2.1</add>
 151     <html>
 152       <type>Select</type>
 153     </html>
 154   </field>
 155   <field>
 156     <name>frequency_interval</name>
 157     <uniqueName>pledge_frequency_interval</uniqueName>
 158     <title>Pledge Frequency Interval</title>
 159     <type>int unsigned</type>
 160     <required>true</required>
 161     <default>1</default>
 162     <comment>Number of time units for recurrence of pledge payments.</comment>
 163     <add>2.1</add>
 164     <html>
 165       <type>Text</type>
 166     </html>
 167   </field>
 168   <field>
 169     <name>frequency_day</name>
 170     <type>int unsigned</type>
 171     <title>Pledge day</title>
 172     <default>3</default>
 173     <required>true</required>
 174     <comment>Day in the period when the pledge payment is due e.g. 1st of month, 15th etc. Use this to set the scheduled dates for pledge payments.</comment>
 175     <add>2.1</add>
 176     <html>
 177       <type>Select</type>
 178     </html>
 179   </field>
 180   <field>
 181     <name>installments</name>
 182     <type>int unsigned</type>
 183     <title>Pledge Number of Installments</title>
 184     <default>1</default>
 185     <comment>Total number of payments to be made.</comment>
 186     <add>2.1</add>
 187     <html>
 188      <type>Text</type>
 189    </html>
 190   </field>
 191   <field>
 192     <name>start_date</name>
 193     <type>datetime</type>
 194     <title>Pledge Start Date</title>
 195     <required>true</required>
 196     <comment>The date the first scheduled pledge occurs.</comment>
 197     <add>2.1</add>
 198     <html>
 199         <type>Select Date</type>
 200       </html>
 201   </field>
 202   <field>
 203     <name>create_date</name>
 204     <type>datetime</type>
 205     <uniqueName>pledge_create_date</uniqueName>
 206     <title>Pledge Made</title>
 207     <required>true</required>
 208     <import>true</import>
 209     <comment>When this pledge record was created.</comment>
 210     <add>2.1</add>
 211     <html>
 212       <type>Select Date</type>
 213     </html>
 214   </field>
 215   <field>
 216     <name>acknowledge_date</name>
 217     <type>datetime</type>
 218     <title>Pledge Acknowledged</title>
 219     <comment>When a pledge acknowledgement message was sent to the contributor.</comment>
 220     <add>2.1</add>
 221     <html>
 222         <type>Select Date</type>
 223     </html>
 224   </field>
 225   <field>
 226     <name>modified_date</name>
 227     <type>datetime</type>
 228     <title>Pledge Modified Date</title>
 229     <comment>Last updated date for this pledge record.</comment>
 230     <add>2.1</add>
 231   </field>
 232   <field>
 233     <name>cancel_date</name>
 234     <type>datetime</type>
 235     <title>Pledge Cancelled Date</title>
 236     <comment>Date this pledge was cancelled by contributor.</comment>
 237     <add>2.1</add>
 238     <html>
 239         <type>Select Date</type>
 240     </html>
 241   </field>
 242   <field>
 243     <name>end_date</name>
 244     <type>datetime</type>
 245     <title>Pledge End Date</title>
 246     <comment>Date this pledge finished successfully (total pledge payments equal to or greater than pledged amount).</comment>
 247     <add>2.1</add>
 248     <html>
 249         <type>Select Date</type>
 250     </html>
 251   </field>
 252   <field>
 253     <name>max_reminders</name>
 254     <title>Maximum Number of Reminders</title>
 255     <type>int unsigned</type>
 256     <default>1</default>
 257     <comment>The maximum number of payment reminders to send for any given payment.</comment>
 258     <html>
 259          <type>Text</type>
 260        </html>
 261     <add>2.1</add>
 262   </field>
 263   <field>
 264     <name>initial_reminder_day</name>
 265     <title>Initial Reminder Day</title>
 266     <type>int unsigned</type>
 267     <default>5</default>
 268     <comment>Send initial reminder this many days prior to the payment due date.</comment>
 269     <add>2.1</add>
 270     <html>
 271           <type>Select</type>
 272         </html>
 273   </field>
 274   <field>
 275     <name>additional_reminder_day</name>
 276     <title>Additional Reminder Days</title>
 277     <type>int unsigned</type>
 278     <default>5</default>
 279     <comment>Send additional reminder this many days after last one sent, up to maximum number of reminders.</comment>
 280     <add>2.1</add>
 281     <html>
 282          <type>Text</type>
 283        </html>
 284   </field>
 285   <field>
 286     <name>status_id</name>
 287     <title>Pledge Status Id</title>
 288     <uniqueName>pledge_status_id</uniqueName>
 289     <import>true</import>
 290     <export>false</export>
 291     <type>int unsigned</type>
 292     <comment>Implicit foreign key to civicrm_option_values in the contribution_status option group.</comment>
 293     <add>2.1</add>
 294   </field>
 295   <index>
 296     <name>index_status</name>
 297     <fieldName>status_id</fieldName>
 298     <add>2.1</add>
 299   </index>
 300   <field>
 301     <name>is_test</name>
 302     <uniqueName>pledge_is_test</uniqueName>
 303     <import>true</import>
 304     <title>Test</title>
 305     <type>boolean</type>
 306     <default>0</default>
 307     <html>
 308      <type>CheckBox</type>
 309    </html>
 310   </field>
 311   <field>
 312     <name>campaign_id</name>
 313     <uniqueName>pledge_campaign_id</uniqueName>
 314     <type>int unsigned</type>
 315     <title>Campaign</title>
 316     <import>true</import>
 317     <comment>The campaign for which this pledge has been initiated.</comment>
 318     <pseudoconstant>
 319       <table>civicrm_campaign</table>
 320       <keyColumn>id</keyColumn>
 321       <labelColumn>title</labelColumn>
 322     </pseudoconstant>
 323     <add>3.4</add>
 324     <html>
 325       <type>Select</type>
 326     </html>
 327   </field>
 328   <foreignKey>
 329     <name>campaign_id</name>
 330     <table>civicrm_campaign</table>
 331     <key>id</key>
 332     <onDelete>SET NULL</onDelete>
 333   </foreignKey>
 334 </table>