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

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

<table>
  <base>CRM/Core</base>
  <class>CustomGroup</class>
  <name>civicrm_custom_group</name>
  <comment>All extended (custom) properties are associated with a group. These are logical sets of related data.
  </comment>
  <add>1.1</add>
  <log>true</log>
  <title>Custom Field Group</title>
  <labelField>title</labelField>
  <paths>
    <add>civicrm/admin/custom/group/edit?action=add&amp;reset=1</add>
    <update>civicrm/admin/custom/group/edit?action=update&amp;reset=1&amp;id=[id]</update>
    <preview>civicrm/admin/custom/group/preview?reset=1&amp;gid=[id]</preview>
    <delete>civicrm/admin/custom/group/delete?reset=1&amp;id=[id]</delete>
  </paths>
  <field>
    <name>id</name>
    <type>int unsigned</type>
    <title>Custom Group ID</title>
    <required>true</required>
    <comment>Unique Custom 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>Custom Group Name</title>
    <length>64</length>
    <comment>Variable name/programmatic handle for this group.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>title</name>
    <type>varchar</type>
    <title>Custom Group Title</title>
    <length>64</length>
    <required>true</required>
    <localizable>true</localizable>
    <comment>Friendly Name.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>extends</name>
    <type>varchar</type>
    <title>Custom Group Extends</title>
    <length>255</length>
    <default>'Contact'</default>
    <comment>Type of object this group extends (can add other options later e.g. contact_address, etc.).</comment>
    <add>1.1</add>
    <pseudoconstant>
      <callback>CRM_Core_BAO_CustomGroup::getCustomGroupExtendsOptions</callback>
    </pseudoconstant>
  </field>
  <field>
    <name>extends_entity_column_id</name>
    <type>int unsigned</type>
    <title>Custom Group Subtype List</title>
    <default>NULL</default>
    <comment>FK to civicrm_option_value.id (for option group custom_data_type.)</comment>
    <pseudoconstant>
      <optionGroupName>custom_data_type</optionGroupName>
    </pseudoconstant>
    <add>2.2</add>
    <html>
      <type>ChainSelect</type>
      <controlField>extends</controlField>
    </html>
  </field>
  <field>
    <name>extends_entity_column_value</name>
    <type>varchar</type>
    <title>Custom Group Subtype</title>
    <length>255</length>
    <comment>linking custom group for dynamic object</comment>
    <serialize>SEPARATOR_BOOKEND</serialize>
    <pseudoconstant>
      <callback>CRM_Core_BAO_CustomGroup::getExtendsEntityColumnValueOptions</callback>
    </pseudoconstant>
    <html>
      <type>ChainSelect</type>
      <controlField>extends_entity_column_id</controlField>
    </html>
    <add>1.6</add>
  </field>
  <field>
    <name>style</name>
    <type>varchar</type>
    <title>Custom Group Style</title>
    <length>15</length>
    <comment>Visual relationship between this form and its parent.</comment>
    <pseudoconstant>
      <callback>CRM_Core_SelectValues::customGroupStyle</callback>
    </pseudoconstant>
    <add>1.1</add>
    <html>
      <type>Select</type>
    </html>
  </field>
  <field>
    <name>collapse_display</name>
    <type>boolean</type>
    <title>Collapse Custom Group?</title>
    <default>0</default>
    <required>true</required>
    <comment>Will this group be in collapsed or expanded mode on initial display ?</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>help_pre</name>
    <type>text</type>
    <title>Custom Group Pre Text</title>
    <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.1</add>
  </field>
  <field>
    <name>help_post</name>
    <type>text</type>
    <title>Custom Group Post Text</title>
    <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.1</add>
  </field>
  <field>
    <name>weight</name>
    <type>int</type>
    <title>Order</title>
    <required>true</required>
    <default>1</default>
    <comment>Controls display order when multiple extended property groups are setup for the same class.</comment>
    <add>1.1</add>
  </field>
  <field>
    <name>is_active</name>
    <type>boolean</type>
    <title>Custom Group Is Active?</title>
    <comment>Is this property active?</comment>
    <default>1</default>
    <required>true</required>
    <add>1.1</add>
  </field>
  <field>
    <name>table_name</name>
    <type>varchar</type>
    <length>255</length>
    <comment>Name of the table that holds the values for this group.</comment>
    <html>
      <label>Table Name</label>
    </html>
    <readonly>true</readonly>
    <add>2.0</add>
  </field>
  <field>
    <name>is_multiple</name>
    <type>boolean</type>
    <title>Supports Multiple Records</title>
    <comment>Does this group hold multiple values?</comment>
    <default>0</default>
    <required>true</required>
    <add>2.0</add>
  </field>
  <field>
    <name>min_multiple</name>
    <type>int unsigned</type>
    <title>Minimum Multiple Records</title>
    <comment>minimum number of multiple records (typically 0?)</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>max_multiple</name>
    <type>int unsigned</type>
    <title>Maximum Multiple Records</title>
    <comment>maximum number of multiple records, if 0 - no max</comment>
    <add>2.2</add>
  </field>
  <field>
    <name>collapse_adv_display</name>
    <type>boolean</type>
    <title>Collapse Group Display</title>
    <default>0</default>
    <required>true</required>
    <comment>Will this group be in collapsed or expanded mode on advanced search display ?</comment>
    <add>3.0</add>
  </field>
  <index>
    <name>UI_title_extends</name>
    <fieldName>title</fieldName>
    <fieldName>extends</fieldName>
    <unique>true</unique>
    <add>2.1</add>
  </index>
  <index>
    <name>UI_name</name>
    <fieldName>name</fieldName>
    <unique>true</unique>
    <add>5.47</add>
  </index>
  <field>
    <name>created_id</name>
    <type>int unsigned</type>
    <title>Created By Contact ID</title>
    <comment>FK to civicrm_contact, who created this custom group</comment>
    <html>
      <label>Created By</label>
    </html>
    <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>Custom Group Created Date</title>
    <comment>Date and time this custom group was created.</comment>
    <add>3.0</add>
  </field>
  <field>
    <name>is_reserved</name>
    <type>boolean</type>
    <title>Reserved Group?</title>
    <default>0</default>
    <required>true</required>
    <comment>Is this a reserved Custom Group?</comment>
    <add>4.4</add>
  </field>
  <field>
    <name>is_public</name>
    <type>boolean</type>
    <title>Custom Group Is Public?</title>
    <default>1</default>
    <required>true</required>
    <comment>Is this property public?</comment>
    <add>4.7</add>
  </field>
  <field>
    <name>icon</name>
    <title>Icon</title>
    <type>varchar</type>
    <length>255</length>
    <default>NULL</default>
    <comment>crm-i icon class</comment>
    <add>5.28</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>CustomGroup</class>
	6	<name>civicrm_custom_group</name>
