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

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

<table>
  <base>CRM/Core</base>
  <class>UFField</class>
  <name>civicrm_uf_field</name>
  <comment>User Framework fields and their properties.</comment>
  <add>1.1</add>
  <log>true</log>
  <field>
    <name>id</name>
    <title>Profile Field ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Unique table ID</comment>
    <add>1.1</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>uf_group_id</name>
    <title>Profile ID</title>
    <type>int unsigned</type>
    <required>true</required>
    <comment>Which form does this field belong to.</comment>
    <add>1.1</add>
    <pseudoconstant>
      <table>civicrm_uf_group</table>
      <keyColumn>id</keyColumn>
      <labelColumn>title</labelColumn>
    </pseudoconstant>
    <html>
      <type>Select</type>
    </html>
  </field>
  <foreignKey>
    <name>uf_group_id</name>
    <table>civicrm_uf_group</table>
    <key>id</key>
    <add>1.1</add>
    <onDelete>CASCADE</onDelete>
  </foreignKey>
  <field>
    <name>field_name</name>
    <title>Profile Field Name</title>
    <type>varchar</type>
    <length>64</length>
    <required>true</required>
    <comment>Name for CiviCRM field which is being exposed for sharing.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>is_active</name>
    <title>Profile Field Is Active</title>
    <type>boolean</type>
    <default>1</default>
    <comment>Is this field currently shareable? If false, hide the field for all sharing contexts.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>is_view</name>
    <title>Profile Is View Only</title>
    <type>boolean</type>
    <default>0</default>
    <comment>the field is view only and not editable in user forms.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>is_required</name>
    <title>Profile Field Is Required</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Is this field required when included in a user or registration form?</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>weight</name>
    <title>Order</title>
    <type>int</type>
    <required>true</required>
    <default>1</default>
    <comment>Controls field display order when user framework fields are displayed in registration and account editing forms.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>help_post</name>
    <title>Profile Field Post Help</title>
    <type>text</type>
    <localizable>true</localizable>
    <comment>Description and/or help text to display after this field.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>help_pre</name>
    <title>Profile Field Pre Help</title>
    <type>text</type>
    <localizable>true</localizable>
    <comment>Description and/or help text to display before this field.</comment>
    <add>3.2</add>
  </field>
  <field>
    <name>is_registration</name>
    <type>boolean</type>
    <default>0</default>
    <comment>Is this field included in new user registration forms?</comment>
    <add>1.1</add>
    <drop>1.3</drop>
  </field>
  <field>
    <name>is_match</name>
    <type>boolean</type>
    <default>0</default>
    <comment>Is this field part of the key for matching users to contacts?</comment>
    <add>1.1</add>
    <drop>1.3</drop>
  </field>
  <field>
    <name>visibility</name>
    <title>Profile Field Visibility</title>
    <type>varchar</type>
    <length>32</length>
    <default>'User and User Admin Only'</default>
    <comment>In what context(s) is this field visible.</comment>
    <pseudoconstant>
      <callback>CRM_Core_SelectValues::ufVisibility</callback>
    </pseudoconstant>
    <add>1.1</add>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>listings_title</name>
    <type>varchar</type>
    <length>64</length>
    <comment>Page title for listings page (users who share a common value for this property).</comment>
    <add>1.1</add>
    <drop>1.2</drop>
  </field>
  <field>
    <name>in_selector</name>
    <title>Profile Field Is a Filter</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Is this field included as a column in the selector table?</comment>
    <add>1.2</add>
  </field>
  <field>
    <name>is_searchable</name>
    <title>Profile Field Is Searchable</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Is this field included search form of profile?</comment>
    <add>1.4</add>
  </field>
  <field>
    <name>location_type_id</name>
    <title>Profile Field Location Type</title>
    <type>int unsigned</type>
    <comment>Location type of this mapping, if required</comment>
    <add>1.3</add>
  </field>
  <foreignKey>
    <name>location_type_id</name>
    <table>civicrm_location_type</table>
    <key>id</key>
    <add>1.3</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>phone_type</name>
    <type>varchar</type>
    <length>64</length>
    <comment>Phone type, if required</comment>
    <add>1.3</add>
    <drop>2.2</drop>
  </field>
  <field>
    <name>phone_type_id</name>
    <title>Profile Field Phone Type</title>
    <type>int unsigned</type>
    <comment>Phone Type Id, if required</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>website_type_id</name>
    <title>Profile Field Website Type</title>
    <type>int unsigned</type>
    <comment>Website Type Id, if required</comment>
    <add>4.5</add>
  </field>
  <field>
    <name>label</name>
    <title>Profile Field Label</title>
    <type>varchar</type>
    <length>255</length>
    <required>true</required>
    <localizable>true</localizable>
    <comment>To save label for fields.</comment>
    <add>1.4</add>
  </field>
  <field>
    <name>field_type</name>
    <title>Profile Field Type</title>
    <type>varchar</type>
    <length>255</length>
    <comment>This field saves field type (ie individual,household.. field etc).</comment>
    <add>1.4</add>
  </field>
  <field>
    <name>is_reserved</name>
    <title>Profile Field Is Reserved</title>
    <type>boolean</type>
    <comment>Is this field reserved for use by some other CiviCRM functionality?</comment>
    <add>3.0</add>
  </field>
  <field>
    <name>is_multi_summary</name>
    <title>Profile Field Supports Multiple</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Include in multi-record listing?</comment>
    <add>4.3</add>
  </field>
  <index>
    <name>IX_website_type_id</name>
    <title>Profile Field Website Type</title>
    <fieldName>website_type_id</fieldName>
    <add>4.5</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>UFField</class>
	6	<name>civicrm_uf_field</name>
	7	<comment>User Framework fields and their properties.</comment>
	8	<add>1.1</add>
	9	<log>true</log>
	10	<field>
