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