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