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

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

<table>
  <base>CRM/Core</base>
  <class>UFGroup</class>
  <name>civicrm_uf_group</name>
  <comment>User framework groups. Each group represents a form which encompasses a set of fields defined in civicrm_uf_fields table. Initially will be used for CiviCRM Profile form(s). Subsequently we anticipate using this to define other public facing forms (e.g. online donation solicitation forms, mailing list preferences, etc.).</comment>
  <add>1.1</add>
  <log>true</log>
  <field>
    <name>id</name>
    <title>Profile 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>is_active</name>
    <title>Profile Is Active</title>
    <type>boolean</type>
    <default>1</default>
    <comment>Is this form currently active? If false, hide all related fields for all sharing contexts.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>group_type</name>
    <title>Profile Group Type</title>
    <type>varchar</type>
    <length>255</length>
    <import>true</import>
    <comment>Comma separated list of the type(s) of profile fields.</comment>
    <serialize>COMMA</serialize>
    <add>2.1</add>
  </field>
  <field>
    <name>form_type</name>
    <type>enum</type>
    <values>CiviCRM Profile</values>
    <comment>Type of form.</comment>
    <drop>2.1</drop>
  </field>
  <field>
    <name>title</name>
    <title>Profile Name</title>
    <type>varchar</type>
    <length>64</length>
    <localizable>true</localizable>
    <required>true</required>
    <html>
      <type>Text</type>
    </html>
    <comment>Form title.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>frontend_title</name>
    <title>Public Title</title>
    <type>varchar</type>
    <length>64</length>
    <localizable>true</localizable>
    <comment>Profile Form Public title</comment>
    <html>
      <type>Text</type>
    </html>
    <add>4.7</add>
  </field>
  <field>
    <name>description</name>
    <type>text</type>
    <title>Profile Description</title>
    <html>
      <type>TextArea</type>
      <rows>2</rows>
      <cols>60</cols>
    </html>
    <comment>Optional verbose description of the profile.</comment>
    <add>4.4</add>
  </field>
  <field>
    <name>collapse_display</name>
    <type>int unsigned</type>
    <default>0</default>
    <comment>Will this group be in collapsed or expanded mode on initial display ?</comment>
    <add>1.1</add>
    <drop>2.2</drop>
  </field>
  <field>
    <name>help_pre</name>
    <type>text</type>
    <localizable>true</localizable>
    <comment>Description and/or help text to display before fields in form.</comment>
    <html>
      <type>TextArea</type>
      <rows>4</rows>
      <cols>80</cols>
    </html>
    <add>1.2</add>
  </field>
  <field>
    <name>help_post</name>
    <title>Profile Post Text</title>
    <type>text</type>
    <localizable>true</localizable>
    <comment>Description and/or help text to display after fields in form.</comment>
    <html>
      <type>TextArea</type>
      <rows>4</rows>
      <cols>80</cols>
    </html>
    <add>1.2</add>
  </field>
  <field>
    <name>weight</name>
    <title>Profile Weight</title>
    <type>int</type>
    <required>true</required>
    <default>1</default>
    <html>
      <type>Text</type>
    </html>
    <comment>Controls display order when multiple user framework groups are setup for concurrent display.</comment>
    <add>1.2</add>
    <drop>1.3</drop>
  </field>
  <field>
    <name>limit_listings_group_id</name>
    <title>Profile Search Limit Group</title>
    <type>int unsigned</type>
    <comment>Group id, foreign key from civicrm_group</comment>
    <add>1.4</add>
  </field>
  <foreignKey>
    <name>limit_listings_group_id</name>
    <table>civicrm_group</table>
    <key>id</key>
    <add>1.4</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>post_URL</name>
    <type>varchar</type>
    <length>255</length>
    <comment>Redirect to URL.</comment>
    <add>1.4</add>
  </field>
  <field>
    <name>add_to_group_id</name>
    <title>Add Contact To Group</title>
    <type>int unsigned</type>
    <comment>foreign key to civicrm_group_id</comment>
  </field>
  <foreignKey>
    <name>add_to_group_id</name>
    <table>civicrm_group</table>
    <key>id</key>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>add_captcha</name>
    <title>Show Captcha On Profile</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Should a CAPTCHA widget be included this Profile form.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>is_map</name>
    <title>Map Profile</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Do we want to map results from this profile.</comment>
    <add>1.5</add>
  </field>
  <field>
    <name>is_edit_link</name>
    <title>Show Edit Link?</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Should edit link display in profile selector</comment>
    <add>1.6</add>
  </field>
  <field>
    <name>is_uf_link</name>
    <title>Show Link to CMS User</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Should we display a link to the website profile in profile selector</comment>
    <add>1.7</add>
  </field>
  <field>
    <name>is_update_dupe</name>
    <title>Update on Duplicate</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Should we update the contact record if we find a duplicate</comment>
    <add>1.7</add>
  </field>
  <field>
    <name>cancel_URL</name>
    <title>Profile Cancel URL</title>
    <type>varchar</type>
    <length>255</length>
    <comment>Redirect to URL when Cancle button clik .</comment>
    <add>1.4</add>
  </field>
  <field>
    <name>is_cms_user</name>
    <title>Create CMS User?</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Should we create a cms user for this profile </comment>
    <add>1.8</add>
  </field>
  <field>
    <name>notify</name>
    <title>Notify on Profile Submit</title>
    <type>text</type>
    <add>1.8</add>
  </field>
  <field>
    <name>is_reserved</name>
    <title>Profile Is Reserved</title>
    <type>boolean</type>
    <comment>Is this group reserved for use by some other CiviCRM functionality?</comment>
    <add>3.0</add>
  </field>
  <field>
    <name>name</name>
    <title>Profile Name</title>
    <type>varchar</type>
    <length>64</length>
    <comment>Name of the UF group for directly addressing it in the codebase</comment>
    <add>3.0</add>
  </field>
  <index>
    <name>UI_name</name>
    <fieldName>name</fieldName>
    <unique>true</unique>
    <add>4.7</add>
  </index>
  <field>
    <name>created_id</name>
    <title>Profile Created By</title>
    <type>int unsigned</type>
    <comment>FK to civicrm_contact, who created this UF group</comment>
    <add>3.0</add>
  </field>
  <foreignKey>
    <name>created_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <add>3.0</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>created_date</name>
    <type>datetime</type>
    <title>UF Group Created Date</title>
    <comment>Date and time this UF group was created.</comment>
    <add>3.0</add>
  </field>
  <field>
    <name>is_proximity_search</name>
    <title>Include Proximity Search?</title>
    <type>boolean</type>
    <default>0</default>
    <comment>Should we include proximity search feature in this profile search form?</comment>
    <add>3.2</add>
  </field>
  <field>
    <name>cancel_button_text</name>
    <title>Cancel Button Text</title>
    <type>varchar</type>
    <length>64</length>
    <comment>Custom Text to display on the Cancel button when used in create or edit mode</comment>
    <default>NULL</default>
    <localizable>true</localizable>
    <add>4.7</add>
    <html>
      <type>Text</type>
    </html>
  </field>
  <field>
    <name>submit_button_text</name>
    <title>Submit Button Text</title>
    <type>varchar</type>
    <length>64</length>
    <comment>Custom Text to display on the submit button on profile edit/create screens</comment>
    <default>NULL</default>
    <localizable>true</localizable>
    <add>4.7</add>
    <html>
      <type>Text</type>
    </html>
  </field>
  <field>
    <name>add_cancel_button</name>
    <title>Include Cancel Button</title>
    <type>boolean</type>
    <default>1</default>
    <comment>Should a Cancel button be included in this Profile form.</comment>
    <add>5.0</add>
  </field>
