xml/schema/Batch/Batch.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Batch</base>
   5   <class>Batch</class>
   6   <name>civicrm_batch</name>
   7   <comment>Stores the details of a batch operation Used primarily when doing batch operations with an external system.</comment>
   8   <add>3.3</add>
   9   <field>
  10     <name>id</name>
  11     <title>Batch ID</title>
  12     <type>int unsigned</type>
  13     <required>true</required>
  14     <comment>Unique Address ID</comment>
  15     <html>
  16       <type>Number</type>
  17     </html>
  18     <add>3.3</add>
  19   </field>
  20   <primaryKey>
  21     <name>id</name>
  22     <autoincrement>true</autoincrement>
  23   </primaryKey>
  24   <field>
  25     <name>name</name>
  26     <title>Batch Name</title>
  27     <type>varchar</type>
  28     <length>64</length>
  29     <comment>Variable name/programmatic handle for this batch.</comment>
  30     <add>3.3</add>
  31     <html>
  32       <type>Text</type>
  33     </html>
  34   </field>
  35   <index>
  36     <name>UI_name</name>
  37     <fieldName>name</fieldName>
  38     <unique>true</unique>
  39     <add>4.2</add>
  40   </index>
  41   <field>
  42     <name>title</name>
  43     <title>Batch Title</title>
  44     <type>varchar</type>
  45     <length>255</length>
  46     <localizable>true</localizable>
  47     <comment>Friendly Name.</comment>
  48     <add>4.2</add>
  49     <html>
  50       <type>Text</type>
  51     </html>
  52   </field>
  53   <field>
  54     <name>description</name>
  55     <title>Batch Description</title>
  56     <type>text</type>
  57     <comment>Description of this batch set.</comment>
  58     <localizable>true</localizable>
  59     <html>
  60       <type>TextArea</type>
  61       <rows>4</rows>
  62       <cols>80</cols>
  63     </html>
  64     <add>3.3</add>
  65   </field>
  66   <field>
  67     <name>created_id</name>
  68     <title>Created By Contact ID</title>
  69     <type>int unsigned</type>
  70     <comment>FK to Contact ID</comment>
  71     <html>
  72       <label>Created By</label>
  73     </html>
  74     <add>3.3</add>
  75   </field>
  76   <foreignKey>
  77     <name>created_id</name>
  78     <table>civicrm_contact</table>
  79     <key>id</key>
  80     <add>3.3</add>
  81     <onDelete>SET NULL</onDelete>
  82   </foreignKey>
  83   <field>
  84     <name>created_date</name>
  85     <title>Batch Created Date</title>
  86     <type>datetime</type>
  87     <comment>When was this item created</comment>
  88     <add>3.3</add>
  89     <html>
  90       <type>Select Date</type>
  91       <formatType>activityDateTime</formatType>
  92     </html>
  93   </field>
  94   <field>
  95     <name>modified_id</name>
  96     <title>Modified By Contact ID</title>
  97     <type>int unsigned</type>
  98     <comment>FK to Contact ID</comment>
  99     <html>
 100       <label>Modified By</label>
 101     </html>
 102     <add>3.3</add>
 103   </field>
 104   <field>
 105     <name>modified_date</name>
 106     <title>Batch Modified Date</title>
 107     <type>datetime</type>
 108     <comment>When was this item modified</comment>
 109     <readonly>true</readonly>
 110     <add>3.3</add>
 111   </field>
 112   <foreignKey>
 113     <name>modified_id</name>
 114     <table>civicrm_contact</table>
 115     <key>id</key>
 116     <add>3.3</add>
 117     <onDelete>SET NULL</onDelete>
 118   </foreignKey>
 119   <field>
 120     <name>saved_search_id</name>
 121     <title>Smart Group ID</title>
 122     <type>int unsigned</type>
 123     <comment>FK to Saved Search ID</comment>
 124     <add>4.1</add>
 125     <html>
 126       <type>EntityRef</type>
 127       <label>Smart Group</label>
 128     </html>
 129   </field>
 130   <foreignKey>
 131     <name>saved_search_id</name>
 132     <table>civicrm_saved_search</table>
 133     <key>id</key>
 134     <add>4.2</add>
 135     <onDelete>SET NULL</onDelete>
 136   </foreignKey>
 137   <field>
 138     <name>status_id</name>
 139     <title>Batch Status</title>
 140     <type>int unsigned</type>
 141     <required>true</required>
 142     <comment>fk to Batch Status options in civicrm_option_values</comment>
 143     <add>4.2</add>
 144     <pseudoconstant>
 145       <optionGroupName>batch_status</optionGroupName>
 146     </pseudoconstant>
 147     <html>
 148       <type>Select</type>
 149     </html>
 150   </field>
 151   <field>
 152     <name>type_id</name>
 153     <title>Batch Type</title>
 154     <type>int unsigned</type>
 155     <comment>fk to Batch Type options in civicrm_option_values</comment>
 156     <add>4.2</add>
 157     <pseudoconstant>
 158       <optionGroupName>batch_type</optionGroupName>
 159     </pseudoconstant>
 160     <html>
 161       <type>Select</type>
 162     </html>
 163   </field>
 164   <field>
 165     <name>mode_id</name>
 166     <title>Batch Mode</title>
 167     <type>int unsigned</type>
 168     <comment>fk to Batch mode options in civicrm_option_values</comment>
 169     <add>4.2</add>
 170     <pseudoconstant>
 171       <optionGroupName>batch_mode</optionGroupName>
 172     </pseudoconstant>
 173     <html>
 174       <type>Select</type>
 175     </html>
 176   </field>
 177   <field>
 178     <name>total</name>
 179     <title>Batch Total</title>
 180     <type>decimal</type>
 181     <comment>Total amount for this batch.</comment>
 182     <add>4.2</add>
 183     <html>
 184       <type>Text</type>
 185     </html>
 186   </field>
 187   <field>
 188     <name>item_count</name>
 189     <title>Batch Number of Items</title>
 190     <type>int unsigned</type>
 191     <comment>Number of items in a batch.</comment>
 192     <add>4.2</add>
 193     <html>
 194       <type>Text</type>
 195     </html>
 196   </field>
 197   <field>
 198     <name>payment_instrument_id</name>
 199     <title>Batch Payment Method</title>
 200     <type>int unsigned</type>
 201     <comment>fk to Payment Instrument options in civicrm_option_values</comment>
 202     <pseudoconstant>
 203       <optionGroupName>payment_instrument</optionGroupName>
 204     </pseudoconstant>
 205     <html>
 206       <type>Select</type>
 207     </html>
 208     <add>4.3</add>
 209   </field>
 210   <field>
 211     <name>exported_date</name>
 212     <title>Batch Exported Date</title>
 213     <type>datetime</type>
 214     <add>4.3</add>
 215   </field>
 216   <field>
 217     <name>data</name>
 218     <title>Batch Data</title>
 219     <type>longtext</type>
 220     <comment>cache entered data</comment>
 221     <add>4.4</add>
 222   </field>
 223 </table>