[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?action=add&amp;reset=1</add>
    <update>civicrm/admin/custom/group?action=update&amp;reset=1&amp;id=[id]</update>
    <preview>civicrm/admin/custom/group?action=preview&amp;reset=1&amp;id=[id]</preview>
    <delete>civicrm/admin/custom/group?action=delete&amp;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_SelectValues::customGroupExtends</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>Select</type>
    </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>
    <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>
    <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>
    <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>
    <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>
    <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_extends</name>
    <fieldName>name</fieldName>
    <fieldName>extends</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 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>
    <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>
    <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 CW	13	<paths>
	14	<add>civicrm/admin/custom/group?action=add&reset=1</add>
	15	<update>civicrm/admin/custom/group?action=update&reset=1&id=[id]</update>
	16	<preview>civicrm/admin/custom/group?action=preview&reset=1&id=[id]</preview>
	17	<delete>civicrm/admin/custom/group?action=delete&reset=1&id=[id]</delete>
	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 CW	60	<pseudoconstant>
	61	<callback>CRM_Core_SelectValues::customGroupExtends</callback>
	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>
	75	<type>Select</type>
	76	</html>
186e0984 EM	77	</field>
	78	<field>
	79	<name>extends_entity_column_value</name>
	80	<type>varchar</type>
56b7523d	81	<title>Custom Group Subtype</title>
186e0984 EM	82	<length>255</length>
186e0984 EM	83	<comment>linking custom group for dynamic object</comment>
2a5c9b4d	84	<serialize>SEPARATOR_BOOKEND</serialize>
186e0984 EM	85	<add>1.6</add>
	86	</field>
	87	<field>
	88	<name>style</name>
	89	<type>varchar</type>
56b7523d	90	<title>Custom Group Style</title>
186e0984 EM	91	<length>15</length>
	92	<comment>Visual relationship between this form and its parent.</comment>
	93	<pseudoconstant>
	94	<callback>CRM_Core_SelectValues::customGroupStyle</callback>
	95	</pseudoconstant>
	96	<add>1.1</add>
	97	<html>
	98	<type>Select</type>
	99	</html>
	100	</field>
	101	<field>
	102	<name>collapse_display</name>
9752268e	103	<type>boolean</type>
56b7523d	104	<title>Collapse Custom Group?</title>
186e0984 EM	105	<default>0</default>
	106	<comment>Will this group be in collapsed or expanded mode on initial display ?</comment>
	107	<add>1.1</add>
	108	</field>
	109	<field>
	110	<name>help_pre</name>
	111	<type>text</type>
56b7523d	112	<title>Custom Group Pre Text</title>
186e0984 EM	113	<localizable>true</localizable>
	114	<comment>Description and/or help text to display before fields in form.</comment>
	115	<html>
	116	<type>TextArea</type>
	117	<rows>4</rows>
	118	<cols>80</cols>
	119	</html>
	120	<add>1.1</add>
	121	</field>
	122	<field>
	123	<name>help_post</name>
	124	<type>text</type>
56b7523d	125	<title>Custom Group Post Text</title>
186e0984 EM	126	<localizable>true</localizable>
	127	<comment>Description and/or help text to display after fields in form.</comment>
	128	<html>
	129	<type>TextArea</type>
	130	<rows>4</rows>
	131	<cols>80</cols>
	132	</html>
	133	<add>1.1</add>
	134	</field>
	135	<field>
	136	<name>weight</name>
	137	<type>int</type>
7ecddde4	138	<title>Order</title>
186e0984 EM	139	<required>true</required>
	140	<default>1</default>
	141	<comment>Controls display order when multiple extended property groups are setup for the same class.</comment>
	142	<add>1.1</add>
	143	</field>
	144	<field>
	145	<name>is_active</name>
	146	<type>boolean</type>
56b7523d	147	<title>Custom Group Is Active?</title>
186e0984	148	<comment>Is this property active?</comment>
c0c9c8bf	149	<default>1</default>
186e0984 EM	150	<add>1.1</add>
	151	</field>
	152	<field>
	153	<name>table_name</name>
	154	<type>varchar</type>
	155	<length>255</length>
	156	<comment>Name of the table that holds the values for this group.</comment>
1662d426 A	157	<html>
	158	<label>Table Name</label>
	159	</html>
88620a59	160	<readonly>true</readonly>
186e0984 EM	161	<add>2.0</add>
	162	</field>
	163	<field>
	164	<name>is_multiple</name>
	165	<type>boolean</type>
56b7523d	166	<title>Supports Multiple Records</title>
186e0984	167	<comment>Does this group hold multiple values?</comment>
c0c9c8bf	168	<default>0</default>
186e0984 EM	169	<add>2.0</add>
	170	</field>
	171	<field>
	172	<name>min_multiple</name>
	173	<type>int unsigned</type>
56b7523d	174	<title>Minimum Multiple Records</title>
186e0984 EM	175	<comment>minimum number of multiple records (typically 0?)</comment>
	176	<add>2.2</add>
	177	</field>
	178	<field>
	179	<name>max_multiple</name>
	180	<type>int unsigned</type>
56b7523d	181	<title>Maximum Multiple Records</title>
186e0984 EM	182	<comment>maximum number of multiple records, if 0 - no max</comment>
	183	<add>2.2</add>
	184	</field>
	185	<field>
	186	<name>collapse_adv_display</name>
9752268e	187	<type>boolean</type>
56b7523d	188	<title>Collapse Group Display</title>
186e0984 EM	189	<default>0</default>
	190	<comment>Will this group be in collapsed or expanded mode on advanced search display ?</comment>
	191	<add>3.0</add>
6a488035 TO	192	</field>
	193	<index>
	194	<name>UI_title_extends</name>
	195	<fieldName>title</fieldName>
	196	<fieldName>extends</fieldName>
	197	<unique>true</unique>
	198	<add>2.1</add>
	199	</index>
	200	<index>
	201	<name>UI_name_extends</name>
	202	<fieldName>name</fieldName>
	203	<fieldName>extends</fieldName>
	204	<unique>true</unique>
	205	<add>2.1</add>
	206	</index>
	207	<field>
	208	<name>created_id</name>
	209	<type>int unsigned</type>
047c5009	210	<title>Created By Contact ID</title>
6a488035	211	<comment>FK to civicrm_contact, who created this custom group</comment>
57e94608	212	<html>
047c5009	213	<label>Created By</label>
57e94608	214	</html>
6a488035 TO	215	<add>3.0</add>
	216	</field>
	217	<foreignKey>
	218	<name>created_id</name>
	219	<table>civicrm_contact</table>
	220	<key>id</key>
	221	<add>3.0</add>
	222	<onDelete>SET NULL</onDelete>
	223	</foreignKey>
	224	<field>
	225	<name>created_date</name>
	226	<type>datetime</type>
	227	<title>Custom Group Created Date</title>
	228	<comment>Date and time this custom group was created.</comment>
	229	<add>3.0</add>
	230	</field>
3c7d2158	231	<field>
d06700a7 RN	232	<name>is_reserved</name>
d06700a7 RN	233	<type>boolean</type>
56b7523d	234	<title>Reserved Group?</title>
d06700a7 RN	235	<default>0</default>
d06700a7 RN	236	<comment>Is this a reserved Custom Group?</comment>
3c7d2158	237	<add>4.4</add>
3c7d2158	238	</field>
460931ca JP	239	<field>
	240	<name>is_public</name>
	241	<type>boolean</type>
	242	<title>Custom Group Is Public?</title>
	243	<default>1</default>
	244	<comment>Is this property public?</comment>
	245	<add>4.7</add>
	246	</field>
2af06525 CW	247	<field>
	248	<name>icon</name>
	249	<title>Icon</title>
	250	<type>varchar</type>
	251	<length>255</length>
	252	<default>NULL</default>
	253	<comment>crm-i icon class</comment>
	254	<add>5.28</add>
	255	</field>
6a488035	256	</table>