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