[civicrm-core.git] / xml / schema / Core / CustomField.xml

<?xml version="1.0" encoding="iso-8859-1" ?>

<table>
  <base>CRM/Core</base>
  <class>CustomField</class>
  <name>civicrm_custom_field</name>
  <comment>Stores info about an extended (custom) property (data and form field info).</comment>
  <add>1.1</add>
  <log>true</log>
  <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>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <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>
    <pseudoconstant>
      <table>civicrm_custom_group</table>
      <keyColumn>id</keyColumn>
      <labelColumn>title</labelColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <foreignKey>
    <name>custom_group_id</name>
    <table>civicrm_custom_group</table>
    <key>id</key>
    <add>1.1</add>
    <onDelete>CASCADE</onDelete>
  </foreignKey>
  <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>
  <field>
    <name>label</name>
    <type>varchar</type>
    <title>Custom Field Label</title>
    <length>255</length>
    <required>true</required>
    <localizable>true</localizable>
    <comment>Text for form field label (also friendly name for administering this custom property).</comment>
    <add>1.1</add>
  </field>
  <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>
    <pseudoconstant>
      <callback>CRM_Core_BAO_CustomField::dataType</callback>
    </pseudoconstant>
    <add>1.1</add>
    <html>
      <type>Select</type>
    </html>
  </field>
  <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>
    <pseudoconstant>
      <callback>CRM_Core_SelectValues::customHtmlType</callback>
    </pseudoconstant>
    <add>1.1</add>
  </field>
  <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>
    <default>0</default>
    <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>
    <default>0</default>
    <add>1.1</add>
  </field>
  <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>
  <field>
    <name>weight</name>
    <type>int</type>
    <title>Order</title>
    <required>true</required>
    <default>1</default>
    <comment>Controls field display order within an extended property group.</comment>
    <add>1.1</add>
  </field>
  <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>
  <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>
  <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>
  <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>
  <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>
  <field>
    <name>is_active</name>
    <type>boolean</type>
    <title>Custom Field Is Active?</title>
    <comment>Is this property active?</comment>
    <default>1</default>
    <add>1.1</add>
  </field>
  <field>
    <name>is_view</name>
    <type>boolean</type>
    <title>Field is Viewable</title>
    <default>0</default>
    <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_parts</name>
    <type>varchar</type>
    <length>255</length>
    <comment>which date part included in display </comment>
    <add>1.4</add>
    <drop>3.1</drop>
  </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>
    <pseudoconstant>
      <callback>CRM_Core_SelectValues::getDatePluginInputFormats</callback>
    </pseudoconstant>
  </field>
  <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>
    <pseudoconstant>
      <callback>CRM_Core_SelectValues::getTimeFormats</callback>
    </pseudoconstant>
  </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>
  <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>
    <pseudoconstant>
      <table>civicrm_option_group</table>
      <keyColumn>id</keyColumn>
      <labelColumn>title</labelColumn>
    </pseudoconstant>
  </field>
  <foreignKey>
    <name>option_group_id</name>
    <table>civicrm_option_group</table>
    <key>id</key>
    <add>5.6</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <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>
  <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>
  </field>
  <index>
    <name>UI_label_custom_group_id</name>
    <fieldName>label</fieldName>
    <fieldName>custom_group_id</fieldName>
    <unique>true</unique>
    <add>1.1</add>
  </index>
  <index>
    <name>UI_name_custom_group_id</name>
    <fieldName>name</fieldName>
    <fieldName>custom_group_id</fieldName>
    <unique>true</unique>
    <add>4.3</add>
  </index>
</table>
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>
186e0984 EM	11	<name>id</name>
186e0984 EM	12	<type>int unsigned</type>
56b7523d	13	<title>Custom Field ID</title>
186e0984 EM	14	<required>true</required>
	15	<comment>Unique Custom Field ID</comment>
	16	<add>1.1</add>
6a488035 TO	17	</field>
6a488035 TO	18	<primaryKey>
186e0984 EM	19	<name>id</name>
186e0984 EM	20	<autoincrement>true</autoincrement>
6a488035 TO	21	</primaryKey>
6a488035 TO	22	<field>
186e0984 EM	23	<name>custom_group_id</name>
186e0984 EM	24	<type>int unsigned</type>
56b7523d	25	<title>Custom Group</title>
186e0984 EM	26	<required>true</required>
	27	<comment>FK to civicrm_custom_group.</comment>
	28	<add>1.1</add>
	29	<pseudoconstant>
	30	<table>civicrm_custom_group</table>
	31	<keyColumn>id</keyColumn>
	32	<labelColumn>title</labelColumn>
	33	</pseudoconstant>
	34	<html>
	35	<type>Select</type>
	36	</html>
