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