CRM-13497 - Add html type to schema xml
[civicrm-core.git] / xml / schema / Core / CustomGroup.xml
CommitLineData
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>
7 <comment>All extended (custom) properties are associated with a group. These are logical sets of related data.</comment>
8 <add>1.1</add>
9 <log>true</log>
10 <field>
11 <name>id</name>
12 <type>int unsigned</type>
13 <required>true</required>
14 <comment>Unique Custom Group ID</comment>
15 <add>1.1</add>
16 </field>
17 <primaryKey>
18 <name>id</name>
19 <autoincrement>true</autoincrement>
20 </primaryKey>
21 <field>
22 <name>name</name>
23 <type>varchar</type>
24 <length>64</length>
25 <comment>Variable name/programmatic handle for this group.</comment>
26 <add>1.1</add>
27 </field>
28 <field>
29 <name>title</name>
30 <type>varchar</type>
31 <length>64</length>
32 <required>true</required>
33 <localizable>true</localizable>
34 <comment>Friendly Name.</comment>
35 <add>1.1</add>
36 </field>
37 <field>
38 <name>extends</name>
39 <type>varchar</type>
40 <length>255</length>
41 <default>'Contact'</default>
42 <comment>Type of object this group extends (can add other options later e.g. contact_address, etc.).</comment>
43 <add>1.1</add>
44 </field>
45 <field>
46 <name>extends_entity_column_name</name>
47 <type>varchar</type>
48 <length>64</length>
49 <comment>linking custom group for dynamic object</comment>
50 <add>1.6</add>
51 <drop>2.2</drop>
52 </field>
53 <field>
54 <name>extends_entity_column_id</name>
55 <type>int unsigned</type>
56 <default>NULL</default>
57 <comment>FK to civicrm_option_value.id (for option group custom_data_type.)</comment>
58 <add>2.2</add>
59 </field>
60 <field>
61 <name>extends_entity_column_value</name>
62 <type>varchar</type>
63 <length>255</length>
64 <comment>linking custom group for dynamic object</comment>
65 <add>1.6</add>
66 </field>
3c7d2158 67
6a488035
TO
68 <field>
69 <name>style</name>
70 <type>enum</type>
71 <values>Tab, Inline</values>
72 <comment>Visual relationship between this form and its parent.</comment>
73 <add>1.1</add>
74 </field>
75 <field>
76 <name>collapse_display</name>
77 <type>int unsigned</type>
78 <default>0</default>
79 <comment>Will this group be in collapsed or expanded mode on initial display ?</comment>
80 <add>1.1</add>
81 </field>
82 <field>
83 <name>help_pre</name>
84 <type>text</type>
85 <localizable>true</localizable>
86 <comment>Description and/or help text to display before fields in form.</comment>
7deea513 87 <html>
88 <type>TextArea</type>
89 </html>
90
6a488035
TO
91 <rows>4</rows>
92 <cols>80</cols>
93 <add>1.1</add>
94 </field>
95 <field>
96 <name>help_post</name>
97 <type>text</type>
98 <localizable>true</localizable>
99 <comment>Description and/or help text to display after fields in form.</comment>
7deea513 100 <html>
101 <type>TextArea</type>
102 </html>
103
6a488035
TO
104 <rows>4</rows>
105 <cols>80</cols>
106 <add>1.1</add>
107 </field>
108 <field>
109 <name>weight</name>
110 <type>int</type>
111 <required>true</required>
112 <default>1</default>
113 <comment>Controls display order when multiple extended property groups are setup for the same class.</comment>
114 <add>1.1</add>
115 </field>
116 <field>
117 <name>is_active</name>
118 <type>boolean</type>
119 <comment>Is this property active?</comment>
120 <add>1.1</add>
121 </field>
122 <field>
123 <name>table_name</name>
124 <type>varchar</type>
125 <length>255</length>
126 <comment>Name of the table that holds the values for this group.</comment>
127 <add>2.0</add>
128 </field>
129 <field>
130 <name>is_multiple</name>
131 <type>boolean</type>
132 <comment>Does this group hold multiple values?</comment>
133 <add>2.0</add>
134 </field>
135 <field>
136 <name>min_multiple</name>
137 <type>int unsigned</type>
138 <comment>minimum number of multiple records (typically 0?)</comment>
139 <add>2.2</add>
140 </field>
141 <field>
142 <name>max_multiple</name>
143 <type>int unsigned</type>
144 <comment>maximum number of multiple records, if 0 - no max</comment>
145 <add>2.2</add>
146 </field>
147 <field>
148 <name>collapse_adv_display</name>
149 <type>int unsigned</type>
150 <default>0</default>
151 <comment>Will this group be in collapsed or expanded mode on advanced search display ?</comment>
152 <add>3.0</add>
153 </field>
154 <index>
155 <name>UI_title_extends</name>
156 <fieldName>title</fieldName>
157 <fieldName>extends</fieldName>
158 <unique>true</unique>
159 <add>2.1</add>
160 </index>
161 <index>
162 <name>UI_name_extends</name>
163 <fieldName>name</fieldName>
164 <fieldName>extends</fieldName>
165 <unique>true</unique>
166 <add>2.1</add>
167 </index>
168 <field>
169 <name>created_id</name>
170 <type>int unsigned</type>
171 <comment>FK to civicrm_contact, who created this custom group</comment>
172 <add>3.0</add>
173 </field>
174 <foreignKey>
175 <name>created_id</name>
176 <table>civicrm_contact</table>
177 <key>id</key>
178 <add>3.0</add>
179 <onDelete>SET NULL</onDelete>
180 </foreignKey>
181 <field>
182 <name>created_date</name>
183 <type>datetime</type>
184 <title>Custom Group Created Date</title>
185 <comment>Date and time this custom group was created.</comment>
186 <add>3.0</add>
187 </field>
3c7d2158 188 <field>
d06700a7
RN
189 <name>is_reserved</name>
190 <type>boolean</type>
191 <default>0</default>
192 <comment>Is this a reserved Custom Group?</comment>
3c7d2158 193 <add>4.4</add>
194 </field>
6a488035
TO
195</table>
196
197