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