[civicrm-core.git] / xml / schema / Contact / Group.xml

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

<table>
  <base>CRM/Contact</base>
  <class>Group</class>
  <name>civicrm_group</name>
  <comment>Provide grouping of related contacts</comment>
  <add>1.1</add>
  <log>true</log>
  <icon>fa-users</icon>
  <labelField>title</labelField>
  <paths>
    <add>civicrm/group/add?reset=1</add>
  </paths>
  <field>
    <name>id</name>
    <type>int unsigned</type>
    <title>Group ID</title>
    <required>true</required>
    <comment>Group ID</comment>
    <add>1.1</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>true</autoincrement>
  </primaryKey>
  <field>
    <name>name</name>
    <type>varchar</type>
    <title>Group Name</title>
    <length>64</length>
    <comment>Internal name of Group.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>title</name>
    <type>varchar</type>
    <title>Group Title</title>
    <length>255</length>
    <localizable>true</localizable>
    <comment>Name of Group.</comment>
    <add>1.1</add>
    <html>
      <type>Text</type>
    </html>
  </field>
  <field>
    <name>description</name>
    <type>text</type>
    <title>Group Description</title>
    <html>
      <type>TextArea</type>
      <rows>2</rows>
      <cols>60</cols>
    </html>
    <comment>Optional verbose description of the group.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>source</name>
    <type>varchar</type>
    <title>Group Source</title>
    <length>64</length>
    <comment>Module or process which created this group.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>saved_search_id</name>
    <type>int unsigned</type>
    <title>Saved Search ID</title>
    <comment>FK to saved search table.</comment>
    <add>1.1</add>
  </field>
  <foreignKey>
    <name>saved_search_id</name>
    <table>civicrm_saved_search</table>
    <key>id</key>
    <add>1.1</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>is_active</name>
    <type>boolean</type>
    <title>Group Enabled</title>
    <comment>Is this entry active?</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>visibility</name>
    <type>varchar</type>
    <length>24</length>
    <title>Group Visibility Setting</title>
    <default>'User and User Admin Only'</default>
    <comment>In what context(s) is this field visible.</comment>
    <pseudoconstant>
      <callback>CRM_Core_SelectValues::groupVisibility</callback>
    </pseudoconstant>
    <add>1.2</add>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>where_clause</name>
    <type>text</type>
    <title>Group Where Clause</title>
    <comment>the sql where clause if a saved search acl</comment>
    <add>1.6</add>
  </field>
  <field>
    <name>select_tables</name>
    <type>text</type>
    <title>Tables For Select Clause</title>
    <comment>the tables to be included in a select data</comment>
    <serialize>PHP</serialize>
    <add>1.6</add>
  </field>
  <field>
    <name>where_tables</name>
    <type>text</type>
    <title>Tables For Where Clause</title>
    <comment>the tables to be included in the count statement</comment>
    <serialize>PHP</serialize>
    <add>1.6</add>
  </field>
  <field>
    <name>group_type</name>
    <type>varchar</type>
    <title>Group Type</title>
    <length>128</length>
    <comment>FK to group type</comment>
    <pseudoconstant>
      <optionGroupName>group_type</optionGroupName>
    </pseudoconstant>
    <serialize>SEPARATOR_BOOKEND</serialize>
    <add>1.9</add>
  </field>
  <field>
    <name>cache_date</name>
    <type>timestamp</type>
    <title>Group Cache Date</title>
    <required>false</required>
    <comment>Date when we created the cache for a smart group</comment>
    <add>2.1</add>
  </field>
  <index>
    <name>UI_cache_date</name>
    <fieldName>cache_date</fieldName>
    <add>5.34</add>
  </index>
  <field>
    <name>refresh_date</name>
    <type>timestamp</type>
    <title>Next Group Refresh Time</title>
    <required>false</required>
    <comment>Date and time when we need to refresh the cache next.</comment>
    <add>4.3</add>
  </field>
  <field>
    <name>parents</name>
    <type>text</type>
    <title>Group Parents</title>
    <comment>IDs of the parent(s)</comment>
    <add>2.1</add>
    <serialize>COMMA</serialize>
    <pseudoconstant>
      <callback>CRM_Core_PseudoConstant::allGroup</callback>
    </pseudoconstant>
  </field>
  <field>
    <name>children</name>
    <type>text</type>
    <title>Group Children</title>
    <comment>IDs of the child(ren)</comment>
    <add>2.1</add>
  </field>
  <field>
    <name>is_hidden</name>
    <type>boolean</type>
    <title>Group is Hidden</title>
    <default>0</default>
    <comment>Is this group hidden?</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>is_reserved</name>
    <type>boolean</type>
    <title>Group is Reserved</title>
    <default>0</default>
    <add>4.2</add>
  </field>
  <index>
    <name>index_group_type</name>
    <fieldName>group_type</fieldName>
    <add>1.9</add>
  </index>
  <index>
    <name>UI_title</name>
    <fieldName>title</fieldName>
    <unique>true</unique>
    <add>2.1</add>
  </index>
  <index>
    <name>UI_name</name>
    <fieldName>name</fieldName>
    <unique>true</unique>
    <add>2.1</add>
  </index>
  <field>
    <name>created_id</name>
    <type>int unsigned</type>
    <title>Group Created By</title>
    <comment>FK to contact table.</comment>
    <add>4.3</add>
  </field>
  <foreignKey>
    <name>created_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <add>4.3</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>modified_id</name>
    <type>int unsigned</type>
    <title>Group Modified By</title>
    <comment>FK to contact table.</comment>
    <add>4.5</add>
  </field>
  <foreignKey>
    <name>modified_id</name>
    <table>civicrm_contact</table>
    <key>id</key>
    <add>4.5</add>
    <onDelete>SET NULL</onDelete>
  </foreignKey>
  <field>
    <name>frontend_title</name>
    <type>varchar</type>
    <title>Public Group Title</title>
    <length>255</length>
    <localizable>true</localizable>
    <comment>Alternative public title for this Group.</comment>
    <default>NULL</default>
    <add>5.31</add>
    <html>
      <type>Text</type>
    </html>
  </field>
  <field>
    <name>frontend_description</name>
    <type>text</type>
    <title>Public Group Description</title>
    <html>
      <type>TextArea</type>
      <rows>2</rows>
      <cols>60</cols>
    </html>
    <comment>Alternative public description of the group.</comment>
    <localizable>true</localizable>
    <default>NULL</default>
    <add>5.31</add>
  </field>
