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