</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>UFGroup</class>
	6	<name>civicrm_uf_group</name>
	7	<comment>User framework groups. Each group represents a form which encompasses a set of fields defined in civicrm_uf_fields table. Initially will be used for CiviCRM Profile form(s). Subsequently we anticipate using this to define other public facing forms (e.g. online donation solicitation forms, mailing list preferences, etc.).</comment>
	8	<add>1.1</add>
	9	<log>true</log>
	10	<field>
8f069c03 EM	11	<name>id</name>
	12	<title>Profile ID</title>
	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>
8f069c03 EM	19	<name>id</name>
8f069c03 EM	20	<autoincrement>true</autoincrement>
6a488035 TO	21	</primaryKey>
6a488035 TO	22	<field>
8f069c03 EM	23	<name>is_active</name>
	24	<title>Profile Is Active</title>
	25	<type>boolean</type>
	26	<default>1</default>
	27	<comment>Is this form currently active? If false, hide all related fields for all sharing contexts.</comment>
	28	<add>1.1</add>
	29	</field>
	30	<field>
	31	<name>group_type</name>
	32	<title>Profile Group Type</title>
	33	<type>varchar</type>
	34	<length>255</length>
	35	<import>true</import>
dd3ec98b CW	36	<comment>Comma separated list of the type(s) of profile fields.</comment>
dd3ec98b CW	37	<serialize>COMMA</serialize>
8f069c03 EM	38	<add>2.1</add>
	39	</field>
	40	<field>
	41	<name>form_type</name>
	42	<type>enum</type>
	43	<values>CiviCRM Profile</values>
	44	<comment>Type of form.</comment>
	45	<drop>2.1</drop>
	46	</field>
	47	<field>
	48	<name>title</name>
