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>
12 <type>int unsigned
</type>
13 <required>true
</required>
14 <comment>Unique Custom Field ID
</comment>
19 <autoincrement>true
</autoincrement>
22 <name>custom_group_id
</name>
23 <type>int unsigned
</type>
24 <required>true
</required>
25 <comment>FK to civicrm_custom_group.
</comment>
28 <table>civicrm_custom_group
</table>
29 <keyColumn>id
</keyColumn>
30 <labelColumn>title
</labelColumn>
34 <name>custom_group_id
</name>
35 <table>civicrm_custom_group
</table>
38 <onDelete>CASCADE
</onDelete>
44 <comment>Variable name/programmatic handle for this group.
</comment>
51 <required>true
</required>
52 <localizable>true
</localizable>
53 <comment>Text for form field label (also friendly name for administering this custom property).
</comment>
57 <name>data_type
</name>
59 <values>String, Int, Float, Money, Memo, Date, Boolean, StateProvince, Country, File, Link, ContactReference
</values>
60 <required>true
</required>
61 <comment>Controls location of data storage in extended_data table.
</comment>
65 <name>html_type
</name>
67 <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>
68 <required>true
</required>
69 <comment>HTML types plus several built-in extended types.
</comment>
73 <name>default_value
</name>
76 <comment>Use form_options.is_default for field_types which use options.
</comment>
80 <name>is_required
</name>
82 <comment>Is a value required for this property.
</comment>
86 <name>is_searchable
</name>
88 <comment>Is this property searchable.
</comment>
92 <name>is_search_range
</name>
94 <comment>Is this property range searchable.
</comment>
101 <required>true
</required>
103 <comment>Controls field display order within an extended property group.
</comment>
107 <name>help_pre
</name>
109 <localizable>true
</localizable>
110 <comment>Description and/or help text to display before this field.
</comment>
114 <name>help_post
</name>
116 <localizable>true
</localizable>
117 <comment>Description and/or help text to display after this field.
</comment>
124 <comment>Optional format instructions for specific field types, like date types.
</comment>
128 <name>attributes
</name>
131 <comment>Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes
</comment>
135 <name>javascript
</name>
138 <comment>Optional scripting attributes for field.
</comment>
142 <name>is_active
</name>
144 <comment>Is this property active?
</comment>
150 <comment>Is this property set by PHP Code? A code field is viewable but not editable
</comment>
154 <name>options_per_line
</name>
155 <type>int unsigned
</type>
156 <comment>number of options per line for checkbox and radio
</comment>
159 <name>text_length
</name>
160 <type>int unsigned
</type>
161 <comment>field length if alphanumeric
</comment>
165 <name>start_date_years
</name>
167 <comment>Date may be up to start_date_years years prior to the current date.
</comment>
171 <name>end_date_years
</name>
173 <comment>Date may be up to end_date_years years after the current date.
</comment>
177 <name>date_parts
</name>
180 <comment>which date part included in display
</comment>
185 <name>date_format
</name>
188 <comment>date format for custom date
</comment>
192 <name>time_format
</name>
193 <type>int unsigned
</type>
194 <comment>time format for custom date
</comment>
198 <name>note_columns
</name>
199 <type>int unsigned
</type>
200 <comment> Number of columns in Note Field
</comment>
204 <name>note_rows
</name>
205 <type>int unsigned
</type>
206 <comment> Number of rows in Note Field
</comment>
210 <name>column_name
</name>
213 <comment>Name of the column that holds the values for this field.
</comment>
217 <name>option_group_id
</name>
218 <type>int unsigned
</type>
219 <comment>For elements with options, the option group id that is used
</comment>
226 <comment>Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.
</comment>
230 <name>UI_label_custom_group_id
</name>
231 <fieldName>label
</fieldName>
232 <fieldName>custom_group_id
</fieldName>
233 <unique>true
</unique>
237 <name>UI_name_custom_group_id
</name>
238 <fieldName>name
</fieldName>
239 <fieldName>custom_group_id
</fieldName>
240 <unique>true
</unique>