</table>
Commit	Line	Data
6a488035 TO	1	<?xml version="1.0" encoding="iso-8859-1" ?>
	2
	3	<table>
	4	<base>CRM/Contact</base>
	5	<class>Group</class>
	6	<name>civicrm_group</name>
	7	<comment>Provide grouping of related contacts</comment>
	8	<add>1.1</add>
	9	<log>true</log>
449c4e6b	10	<icon>fa-users</icon>
8ab43c93	11	<labelField>title</labelField>
a7bd99ff	12	<paths>
5c385299	13	<add>civicrm/group/add?reset=1</add>
a7bd99ff	14	</paths>
6a488035	15	<field>
8f069c03 EM	16	<name>id</name>
	17	<type>int unsigned</type>
	18	<title>Group ID</title>
	19	<required>true</required>
	20	<comment>Group ID</comment>
	21	<add>1.1</add>
6a488035 TO	22	</field>
6a488035 TO	23	<primaryKey>
8f069c03 EM	24	<name>id</name>
8f069c03 EM	25	<autoincrement>true</autoincrement>
6a488035 TO	26	</primaryKey>
6a488035 TO	27	<field>
8f069c03 EM	28	<name>name</name>
	29	<type>varchar</type>
	30	<title>Group Name</title>
	31	<length>64</length>
	32	<comment>Internal name of Group.</comment>
	33	<add>1.1</add>
6a488035	34	</field>
6a488035	35	<field>
8f069c03 EM	36	<name>title</name>
	37	<type>varchar</type>
	38	<title>Group Title</title>
35fd9d21	39	<length>255</length>
8f069c03 EM	40	<localizable>true</localizable>
	41	<comment>Name of Group.</comment>
	42	<add>1.1</add>