7f3c8b3d	49	<title>Profile Name</title>
8f069c03 EM	50	<type>varchar</type>
	51	<length>64</length>
	52	<localizable>true</localizable>
	53	<required>true</required>
7f3c8b3d	54	<html>
	55	<type>Text</type>
	56	</html>
8f069c03 EM	57	<comment>Form title.</comment>
	58	<add>1.1</add>
	59	</field>
bf48be46 SL	60	<field>
bf48be46 SL	61	<name>frontend_title</name>
7f3c8b3d	62	<title>Public Title</title>
bf48be46 SL	63	<type>varchar</type>
	64	<length>64</length>
	65	<localizable>true</localizable>
	66	<comment>Profile Form Public title</comment>
7f3c8b3d	67	<html>
	68	<type>Text</type>
	69	</html>
bf48be46 SL	70	<add>4.7</add>
bf48be46 SL	71	</field>
8f069c03 EM	72	<field>
	73	<name>description</name>
	74	<type>text</type>
	75	<title>Profile Description</title>
	76	<html>
	77	<type>TextArea</type>
	78	<rows>2</rows>
	79	<cols>60</cols>
	80	</html>
	81	<comment>Optional verbose description of the profile.</comment>
	82	<add>4.4</add>
	83	</field>
	84	<field>
	85	<name>collapse_display</name>
	86	<type>int unsigned</type>
	87	<default>0</default>
	88	<comment>Will this group be in collapsed or expanded mode on initial display ?</comment>
	89	<add>1.1</add>
	90	<drop>2.2</drop>
	91	</field>
	92	<field>
	93	<name>help_pre</name>
	94	<type>text</type>
	95	<localizable>true</localizable>
	96	<comment>Description and/or help text to display before fields in form.</comment>
	97	<html>
	98	<type>TextArea</type>
	99	<rows>4</rows>
	100	<cols>80</cols>
	101	</html>
	102	<add>1.2</add>
	103	</field>
	104	<field>
	105	<name>help_post</name>
	106	<title>Profile Post Text</title>
	107	<type>text</type>
	108	<localizable>true</localizable>
	109	<comment>Description and/or help text to display after fields in form.</comment>
	110	<html>
	111	<type>TextArea</type>
	112	<rows>4</rows>
	113	<cols>80</cols>
	114	</html>
	115	<add>1.2</add>
	116	</field>
	117	<field>
	118	<name>weight</name>
	119	<title>Profile Weight</title>
	120	<type>int</type>
	121	<required>true</required>
	122	<default>1</default>
cbd71f73	123	<html>
	124	<type>Text</type>
	125	</html>
8f069c03 EM	126	<comment>Controls display order when multiple user framework groups are setup for concurrent display.</comment>
	127	<add>1.2</add>
	128	<drop>1.3</drop>
	129	</field>
	130	<field>
	131	<name>limit_listings_group_id</name>
	132	<title>Profile Search Limit Group</title>
	133	<type>int unsigned</type>
e4f46be0	134	<comment>Group id, foreign key from civicrm_group</comment>
8f069c03	135	<add>1.4</add>
6a488035 TO	136	</field>
6a488035 TO	137	<foreignKey>
8f069c03 EM	138	<name>limit_listings_group_id</name>
	139	<table>civicrm_group</table>
	140	<key>id</key>
	141	<add>1.4</add>
	142	<onDelete>SET NULL</onDelete>
6a488035 TO	143	</foreignKey>
6a488035 TO	144	<field>
8f069c03 EM	145	<name>post_URL</name>
	146	<type>varchar</type>
	147	<length>255</length>
	148	<comment>Redirect to URL.</comment>
	149	<add>1.4</add>
6a488035	150	</field>
3c7d2158	151	<field>
8f069c03 EM	152	<name>add_to_group_id</name>
	153	<title>Add Contact To Group</title>
	154	<type>int unsigned</type>
	155	<comment>foreign key to civicrm_group_id</comment>
3c7d2158	156	</field>
6a488035	157	<foreignKey>
8f069c03 EM	158	<name>add_to_group_id</name>
	159	<table>civicrm_group</table>
	160	<key>id</key>
	161	<onDelete>SET NULL</onDelete>