186e0984 EM	7	<comment>All extended (custom) properties are associated with a group. These are logical sets of related data.
186e0984 EM	8	</comment>
6a488035 TO	9	<add>1.1</add>
6a488035 TO	10	<log>true</log>
812fe84d	11	<title>Custom Field Group</title>
8ab43c93	12	<labelField>title</labelField>
8ad19d07	13	<paths>
aca7613b CW	14	<add>civicrm/admin/custom/group/edit?action=add&reset=1</add>
	15	<update>civicrm/admin/custom/group/edit?action=update&reset=1&id=[id]</update>
	16	<preview>civicrm/admin/custom/group/preview?reset=1&gid=[id]</preview>
	17	<delete>civicrm/admin/custom/group/delete?reset=1&id=[id]</delete>
8ad19d07	18	</paths>
186e0984 EM	19	<field>
	20	<name>id</name>
	21	<type>int unsigned</type>
56b7523d	22	<title>Custom Group ID</title>
186e0984 EM	23	<required>true</required>
186e0984 EM	24	<comment>Unique Custom Group ID</comment>
0481e12c A	25	<html>
	26	<type>Number</type>
	27	</html>
186e0984	28	<add>1.1</add>
6a488035 TO	29	</field>
6a488035 TO	30	<primaryKey>
186e0984 EM	31	<name>id</name>
186e0984 EM	32	<autoincrement>true</autoincrement>
6a488035 TO	33	</primaryKey>
6a488035 TO	34	<field>
186e0984 EM	35	<name>name</name>
186e0984 EM	36	<type>varchar</type>
56b7523d	37	<title>Custom Group Name</title>
186e0984 EM	38	<length>64</length>
	39	<comment>Variable name/programmatic handle for this group.</comment>
	40	<add>1.1</add>
	41	</field>
	42	<field>
	43	<name>title</name>
	44	<type>varchar</type>
56b7523d	45	<title>Custom Group Title</title>
186e0984 EM	46	<length>64</length>
	47	<required>true</required>
	48	<localizable>true</localizable>
	49	<comment>Friendly Name.</comment>
	50	<add>1.1</add>
	51	</field>
	52	<field>
	53	<name>extends</name>
	54	<type>varchar</type>