4cc2ccac	11	<name>id</name>
4cc6314b	12	<title>Profile Field ID</title>
4cc2ccac EM	13	<type>int unsigned</type>
	14	<required>true</required>
	15	<comment>Unique table ID</comment>
	16	<add>1.1</add>
6a488035 TO	17	</field>
6a488035 TO	18	<primaryKey>
4cc2ccac EM	19	<name>id</name>
4cc2ccac EM	20	<autoincrement>true</autoincrement>
6a488035 TO	21	</primaryKey>
6a488035 TO	22	<field>
4cc2ccac	23	<name>uf_group_id</name>
4cc6314b	24	<title>Profile ID</title>
4cc2ccac EM	25	<type>int unsigned</type>
	26	<required>true</required>
	27	<comment>Which form does this field belong to.</comment>
	28	<add>1.1</add>
	29	<pseudoconstant>
	30	<table>civicrm_uf_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>
4cc2ccac EM	39	<name>uf_group_id</name>
	40	<table>civicrm_uf_group</table>
	41	<key>id</key>
	42	<add>1.1</add>
	43	<onDelete>CASCADE</onDelete>
6a488035 TO	44	</foreignKey>
6a488035 TO	45	<field>
4cc2ccac	46	<name>field_name</name>
4cc6314b	47	<title>Profile Field Name</title>
4cc2ccac EM	48	<type>varchar</type>
	49	<length>64</length>
	50	<required>true</required>
	51	<comment>Name for CiviCRM field which is being exposed for sharing.</comment>
	52	<add>1.1</add>
6a488035 TO	53	</field>
6a488035 TO	54	<field>
4cc2ccac	55	<name>is_active</name>
4cc6314b	56	<title>Profile Field Is Active</title>
4cc2ccac EM	57	<type>boolean</type>
	58	<default>1</default>
	59	<comment>Is this field currently shareable? If false, hide the field for all sharing contexts.</comment>
	60	<add>1.1</add>
6a488035 TO	61	</field>
6a488035 TO	62	<field>
4cc2ccac	63	<name>is_view</name>
4cc6314b	64	<title>Profile Is View Only</title>
4cc2ccac EM	65	<type>boolean</type>
	66	<default>0</default>
	67	<comment>the field is view only and not editable in user forms.</comment>
	68	<add>1.1</add>
6a488035 TO	69	</field>
6a488035 TO	70	<field>
4cc2ccac	71	<name>is_required</name>
4cc6314b	72	<title>Profile Field Is Required</title>
4cc2ccac EM	73	<type>boolean</type>
	74	<default>0</default>
	75	<comment>Is this field required when included in a user or registration form?</comment>
	76	<add>1.1</add>
6a488035 TO	77	</field>
6a488035 TO	78	<field>
4cc2ccac	79	<name>weight</name>
7ecddde4	80	<title>Order</title>
4cc2ccac EM	81	<type>int</type>
	82	<required>true</required>
	83	<default>1</default>
	84	<comment>Controls field display order when user framework fields are displayed in registration and account editing forms.</comment>
	85	<add>1.1</add>
6a488035 TO	86	</field>
6a488035 TO	87	<field>
4cc2ccac	88	<name>help_post</name>
4cc6314b	89	<title>Profile Field Post Help</title>
4cc2ccac EM	90	<type>text</type>
	91	<localizable>true</localizable>
	92	<comment>Description and/or help text to display after this field.</comment>
	93	<add>1.1</add>
6a488035 TO	94	</field>
6a488035 TO	95	<field>
4cc2ccac	96	<name>help_pre</name>
4cc6314b	97	<title>Profile Field Pre Help</title>
4cc2ccac EM	98	<type>text</type>
	99	<localizable>true</localizable>
	100	<comment>Description and/or help text to display before this field.</comment>
	101	<add>3.2</add>
6a488035 TO	102	</field>
6a488035 TO	103	<field>
4cc2ccac EM	104	<name>is_registration</name>
	105	<type>boolean</type>
	106	<default>0</default>
	107	<comment>Is this field included in new user registration forms?</comment>
	108	<add>1.1</add>
	109	<drop>1.3</drop>