6a488035	162	</foreignKey>
8f069c03 EM	163	<field>
	164	<name>add_captcha</name>
	165	<title>Show Captcha On Profile</title>
	166	<type>boolean</type>
	167	<default>0</default>
	168	<comment>Should a CAPTCHA widget be included this Profile form.</comment>
	169	<add>1.1</add>
	170	</field>
	171	<field>
	172	<name>is_map</name>
	173	<title>Map Profile</title>
	174	<type>boolean</type>
	175	<default>0</default>
	176	<comment>Do we want to map results from this profile.</comment>
	177	<add>1.5</add>
	178	</field>
	179	<field>
	180	<name>is_edit_link</name>
	181	<title>Show Edit Link?</title>
	182	<type>boolean</type>
	183	<default>0</default>
	184	<comment>Should edit link display in profile selector</comment>
	185	<add>1.6</add>
	186	</field>
	187	<field>
	188	<name>is_uf_link</name>
	189	<title>Show Link to CMS User</title>
	190	<type>boolean</type>
	191	<default>0</default>
	192	<comment>Should we display a link to the website profile in profile selector</comment>
	193	<add>1.7</add>
	194	</field>
	195	<field>
	196	<name>is_update_dupe</name>
	197	<title>Update on Duplicate</title>
	198	<type>boolean</type>
	199	<default>0</default>
	200	<comment>Should we update the contact record if we find a duplicate</comment>
	201	<add>1.7</add>
	202	</field>
	203	<field>
	204	<name>cancel_URL</name>
	205	<title>Profile Cancel URL</title>
	206	<type>varchar</type>
	207	<length>255</length>
	208	<comment>Redirect to URL when Cancle button clik .</comment>
	209	<add>1.4</add>
	210	</field>
	211	<field>
	212	<name>is_cms_user</name>
	213	<title>Create CMS User?</title>
	214	<type>boolean</type>
	215	<default>0</default>
	216	<comment>Should we create a cms user for this profile </comment>
	217	<add>1.8</add>
	218	</field>
	219	<field>
	220	<name>notify</name>
	221	<title>Notify on Profile Submit</title>
	222	<type>text</type>
	223	<add>1.8</add>
6a488035 TO	224	</field>
	225	<field>
	226	<name>is_reserved</name>
61ce9b45	227	<title>Profile Is Reserved</title>
6a488035 TO	228	<type>boolean</type>
	229	<comment>Is this group reserved for use by some other CiviCRM functionality?</comment>
	230	<add>3.0</add>
	231	</field>
	232	<field>
	233	<name>name</name>
61ce9b45	234	<title>Profile Name</title>
6a488035 TO	235	<type>varchar</type>
	236	<length>64</length>
	237	<comment>Name of the UF group for directly addressing it in the codebase</comment>
	238	<add>3.0</add>
	239	</field>
a998935a	240	<index>
	241	<name>UI_name</name>
	242	<fieldName>name</fieldName>
	243	<unique>true</unique>
	244	<add>4.7</add>
	245	</index>
6a488035 TO	246	<field>
6a488035 TO	247	<name>created_id</name>
61ce9b45	248	<title>Profile Created By</title>
6a488035 TO	249	<type>int unsigned</type>
	250	<comment>FK to civicrm_contact, who created this UF group</comment>
	251	<add>3.0</add>
	252	</field>
	253	<foreignKey>
	254	<name>created_id</name>
	255	<table>civicrm_contact</table>
	256	<key>id</key>
	257	<add>3.0</add>
	258	<onDelete>SET NULL</onDelete>
	259	</foreignKey>
	260	<field>
	261	<name>created_date</name>
	262	<type>datetime</type>
	263	<title>UF Group Created Date</title>
	264	<comment>Date and time this UF group was created.</comment>
	265	<add>3.0</add>
	266	</field>
	267	<field>
61ce9b45 EM	268	<name>is_proximity_search</name>
	269	<title>Include Proximity Search?</title>
	270	<type>boolean</type>
	271	<default>0</default>
	272	<comment>Should we include proximity search feature in this profile search form?</comment>
	273	<add>3.2</add>
6a488035	274	</field>
41ace555 SL	275	<field>
	276	<name>cancel_button_text</name>
	277	<title>Cancel Button Text</title>
	278	<type>varchar</type>
	279	<length>64</length>
	280	<comment>Custom Text to display on the Cancel button when used in create or edit mode</comment>
	281	<default>NULL</default>
	282	<localizable>true</localizable>
	283	<add>4.7</add>
5e59ce48 SL	284	<html>
	285	<type>Text</type>
	286	</html>
41ace555 SL	287	</field>
	288	<field>
	289	<name>submit_button_text</name>
	290	<title>Submit Button Text</title>
	291	<type>varchar</type>
	292	<length>64</length>
	293	<comment>Custom Text to display on the submit button on profile edit/create screens</comment>
	294	<default>NULL</default>
	295	<localizable>true</localizable>
	296	<add>4.7</add>
5e59ce48 SL	297	<html>
	298	<type>Text</type>
	299	</html>
41ace555	300	</field>
b3f1028c JP	301	<field>
	302	<name>add_cancel_button</name>
	303	<title>Include Cancel Button</title>
	304	<type>boolean</type>
	305	<default>1</default>
	306	<comment>Should a Cancel button be included in this Profile form.</comment>
	307	<add>5.0</add>
	308	</field>
6a488035	309	</table>