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> | |
11 | <name>id</name> | |
12 | <type>int unsigned</type> | |
13 | <required>true</required> | |
14 | <comment>Unique Custom Field ID</comment> | |
15 | <add>1.1</add> | |
16 | </field> | |
17 | <primaryKey> | |
18 | <name>id</name> | |
19 | <autoincrement>true</autoincrement> | |
20 | </primaryKey> | |
21 | <field> | |
22 | <name>custom_group_id</name> | |
23 | <type>int unsigned</type> | |
24 | <required>true</required> | |
25 | <comment>FK to civicrm_custom_group.</comment> | |
cd43c5e3 AS |
26 | <add>1.1</add> |
27 | <pseudoconstant> | |
28 | <table>civicrm_custom_group</table> | |
29 | <keyColumn>id</keyColumn> | |
30 | <labelColumn>title</labelColumn> | |
31 | </pseudoconstant> | |
614d72ec | 32 | <html> |
33 | <type>Select></type> | |
34 | </html> | |
6a488035 TO |
35 | </field> |
36 | <foreignKey> | |
37 | <name>custom_group_id</name> | |
38 | <table>civicrm_custom_group</table> | |
39 | <key>id</key> | |
40 | <add>1.1</add> | |
41 | <onDelete>CASCADE</onDelete> | |
42 | </foreignKey> | |
43 | <field> | |
44 | <name>name</name> | |
45 | <type>varchar</type> | |
46 | <length>64</length> | |
47 | <comment>Variable name/programmatic handle for this group.</comment> | |
48 | <add>3.3</add> | |
49 | </field> | |
50 | <field> | |
51 | <name>label</name> | |
52 | <type>varchar</type> | |
53 | <length>255</length> | |
54 | <required>true</required> | |
55 | <localizable>true</localizable> | |
56 | <comment>Text for form field label (also friendly name for administering this custom property).</comment> | |
57 | <add>1.1</add> | |
58 | </field> | |
59 | <field> | |
60 | <name>data_type</name> | |
61 | <type>enum</type> | |
62 | <values>String, Int, Float, Money, Memo, Date, Boolean, StateProvince, Country, File, Link, ContactReference</values> | |
63 | <required>true</required> | |
64 | <comment>Controls location of data storage in extended_data table.</comment> | |
65 | <add>1.1</add> | |
614d72ec | 66 | <html> |
67 | <type>Select</type> | |
68 | </html> | |
6a488035 TO |
69 | </field> |
70 | <field> | |
71 | <name>html_type</name> | |
72 | <type>enum</type> | |
73 | <values>Text, TextArea, Select, Multi-Select, AdvMulti-Select, Radio, CheckBox, Select Date, Select State/Province, Select Country, Multi-Select Country, Multi-Select State/Province, File, Link, RichTextEditor, Autocomplete-Select</values> | |
74 | <required>true</required> | |
75 | <comment>HTML types plus several built-in extended types.</comment> | |
76 | <add>1.1</add> | |
77 | </field> | |
78 | <field> | |
79 | <name>default_value</name> | |
80 | <type>varchar</type> | |
81 | <length>255</length> | |
82 | <comment>Use form_options.is_default for field_types which use options.</comment> | |
83 | <add>1.1</add> | |
84 | </field> | |
85 | <field> | |
86 | <name>is_required</name> | |
87 | <type>boolean</type> | |
88 | <comment>Is a value required for this property.</comment> | |
89 | <add>1.1</add> | |
90 | </field> | |
91 | <field> | |
92 | <name>is_searchable</name> | |
93 | <type>boolean</type> | |
94 | <comment>Is this property searchable.</comment> | |
95 | <add>1.1</add> | |
96 | </field> | |
97 | <field> | |
98 | <name>is_search_range</name> | |
99 | <type>boolean</type> | |
100 | <comment>Is this property range searchable.</comment> | |
101 | <add>1.4</add> | |
102 | <default>0</default> | |
103 | </field> | |
104 | <field> | |
105 | <name>weight</name> | |
106 | <type>int</type> | |
107 | <required>true</required> | |
108 | <default>1</default> | |
109 | <comment>Controls field display order within an extended property group.</comment> | |
110 | <add>1.1</add> | |
111 | </field> | |
112 | <field> | |
113 | <name>help_pre</name> | |
114 | <type>text</type> | |
115 | <localizable>true</localizable> | |
116 | <comment>Description and/or help text to display before this field.</comment> | |
117 | <add>1.1</add> | |
118 | </field> | |
119 | <field> | |
120 | <name>help_post</name> | |
121 | <type>text</type> | |
122 | <localizable>true</localizable> | |
123 | <comment>Description and/or help text to display after this field.</comment> | |
124 | <add>1.1</add> | |
125 | </field> | |
126 | <field> | |
127 | <name>mask</name> | |
128 | <type>varchar</type> | |
129 | <length>64</length> | |
130 | <comment>Optional format instructions for specific field types, like date types.</comment> | |
131 | <add>1.1</add> | |
132 | </field> | |
133 | <field> | |
134 | <name>attributes</name> | |
135 | <type>varchar</type> | |
136 | <length>255</length> | |
137 | <comment>Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes</comment> | |
138 | <add>1.1</add> | |
139 | </field> | |
140 | <field> | |
141 | <name>javascript</name> | |
142 | <type>varchar</type> | |
143 | <length>255</length> | |
144 | <comment>Optional scripting attributes for field.</comment> | |
145 | <add>1.1</add> | |
146 | </field> | |
147 | <field> | |
148 | <name>is_active</name> | |
149 | <type>boolean</type> | |
150 | <comment>Is this property active?</comment> | |
151 | <add>1.1</add> | |
152 | </field> | |
153 | <field> | |
154 | <name>is_view</name> | |
155 | <type>boolean</type> | |
156 | <comment>Is this property set by PHP Code? A code field is viewable but not editable</comment> | |
157 | <add>1.1</add> | |
158 | </field> | |
159 | <field> | |
160 | <name>options_per_line</name> | |
161 | <type>int unsigned</type> | |
162 | <comment>number of options per line for checkbox and radio</comment> | |
163 | </field> | |
164 | <field> | |
165 | <name>text_length</name> | |
166 | <type>int unsigned</type> | |
167 | <comment>field length if alphanumeric</comment> | |
168 | <add>2.2</add> | |
169 | </field> | |
170 | <field> | |
171 | <name>start_date_years</name> | |
172 | <type>int</type> | |
173 | <comment>Date may be up to start_date_years years prior to the current date.</comment> | |
174 | <add>1.4</add> | |
175 | </field> | |
176 | <field> | |
177 | <name>end_date_years</name> | |
178 | <type>int</type> | |
179 | <comment>Date may be up to end_date_years years after the current date.</comment> | |
180 | <add>1.4</add> | |
181 | </field> | |
182 | <field> | |
183 | <name>date_parts</name> | |
184 | <type>varchar</type> | |
185 | <length>255</length> | |
186 | <comment>which date part included in display </comment> | |
187 | <add>1.4</add> | |
188 | <drop>3.1</drop> | |
189 | </field> | |
190 | <field> | |
191 | <name>date_format</name> | |
192 | <type>varchar</type> | |
193 | <length>64</length> | |
194 | <comment>date format for custom date</comment> | |
195 | <add>3.1</add> | |
196 | </field> | |
197 | <field> | |
198 | <name>time_format</name> | |
199 | <type>int unsigned</type> | |
200 | <comment>time format for custom date</comment> | |
201 | <add>3.1</add> | |
202 | </field> | |
203 | <field> | |
204 | <name>note_columns</name> | |
205 | <type>int unsigned</type> | |
206 | <comment> Number of columns in Note Field </comment> | |
207 | <add>1.4</add> | |
208 | </field> | |
209 | <field> | |
210 | <name>note_rows</name> | |
211 | <type>int unsigned</type> | |
212 | <comment> Number of rows in Note Field </comment> | |
213 | <add>1.4</add> | |
214 | </field> | |
215 | <field> | |
216 | <name>column_name</name> | |
217 | <type>varchar</type> | |
218 | <length>255</length> | |
219 | <comment>Name of the column that holds the values for this field.</comment> | |
220 | <add>2.0</add> | |
221 | </field> | |
222 | <field> | |
223 | <name>option_group_id</name> | |
224 | <type>int unsigned</type> | |
225 | <comment>For elements with options, the option group id that is used</comment> | |
226 | <add>1.4</add> | |
227 | </field> | |
228 | <field> | |
229 | <name>filter</name> | |
230 | <type>varchar</type> | |
231 | <length>255</length> | |
232 | <comment>Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.</comment> | |
233 | <add>4.1</add> | |
234 | </field> | |
235 | <index> | |
236 | <name>UI_label_custom_group_id</name> | |
237 | <fieldName>label</fieldName> | |
238 | <fieldName>custom_group_id</fieldName> | |
239 | <unique>true</unique> | |
240 | <add>1.1</add> | |
241 | </index> | |
242 | <index> | |
243 | <name>UI_name_custom_group_id</name> | |
244 | <fieldName>name</fieldName> | |
245 | <fieldName>custom_group_id</fieldName> | |
246 | <unique>true</unique> | |
247 | <add>4.3</add> | |
248 | </index> | |
249 | </table> |