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