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. |
8 | </comment> | |
6a488035 TO |
9 | <add>1.1</add> |
10 | <log>true</log> | |
812fe84d | 11 | <title>Custom Field Group</title> |
8ab43c93 | 12 | <labelField>title</labelField> |
8ad19d07 | 13 | <paths> |
aca7613b CW |
14 | <add>civicrm/admin/custom/group/edit?action=add&reset=1</add> |
15 | <update>civicrm/admin/custom/group/edit?action=update&reset=1&id=[id]</update> | |
16 | <preview>civicrm/admin/custom/group/preview?reset=1&gid=[id]</preview> | |
17 | <delete>civicrm/admin/custom/group/delete?reset=1&id=[id]</delete> | |
8ad19d07 | 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> |
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> |
30 | <primaryKey> | |
186e0984 EM |
31 | <name>id</name> |
32 | <autoincrement>true</autoincrement> | |
6a488035 TO |
33 | </primaryKey> |
34 | <field> | |
186e0984 EM |
35 | <name>name</name> |
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> |
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> |
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 | 105 | <default>0</default> |
c1e814c7 | 106 | <required>true</required> |
186e0984 EM |
107 | <comment>Will this group be in collapsed or expanded mode on initial display ?</comment> |
108 | <add>1.1</add> | |
109 | </field> | |
110 | <field> | |
111 | <name>help_pre</name> | |
112 | <type>text</type> | |
56b7523d | 113 | <title>Custom Group Pre Text</title> |
186e0984 EM |
114 | <localizable>true</localizable> |
115 | <comment>Description and/or help text to display before fields in form.</comment> | |
116 | <html> | |
117 | <type>TextArea</type> | |
118 | <rows>4</rows> | |
119 | <cols>80</cols> | |
120 | </html> | |
121 | <add>1.1</add> | |
122 | </field> | |
123 | <field> | |
124 | <name>help_post</name> | |
125 | <type>text</type> | |
56b7523d | 126 | <title>Custom Group Post Text</title> |
186e0984 EM |
127 | <localizable>true</localizable> |
128 | <comment>Description and/or help text to display after fields in form.</comment> | |
129 | <html> | |
130 | <type>TextArea</type> | |
131 | <rows>4</rows> | |
132 | <cols>80</cols> | |
133 | </html> | |
134 | <add>1.1</add> | |
135 | </field> | |
136 | <field> | |
137 | <name>weight</name> | |
138 | <type>int</type> | |
7ecddde4 | 139 | <title>Order</title> |
186e0984 EM |
140 | <required>true</required> |
141 | <default>1</default> | |
142 | <comment>Controls display order when multiple extended property groups are setup for the same class.</comment> | |
143 | <add>1.1</add> | |
144 | </field> | |
145 | <field> | |
146 | <name>is_active</name> | |
147 | <type>boolean</type> | |
56b7523d | 148 | <title>Custom Group Is Active?</title> |
186e0984 | 149 | <comment>Is this property active?</comment> |
c0c9c8bf | 150 | <default>1</default> |
c1e814c7 | 151 | <required>true</required> |
186e0984 EM |
152 | <add>1.1</add> |
153 | </field> | |
154 | <field> | |
155 | <name>table_name</name> | |
156 | <type>varchar</type> | |
157 | <length>255</length> | |
158 | <comment>Name of the table that holds the values for this group.</comment> | |
1662d426 A |
159 | <html> |
160 | <label>Table Name</label> | |
161 | </html> | |
88620a59 | 162 | <readonly>true</readonly> |
186e0984 EM |
163 | <add>2.0</add> |
164 | </field> | |
165 | <field> | |
166 | <name>is_multiple</name> | |
167 | <type>boolean</type> | |
56b7523d | 168 | <title>Supports Multiple Records</title> |
186e0984 | 169 | <comment>Does this group hold multiple values?</comment> |
c0c9c8bf | 170 | <default>0</default> |
c1e814c7 | 171 | <required>true</required> |
186e0984 EM |
172 | <add>2.0</add> |
173 | </field> | |
174 | <field> | |
175 | <name>min_multiple</name> | |
176 | <type>int unsigned</type> | |
56b7523d | 177 | <title>Minimum Multiple Records</title> |
186e0984 EM |
178 | <comment>minimum number of multiple records (typically 0?)</comment> |
179 | <add>2.2</add> | |
180 | </field> | |
181 | <field> | |
182 | <name>max_multiple</name> | |
183 | <type>int unsigned</type> | |
56b7523d | 184 | <title>Maximum Multiple Records</title> |
186e0984 EM |
185 | <comment>maximum number of multiple records, if 0 - no max</comment> |
186 | <add>2.2</add> | |
187 | </field> | |
188 | <field> | |
189 | <name>collapse_adv_display</name> | |
9752268e | 190 | <type>boolean</type> |
56b7523d | 191 | <title>Collapse Group Display</title> |
186e0984 | 192 | <default>0</default> |
c1e814c7 | 193 | <required>true</required> |
186e0984 EM |
194 | <comment>Will this group be in collapsed or expanded mode on advanced search display ?</comment> |
195 | <add>3.0</add> | |
6a488035 TO |
196 | </field> |
197 | <index> | |
198 | <name>UI_title_extends</name> | |
199 | <fieldName>title</fieldName> | |
200 | <fieldName>extends</fieldName> | |
201 | <unique>true</unique> | |
202 | <add>2.1</add> | |
203 | </index> | |
204 | <index> | |
79b6ac2b | 205 | <name>UI_name</name> |
6a488035 | 206 | <fieldName>name</fieldName> |
6a488035 | 207 | <unique>true</unique> |
79b6ac2b | 208 | <add>5.47</add> |
6a488035 TO |
209 | </index> |
210 | <field> | |
211 | <name>created_id</name> | |
212 | <type>int unsigned</type> | |
047c5009 | 213 | <title>Created By Contact ID</title> |
6a488035 | 214 | <comment>FK to civicrm_contact, who created this custom group</comment> |
57e94608 | 215 | <html> |
047c5009 | 216 | <label>Created By</label> |
57e94608 | 217 | </html> |
6a488035 TO |
218 | <add>3.0</add> |
219 | </field> | |
220 | <foreignKey> | |
221 | <name>created_id</name> | |
222 | <table>civicrm_contact</table> | |
223 | <key>id</key> | |
224 | <add>3.0</add> | |
225 | <onDelete>SET NULL</onDelete> | |
226 | </foreignKey> | |
227 | <field> | |
228 | <name>created_date</name> | |
229 | <type>datetime</type> | |
230 | <title>Custom Group Created Date</title> | |
231 | <comment>Date and time this custom group was created.</comment> | |
232 | <add>3.0</add> | |
233 | </field> | |
3c7d2158 | 234 | <field> |
d06700a7 RN |
235 | <name>is_reserved</name> |
236 | <type>boolean</type> | |
56b7523d | 237 | <title>Reserved Group?</title> |
d06700a7 | 238 | <default>0</default> |
c1e814c7 | 239 | <required>true</required> |
d06700a7 | 240 | <comment>Is this a reserved Custom Group?</comment> |
3c7d2158 | 241 | <add>4.4</add> |
242 | </field> | |
460931ca JP |
243 | <field> |
244 | <name>is_public</name> | |
245 | <type>boolean</type> | |
246 | <title>Custom Group Is Public?</title> | |
247 | <default>1</default> | |
c1e814c7 | 248 | <required>true</required> |
460931ca JP |
249 | <comment>Is this property public?</comment> |
250 | <add>4.7</add> | |
251 | </field> | |
2af06525 CW |
252 | <field> |
253 | <name>icon</name> | |
254 | <title>Icon</title> | |
255 | <type>varchar</type> | |
256 | <length>255</length> | |
257 | <default>NULL</default> | |
258 | <comment>crm-i icon class</comment> | |
259 | <add>5.28</add> | |
260 | </field> | |
6a488035 | 261 | </table> |