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