xml/schema/Core/CustomGroup.xml

   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.
   8   </comment>
   9   <add>1.1</add>
  10   <log>true</log>
  11   <title>Custom Field Group</title>
  12   <labelField>title</labelField>
  13   <paths>
  14     <add>civicrm/admin/custom/group/edit?action=add&amp;reset=1</add>
  15     <update>civicrm/admin/custom/group/edit?action=update&amp;reset=1&amp;id=[id]</update>
  16     <preview>civicrm/admin/custom/group/preview?reset=1&amp;gid=[id]</preview>
  17     <delete>civicrm/admin/custom/group/delete?reset=1&amp;id=[id]</delete>
  18   </paths>
  19   <field>
  20     <name>id</name>
  21     <type>int unsigned</type>
  22     <title>Custom Group ID</title>
  23     <required>true</required>
  24     <comment>Unique Custom Group ID</comment>
  25     <html>
  26       <type>Number</type>
  27     </html>
  28     <add>1.1</add>
  29   </field>
  30   <primaryKey>
  31     <name>id</name>
  32     <autoincrement>true</autoincrement>
  33   </primaryKey>
  34   <field>
  35     <name>name</name>
  36     <type>varchar</type>
  37     <title>Custom Group Name</title>
  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>
  45     <title>Custom Group Title</title>
  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>
  55     <title>Custom Group Extends</title>
  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>
  60     <pseudoconstant>
  61       <callback>CRM_Core_BAO_CustomGroup::getCustomGroupExtendsOptions</callback>
  62     </pseudoconstant>
  63   </field>
  64   <field>
  65     <name>extends_entity_column_id</name>
  66     <type>int unsigned</type>
  67     <title>Custom Group Subtype List</title>
  68     <default>NULL</default>
  69     <comment>FK to civicrm_option_value.id (for option group custom_data_type.)</comment>
  70     <pseudoconstant>
  71       <optionGroupName>custom_data_type</optionGroupName>
  72     </pseudoconstant>
  73     <add>2.2</add>
  74     <html>
  75       <type>ChainSelect</type>
  76       <controlField>extends</controlField>
  77     </html>
  78   </field>
  79   <field>
  80     <name>extends_entity_column_value</name>
  81     <type>varchar</type>
  82     <title>Custom Group Subtype</title>
  83     <length>255</length>
  84     <comment>linking custom group for dynamic object</comment>
  85     <serialize>SEPARATOR_BOOKEND</serialize>
  86     <pseudoconstant>
  87       <callback>CRM_Core_BAO_CustomGroup::getExtendsEntityColumnValueOptions</callback>
  88     </pseudoconstant>
  89     <html>
  90       <type>ChainSelect</type>
  91       <controlField>extends_entity_column_id</controlField>
  92     </html>
  93     <add>1.6</add>
  94   </field>
  95   <field>
  96     <name>style</name>
  97     <type>varchar</type>
  98     <title>Custom Group Style</title>
  99     <length>15</length>
 100     <comment>Visual relationship between this form and its parent.</comment>
 101     <pseudoconstant>
 102       <callback>CRM_Core_SelectValues::customGroupStyle</callback>
 103     </pseudoconstant>
 104     <add>1.1</add>
 105     <html>
 106       <type>Select</type>
 107     </html>
 108   </field>
 109   <field>
 110     <name>collapse_display</name>
 111     <type>boolean</type>
 112     <title>Collapse Custom Group?</title>
 113     <default>0</default>
 114     <required>true</required>
 115     <comment>Will this group be in collapsed or expanded mode on initial display ?</comment>
 116     <add>1.1</add>
 117   </field>
 118   <field>
 119     <name>help_pre</name>
 120     <type>text</type>
 121     <title>Custom Group Pre Text</title>
 122     <localizable>true</localizable>
 123     <comment>Description and/or help text to display before fields in form.</comment>
 124     <html>
 125       <type>TextArea</type>
 126       <rows>4</rows>
 127       <cols>80</cols>
 128     </html>
 129     <add>1.1</add>
 130   </field>
 131   <field>
 132     <name>help_post</name>
 133     <type>text</type>
 134     <title>Custom Group Post Text</title>
 135     <localizable>true</localizable>
 136     <comment>Description and/or help text to display after fields in form.</comment>
 137     <html>
 138       <type>TextArea</type>
 139       <rows>4</rows>
 140       <cols>80</cols>
 141     </html>
 142     <add>1.1</add>
 143   </field>
 144   <field>
 145     <name>weight</name>
 146     <type>int</type>
 147     <title>Order</title>
 148     <required>true</required>
 149     <default>1</default>
 150     <comment>Controls display order when multiple extended property groups are setup for the same class.</comment>
 151     <add>1.1</add>
 152   </field>
 153   <field>
 154     <name>is_active</name>
 155     <type>boolean</type>
 156     <title>Custom Group Is Active?</title>
 157     <comment>Is this property active?</comment>
 158     <default>1</default>
 159     <required>true</required>
 160     <add>1.1</add>
 161   </field>
 162   <field>
 163     <name>table_name</name>
 164     <type>varchar</type>
 165     <length>255</length>
 166     <comment>Name of the table that holds the values for this group.</comment>
 167     <html>
 168       <label>Table Name</label>
 169     </html>
 170     <readonly>true</readonly>
 171     <add>2.0</add>
 172   </field>
 173   <field>
 174     <name>is_multiple</name>
 175     <type>boolean</type>
 176     <title>Supports Multiple Records</title>
 177     <comment>Does this group hold multiple values?</comment>
 178     <default>0</default>
 179     <required>true</required>
 180     <add>2.0</add>
 181   </field>
 182   <field>
 183     <name>min_multiple</name>
 184     <type>int unsigned</type>
 185     <title>Minimum Multiple Records</title>
 186     <comment>minimum number of multiple records (typically 0?)</comment>
 187     <add>2.2</add>
 188   </field>
 189   <field>
 190     <name>max_multiple</name>
 191     <type>int unsigned</type>
 192     <title>Maximum Multiple Records</title>
 193     <comment>maximum number of multiple records, if 0 - no max</comment>
 194     <add>2.2</add>
 195   </field>
 196   <field>
 197     <name>collapse_adv_display</name>
 198     <type>boolean</type>
 199     <title>Collapse Group Display</title>
 200     <default>0</default>
 201     <required>true</required>
 202     <comment>Will this group be in collapsed or expanded mode on advanced search display ?</comment>
 203     <add>3.0</add>
 204   </field>
 205   <index>
 206     <name>UI_title_extends</name>
 207     <fieldName>title</fieldName>
 208     <fieldName>extends</fieldName>
 209     <unique>true</unique>
 210     <add>2.1</add>
 211   </index>
 212   <index>
 213     <name>UI_name</name>
 214     <fieldName>name</fieldName>
 215     <unique>true</unique>
 216     <add>5.47</add>
 217   </index>
 218   <field>
 219     <name>created_id</name>
 220     <type>int unsigned</type>
 221     <title>Created By Contact ID</title>
 222     <comment>FK to civicrm_contact, who created this custom group</comment>
 223     <html>
 224       <label>Created By</label>
 225     </html>
 226     <add>3.0</add>
 227   </field>
 228   <foreignKey>
 229     <name>created_id</name>
 230     <table>civicrm_contact</table>
 231     <key>id</key>
 232     <add>3.0</add>
 233     <onDelete>SET NULL</onDelete>
 234   </foreignKey>
 235   <field>
 236     <name>created_date</name>
 237     <type>datetime</type>
 238     <title>Custom Group Created Date</title>
 239     <comment>Date and time this custom group was created.</comment>
 240     <add>3.0</add>
 241   </field>
 242   <field>
 243     <name>is_reserved</name>
 244     <type>boolean</type>
 245     <title>Reserved Group?</title>
 246     <default>0</default>
 247     <required>true</required>
 248     <comment>Is this a reserved Custom Group?</comment>
 249     <add>4.4</add>
 250   </field>
 251   <field>
 252     <name>is_public</name>
 253     <type>boolean</type>
 254     <title>Custom Group Is Public?</title>
 255     <default>1</default>
 256     <required>true</required>
 257     <comment>Is this property public?</comment>
 258     <add>4.7</add>
 259   </field>
 260   <field>
 261     <name>icon</name>
 262     <title>Icon</title>
 263     <type>varchar</type>
 264     <length>255</length>
 265     <default>NULL</default>
 266     <comment>crm-i icon class</comment>
 267     <add>5.28</add>
 268   </field>
 269 </table>