Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?xml version="1.0" encoding="iso-8859-1" ?> |
2 | ||
3 | <table> | |
4 | <base>CRM/Core</base> | |
5 | <class>CustomField</class> | |
6 | <name>civicrm_custom_field</name> | |
7 | <comment>Stores info about an extended (custom) property (data and form field info).</comment> | |
8 | <add>1.1</add> | |
9 | <log>true</log> | |
10 | <field> | |
186e0984 EM |
11 | <name>id</name> |
12 | <type>int unsigned</type> | |
56b7523d | 13 | <title>Custom Field ID</title> |
186e0984 EM |
14 | <required>true</required> |
15 | <comment>Unique Custom Field ID</comment> | |
16 | <add>1.1</add> | |
6a488035 TO |
17 | </field> |
18 | <primaryKey> | |
186e0984 EM |
19 | <name>id</name> |
20 | <autoincrement>true</autoincrement> | |
6a488035 TO |
21 | </primaryKey> |
22 | <field> | |
186e0984 EM |
23 | <name>custom_group_id</name> |
24 | <type>int unsigned</type> | |
56b7523d | 25 | <title>Custom Group</title> |
186e0984 EM |
26 | <required>true</required> |
27 | <comment>FK to civicrm_custom_group.</comment> | |
28 | <add>1.1</add> | |
29 | <pseudoconstant> | |
30 | <table>civicrm_custom_group</table> | |
31 | <keyColumn>id</keyColumn> | |
32 | <labelColumn>title</labelColumn> | |
33 | </pseudoconstant> | |
34 | <html> | |
35 | <type>Select</type> | |
36 | </html> | |
6a488035 TO |
37 | </field> |
38 | <foreignKey> | |
186e0984 EM |
39 | <name>custom_group_id</name> |
40 | <table>civicrm_custom_group</table> | |
41 | <key>id</key> | |
42 | <add>1.1</add> | |
43 | <onDelete>CASCADE</onDelete> | |
6a488035 TO |
44 | </foreignKey> |
45 | <field> | |
186e0984 EM |
46 | <name>name</name> |
47 | <type>varchar</type> | |
56b7523d | 48 | <title>Custom Field Name</title> |
186e0984 EM |
49 | <length>64</length> |
50 | <comment>Variable name/programmatic handle for this group.</comment> | |
51 | <add>3.3</add> | |
6a488035 TO |
52 | </field> |
53 | <field> | |
186e0984 EM |
54 | <name>label</name> |
55 | <type>varchar</type> | |
56b7523d | 56 | <title>Custom Field Label</title> |
186e0984 EM |
57 | <length>255</length> |
58 | <required>true</required> | |
59 | <localizable>true</localizable> | |
60 | <comment>Text for form field label (also friendly name for administering this custom property).</comment> | |
61 | <add>1.1</add> | |
6a488035 TO |
62 | </field> |
63 | <field> | |
186e0984 EM |
64 | <name>data_type</name> |
65 | <type>varchar</type> | |
56b7523d | 66 | <title>Custom Field Data Type</title> |
186e0984 EM |
67 | <length>16</length> |
68 | <required>true</required> | |
69 | <comment>Controls location of data storage in extended_data table.</comment> | |
70 | <pseudoconstant> | |
71 | <callback>CRM_Core_BAO_CustomField::dataType</callback> | |
72 | </pseudoconstant> | |
73 | <add>1.1</add> | |
74 | <html> | |
75 | <type>Select</type> | |
9b85cd33 | 76 | <label>Data Type</label> |
186e0984 | 77 | </html> |
6a488035 TO |
78 | </field> |
79 | <field> | |
186e0984 EM |
80 | <name>html_type</name> |
81 | <type>varchar</type> | |
4d1776fb | 82 | <title>Custom Field HTML Type</title> |
186e0984 EM |
83 | <length>32</length> |
84 | <required>true</required> | |
85 | <comment>HTML types plus several built-in extended types.</comment> | |
86 | <pseudoconstant> | |
87 | <callback>CRM_Core_SelectValues::customHtmlType</callback> | |
88 | </pseudoconstant> | |
9b85cd33 CW |
89 | <html> |
90 | <type>Select</type> | |
91 | <label>Field Input Type</label> | |
92 | </html> | |
186e0984 | 93 | <add>1.1</add> |
6a488035 TO |
94 | </field> |
95 | <field> | |
186e0984 EM |
96 | <name>default_value</name> |
97 | <type>varchar</type> | |
56b7523d | 98 | <title>Custom Field Default</title> |
186e0984 EM |
99 | <length>255</length> |
100 | <comment>Use form_options.is_default for field_types which use options.</comment> | |
101 | <add>1.1</add> | |
6a488035 TO |
102 | </field> |
103 | <field> | |
186e0984 | 104 | <name>is_required</name> |
56b7523d | 105 | <title>Custom Field Is Required?</title> |
186e0984 EM |
106 | <type>boolean</type> |
107 | <comment>Is a value required for this property.</comment> | |
110f4343 | 108 | <default>0</default> |
186e0984 | 109 | <add>1.1</add> |
6a488035 TO |
110 | </field> |
111 | <field> | |
186e0984 | 112 | <name>is_searchable</name> |
56b7523d | 113 | <title>Allow Searching on Field?</title> |
186e0984 EM |
114 | <type>boolean</type> |
115 | <comment>Is this property searchable.</comment> | |
110f4343 | 116 | <default>0</default> |
186e0984 | 117 | <add>1.1</add> |
6a488035 TO |
118 | </field> |
119 | <field> | |
186e0984 EM |
120 | <name>is_search_range</name> |
121 | <type>boolean</type> | |
56b7523d | 122 | <title>Search as a Range</title> |
186e0984 EM |
123 | <comment>Is this property range searchable.</comment> |
124 | <add>1.4</add> | |
125 | <default>0</default> | |
6a488035 TO |
126 | </field> |
127 | <field> | |
186e0984 EM |
128 | <name>weight</name> |
129 | <type>int</type> | |
7ecddde4 | 130 | <title>Order</title> |
186e0984 EM |
131 | <required>true</required> |
132 | <default>1</default> | |
133 | <comment>Controls field display order within an extended property group.</comment> | |
134 | <add>1.1</add> | |
6a488035 TO |
135 | </field> |
136 | <field> | |
186e0984 EM |
137 | <name>help_pre</name> |
138 | <type>text</type> | |
56b7523d | 139 | <title>Custom Field Pre Text</title> |
186e0984 EM |
140 | <localizable>true</localizable> |
141 | <comment>Description and/or help text to display before this field.</comment> | |
142 | <add>1.1</add> | |
6a488035 TO |
143 | </field> |
144 | <field> | |
186e0984 EM |
145 | <name>help_post</name> |
146 | <type>text</type> | |
56b7523d | 147 | <title>Custom Field Post Text</title> |
186e0984 EM |
148 | <localizable>true</localizable> |
149 | <comment>Description and/or help text to display after this field.</comment> | |
150 | <add>1.1</add> | |
6a488035 TO |
151 | </field> |
152 | <field> | |
186e0984 EM |
153 | <name>mask</name> |
154 | <type>varchar</type> | |
56b7523d | 155 | <title>Custom Field Formatting</title> |
186e0984 EM |
156 | <length>64</length> |
157 | <comment>Optional format instructions for specific field types, like date types.</comment> | |
158 | <add>1.1</add> | |
6a488035 TO |
159 | </field> |
160 | <field> | |
186e0984 EM |
161 | <name>attributes</name> |
162 | <type>varchar</type> | |
56b7523d | 163 | <title>Custom Field Attributes</title> |
186e0984 EM |
164 | <length>255</length> |
165 | <comment>Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes</comment> | |
166 | <add>1.1</add> | |
6a488035 TO |
167 | </field> |
168 | <field> | |
186e0984 EM |
169 | <name>javascript</name> |
170 | <type>varchar</type> | |
56b7523d | 171 | <title>Custom Field Javascript</title> |
186e0984 EM |
172 | <length>255</length> |
173 | <comment>Optional scripting attributes for field.</comment> | |
174 | <add>1.1</add> | |
6a488035 TO |
175 | </field> |
176 | <field> | |
186e0984 EM |
177 | <name>is_active</name> |
178 | <type>boolean</type> | |
56b7523d | 179 | <title>Custom Field Is Active?</title> |
186e0984 | 180 | <comment>Is this property active?</comment> |
110f4343 | 181 | <default>1</default> |
186e0984 | 182 | <add>1.1</add> |
6a488035 TO |
183 | </field> |
184 | <field> | |
186e0984 EM |
185 | <name>is_view</name> |
186 | <type>boolean</type> | |
56b7523d | 187 | <title>Field is Viewable</title> |
110f4343 | 188 | <default>0</default> |
186e0984 EM |
189 | <comment>Is this property set by PHP Code? A code field is viewable but not editable</comment> |
190 | <add>1.1</add> | |
6a488035 TO |
191 | </field> |
192 | <field> | |
186e0984 EM |
193 | <name>options_per_line</name> |
194 | <type>int unsigned</type> | |
56b7523d | 195 | <title>Field Options Per Line</title> |
186e0984 | 196 | <comment>number of options per line for checkbox and radio</comment> |
6a488035 TO |
197 | </field> |
198 | <field> | |
186e0984 EM |
199 | <name>text_length</name> |
200 | <type>int unsigned</type> | |
56b7523d | 201 | <title>Field Length</title> |
186e0984 EM |
202 | <comment>field length if alphanumeric</comment> |
203 | <add>2.2</add> | |
6a488035 TO |
204 | </field> |
205 | <field> | |
186e0984 EM |
206 | <name>start_date_years</name> |
207 | <type>int</type> | |
56b7523d | 208 | <title>Field Start Date</title> |
186e0984 EM |
209 | <comment>Date may be up to start_date_years years prior to the current date.</comment> |
210 | <add>1.4</add> | |
6a488035 TO |
211 | </field> |
212 | <field> | |
186e0984 EM |
213 | <name>end_date_years</name> |
214 | <type>int</type> | |
56b7523d | 215 | <title>Field End Date</title> |
186e0984 EM |
216 | <comment>Date may be up to end_date_years years after the current date.</comment> |
217 | <add>1.4</add> | |
6a488035 | 218 | </field> |
6a488035 | 219 | <field> |
186e0984 EM |
220 | <name>date_format</name> |
221 | <type>varchar</type> | |
56b7523d | 222 | <title>Field Data Format</title> |
186e0984 EM |
223 | <length>64</length> |
224 | <comment>date format for custom date</comment> | |
225 | <add>3.1</add> | |
72c65bfa CW |
226 | <pseudoconstant> |
227 | <callback>CRM_Core_SelectValues::getDatePluginInputFormats</callback> | |
228 | </pseudoconstant> | |
6a488035 TO |
229 | </field> |
230 | <field> | |
186e0984 EM |
231 | <name>time_format</name> |
232 | <type>int unsigned</type> | |
56b7523d | 233 | <title>Field Time Format</title> |
186e0984 EM |
234 | <comment>time format for custom date</comment> |
235 | <add>3.1</add> | |
72c65bfa CW |
236 | <pseudoconstant> |
237 | <callback>CRM_Core_SelectValues::getTimeFormats</callback> | |
238 | </pseudoconstant> | |
6a488035 TO |
239 | </field> |
240 | <field> | |
186e0984 EM |
241 | <name>note_columns</name> |
242 | <type>int unsigned</type> | |
56b7523d | 243 | <title>Field Note Columns</title> |
72c65bfa | 244 | <comment>Number of columns in Note Field</comment> |
186e0984 | 245 | <add>1.4</add> |
6a488035 TO |
246 | </field> |
247 | <field> | |
186e0984 EM |
248 | <name>note_rows</name> |
249 | <type>int unsigned</type> | |
56b7523d | 250 | <title>Field Note Rows</title> |
72c65bfa | 251 | <comment>Number of rows in Note Field</comment> |
186e0984 | 252 | <add>1.4</add> |
6a488035 TO |
253 | </field> |
254 | <field> | |
186e0984 EM |
255 | <name>column_name</name> |
256 | <type>varchar</type> | |
56b7523d | 257 | <title>Field Column Name</title> |
186e0984 EM |
258 | <length>255</length> |
259 | <comment>Name of the column that holds the values for this field.</comment> | |
260 | <add>2.0</add> | |
6a488035 TO |
261 | </field> |
262 | <field> | |
186e0984 EM |
263 | <name>option_group_id</name> |
264 | <type>int unsigned</type> | |
56b7523d | 265 | <title>Field Option Group</title> |
186e0984 EM |
266 | <comment>For elements with options, the option group id that is used</comment> |
267 | <add>1.4</add> | |
5830940d MM |
268 | <pseudoconstant> |
269 | <table>civicrm_option_group</table> | |
270 | <keyColumn>id</keyColumn> | |
271 | <labelColumn>title</labelColumn> | |
272 | </pseudoconstant> | |
6a488035 | 273 | </field> |
2b216479 PN |
274 | <foreignKey> |
275 | <name>option_group_id</name> | |
276 | <table>civicrm_option_group</table> | |
277 | <key>id</key> | |
febf277f | 278 | <add>5.6</add> |
2b216479 PN |
279 | <onDelete>SET NULL</onDelete> |
280 | </foreignKey> | |
2bcfa9ee CW |
281 | <field> |
282 | <name>serialize</name> | |
283 | <type>int unsigned</type> | |
284 | <title>Serialize</title> | |
285 | <length>255</length> | |
49df88a8 | 286 | <comment>Serialization method - a non-zero value indicates a multi-valued field.</comment> |
2bcfa9ee CW |
287 | <pseudoconstant> |
288 | <callback>CRM_Core_SelectValues::fieldSerialization</callback> | |
289 | </pseudoconstant> | |
d51a6a62 | 290 | <add>5.27</add> |
49df88a8 CW |
291 | <required>true</required> |
292 | <default>0</default> | |
2bcfa9ee | 293 | </field> |
6a488035 | 294 | <field> |
186e0984 EM |
295 | <name>filter</name> |
296 | <type>varchar</type> | |
56b7523d | 297 | <title>Field Filter</title> |
186e0984 EM |
298 | <length>255</length> |
299 | <comment>Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.</comment> | |
300 | <add>4.1</add> | |
6a488035 | 301 | </field> |
5a205b89 PJ |
302 | <field> |
303 | <name>in_selector</name> | |
304 | <type>boolean</type> | |
56b7523d | 305 | <title>Field Display</title> |
5a205b89 PJ |
306 | <default>0</default> |
307 | <comment>Should the multi-record custom field values be displayed in tab table listing</comment> | |
308 | <add>4.5</add> | |
309 | </field> | |
6a488035 TO |
310 | <index> |
311 | <name>UI_label_custom_group_id</name> | |
312 | <fieldName>label</fieldName> | |
313 | <fieldName>custom_group_id</fieldName> | |
314 | <unique>true</unique> | |
315 | <add>1.1</add> | |
316 | </index> | |
317 | <index> | |
318 | <name>UI_name_custom_group_id</name> | |
319 | <fieldName>name</fieldName> | |
320 | <fieldName>custom_group_id</fieldName> | |
321 | <unique>true</unique> | |
322 | <add>4.3</add> | |
323 | </index> | |
324 | </table> |