6a488035 TO	37	</field>
6a488035 TO	38	<foreignKey>
186e0984 EM	39	<name>custom_group_id</name>
	40	<table>civicrm_custom_group</table>
	41	<key>id</key>
	42	<add>1.1</add>
	43	<onDelete>CASCADE</onDelete>
6a488035 TO	44	</foreignKey>
6a488035 TO	45	<field>
186e0984 EM	46	<name>name</name>
186e0984 EM	47	<type>varchar</type>
56b7523d	48	<title>Custom Field Name</title>
186e0984 EM	49	<length>64</length>
	50	<comment>Variable name/programmatic handle for this group.</comment>
	51	<add>3.3</add>
6a488035 TO	52	</field>
6a488035 TO	53	<field>
186e0984 EM	54	<name>label</name>
186e0984 EM	55	<type>varchar</type>
56b7523d	56	<title>Custom Field Label</title>
186e0984 EM	57	<length>255</length>
	58	<required>true</required>
	59	<localizable>true</localizable>
	60	<comment>Text for form field label (also friendly name for administering this custom property).</comment>
	61	<add>1.1</add>
6a488035 TO	62	</field>
6a488035 TO	63	<field>
186e0984 EM	64	<name>data_type</name>
186e0984 EM	65	<type>varchar</type>
56b7523d	66	<title>Custom Field Data Type</title>
186e0984 EM	67	<length>16</length>
	68	<required>true</required>
	69	<comment>Controls location of data storage in extended_data table.</comment>
	70	<pseudoconstant>
	71	<callback>CRM_Core_BAO_CustomField::dataType</callback>
	72	</pseudoconstant>
	73	<add>1.1</add>
	74	<html>
	75	<type>Select</type>
	76	</html>
6a488035 TO	77	</field>
6a488035 TO	78	<field>
186e0984 EM	79	<name>html_type</name>
186e0984 EM	80	<type>varchar</type>
4d1776fb	81	<title>Custom Field HTML Type</title>
186e0984 EM	82	<length>32</length>
	83	<required>true</required>
	84	<comment>HTML types plus several built-in extended types.</comment>
	85	<pseudoconstant>
	86	<callback>CRM_Core_SelectValues::customHtmlType</callback>
	87	</pseudoconstant>
	88	<add>1.1</add>
6a488035 TO	89	</field>
6a488035 TO	90	<field>
186e0984 EM	91	<name>default_value</name>
186e0984 EM	92	<type>varchar</type>
56b7523d	93	<title>Custom Field Default</title>
186e0984 EM	94	<length>255</length>
	95	<comment>Use form_options.is_default for field_types which use options.</comment>
	96	<add>1.1</add>
6a488035 TO	97	</field>
6a488035 TO	98	<field>
186e0984	99	<name>is_required</name>
56b7523d	100	<title>Custom Field Is Required?</title>
186e0984 EM	101	<type>boolean</type>
186e0984 EM	102	<comment>Is a value required for this property.</comment>
110f4343	103	<default>0</default>
186e0984	104	<add>1.1</add>
6a488035 TO	105	</field>
6a488035 TO	106	<field>
186e0984	107	<name>is_searchable</name>
56b7523d	108	<title>Allow Searching on Field?</title>
186e0984 EM	109	<type>boolean</type>
186e0984 EM	110	<comment>Is this property searchable.</comment>
110f4343	111	<default>0</default>
186e0984	112	<add>1.1</add>
6a488035 TO	113	</field>
6a488035 TO	114	<field>
186e0984 EM	115	<name>is_search_range</name>
186e0984 EM	116	<type>boolean</type>
56b7523d	117	<title>Search as a Range</title>
186e0984 EM	118	<comment>Is this property range searchable.</comment>
	119	<add>1.4</add>
	120	<default>0</default>
6a488035 TO	121	</field>
6a488035 TO	122	<field>
186e0984 EM	123	<name>weight</name>
186e0984 EM	124	<type>int</type>
7ecddde4	125	<title>Order</title>
186e0984 EM	126	<required>true</required>
	127	<default>1</default>
	128	<comment>Controls field display order within an extended property group.</comment>
	129	<add>1.1</add>
