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