Commit | Line | Data |
---|---|---|
6a488035 TO |
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> | |
61ce9b45 | 11 | <title>Batch ID</title> |
6a488035 TO |
12 | <type>int unsigned</type> |
13 | <required>true</required> | |
14 | <comment>Unique Address ID</comment> | |
0481e12c A |
15 | <html> |
16 | <type>Number</type> | |
17 | </html> | |
6a488035 TO |
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> | |
61ce9b45 | 26 | <title>Batch Name</title> |
6a488035 TO |
27 | <type>varchar</type> |
28 | <length>64</length> | |
29 | <comment>Variable name/programmatic handle for this batch.</comment> | |
30 | <add>3.3</add> | |
614d72ec | 31 | <html> |
32 | <type>Text</type> | |
33 | </html> | |
6a488035 TO |
34 | </field> |
35 | <index> | |
36 | <name>UI_name</name> | |
37 | <fieldName>name</fieldName> | |
38 | <unique>true</unique> | |
39 | <add>4.2</add> | |
40 | </index> | |
6a488035 TO |
41 | <field> |
42 | <name>title</name> | |
61ce9b45 | 43 | <title>Batch Title</title> |
6a488035 | 44 | <type>varchar</type> |
59ccff56 | 45 | <length>255</length> |
6a488035 TO |
46 | <localizable>true</localizable> |
47 | <comment>Friendly Name.</comment> | |
48 | <add>4.2</add> | |
614d72ec | 49 | <html> |
50 | <type>Text</type> | |
51 | </html> | |
6a488035 TO |
52 | </field> |
53 | <field> | |
54 | <name>description</name> | |
61ce9b45 | 55 | <title>Batch Description</title> |
6a488035 TO |
56 | <type>text</type> |
57 | <comment>Description of this batch set.</comment> | |
58 | <localizable>true</localizable> | |
7deea513 | 59 | <html> |
60 | <type>TextArea</type> | |
817807ab | 61 | <rows>4</rows> |
62 | <cols>80</cols> | |
7deea513 | 63 | </html> |
6a488035 TO |
64 | <add>3.3</add> |
65 | </field> | |
66 | <field> | |
67 | <name>created_id</name> | |
047c5009 | 68 | <title>Created By Contact ID</title> |
6a488035 TO |
69 | <type>int unsigned</type> |
70 | <comment>FK to Contact ID</comment> | |
57e94608 | 71 | <html> |
047c5009 | 72 | <label>Created By</label> |
57e94608 | 73 | </html> |
6a488035 TO |
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> | |
61ce9b45 | 85 | <title>Batch Created Date</title> |
6a488035 TO |
86 | <type>datetime</type> |
87 | <comment>When was this item created</comment> | |
88 | <add>3.3</add> | |
614d72ec | 89 | <html> |
90 | <type>Select Date</type> | |
efcda6b9 | 91 | <formatType>activityDateTime</formatType> |
614d72ec | 92 | </html> |
6a488035 TO |
93 | </field> |
94 | <field> | |
95 | <name>modified_id</name> | |
047c5009 | 96 | <title>Modified By Contact ID</title> |
6a488035 TO |
97 | <type>int unsigned</type> |
98 | <comment>FK to Contact ID</comment> | |
57e94608 | 99 | <html> |
047c5009 | 100 | <label>Modified By</label> |
57e94608 | 101 | </html> |
6a488035 TO |
102 | <add>3.3</add> |
103 | </field> | |
104 | <field> | |
105 | <name>modified_date</name> | |
61ce9b45 | 106 | <title>Batch Modified Date</title> |
6a488035 | 107 | <type>datetime</type> |
a0e733f3 CW |
108 | <comment>When was this item modified</comment> |
109 | <readonly>true</readonly> | |
6a488035 TO |
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> | |
047c5009 | 121 | <title>Smart Group ID</title> |
6a488035 TO |
122 | <type>int unsigned</type> |
123 | <comment>FK to Saved Search ID</comment> | |
124 | <add>4.1</add> | |
614d72ec | 125 | <html> |
916b6181 | 126 | <type>EntityRef</type> |
047c5009 | 127 | <label>Smart Group</label> |
614d72ec | 128 | </html> |
6a488035 TO |
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> | |
61ce9b45 | 139 | <title>Batch Status</title> |
6a488035 TO |
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> | |
97afa853 AS |
144 | <pseudoconstant> |
145 | <optionGroupName>batch_status</optionGroupName> | |
146 | </pseudoconstant> | |
614d72ec | 147 | <html> |
e0991796 | 148 | <type>Select</type> |
614d72ec | 149 | </html> |
6a488035 TO |
150 | </field> |
151 | <field> | |
152 | <name>type_id</name> | |
61ce9b45 | 153 | <title>Batch Type</title> |
6a488035 TO |
154 | <type>int unsigned</type> |
155 | <comment>fk to Batch Type options in civicrm_option_values</comment> | |
156 | <add>4.2</add> | |
97afa853 AS |
157 | <pseudoconstant> |
158 | <optionGroupName>batch_type</optionGroupName> | |
159 | </pseudoconstant> | |
614d72ec | 160 | <html> |
e0991796 | 161 | <type>Select</type> |
614d72ec | 162 | </html> |
6a488035 TO |
163 | </field> |
164 | <field> | |
165 | <name>mode_id</name> | |
61ce9b45 | 166 | <title>Batch Mode</title> |
6a488035 TO |
167 | <type>int unsigned</type> |
168 | <comment>fk to Batch mode options in civicrm_option_values</comment> | |
169 | <add>4.2</add> | |
e7e657f0 AS |
170 | <pseudoconstant> |
171 | <optionGroupName>batch_mode</optionGroupName> | |
172 | </pseudoconstant> | |
614d72ec | 173 | <html> |
e0991796 | 174 | <type>Select</type> |
614d72ec | 175 | </html> |
6a488035 TO |
176 | </field> |
177 | <field> | |
178 | <name>total</name> | |
61ce9b45 | 179 | <title>Batch Total</title> |
6a488035 TO |
180 | <type>decimal</type> |
181 | <comment>Total amount for this batch.</comment> | |
182 | <add>4.2</add> | |
614d72ec | 183 | <html> |
184 | <type>Text</type> | |
185 | </html> | |
6a488035 TO |
186 | </field> |
187 | <field> | |
188 | <name>item_count</name> | |
61ce9b45 | 189 | <title>Batch Number of Items</title> |
6a488035 TO |
190 | <type>int unsigned</type> |
191 | <comment>Number of items in a batch.</comment> | |
192 | <add>4.2</add> | |
614d72ec | 193 | <html> |
194 | <type>Text</type> | |
195 | </html> | |
6a488035 TO |
196 | </field> |
197 | <field> | |
198 | <name>payment_instrument_id</name> | |
536f0e02 | 199 | <title>Batch Payment Method</title> |
6a488035 TO |
200 | <type>int unsigned</type> |
201 | <comment>fk to Payment Instrument options in civicrm_option_values</comment> | |
6d68a4cb CW |
202 | <pseudoconstant> |
203 | <optionGroupName>payment_instrument</optionGroupName> | |
204 | </pseudoconstant> | |
614d72ec | 205 | <html> |
e0991796 | 206 | <type>Select</type> |
614d72ec | 207 | </html> |
6a488035 TO |
208 | <add>4.3</add> |
209 | </field> | |
210 | <field> | |
211 | <name>exported_date</name> | |
61ce9b45 | 212 | <title>Batch Exported Date</title> |
6a488035 TO |
213 | <type>datetime</type> |
214 | <add>4.3</add> | |
215 | </field> | |
638aee74 | 216 | <field> |
217 | <name>data</name> | |
61ce9b45 | 218 | <title>Batch Data</title> |
638aee74 | 219 | <type>longtext</type> |
220 | <comment>cache entered data</comment> | |
221 | <add>4.4</add> | |
222 | </field> | |
6a488035 | 223 | </table> |