6a488035 TO	130	</field>
6a488035 TO	131	<field>
186e0984 EM	132	<name>help_pre</name>
186e0984 EM	133	<type>text</type>
56b7523d	134	<title>Custom Field Pre Text</title>
186e0984 EM	135	<localizable>true</localizable>
	136	<comment>Description and/or help text to display before this field.</comment>
	137	<add>1.1</add>
6a488035 TO	138	</field>
6a488035 TO	139	<field>
186e0984 EM	140	<name>help_post</name>
186e0984 EM	141	<type>text</type>
56b7523d	142	<title>Custom Field Post Text</title>
186e0984 EM	143	<localizable>true</localizable>
	144	<comment>Description and/or help text to display after this field.</comment>
	145	<add>1.1</add>
6a488035 TO	146	</field>
6a488035 TO	147	<field>
186e0984 EM	148	<name>mask</name>
186e0984 EM	149	<type>varchar</type>
56b7523d	150	<title>Custom Field Formatting</title>
186e0984 EM	151	<length>64</length>
	152	<comment>Optional format instructions for specific field types, like date types.</comment>
	153	<add>1.1</add>
6a488035 TO	154	</field>
6a488035 TO	155	<field>
186e0984 EM	156	<name>attributes</name>
186e0984 EM	157	<type>varchar</type>
56b7523d	158	<title>Custom Field Attributes</title>
186e0984 EM	159	<length>255</length>
	160	<comment>Store collection of type-appropriate attributes, e.g. textarea needs rows/cols attributes</comment>
	161	<add>1.1</add>
6a488035 TO	162	</field>
6a488035 TO	163	<field>
186e0984 EM	164	<name>javascript</name>
186e0984 EM	165	<type>varchar</type>
56b7523d	166	<title>Custom Field Javascript</title>
186e0984 EM	167	<length>255</length>
	168	<comment>Optional scripting attributes for field.</comment>
	169	<add>1.1</add>
6a488035 TO	170	</field>
6a488035 TO	171	<field>
186e0984 EM	172	<name>is_active</name>
186e0984 EM	173	<type>boolean</type>
56b7523d	174	<title>Custom Field Is Active?</title>
186e0984	175	<comment>Is this property active?</comment>
110f4343	176	<default>1</default>
186e0984	177	<add>1.1</add>
6a488035 TO	178	</field>
6a488035 TO	179	<field>
186e0984 EM	180	<name>is_view</name>
186e0984 EM	181	<type>boolean</type>
56b7523d	182	<title>Field is Viewable</title>
110f4343	183	<default>0</default>
186e0984 EM	184	<comment>Is this property set by PHP Code? A code field is viewable but not editable</comment>
186e0984 EM	185	<add>1.1</add>
6a488035 TO	186	</field>
6a488035 TO	187	<field>
186e0984 EM	188	<name>options_per_line</name>
186e0984 EM	189	<type>int unsigned</type>
56b7523d	190	<title>Field Options Per Line</title>
186e0984	191	<comment>number of options per line for checkbox and radio</comment>
6a488035 TO	192	</field>
6a488035 TO	193	<field>
186e0984 EM	194	<name>text_length</name>
186e0984 EM	195	<type>int unsigned</type>
56b7523d	196	<title>Field Length</title>
186e0984 EM	197	<comment>field length if alphanumeric</comment>
186e0984 EM	198	<add>2.2</add>
6a488035 TO	199	</field>
6a488035 TO	200	<field>
186e0984 EM	201	<name>start_date_years</name>
186e0984 EM	202	<type>int</type>
56b7523d	203	<title>Field Start Date</title>
186e0984 EM	204	<comment>Date may be up to start_date_years years prior to the current date.</comment>
186e0984 EM	205	<add>1.4</add>
6a488035 TO	206	</field>
6a488035 TO	207	<field>
186e0984 EM	208	<name>end_date_years</name>
186e0984 EM	209	<type>int</type>
56b7523d	210	<title>Field End Date</title>
186e0984 EM	211	<comment>Date may be up to end_date_years years after the current date.</comment>
186e0984 EM	212	<add>1.4</add>
6a488035 TO	213	</field>
6a488035 TO	214	<field>
186e0984 EM	215	<name>date_parts</name>
	216	<type>varchar</type>
	217	<length>255</length>
	218	<comment>which date part included in display </comment>
	219	<add>1.4</add>
	220	<drop>3.1</drop>
