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.</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>
  67   <field>
  68      <name>style</name>
  69      <type>varchar</type>
  70      <length>15</length>
  71      <comment>Visual relationship between this form and its parent.</comment>
  72      <pseudoconstant>
  73        <callback>CRM_Core_SelectValues::customGroupStyle</callback>
  74      </pseudoconstant>
  75        <add>1.1</add>
  76        <html>
  77          <type>Select</type>
  78        </html>
  79   </field>
  80   <field>
  81      <name>collapse_display</name>
  82      <type>int unsigned</type>
  83      <default>0</default>
  84      <comment>Will this group be in collapsed or expanded mode on initial display ?</comment>
  85        <add>1.1</add>
  86   </field>
  87   <field>
  88      <name>help_pre</name>
  89      <type>text</type>
  90      <localizable>true</localizable>
  91      <comment>Description and/or help text to display before fields in form.</comment>
  92      <html>
  93        <type>TextArea</type>
  94        <rows>4</rows>
  95        <cols>80</cols>
  96      </html>
  97      <add>1.1</add>
  98   </field>
  99   <field>
 100      <name>help_post</name>
 101      <type>text</type>
 102      <localizable>true</localizable>
 103      <comment>Description and/or help text to display after fields in form.</comment>
 104      <html>
 105        <type>TextArea</type>
 106        <rows>4</rows>
 107        <cols>80</cols>
 108      </html>
 109      <add>1.1</add>
 110   </field>
 111   <field>
 112       <name>weight</name>
 113       <type>int</type>
 114       <required>true</required>
 115       <default>1</default>
 116       <comment>Controls display order when multiple extended property groups are setup for the same class.</comment>
 117        <add>1.1</add>
 118   </field>
 119   <field>
 120        <name>is_active</name>
 121        <type>boolean</type>
 122        <comment>Is this property active?</comment>
 123        <add>1.1</add>
 124   </field>
 125   <field>
 126      <name>table_name</name>
 127      <type>varchar</type>
 128      <length>255</length>
 129      <comment>Name of the table that holds the values for this group.</comment>
 130      <add>2.0</add>
 131   </field>
 132   <field>
 133        <name>is_multiple</name>
 134        <type>boolean</type>
 135        <comment>Does this group hold multiple values?</comment>
 136        <add>2.0</add>
 137   </field>
 138   <field>
 139        <name>min_multiple</name>
 140        <type>int unsigned</type>
 141        <comment>minimum number of multiple records (typically 0?)</comment>
 142        <add>2.2</add>
 143   </field>
 144   <field>
 145        <name>max_multiple</name>
 146        <type>int unsigned</type>
 147        <comment>maximum number of multiple records, if 0 - no max</comment>
 148        <add>2.2</add>
 149   </field>
 150   <field>
 151      <name>collapse_adv_display</name>
 152      <type>int unsigned</type>
 153      <default>0</default>
 154      <comment>Will this group be in collapsed or expanded mode on advanced search display ?</comment>
 155        <add>3.0</add>
 156   </field>
 157   <index>
 158     <name>UI_title_extends</name>
 159     <fieldName>title</fieldName>
 160     <fieldName>extends</fieldName>
 161     <unique>true</unique>
 162     <add>2.1</add>
 163   </index>
 164   <index>
 165     <name>UI_name_extends</name>
 166     <fieldName>name</fieldName>
 167     <fieldName>extends</fieldName>
 168     <unique>true</unique>
 169     <add>2.1</add>
 170   </index>
 171   <field>
 172     <name>created_id</name>
 173     <type>int unsigned</type>
 174     <comment>FK to civicrm_contact, who created this custom group</comment>
 175     <add>3.0</add>
 176   </field>
 177   <foreignKey>
 178     <name>created_id</name>
 179     <table>civicrm_contact</table>
 180     <key>id</key>
 181     <add>3.0</add>
 182     <onDelete>SET NULL</onDelete>
 183   </foreignKey>
 184   <field>
 185     <name>created_date</name>
 186     <type>datetime</type>
 187     <title>Custom Group Created Date</title>
 188     <comment>Date and time this custom group was created.</comment>
 189     <add>3.0</add>
 190   </field>
 191   <field>
 192     <name>is_reserved</name>
 193     <type>boolean</type>
 194     <default>0</default>
 195     <comment>Is this a reserved Custom Group?</comment>
 196     <add>4.4</add>
 197   </field>
 198 </table>
 199
 200