56b7523d	55	<title>Custom Group Extends</title>
186e0984 EM	56	<length>255</length>
	57	<default>'Contact'</default>
	58	<comment>Type of object this group extends (can add other options later e.g. contact_address, etc.).</comment>
	59	<add>1.1</add>
c9ac084f	60	<pseudoconstant>
c100cf44	61	<callback>CRM_Core_BAO_CustomGroup::getCustomGroupExtendsOptions</callback>
c9ac084f	62	</pseudoconstant>
186e0984	63	</field>
186e0984 EM	64	<field>
	65	<name>extends_entity_column_id</name>
	66	<type>int unsigned</type>
56b7523d	67	<title>Custom Group Subtype List</title>
186e0984 EM	68	<default>NULL</default>
186e0984 EM	69	<comment>FK to civicrm_option_value.id (for option group custom_data_type.)</comment>
233319bf	70	<pseudoconstant>
	71	<optionGroupName>custom_data_type</optionGroupName>
	72	</pseudoconstant>
186e0984	73	<add>2.2</add>
233319bf	74	<html>
38016453 CW	75	<type>ChainSelect</type>
38016453 CW	76	<controlField>extends</controlField>
233319bf	77	</html>
186e0984 EM	78	</field>
	79	<field>
	80	<name>extends_entity_column_value</name>
	81	<type>varchar</type>
56b7523d	82	<title>Custom Group Subtype</title>
186e0984 EM	83	<length>255</length>
186e0984 EM	84	<comment>linking custom group for dynamic object</comment>
2a5c9b4d	85	<serialize>SEPARATOR_BOOKEND</serialize>
3d2f86c5 CW	86	<pseudoconstant>
	87	<callback>CRM_Core_BAO_CustomGroup::getExtendsEntityColumnValueOptions</callback>
	88	</pseudoconstant>
38016453 CW	89	<html>
	90	<type>ChainSelect</type>
	91	<controlField>extends_entity_column_id</controlField>
	92	</html>
186e0984 EM	93	<add>1.6</add>
	94	</field>
	95	<field>
	96	<name>style</name>
	97	<type>varchar</type>
56b7523d	98	<title>Custom Group Style</title>
186e0984 EM	99	<length>15</length>
	100	<comment>Visual relationship between this form and its parent.</comment>
	101	<pseudoconstant>
	102	<callback>CRM_Core_SelectValues::customGroupStyle</callback>
	103	</pseudoconstant>
	104	<add>1.1</add>
	105	<html>
	106	<type>Select</type>
	107	</html>
	108	</field>
	109	<field>
	110	<name>collapse_display</name>
9752268e	111	<type>boolean</type>
56b7523d	112	<title>Collapse Custom Group?</title>
186e0984	113	<default>0</default>
c1e814c7	114	<required>true</required>
186e0984 EM	115	<comment>Will this group be in collapsed or expanded mode on initial display ?</comment>
	116	<add>1.1</add>
	117	</field>
	118	<field>
	119	<name>help_pre</name>
	120	<type>text</type>
56b7523d	121	<title>Custom Group Pre Text</title>
186e0984 EM	122	<localizable>true</localizable>
	123	<comment>Description and/or help text to display before fields in form.</comment>
	124	<html>
	125	<type>TextArea</type>
	126	<rows>4</rows>
	127	<cols>80</cols>
	128	</html>
	129	<add>1.1</add>
	130	</field>
	131	<field>
	132	<name>help_post</name>
	133	<type>text</type>
56b7523d	134	<title>Custom Group Post Text</title>
186e0984 EM	135	<localizable>true</localizable>
	136	<comment>Description and/or help text to display after fields in form.</comment>
	137	<html>
	138	<type>TextArea</type>
	139	<rows>4</rows>
	140	<cols>80</cols>
	141	</html>
	142	<add>1.1</add>
	143	</field>
	144	<field>
	145	<name>weight</name>
	146	<type>int</type>
7ecddde4	147	<title>Order</title>
186e0984 EM	148	<required>true</required>
	149	<default>1</default>
	150	<comment>Controls display order when multiple extended property groups are setup for the same class.</comment>
	151	<add>1.1</add>
	152	</field>
	153	<field>
	154	<name>is_active</name>
	155	<type>boolean</type>