6a488035 TO	221	</field>
6a488035 TO	222	<field>
186e0984 EM	223	<name>date_format</name>
186e0984 EM	224	<type>varchar</type>
56b7523d	225	<title>Field Data Format</title>
186e0984 EM	226	<length>64</length>
	227	<comment>date format for custom date</comment>
	228	<add>3.1</add>
72c65bfa CW	229	<pseudoconstant>
	230	<callback>CRM_Core_SelectValues::getDatePluginInputFormats</callback>
	231	</pseudoconstant>
6a488035 TO	232	</field>
6a488035 TO	233	<field>
186e0984 EM	234	<name>time_format</name>
186e0984 EM	235	<type>int unsigned</type>
56b7523d	236	<title>Field Time Format</title>
186e0984 EM	237	<comment>time format for custom date</comment>
186e0984 EM	238	<add>3.1</add>
72c65bfa CW	239	<pseudoconstant>
	240	<callback>CRM_Core_SelectValues::getTimeFormats</callback>
	241	</pseudoconstant>
6a488035 TO	242	</field>
6a488035 TO	243	<field>
186e0984 EM	244	<name>note_columns</name>
186e0984 EM	245	<type>int unsigned</type>
56b7523d	246	<title>Field Note Columns</title>
72c65bfa	247	<comment>Number of columns in Note Field</comment>
186e0984	248	<add>1.4</add>
6a488035 TO	249	</field>
6a488035 TO	250	<field>
186e0984 EM	251	<name>note_rows</name>
186e0984 EM	252	<type>int unsigned</type>
56b7523d	253	<title>Field Note Rows</title>
72c65bfa	254	<comment>Number of rows in Note Field</comment>
186e0984	255	<add>1.4</add>
6a488035 TO	256	</field>
6a488035 TO	257	<field>
186e0984 EM	258	<name>column_name</name>
186e0984 EM	259	<type>varchar</type>
56b7523d	260	<title>Field Column Name</title>
186e0984 EM	261	<length>255</length>
	262	<comment>Name of the column that holds the values for this field.</comment>
	263	<add>2.0</add>
6a488035 TO	264	</field>
6a488035 TO	265	<field>
186e0984 EM	266	<name>option_group_id</name>
186e0984 EM	267	<type>int unsigned</type>
56b7523d	268	<title>Field Option Group</title>
186e0984 EM	269	<comment>For elements with options, the option group id that is used</comment>
186e0984 EM	270	<add>1.4</add>
5830940d MM	271	<pseudoconstant>
	272	<table>civicrm_option_group</table>
	273	<keyColumn>id</keyColumn>
	274	<labelColumn>title</labelColumn>
	275	</pseudoconstant>
6a488035	276	</field>
2b216479 PN	277	<foreignKey>
	278	<name>option_group_id</name>
	279	<table>civicrm_option_group</table>
	280	<key>id</key>
febf277f	281	<add>5.6</add>
2b216479 PN	282	<onDelete>SET NULL</onDelete>
2b216479 PN	283	</foreignKey>
6a488035	284	<field>
186e0984 EM	285	<name>filter</name>
186e0984 EM	286	<type>varchar</type>
56b7523d	287	<title>Field Filter</title>
186e0984 EM	288	<length>255</length>
	289	<comment>Stores Contact Get API params contact reference custom fields. May be used for other filters in the future.</comment>
	290	<add>4.1</add>
6a488035	291	</field>
5a205b89 PJ	292	<field>
	293	<name>in_selector</name>
	294	<type>boolean</type>
56b7523d	295	<title>Field Display</title>
5a205b89 PJ	296	<default>0</default>
	297	<comment>Should the multi-record custom field values be displayed in tab table listing</comment>
	298	<add>4.5</add>
	299	</field>
6a488035 TO	300	<index>
	301	<name>UI_label_custom_group_id</name>
	302	<fieldName>label</fieldName>
	303	<fieldName>custom_group_id</fieldName>
	304	<unique>true</unique>
	305	<add>1.1</add>
	306	</index>
	307	<index>
	308	<name>UI_name_custom_group_id</name>
	309	<fieldName>name</fieldName>
	310	<fieldName>custom_group_id</fieldName>
	311	<unique>true</unique>
	312	<add>4.3</add>
	313	</index>
	314	</table>