[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_name</name>
    <type>varchar</type>
    <length>64</length>
    <comment>linking custom group for dynamic object</comment>
    <add>1.6</add>
    <drop>2.2</drop>
  </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>
    <add>2.2</add>
  </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>
    <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>int unsigned</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>
    <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>
    <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>int unsigned</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>
</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>
	50	<field>
	51	<name>extends_entity_column_name</name>
	52	<type>varchar</type>
	53	<length>64</length>
	54	<comment>linking custom group for dynamic object</comment>
	55	<add>1.6</add>
	56	<drop>2.2</drop>
	57	</field>
	58	<field>
	59	<name>extends_entity_column_id</name>
	60	<type>int unsigned</type>
56b7523d	61	<title>Custom Group Subtype List</title>
186e0984 EM	62	<default>NULL</default>
	63	<comment>FK to civicrm_option_value.id (for option group custom_data_type.)</comment>
	64	<add>2.2</add>
	65	</field>
	66	<field>
	67	<name>extends_entity_column_value</name>
	68	<type>varchar</type>
56b7523d	69	<title>Custom Group Subtype</title>
186e0984 EM	70	<length>255</length>
	71	<comment>linking custom group for dynamic object</comment>
	72	<add>1.6</add>
	73	</field>
	74	<field>
	75	<name>style</name>
	76	<type>varchar</type>
56b7523d	77	<title>Custom Group Style</title>
186e0984 EM	78	<length>15</length>
	79	<comment>Visual relationship between this form and its parent.</comment>
	80	<pseudoconstant>
	81	<callback>CRM_Core_SelectValues::customGroupStyle</callback>
	82	</pseudoconstant>
	83	<add>1.1</add>
	84	<html>
	85	<type>Select</type>
	86	</html>
	87	</field>
	88	<field>
	89	<name>collapse_display</name>
	90	<type>int unsigned</type>
56b7523d	91	<title>Collapse Custom Group?</title>
186e0984 EM	92	<default>0</default>
	93	<comment>Will this group be in collapsed or expanded mode on initial display ?</comment>
	94	<add>1.1</add>
	95	</field>
	96	<field>
	97	<name>help_pre</name>
	98	<type>text</type>
56b7523d	99	<title>Custom Group Pre Text</title>
186e0984 EM	100	<localizable>true</localizable>
	101	<comment>Description and/or help text to display before fields in form.</comment>
	102	<html>
	103	<type>TextArea</type>
	104	<rows>4</rows>
	105	<cols>80</cols>
	106	</html>
	107	<add>1.1</add>
	108	</field>
	109	<field>
	110	<name>help_post</name>
	111	<type>text</type>
56b7523d	112	<title>Custom Group Post Text</title>
186e0984 EM	113	<localizable>true</localizable>
	114	<comment>Description and/or help text to display after 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>weight</name>
	124	<type>int</type>
7ecddde4	125	<title>Order</title>
186e0984 EM	126	<required>true</required>
	127	<default>1</default>
	128	<comment>Controls display order when multiple extended property groups are setup for the same class.</comment>
	129	<add>1.1</add>
	130	</field>
	131	<field>
	132	<name>is_active</name>
	133	<type>boolean</type>
56b7523d	134	<title>Custom Group Is Active?</title>
186e0984 EM	135	<comment>Is this property active?</comment>
	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 EM	149	<comment>Does this group hold multiple values?</comment>
	150	<add>2.0</add>
	151	</field>
	152	<field>
	153	<name>min_multiple</name>
	154	<type>int unsigned</type>
56b7523d	155	<title>Minimum Multiple Records</title>
186e0984 EM	156	<comment>minimum number of multiple records (typically 0?)</comment>
	157	<add>2.2</add>
	158	</field>
	159	<field>
	160	<name>max_multiple</name>
	161	<type>int unsigned</type>
56b7523d	162	<title>Maximum Multiple Records</title>
186e0984 EM	163	<comment>maximum number of multiple records, if 0 - no max</comment>
	164	<add>2.2</add>
	165	</field>
	166	<field>
	167	<name>collapse_adv_display</name>
	168	<type>int unsigned</type>
56b7523d	169	<title>Collapse Group Display</title>
186e0984 EM	170	<default>0</default>
	171	<comment>Will this group be in collapsed or expanded mode on advanced search display ?</comment>
	172	<add>3.0</add>
6a488035 TO	173	</field>
	174	<index>
	175	<name>UI_title_extends</name>
	176	<fieldName>title</fieldName>
	177	<fieldName>extends</fieldName>
	178	<unique>true</unique>
	179	<add>2.1</add>
	180	</index>
	181	<index>
	182	<name>UI_name_extends</name>
	183	<fieldName>name</fieldName>
	184	<fieldName>extends</fieldName>
	185	<unique>true</unique>
	186	<add>2.1</add>
	187	</index>
	188	<field>
	189	<name>created_id</name>
	190	<type>int unsigned</type>
56b7523d	191	<title>Custom Group Created By</title>
6a488035 TO	192	<comment>FK to civicrm_contact, who created this custom group</comment>
	193	<add>3.0</add>
	194	</field>
	195	<foreignKey>
	196	<name>created_id</name>
	197	<table>civicrm_contact</table>
	198	<key>id</key>
	199	<add>3.0</add>
	200	<onDelete>SET NULL</onDelete>
	201	</foreignKey>
	202	<field>
	203	<name>created_date</name>
	204	<type>datetime</type>
	205	<title>Custom Group Created Date</title>
	206	<comment>Date and time this custom group was created.</comment>
	207	<add>3.0</add>
	208	</field>
3c7d2158	209	<field>
d06700a7 RN	210	<name>is_reserved</name>
d06700a7 RN	211	<type>boolean</type>
56b7523d	212	<title>Reserved Group?</title>
d06700a7 RN	213	<default>0</default>
d06700a7 RN	214	<comment>Is this a reserved Custom Group?</comment>
3c7d2158	215	<add>4.4</add>
3c7d2158	216	</field>
6a488035	217	</table>