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