xml/schema/Core/UFField.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Core</base>
   5   <class>UFField</class>
   6   <name>civicrm_uf_field</name>
   7   <comment>User Framework fields and their properties.</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 table 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>uf_group_id</name>
  23       <type>int unsigned</type>
  24       <required>true</required>
  25       <comment>Which form does this field belong to.</comment>
  26       <add>1.1</add>
  27   </field>
  28   <foreignKey>
  29        <name>uf_group_id</name>
  30        <table>civicrm_uf_group</table>
  31        <key>id</key>
  32        <add>1.1</add>
  33        <onDelete>CASCADE</onDelete>
  34   </foreignKey>
  35   <field>
  36        <name>field_name</name>
  37        <type>varchar</type>
  38        <length>64</length>
  39        <required>true</required>
  40        <comment>Name for CiviCRM field which is being exposed for sharing.</comment>
  41        <add>1.1</add>
  42   </field>
  43   <field>
  44        <name>is_active</name>
  45        <type>boolean</type>
  46        <default>1</default>
  47        <comment>Is this field currently shareable? If false, hide the field for all sharing contexts.</comment>
  48        <add>1.1</add>
  49   </field>
  50   <field>
  51        <name>is_view</name>
  52        <type>boolean</type>
  53        <default>0</default>
  54        <comment>the field is view only and not editable in user forms.</comment>
  55        <add>1.1</add>
  56   </field>
  57   <field>
  58        <name>is_required</name>
  59        <type>boolean</type>
  60         <default>0</default>
  61        <comment>Is this field required when included in a user or registration form?</comment>
  62        <add>1.1</add>
  63   </field>
  64   <field>
  65       <name>weight</name>
  66       <type>int</type>
  67       <required>true</required>
  68       <default>1</default>
  69       <comment>Controls field display order when user framework fields are displayed in registration and account editing forms.</comment>
  70       <add>1.1</add>
  71   </field>
  72   <field>
  73      <name>help_post</name>
  74      <type>text</type>
  75      <localizable>true</localizable>
  76      <comment>Description and/or help text to display after this field.</comment>
  77      <add>1.1</add>
  78   </field>
  79   <field>
  80      <name>help_pre</name>
  81      <type>text</type>
  82      <localizable>true</localizable>
  83      <comment>Description and/or help text to display before this field.</comment>
  84      <add>3.2</add>
  85   </field>
  86   <field>
  87        <name>is_registration</name>
  88        <type>boolean</type>
  89        <default>0</default>
  90        <comment>Is this field included in new user registration forms?</comment>
  91        <add>1.1</add>
  92        <drop>1.3</drop>
  93   </field>
  94   <field>
  95        <name>is_match</name>
  96        <type>boolean</type>
  97        <default>0</default>
  98        <comment>Is this field part of the key for matching users to contacts?</comment>
  99        <add>1.1</add>
 100        <drop>1.3</drop>
 101   </field>
 102   <field>
 103        <name>visibility</name>
 104        <type>enum</type>
 105        <values>User and User Admin Only,Public Pages,Public Pages and Listings</values>
 106        <default>'User and User Admin Only'</default>
 107        <comment>In what context(s) is this field visible.</comment>
 108        <add>1.1</add>
 109   </field>
 110   <field>
 111        <name>listings_title</name>
 112        <type>varchar</type>
 113        <length>64</length>
 114        <comment>Page title for listings page (users who share a common value for this property).</comment>
 115        <add>1.1</add>
 116        <drop>1.2</drop>
 117   </field>
 118   <field>
 119        <name>in_selector</name>
 120        <type>boolean</type>
 121        <default>0</default>
 122        <comment>Is this field included as a column in the selector table?</comment>
 123        <add>1.2</add>
 124   </field>
 125   <field>
 126        <name>is_searchable</name>
 127        <type>boolean</type>
 128        <default>0</default>
 129        <comment>Is this field included search form of profile?</comment>
 130        <add>1.4</add>
 131   </field>
 132   <field>
 133        <name>location_type_id</name>
 134        <type>int unsigned</type>
 135        <comment>Location type of this mapping, if required</comment>
 136       <add>1.3</add>
 137   </field>
 138   <foreignKey>
 139        <name>location_type_id</name>
 140        <table>civicrm_location_type</table>
 141        <key>id</key>
 142        <add>1.3</add>
 143        <onDelete>SET NULL</onDelete>
 144   </foreignKey>
 145   <field>
 146        <name>phone_type</name>
 147        <type>varchar</type>
 148        <length>64</length>
 149        <comment>Phone type, if required</comment>
 150        <add>1.3</add>
 151        <drop>2.2</drop>
 152   </field>
 153   <field>
 154        <name>phone_type_id</name>
 155        <type>int unsigned</type>
 156        <comment>Phone Type Id, if required</comment>
 157        <add>2.2</add>
 158   </field>
 159   <field>
 160        <name>label</name>
 161        <type>varchar</type>
 162        <length>255</length>
 163        <required>true</required>
 164        <localizable>true</localizable>
 165        <comment>To save label for fields.</comment>
 166       <add>1.4</add>
 167   </field>
 168   <field>
 169        <name>field_type</name>
 170        <type>varchar</type>
 171        <length>255</length>
 172        <comment>This field saves field type (ie individual,household.. field etc).</comment>
 173       <add>1.4</add>
 174   </field>
 175   <field>
 176     <name>is_reserved</name>
 177     <type>boolean</type>
 178     <comment>Is this field reserved for use by some other CiviCRM functionality?</comment>
 179     <add>3.0</add>
 180   </field>
 181   <field>
 182     <name>is_multi_summary</name>
 183     <type>boolean</type>
 184     <default>0</default>
 185     <comment>Include in multi-record listing?</comment>
 186     <add>4.3</add>
 187   </field>
 188 </table>