56b7523d	156	<title>Custom Group Is Active?</title>
186e0984	157	<comment>Is this property active?</comment>
c0c9c8bf	158	<default>1</default>
c1e814c7	159	<required>true</required>
186e0984 EM	160	<add>1.1</add>
	161	</field>
	162	<field>
	163	<name>table_name</name>
	164	<type>varchar</type>
	165	<length>255</length>
	166	<comment>Name of the table that holds the values for this group.</comment>
1662d426 A	167	<html>
	168	<label>Table Name</label>
	169	</html>
88620a59	170	<readonly>true</readonly>
186e0984 EM	171	<add>2.0</add>
	172	</field>
	173	<field>
	174	<name>is_multiple</name>
	175	<type>boolean</type>
56b7523d	176	<title>Supports Multiple Records</title>
186e0984	177	<comment>Does this group hold multiple values?</comment>
c0c9c8bf	178	<default>0</default>
c1e814c7	179	<required>true</required>
186e0984 EM	180	<add>2.0</add>
	181	</field>
	182	<field>
	183	<name>min_multiple</name>
	184	<type>int unsigned</type>
56b7523d	185	<title>Minimum Multiple Records</title>
186e0984 EM	186	<comment>minimum number of multiple records (typically 0?)</comment>
	187	<add>2.2</add>
	188	</field>
	189	<field>
	190	<name>max_multiple</name>
	191	<type>int unsigned</type>
56b7523d	192	<title>Maximum Multiple Records</title>
186e0984 EM	193	<comment>maximum number of multiple records, if 0 - no max</comment>
	194	<add>2.2</add>
	195	</field>
	196	<field>
	197	<name>collapse_adv_display</name>
9752268e	198	<type>boolean</type>
56b7523d	199	<title>Collapse Group Display</title>
186e0984	200	<default>0</default>
c1e814c7	201	<required>true</required>
186e0984 EM	202	<comment>Will this group be in collapsed or expanded mode on advanced search display ?</comment>
186e0984 EM	203	<add>3.0</add>
6a488035 TO	204	</field>
	205	<index>
	206	<name>UI_title_extends</name>
	207	<fieldName>title</fieldName>
	208	<fieldName>extends</fieldName>
	209	<unique>true</unique>
	210	<add>2.1</add>
	211	</index>
	212	<index>
79b6ac2b	213	<name>UI_name</name>
6a488035	214	<fieldName>name</fieldName>
6a488035	215	<unique>true</unique>
79b6ac2b	216	<add>5.47</add>
6a488035 TO	217	</index>
	218	<field>
	219	<name>created_id</name>
	220	<type>int unsigned</type>
047c5009	221	<title>Created By Contact ID</title>
6a488035	222	<comment>FK to civicrm_contact, who created this custom group</comment>
57e94608	223	<html>
047c5009	224	<label>Created By</label>
57e94608	225	</html>
6a488035 TO	226	<add>3.0</add>
	227	</field>
	228	<foreignKey>
	229	<name>created_id</name>
	230	<table>civicrm_contact</table>
	231	<key>id</key>
	232	<add>3.0</add>
	233	<onDelete>SET NULL</onDelete>
	234	</foreignKey>
	235	<field>
	236	<name>created_date</name>
	237	<type>datetime</type>
	238	<title>Custom Group Created Date</title>
	239	<comment>Date and time this custom group was created.</comment>
	240	<add>3.0</add>
	241	</field>
3c7d2158	242	<field>
d06700a7 RN	243	<name>is_reserved</name>
d06700a7 RN	244	<type>boolean</type>
56b7523d	245	<title>Reserved Group?</title>
d06700a7	246	<default>0</default>
c1e814c7	247	<required>true</required>
d06700a7	248	<comment>Is this a reserved Custom Group?</comment>
3c7d2158	249	<add>4.4</add>
3c7d2158	250	</field>
460931ca JP	251	<field>
	252	<name>is_public</name>
	253	<type>boolean</type>
	254	<title>Custom Group Is Public?</title>
	255	<default>1</default>
c1e814c7	256	<required>true</required>
460931ca JP	257	<comment>Is this property public?</comment>
	258	<add>4.7</add>
	259	</field>
2af06525 CW	260	<field>
	261	<name>icon</name>
	262	<title>Icon</title>
	263	<type>varchar</type>
	264	<length>255</length>
	265	<default>NULL</default>
	266	<comment>crm-i icon class</comment>
	267	<add>5.28</add>
	268	</field>
6a488035	269	</table>