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