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