xml/schema/Core/UFGroup.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Core</base>
   5   <class>UFGroup</class>
   6   <name>civicrm_uf_group</name>
   7   <comment>User framework groups. Each group represents a form which encompasses a set of fields defined in civicrm_uf_fields table. Initially will be used for CiviCRM Profile form(s). Subsequently we anticipate using this to define other public facing forms (e.g. online donation solicitation forms, mailing list preferences, etc.).</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>is_active</name>
  23        <type>boolean</type>
  24        <default>1</default>
  25        <comment>Is this form currently active? If false, hide all related fields for all sharing contexts.</comment>
  26        <add>1.1</add>
  27   </field>
  28   <field>
  29        <name>group_type</name>
  30        <type>varchar</type>
  31        <length>255</length>
  32        <import>true</import>
  33        <comment>This column will store a comma separated list of the type(s) of profile fields.</comment>
  34        <pseudoconstant>
  35          <callback>CRM_Core_SelectValues::getProfileGroupType</callback>
  36        </pseudoconstant>
  37        <add>2.1</add>
  38   </field>
  39   <field>
  40        <name>form_type</name>
  41        <type>enum</type>
  42        <values>CiviCRM Profile</values>
  43        <comment>Type of form.</comment>
  44        <drop>2.1</drop>
  45   </field>
  46   <field>
  47        <name>title</name>
  48        <type>varchar</type>
  49        <length>64</length>
  50        <localizable>true</localizable>
  51       <required>true</required>
  52        <comment>Form title.</comment>
  53        <add>1.1</add>
  54   </field>
  55   <field>
  56        <name>description</name>
  57        <type>text</type>
  58        <title>Profile Description</title>
  59        <html>
  60          <type>TextArea</type>
  61          <rows>2</rows>
  62          <cols>60</cols>
  63        </html>
  64        <comment>Optional verbose description of the profile.</comment>
  65        <add>4.4</add>
  66   </field>
  67   <field>
  68      <name>collapse_display</name>
  69      <type>int unsigned</type>
  70      <default>0</default>
  71      <comment>Will this group be in collapsed or expanded mode on initial display ?</comment>
  72      <add>1.1</add>
  73      <drop>2.2</drop>
  74   </field>
  75   <field>
  76      <name>help_pre</name>
  77      <type>text</type>
  78      <localizable>true</localizable>
  79      <comment>Description and/or help text to display before fields in form.</comment>
  80      <html>
  81        <type>TextArea</type>
  82        <rows>4</rows>
  83        <cols>80</cols>
  84      </html>
  85      <add>1.2</add>
  86   </field>
  87   <field>
  88      <name>help_post</name>
  89      <type>text</type>
  90      <localizable>true</localizable>
  91      <comment>Description and/or help text to display after fields in form.</comment>
  92      <html>
  93        <type>TextArea</type>
  94        <rows>4</rows>
  95        <cols>80</cols>
  96      </html>
  97      <add>1.2</add>
  98   </field>
  99   <field>
 100       <name>weight</name>
 101       <type>int</type>
 102       <required>true</required>
 103       <default>1</default>
 104       <comment>Controls display order when multiple user framework groups are setup for concurrent display.</comment>
 105       <add>1.2</add>
 106       <drop>1.3</drop>
 107   </field>
 108   <field>
 109        <name>limit_listings_group_id</name>
 110        <type>int unsigned</type>
 111        <comment>Group id, foriegn key from civicrm_group</comment>
 112       <add>1.4</add>
 113   </field>
 114   <foreignKey>
 115        <name>limit_listings_group_id</name>
 116        <table>civicrm_group</table>
 117        <key>id</key>
 118        <add>1.4</add>
 119        <onDelete>SET NULL</onDelete>
 120   </foreignKey>
 121   <field>
 122        <name>post_URL</name>
 123        <type>varchar</type>
 124        <length>255</length>
 125        <comment>Redirect to URL.</comment>
 126        <add>1.4</add>
 127   </field>
 128   <field>
 129       <name>add_to_group_id</name>
 130       <type>int unsigned</type>
 131       <comment>foreign key to civicrm_group_id</comment>
 132   </field>
 133   <foreignKey>
 134        <name>add_to_group_id</name>
 135        <table>civicrm_group</table>
 136        <key>id</key>
 137        <onDelete>SET NULL</onDelete>
 138   </foreignKey>
 139    <field>
 140        <name>add_captcha</name>
 141        <type>boolean</type>
 142        <default>0</default>
 143        <comment>Should a CAPTCHA widget be included this Profile form.</comment>
 144        <add>1.1</add>
 145   </field>
 146   <field>
 147        <name>is_map</name>
 148        <type>boolean</type>
 149        <default>0</default>
 150        <comment>Do we want to map results from this profile.</comment>
 151        <add>1.5</add>
 152   </field>
 153   <field>
 154        <name>is_edit_link</name>
 155        <type>boolean</type>
 156        <default>0</default>
 157        <comment>Should edit link display in profile selector</comment>
 158        <add>1.6</add>
 159   </field>
 160   <field>
 161        <name>is_uf_link</name>
 162        <type>boolean</type>
 163        <default>0</default>
 164        <comment>Should we display a link to the website profile in profile selector</comment>
 165        <add>1.7</add>
 166   </field>
 167   <field>
 168        <name>is_update_dupe</name>
 169        <type>boolean</type>
 170        <default>0</default>
 171        <comment>Should we update the contact record if we find a duplicate</comment>
 172        <add>1.7</add>
 173   </field>
 174   <field>
 175        <name>cancel_URL</name>
 176        <type>varchar</type>
 177        <length>255</length>
 178        <comment>Redirect to URL when Cancle button clik .</comment>
 179        <add>1.4</add>
 180   </field>
 181   <field>
 182        <name>is_cms_user</name>
 183        <type>boolean</type>
 184        <default>0</default>
 185        <comment>Should we create a cms user for this profile </comment>
 186        <add>1.8</add>
 187   </field>
 188   <field>
 189        <name>notify</name>
 190        <type>text</type>
 191        <add>1.8</add>
 192   </field>
 193   <field>
 194     <name>is_reserved</name>
 195     <type>boolean</type>
 196     <comment>Is this group reserved for use by some other CiviCRM functionality?</comment>
 197     <add>3.0</add>
 198   </field>
 199   <field>
 200     <name>name</name>
 201     <type>varchar</type>
 202     <length>64</length>
 203     <comment>Name of the UF group for directly addressing it in the codebase</comment>
 204     <add>3.0</add>
 205   </field>
 206   <field>
 207     <name>created_id</name>
 208     <type>int unsigned</type>
 209     <comment>FK to civicrm_contact, who created this UF group</comment>
 210     <add>3.0</add>
 211   </field>
 212   <foreignKey>
 213     <name>created_id</name>
 214     <table>civicrm_contact</table>
 215     <key>id</key>
 216     <add>3.0</add>
 217     <onDelete>SET NULL</onDelete>
 218   </foreignKey>
 219   <field>
 220     <name>created_date</name>
 221     <type>datetime</type>
 222     <title>UF Group Created Date</title>
 223     <comment>Date and time this UF group was created.</comment>
 224     <add>3.0</add>
 225   </field>
 226   <field>
 227        <name>is_proximity_search</name>
 228        <type>boolean</type>
 229        <default>0</default>
 230        <comment>Should we include proximity search feature in this profile search form?</comment>
 231        <add>3.2</add>
 232   </field>
 233 </table>