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