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