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>
12 <add>civicrm/admin/custom/group/field/add?reset=
1&action=add
&gid=[custom_group_id]
</add>
13 <update>civicrm/admin/custom/group/field/update?action=update
&reset=
1&id=[id]
&gid=[custom_group_id]
</update>
14 <preview>civicrm/admin/custom/group/preview?reset=
1&fid=[id]
</preview>
15 <delete>civicrm/admin/custom/group/field/delete?reset=
1&id=[id]
</delete>
16 <move>civicrm/admin/custom/group/field/move?reset=
1&fid=[id]
</move>
20 <type>int unsigned
</type>
21 <title>Custom Field ID
</title>
22 <required>true
</required>
23 <comment>Unique Custom Field ID
</comment>
31 <autoincrement>true
</autoincrement>
34 <name>custom_group_id
</name>
35 <type>int unsigned
</type>
36 <title>Custom Group ID
</title>
37 <required>true
</required>
38 <comment>FK to civicrm_custom_group.
</comment>
41 <table>civicrm_custom_group
</table>
42 <keyColumn>id
</keyColumn>
43 <labelColumn>title
</labelColumn>
47 <label>Custom Group
</label>
51 <name>custom_group_id
</name>
52 <table>civicrm_custom_group
</table>
55 <onDelete>CASCADE
</onDelete>
60 <title>Custom Field Name
</title>
62 <comment>Variable name/programmatic handle for this field.
</comment>
68 <title>Custom Field Label
</title>
70 <required>true
</required>
71 <localizable>true
</localizable>
72 <comment>Text for form field label (also friendly name for administering this custom property).
</comment>
76 <name>data_type
</name>
78 <title>Data Type
</title>
80 <required>true
</required>
81 <comment>Controls location of data storage in extended_data table.
</comment>
83 <callback>CRM_Core_BAO_CustomField::dataType
</callback>
88 <label>Data Type
</label>
92 <name>html_type
</name>
94 <title>HTML Type
</title>
96 <required>true
</required>
97 <comment>HTML types plus several built-in extended types.
</comment>
99 <callback>CRM_Core_SelectValues::customHtmlType
</callback>
103 <label>Field Input Type
</label>
108 <name>default_value
</name>
110 <title>Custom Field Default
</title>
112 <comment>Use form_options.is_default for field_types which use options.
</comment>
116 <name>is_required
</name>
117 <title>Custom Field Is Required?
</title>
119 <comment>Is a value required for this property.
</comment>
121 <required>true
</required>
125 <name>is_searchable
</name>
126 <title>Allow Searching on Field?
</title>
128 <comment>Is this property searchable.
</comment>
130 <required>true
</required>
134 <name>is_search_range
</name>
136 <title>Search as a Range
</title>
137 <comment>Is this property range searchable.
</comment>
140 <required>true
</required>
146 <required>true
</required>
148 <comment>Controls field display order within an extended property group.
</comment>
152 <name>help_pre
</name>
154 <title>Custom Field Pre Text
</title>
155 <localizable>true
</localizable>
156 <comment>Description and/or help text to display before this field.
</comment>
160 <name>help_post
</name>
162 <title>Custom Field Post Text
</title>
163 <localizable>true
</localizable>
164 <comment>Description and/or help text to display after this field.
</comment>
170 <title>Custom Field Formatting
</title>
172 <comment>Optional format instructions for specific field types, like date types.
</comment>
176 <name>attributes
</name>
178 <title>Custom Field Attributes
</title>
180 <comment>Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes
</comment>
184 <name>javascript
</name>
186 <title>Custom Field Javascript
</title>
188 <comment>Optional scripting attributes for field.
</comment>
192 <name>is_active
</name>
194 <title>Custom Field Is Active?
</title>
195 <comment>Is this property active?
</comment>
203 <title>Field is Viewable
</title>
205 <required>true
</required>
206 <comment>Is this property set by PHP Code? A code field is viewable but not editable
</comment>
210 <name>options_per_line
</name>
211 <type>int unsigned
</type>
212 <title>Field Options Per Line
</title>
213 <comment>number of options per line for checkbox and radio
</comment>
216 <name>text_length
</name>
217 <type>int unsigned
</type>
218 <title>Field Length
</title>
219 <comment>field length if alphanumeric
</comment>
223 <name>start_date_years
</name>
225 <title>Field Start Date
</title>
226 <comment>Date may be up to start_date_years years prior to the current date.
</comment>
230 <name>end_date_years
</name>
232 <title>Field End Date
</title>
233 <comment>Date may be up to end_date_years years after the current date.
</comment>
237 <name>date_format
</name>
239 <title>Field Data Format
</title>
241 <comment>date format for custom date
</comment>
244 <callback>CRM_Core_SelectValues::getDatePluginInputFormats
</callback>
248 <name>time_format
</name>
249 <type>int unsigned
</type>
250 <title>Field Time Format
</title>
251 <comment>time format for custom date
</comment>
254 <callback>CRM_Core_SelectValues::getTimeFormats
</callback>
258 <name>note_columns
</name>
259 <type>int unsigned
</type>
260 <title>Field Note Columns
</title>
261 <comment>Number of columns in Note Field
</comment>
265 <name>note_rows
</name>
266 <type>int unsigned
</type>
267 <title>Field Note Rows
</title>
268 <comment>Number of rows in Note Field
</comment>
272 <name>column_name
</name>
274 <title>Field Column Name
</title>
276 <comment>Name of the column that holds the values for this field.
</comment>
280 <name>option_group_id
</name>
281 <type>int unsigned
</type>
282 <title>Field Option Group ID
</title>
283 <comment>For elements with options, the option group id that is used
</comment>
285 <label>Field Option Group
</label>
289 <table>civicrm_option_group
</table>
290 <keyColumn>id
</keyColumn>
291 <labelColumn>title
</labelColumn>
295 <name>option_group_id
</name>
296 <table>civicrm_option_group
</table>
299 <onDelete>SET NULL
</onDelete>
302 <name>serialize
</name>
303 <type>int unsigned
</type>
304 <title>Serialize
</title>
306 <comment>Serialization method - a non-zero value indicates a multi-valued field.
</comment>
308 <callback>CRM_Core_SelectValues::fieldSerialization
</callback>
311 <required>true
</required>
317 <title>Field Filter
</title>
319 <comment>Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.
</comment>
323 <name>in_selector
</name>
325 <title>Field Display
</title>
327 <required>true
</required>
328 <comment>Should the multi-record custom field values be displayed in tab table listing
</comment>
332 <name>UI_label_custom_group_id
</name>
333 <fieldName>label
</fieldName>
334 <fieldName>custom_group_id
</fieldName>
335 <unique>true
</unique>
339 <name>UI_name_custom_group_id
</name>
340 <fieldName>name
</fieldName>
341 <fieldName>custom_group_id
</fieldName>
342 <unique>true
</unique>