7da21f11	43	<html>
	44	<type>Text</type>
	45	</html>
6a488035 TO	46	</field>
6a488035 TO	47	<field>
8f069c03 EM	48	<name>description</name>
	49	<type>text</type>
	50	<title>Group Description</title>
	51	<html>
	52	<type>TextArea</type>
	53	<rows>2</rows>
	54	<cols>60</cols>
	55	</html>
	56	<comment>Optional verbose description of the group.</comment>
	57	<add>1.1</add>
	58	</field>
	59	<field>
	60	<name>source</name>
	61	<type>varchar</type>
	62	<title>Group Source</title>
	63	<length>64</length>
	64	<comment>Module or process which created this group.</comment>
	65	<add>1.1</add>
	66	</field>
	67	<field>
	68	<name>saved_search_id</name>
	69	<type>int unsigned</type>
	70	<title>Saved Search ID</title>
	71	<comment>FK to saved search table.</comment>
	72	<add>1.1</add>
6a488035	73	</field>
8f069c03 EM	74	<foreignKey>
	75	<name>saved_search_id</name>
	76	<table>civicrm_saved_search</table>
	77	<key>id</key>
	78	<add>1.1</add>
	79	<onDelete>SET NULL</onDelete>
	80	</foreignKey>
6a488035	81	<field>
8f069c03 EM	82	<name>is_active</name>
	83	<type>boolean</type>
	84	<title>Group Enabled</title>
	85	<comment>Is this entry active?</comment>
	86	<add>1.1</add>
	87	</field>
	88	<field>
	89	<name>visibility</name>
	90	<type>varchar</type>
	91	<length>24</length>
	92	<title>Group Visibility Setting</title>
	93	<default>'User and User Admin Only'</default>
	94	<comment>In what context(s) is this field visible.</comment>
	95	<pseudoconstant>
	96	<callback>CRM_Core_SelectValues::groupVisibility</callback>
	97	</pseudoconstant>
	98	<add>1.2</add>
	99	<html>
	100	<type>Select</type>
	101	</html>
	102	</field>
	103	<field>
	104	<name>where_clause</name>
	105	<type>text</type>
	106	<title>Group Where Clause</title>
	107	<comment>the sql where clause if a saved search acl</comment>
	108	<add>1.6</add>
6a488035 TO	109	</field>
6a488035 TO	110	<field>
8f069c03 EM	111	<name>select_tables</name>
	112	<type>text</type>
	113	<title>Tables For Select Clause</title>
	114	<comment>the tables to be included in a select data</comment>
2a5c9b4d	115	<serialize>PHP</serialize>
8f069c03	116	<add>1.6</add>
6a488035 TO	117	</field>
6a488035 TO	118	<field>
8f069c03 EM	119	<name>where_tables</name>
	120	<type>text</type>
	121	<title>Tables For Where Clause</title>
	122	<comment>the tables to be included in the count statement</comment>
2a5c9b4d	123	<serialize>PHP</serialize>
8f069c03	124	<add>1.6</add>
6a488035 TO	125	</field>
6a488035 TO	126	<field>
8f069c03 EM	127	<name>group_type</name>
	128	<type>varchar</type>
	129	<title>Group Type</title>
	130	<length>128</length>
	131	<comment>FK to group type</comment>
af3e0975	132	<pseudoconstant>
	133	<optionGroupName>group_type</optionGroupName>
	134	</pseudoconstant>
2a5c9b4d	135	<serialize>SEPARATOR_BOOKEND</serialize>
8f069c03	136	<add>1.9</add>
6a488035 TO	137	</field>
6a488035 TO	138	<field>
8f069c03	139	<name>cache_date</name>
a986056d	140	<type>timestamp</type>
8f069c03	141	<title>Group Cache Date</title>
d020c61d	142	<required>false</required>
8f069c03 EM	143	<comment>Date when we created the cache for a smart group</comment>
8f069c03 EM	144	<add>2.1</add>
6a488035	145	</field>
b29bfb6a	146	<index>
	147	<name>UI_cache_date</name>
	148	<fieldName>cache_date</fieldName>
	149	<add>5.34</add>
	150	</index>