6a488035 TO	110	</field>
6a488035 TO	111	<field>
4cc2ccac EM	112	<name>is_match</name>
	113	<type>boolean</type>
	114	<default>0</default>
	115	<comment>Is this field part of the key for matching users to contacts?</comment>
	116	<add>1.1</add>
	117	<drop>1.3</drop>
	118	</field>
	119	<field>
	120	<name>visibility</name>
4cc6314b	121	<title>Profile Field Visibility</title>
4cc2ccac EM	122	<type>varchar</type>
	123	<length>32</length>
	124	<default>'User and User Admin Only'</default>
	125	<comment>In what context(s) is this field visible.</comment>
	126	<pseudoconstant>
	127	<callback>CRM_Core_SelectValues::ufVisibility</callback>
	128	</pseudoconstant>
	129	<add>1.1</add>
	130	<html>
	131	<type>Select</type>
	132	</html>
	133	</field>
	134	<field>
	135	<name>listings_title</name>
	136	<type>varchar</type>
	137	<length>64</length>
	138	<comment>Page title for listings page (users who share a common value for this property).</comment>
	139	<add>1.1</add>
	140	<drop>1.2</drop>
	141	</field>
	142	<field>
	143	<name>in_selector</name>
4cc6314b	144	<title>Profile Field Is a Filter</title>
4cc2ccac EM	145	<type>boolean</type>
	146	<default>0</default>
	147	<comment>Is this field included as a column in the selector table?</comment>
	148	<add>1.2</add>
6a488035 TO	149	</field>
6a488035 TO	150	<field>
4cc2ccac	151	<name>is_searchable</name>
4cc6314b	152	<title>Profile Field Is Searchable</title>
4cc2ccac EM	153	<type>boolean</type>
	154	<default>0</default>
	155	<comment>Is this field included search form of profile?</comment>
	156	<add>1.4</add>
6a488035 TO	157	</field>
6a488035 TO	158	<field>
4cc2ccac	159	<name>location_type_id</name>
4cc6314b	160	<title>Profile Field Location Type</title>
4cc2ccac EM	161	<type>int unsigned</type>
	162	<comment>Location type of this mapping, if required</comment>
	163	<add>1.3</add>
6a488035 TO	164	</field>
6a488035 TO	165	<foreignKey>
4cc2ccac EM	166	<name>location_type_id</name>
	167	<table>civicrm_location_type</table>
	168	<key>id</key>
	169	<add>1.3</add>
	170	<onDelete>SET NULL</onDelete>
6a488035 TO	171	</foreignKey>
6a488035 TO	172	<field>
4cc2ccac EM	173	<name>phone_type</name>
	174	<type>varchar</type>
	175	<length>64</length>
	176	<comment>Phone type, if required</comment>
	177	<add>1.3</add>
	178	<drop>2.2</drop>
6a488035 TO	179	</field>
6a488035 TO	180	<field>
4cc2ccac	181	<name>phone_type_id</name>
4cc6314b	182	<title>Profile Field Phone Type</title>
4cc2ccac EM	183	<type>int unsigned</type>
	184	<comment>Phone Type Id, if required</comment>
	185	<add>2.2</add>
6a488035	186	</field>
887e764d PN	187	<field>
887e764d PN	188	<name>website_type_id</name>
4cc6314b	189	<title>Profile Field Website Type</title>
887e764d PN	190	<type>int unsigned</type>
	191	<comment>Website Type Id, if required</comment>
	192	<add>4.5</add>
	193	</field>
6a488035	194	<field>
4cc2ccac	195	<name>label</name>
4cc6314b	196	<title>Profile Field Label</title>
4cc2ccac EM	197	<type>varchar</type>
	198	<length>255</length>
	199	<required>true</required>
	200	<localizable>true</localizable>
	201	<comment>To save label for fields.</comment>
	202	<add>1.4</add>
6a488035 TO	203	</field>
6a488035 TO	204	<field>
4cc2ccac	205	<name>field_type</name>
4cc6314b	206	<title>Profile Field Type</title>
4cc2ccac EM	207	<type>varchar</type>
	208	<length>255</length>
	209	<comment>This field saves field type (ie individual,household.. field etc).</comment>
	210	<add>1.4</add>
6a488035 TO	211	</field>
	212	<field>
	213	<name>is_reserved</name>
4cc6314b	214	<title>Profile Field Is Reserved</title>
6a488035 TO	215	<type>boolean</type>
	216	<comment>Is this field reserved for use by some other CiviCRM functionality?</comment>
	217	<add>3.0</add>
	218	</field>
	219	<field>
	220	<name>is_multi_summary</name>
4cc6314b	221	<title>Profile Field Supports Multiple</title>
6a488035 TO	222	<type>boolean</type>
	223	<default>0</default>
	224	<comment>Include in multi-record listing?</comment>
	225	<add>4.3</add>
	226	</field>
887e764d PN	227	<index>
887e764d PN	228	<name>IX_website_type_id</name>
4cc6314b	229	<title>Profile Field Website Type</title>
887e764d PN	230	<fieldName>website_type_id</fieldName>
	231	<add>4.5</add>
	232	</index>
6a488035	233	</table>