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