6a488035	151	<field>
8f069c03	152	<name>refresh_date</name>
a986056d	153	<type>timestamp</type>
8f069c03	154	<title>Next Group Refresh Time</title>
d020c61d	155	<required>false</required>
8f069c03 EM	156	<comment>Date and time when we need to refresh the cache next.</comment>
8f069c03 EM	157	<add>4.3</add>
6a488035 TO	158	</field>
	159	<field>
	160	<name>parents</name>
	161	<type>text</type>
	162	<title>Group Parents</title>
	163	<comment>IDs of the parent(s)</comment>
	164	<add>2.1</add>
30208fab	165	<serialize>COMMA</serialize>
1678a63b	166	<pseudoconstant>
cb594601	167	<callback>CRM_Core_PseudoConstant::allGroup</callback>
1678a63b	168	</pseudoconstant>
6a488035 TO	169	</field>
	170	<field>
	171	<name>children</name>
	172	<type>text</type>
	173	<title>Group Children</title>
	174	<comment>IDs of the child(ren)</comment>
	175	<add>2.1</add>
	176	</field>
	177	<field>
	178	<name>is_hidden</name>
	179	<type>boolean</type>
	180	<title>Group is Hidden</title>
	181	<default>0</default>
	182	<comment>Is this group hidden?</comment>
	183	<add>2.2</add>
	184	</field>
	185	<field>
	186	<name>is_reserved</name>
	187	<type>boolean</type>
	188	<title>Group is Reserved</title>
	189	<default>0</default>
	190	<add>4.2</add>
	191	</field>
	192	<index>
	193	<name>index_group_type</name>
	194	<fieldName>group_type</fieldName>
	195	<add>1.9</add>
	196	</index>
	197	<index>
	198	<name>UI_title</name>
	199	<fieldName>title</fieldName>
	200	<unique>true</unique>
	201	<add>2.1</add>
	202	</index>
	203	<index>
	204	<name>UI_name</name>
	205	<fieldName>name</fieldName>
	206	<unique>true</unique>
	207	<add>2.1</add>
	208	</index>
	209	<field>
8f069c03 EM	210	<name>created_id</name>
	211	<type>int unsigned</type>
	212	<title>Group Created By</title>
	213	<comment>FK to contact table.</comment>
	214	<add>4.3</add>
6a488035 TO	215	</field>
6a488035 TO	216	<foreignKey>
8f069c03 EM	217	<name>created_id</name>
	218	<table>civicrm_contact</table>
	219	<key>id</key>
	220	<add>4.3</add>
	221	<onDelete>SET NULL</onDelete>
6a488035	222	</foreignKey>
d0dfb649	223	<field>
8f069c03 EM	224	<name>modified_id</name>
	225	<type>int unsigned</type>
	226	<title>Group Modified By</title>
	227	<comment>FK to contact table.</comment>
	228	<add>4.5</add>
d0dfb649 PJ	229	</field>
d0dfb649 PJ	230	<foreignKey>
8f069c03 EM	231	<name>modified_id</name>
	232	<table>civicrm_contact</table>
	233	<key>id</key>
	234	<add>4.5</add>
	235	<onDelete>SET NULL</onDelete>
d0dfb649	236	</foreignKey>
35fd9d21 SL	237	<field>
	238	<name>frontend_title</name>
	239	<type>varchar</type>
	240	<title>Public Group Title</title>
	241	<length>255</length>
	242	<localizable>true</localizable>
	243	<comment>Alternative public title for this Group.</comment>
	244	<default>NULL</default>
	245	<add>5.31</add>
	246	<html>
	247	<type>Text</type>
	248	</html>
	249	</field>
	250	<field>
	251	<name>frontend_description</name>
	252	<type>text</type>
	253	<title>Public Group Description</title>
	254	<html>
	255	<type>TextArea</type>
	256	<rows>2</rows>
	257	<cols>60</cols>
	258	</html>
	259	<comment>Alternative public description of the group.</comment>
	260	<localizable>true</localizable>
	261	<default>NULL</default>
	262	<add>5.31</add>
	263	</field>
6a488035	264	</table>