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