1 <?xml version=
"1.0" encoding=
"iso-8859-1" ?>
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>
10 <labelField>label
</labelField>
13 <type>int unsigned
</type>
14 <title>Custom Field ID
</title>
15 <required>true
</required>
16 <comment>Unique Custom Field ID
</comment>
24 <autoincrement>true
</autoincrement>
27 <name>custom_group_id
</name>
28 <type>int unsigned
</type>
29 <title>Custom Group ID
</title>
30 <required>true
</required>
31 <comment>FK to civicrm_custom_group.
</comment>
34 <table>civicrm_custom_group
</table>
35 <keyColumn>id
</keyColumn>
36 <labelColumn>title
</labelColumn>
40 <label>Custom Group
</label>
44 <name>custom_group_id
</name>
45 <table>civicrm_custom_group
</table>
48 <onDelete>CASCADE
</onDelete>
53 <title>Custom Field Name
</title>
55 <comment>Variable name/programmatic handle for this field.
</comment>
61 <title>Custom Field Label
</title>
63 <required>true
</required>
64 <localizable>true
</localizable>
65 <comment>Text for form field label (also friendly name for administering this custom property).
</comment>
69 <name>data_type
</name>
71 <title>Data Type
</title>
73 <required>true
</required>
74 <comment>Controls location of data storage in extended_data table.
</comment>
76 <callback>CRM_Core_BAO_CustomField::dataType
</callback>
81 <label>Data Type
</label>
85 <name>html_type
</name>
87 <title>HTML Type
</title>
89 <required>true
</required>
90 <comment>HTML types plus several built-in extended types.
</comment>
92 <callback>CRM_Core_SelectValues::customHtmlType
</callback>
96 <label>Field Input Type
</label>
101 <name>default_value
</name>
103 <title>Custom Field Default
</title>
105 <comment>Use form_options.is_default for field_types which use options.
</comment>
109 <name>is_required
</name>
110 <title>Custom Field Is Required?
</title>
112 <comment>Is a value required for this property.
</comment>
117 <name>is_searchable
</name>
118 <title>Allow Searching on Field?
</title>
120 <comment>Is this property searchable.
</comment>
125 <name>is_search_range
</name>
127 <title>Search as a Range
</title>
128 <comment>Is this property range searchable.
</comment>
136 <required>true
</required>
138 <comment>Controls field display order within an extended property group.
</comment>
142 <name>help_pre
</name>
144 <title>Custom Field Pre Text
</title>
145 <localizable>true
</localizable>
146 <comment>Description and/or help text to display before this field.
</comment>
150 <name>help_post
</name>
152 <title>Custom Field Post Text
</title>
153 <localizable>true
</localizable>
154 <comment>Description and/or help text to display after this field.
</comment>
160 <title>Custom Field Formatting
</title>
162 <comment>Optional format instructions for specific field types, like date types.
</comment>
166 <name>attributes
</name>
168 <title>Custom Field Attributes
</title>
170 <comment>Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes
</comment>
174 <name>javascript
</name>
176 <title>Custom Field Javascript
</title>
178 <comment>Optional scripting attributes for field.
</comment>
182 <name>is_active
</name>
184 <title>Custom Field Is Active?
</title>
185 <comment>Is this property active?
</comment>
192 <title>Field is Viewable
</title>
194 <comment>Is this property set by PHP Code? A code field is viewable but not editable
</comment>
198 <name>options_per_line
</name>
199 <type>int unsigned
</type>
200 <title>Field Options Per Line
</title>
201 <comment>number of options per line for checkbox and radio
</comment>
204 <name>text_length
</name>
205 <type>int unsigned
</type>
206 <title>Field Length
</title>
207 <comment>field length if alphanumeric
</comment>
211 <name>start_date_years
</name>
213 <title>Field Start Date
</title>
214 <comment>Date may be up to start_date_years years prior to the current date.
</comment>
218 <name>end_date_years
</name>
220 <title>Field End Date
</title>
221 <comment>Date may be up to end_date_years years after the current date.
</comment>
225 <name>date_format
</name>
227 <title>Field Data Format
</title>
229 <comment>date format for custom date
</comment>
232 <callback>CRM_Core_SelectValues::getDatePluginInputFormats
</callback>
236 <name>time_format
</name>
237 <type>int unsigned
</type>
238 <title>Field Time Format
</title>
239 <comment>time format for custom date
</comment>
242 <callback>CRM_Core_SelectValues::getTimeFormats
</callback>
246 <name>note_columns
</name>
247 <type>int unsigned
</type>
248 <title>Field Note Columns
</title>
249 <comment>Number of columns in Note Field
</comment>
253 <name>note_rows
</name>
254 <type>int unsigned
</type>
255 <title>Field Note Rows
</title>
256 <comment>Number of rows in Note Field
</comment>
260 <name>column_name
</name>
262 <title>Field Column Name
</title>
264 <comment>Name of the column that holds the values for this field.
</comment>
268 <name>option_group_id
</name>
269 <type>int unsigned
</type>
270 <title>Field Option Group ID
</title>
271 <comment>For elements with options, the option group id that is used
</comment>
273 <label>Field Option Group
</label>
277 <table>civicrm_option_group
</table>
278 <keyColumn>id
</keyColumn>
279 <labelColumn>title
</labelColumn>
283 <name>option_group_id
</name>
284 <table>civicrm_option_group
</table>
287 <onDelete>SET NULL
</onDelete>
290 <name>serialize
</name>
291 <type>int unsigned
</type>
292 <title>Serialize
</title>
294 <comment>Serialization method - a non-zero value indicates a multi-valued field.
</comment>
296 <callback>CRM_Core_SelectValues::fieldSerialization
</callback>
299 <required>true
</required>
305 <title>Field Filter
</title>
307 <comment>Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.
</comment>
311 <name>in_selector
</name>
313 <title>Field Display
</title>
315 <comment>Should the multi-record custom field values be displayed in tab table listing
</comment>
319 <name>UI_label_custom_group_id
</name>
320 <fieldName>label
</fieldName>
321 <fieldName>custom_group_id
</fieldName>
322 <unique>true
</unique>
326 <name>UI_name_custom_group_id
</name>
327 <fieldName>name
</fieldName>
328 <fieldName>custom_group_id
</fieldName>
329 <unique>true
</unique>