xml/schema/Core/OptionGroup.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Core</base>
   5   <class>OptionGroup</class>
   6   <name>civicrm_option_group</name>
   7   <add>1.5</add>
   8   <log>true</log>
   9   <field>
  10     <name>id</name>
  11     <title>Option Group ID</title>
  12     <type>int unsigned</type>
  13     <required>true</required>
  14     <comment>Option Group ID</comment>
  15     <html>
  16       <type>Number</type>
  17     </html>
  18     <add>1.5</add>
  19   </field>
  20   <primaryKey>
  21     <name>id</name>
  22     <autoincrement>true</autoincrement>
  23   </primaryKey>
  24   <field>
  25     <name>name</name>
  26     <title>Option Group Name</title>
  27     <type>varchar</type>
  28     <length>64</length>
  29     <required>true</required>
  30     <comment>Option group name. Used as selection key by class properties which lookup options in civicrm_option_value.</comment>
  31     <add>1.5</add>
  32   </field>
  33   <field>
  34     <name>title</name>
  35     <title>Option Group title</title>
  36     <type>varchar</type>
  37     <length>255</length>
  38     <localizable>true</localizable>
  39     <comment>Option Group title.</comment>
  40     <add>1.5</add>
  41   </field>
  42   <field>
  43     <name>description</name>
  44     <title>Option Group Description</title>
  45     <type>varchar</type>
  46     <length>255</length>
  47     <localizable>true</localizable>
  48     <comment>Option group description.</comment>
  49     <add>1.5</add>
  50   </field>
  51   <field>
  52     <name>data_type</name>
  53     <title>Data Type</title>
  54     <type>varchar</type>
  55     <length>128</length>
  56     <comment>Type of data stored by this option group.</comment>
  57     <pseudoconstant>
  58       <callback>CRM_Utils_Type::dataTypes</callback>
  59     </pseudoconstant>
  60     <add>4.7</add>
  61   </field>
  62   <field>
  63     <name>is_reserved</name>
  64     <title>Option Group Is Reserved?</title>
  65     <type>boolean</type>
  66     <default>1</default>
  67     <required>true</required>
  68     <comment>Is this a predefined system option group (i.e. it can not be deleted)?</comment>
  69     <add>1.5</add>
  70   </field>
  71   <field>
  72     <name>is_active</name>
  73     <title>Option Group Is Active?</title>
  74     <type>boolean</type>
  75     <default>1</default>
  76     <required>true</required>
  77     <comment>Is this option group active?</comment>
  78     <add>1.5</add>
  79   </field>
  80   <field>
  81     <name>is_locked</name>
  82     <title>Option Group Is Locked</title>
  83     <default>0</default>
  84     <type>boolean</type>
  85     <required>true</required>
  86     <comment>A lock to remove the ability to add new options via the UI.</comment>
  87     <add>4.5</add>
  88   </field>
  89   <field>
  90     <name>option_value_fields</name>
  91     <title>Option Value Fields</title>
  92     <type>varchar</type>
  93     <length>128</length>
  94     <default>"name,label,description"</default>
  95     <comment>Which optional columns from the option_value table are in use by this group.</comment>
  96     <pseudoconstant>
  97       <callback>CRM_Core_SelectValues::optionValueFields</callback>
  98     </pseudoconstant>
  99     <serialize>COMMA</serialize>
 100     <add>5.49</add>
 101   </field>
 102   <index>
 103     <name>UI_name</name>
 104     <fieldName>name</fieldName>
 105     <unique>true</unique>
 106     <add>2.1</add>
 107   </index>
 108 </table>