<field>
<name>id</name>
<type>int unsigned</type>
+ <title>Custom Field ID</title>
<required>true</required>
<comment>Unique Custom Field ID</comment>
<add>1.1</add>
<field>
<name>custom_group_id</name>
<type>int unsigned</type>
+ <title>Custom Group</title>
<required>true</required>
<comment>FK to civicrm_custom_group.</comment>
<add>1.1</add>
<field>
<name>name</name>
<type>varchar</type>
+ <title>Custom Field Name</title>
<length>64</length>
<comment>Variable name/programmatic handle for this group.</comment>
<add>3.3</add>
<field>
<name>label</name>
<type>varchar</type>
+ <title>Custom Field Label</title>
<length>255</length>
<required>true</required>
<localizable>true</localizable>
<field>
<name>data_type</name>
<type>varchar</type>
+ <title>Custom Field Data Type</title>
<length>16</length>
<required>true</required>
<comment>Controls location of data storage in extended_data table.</comment>
<field>
<name>html_type</name>
<type>varchar</type>
+ <title>Custom Field HTMl Type</title>
<length>32</length>
<required>true</required>
<comment>HTML types plus several built-in extended types.</comment>
<field>
<name>default_value</name>
<type>varchar</type>
+ <title>Custom Field Default</title>
<length>255</length>
<comment>Use form_options.is_default for field_types which use options.</comment>
<add>1.1</add>
</field>
<field>
<name>is_required</name>
+ <title>Custom Field Is Required?</title>
<type>boolean</type>
<comment>Is a value required for this property.</comment>
<add>1.1</add>
</field>
<field>
<name>is_searchable</name>
+ <title>Allow Searching on Field?</title>
<type>boolean</type>
<comment>Is this property searchable.</comment>
<add>1.1</add>
<field>
<name>is_search_range</name>
<type>boolean</type>
+ <title>Search as a Range</title>
<comment>Is this property range searchable.</comment>
<add>1.4</add>
<default>0</default>
<field>
<name>weight</name>
<type>int</type>
+ <title>Custom Field Weight</title>
<required>true</required>
<default>1</default>
<comment>Controls field display order within an extended property group.</comment>
<field>
<name>help_pre</name>
<type>text</type>
+ <title>Custom Field Pre Text</title>
<localizable>true</localizable>
<comment>Description and/or help text to display before this field.</comment>
<add>1.1</add>
<field>
<name>help_post</name>
<type>text</type>
+ <title>Custom Field Post Text</title>
<localizable>true</localizable>
<comment>Description and/or help text to display after this field.</comment>
<add>1.1</add>
<field>
<name>mask</name>
<type>varchar</type>
+ <title>Custom Field Formatting</title>
<length>64</length>
<comment>Optional format instructions for specific field types, like date types.</comment>
<add>1.1</add>
<field>
<name>attributes</name>
<type>varchar</type>
+ <title>Custom Field Attributes</title>
<length>255</length>
<comment>Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes</comment>
<add>1.1</add>
<field>
<name>javascript</name>
<type>varchar</type>
+ <title>Custom Field Javascript</title>
<length>255</length>
<comment>Optional scripting attributes for field.</comment>
<add>1.1</add>
<field>
<name>is_active</name>
<type>boolean</type>
+ <title>Custom Field Is Active?</title>
<comment>Is this property active?</comment>
<add>1.1</add>
</field>
<field>
<name>is_view</name>
<type>boolean</type>
+ <title>Field is Viewable</title>
<comment>Is this property set by PHP Code? A code field is viewable but not editable</comment>
<add>1.1</add>
</field>
<field>
<name>options_per_line</name>
<type>int unsigned</type>
+ <title>Field Options Per Line</title>
<comment>number of options per line for checkbox and radio</comment>
</field>
<field>
<name>text_length</name>
<type>int unsigned</type>
+ <title>Field Length</title>
<comment>field length if alphanumeric</comment>
<add>2.2</add>
</field>
<field>
<name>start_date_years</name>
<type>int</type>
+ <title>Field Start Date</title>
<comment>Date may be up to start_date_years years prior to the current date.</comment>
<add>1.4</add>
</field>
<field>
<name>end_date_years</name>
<type>int</type>
+ <title>Field End Date</title>
<comment>Date may be up to end_date_years years after the current date.</comment>
<add>1.4</add>
</field>
<field>
<name>date_format</name>
<type>varchar</type>
+ <title>Field Data Format</title>
<length>64</length>
<comment>date format for custom date</comment>
<add>3.1</add>
<field>
<name>time_format</name>
<type>int unsigned</type>
+ <title>Field Time Format</title>
<comment>time format for custom date</comment>
<add>3.1</add>
</field>
<field>
<name>note_columns</name>
<type>int unsigned</type>
+ <title>Field Note Columns</title>
<comment> Number of columns in Note Field </comment>
<add>1.4</add>
</field>
<field>
<name>note_rows</name>
<type>int unsigned</type>
+ <title>Field Note Rows</title>
<comment> Number of rows in Note Field </comment>
<add>1.4</add>
</field>
<field>
<name>column_name</name>
<type>varchar</type>
+ <title>Field Column Name</title>
<length>255</length>
<comment>Name of the column that holds the values for this field.</comment>
<add>2.0</add>
<field>
<name>option_group_id</name>
<type>int unsigned</type>
+ <title>Field Option Group</title>
<comment>For elements with options, the option group id that is used</comment>
<add>1.4</add>
</field>
<field>
<name>filter</name>
<type>varchar</type>
+ <title>Field Filter</title>
<length>255</length>
<comment>Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.</comment>
<add>4.1</add>
<field>
<name>in_selector</name>
<type>boolean</type>
+ <title>Field Display</title>
<default>0</default>
<comment>Should the multi-record custom field values be displayed in tab table listing</comment>
<add>4.5</add>
projects / civicrm-core.git / blobdiff