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     <title>Profile ID</title>
  13     <type>int unsigned</type>
  14     <required>true</required>
  15     <comment>Unique table ID</comment>
  16     <add>1.1</add>
  17   </field>
  18   <primaryKey>
  19     <name>id</name>
  20     <autoincrement>true</autoincrement>
  21   </primaryKey>
  22   <field>
  23     <name>is_active</name>
  24     <title>Profile Is Active</title>
  25     <type>boolean</type>
  26     <default>1</default>
  27     <comment>Is this form currently active? If false, hide all related fields for all sharing contexts.</comment>
  28     <add>1.1</add>
  29   </field>
  30   <field>
  31     <name>group_type</name>
  32     <title>Profile Group Type</title>
  33     <type>varchar</type>
  34     <length>255</length>
  35     <import>true</import>
  36     <comment>Comma separated list of the type(s) of profile fields.</comment>
  37     <serialize>COMMA</serialize>
  38     <add>2.1</add>
  39   </field>
  40   <field>
  41     <name>form_type</name>
  42     <type>enum</type>
  43     <values>CiviCRM Profile</values>
  44     <comment>Type of form.</comment>
  45     <drop>2.1</drop>
  46   </field>
  47   <field>
  48     <name>title</name>
  49     <type>varchar</type>
  50     <length>64</length>
  51     <localizable>true</localizable>
  52     <required>true</required>
  53     <comment>Form title.</comment>
  54     <add>1.1</add>
  55   </field>
  56   <field>
  57     <name>description</name>
  58     <type>text</type>
  59     <title>Profile Description</title>
  60     <html>
  61       <type>TextArea</type>
  62       <rows>2</rows>
  63       <cols>60</cols>
  64     </html>
  65     <comment>Optional verbose description of the profile.</comment>
  66     <add>4.4</add>
  67   </field>
  68   <field>
  69     <name>collapse_display</name>
  70     <type>int unsigned</type>
  71     <default>0</default>
  72     <comment>Will this group be in collapsed or expanded mode on initial display ?</comment>
  73     <add>1.1</add>
  74     <drop>2.2</drop>
  75   </field>
  76   <field>
  77     <name>help_pre</name>
  78     <type>text</type>
  79     <localizable>true</localizable>
  80     <comment>Description and/or help text to display before fields in form.</comment>
  81     <html>
  82       <type>TextArea</type>
  83       <rows>4</rows>
  84       <cols>80</cols>
  85     </html>
  86     <add>1.2</add>
  87   </field>
  88   <field>
  89     <name>help_post</name>
  90     <title>Profile Post Text</title>
  91     <type>text</type>
  92     <localizable>true</localizable>
  93     <comment>Description and/or help text to display after fields in form.</comment>
  94     <html>
  95       <type>TextArea</type>
  96       <rows>4</rows>
  97       <cols>80</cols>
  98     </html>
  99     <add>1.2</add>
 100   </field>
 101   <field>
 102     <name>weight</name>
 103     <title>Profile Weight</title>
 104     <type>int</type>
 105     <required>true</required>
 106     <default>1</default>
 107     <comment>Controls display order when multiple user framework groups are setup for concurrent display.</comment>
 108     <add>1.2</add>
 109     <drop>1.3</drop>
 110   </field>
 111   <field>
 112     <name>limit_listings_group_id</name>
 113     <title>Profile Search Limit Group</title>
 114     <type>int unsigned</type>
 115     <comment>Group id, foreign key from civicrm_group</comment>
 116     <add>1.4</add>
 117   </field>
 118   <foreignKey>
 119     <name>limit_listings_group_id</name>
 120     <table>civicrm_group</table>
 121     <key>id</key>
 122     <add>1.4</add>
 123     <onDelete>SET NULL</onDelete>
 124   </foreignKey>
 125   <field>
 126     <name>post_URL</name>
 127     <type>varchar</type>
 128     <length>255</length>
 129     <comment>Redirect to URL.</comment>
 130     <add>1.4</add>
 131   </field>
 132   <field>
 133     <name>add_to_group_id</name>
 134     <title>Add Contact To Group</title>
 135     <type>int unsigned</type>
 136     <comment>foreign key to civicrm_group_id</comment>
 137   </field>
 138   <foreignKey>
 139     <name>add_to_group_id</name>
 140     <table>civicrm_group</table>
 141     <key>id</key>
 142     <onDelete>SET NULL</onDelete>
 143   </foreignKey>
 144   <field>
 145     <name>add_captcha</name>
 146     <title>Show Captcha On Profile</title>
 147     <type>boolean</type>
 148     <default>0</default>
 149     <comment>Should a CAPTCHA widget be included this Profile form.</comment>
 150     <add>1.1</add>
 151   </field>
 152   <field>
 153     <name>is_map</name>
 154     <title>Map Profile</title>
 155     <type>boolean</type>
 156     <default>0</default>
 157     <comment>Do we want to map results from this profile.</comment>
 158     <add>1.5</add>
 159   </field>
 160   <field>
 161     <name>is_edit_link</name>
 162     <title>Show Edit Link?</title>
 163     <type>boolean</type>
 164     <default>0</default>
 165     <comment>Should edit link display in profile selector</comment>
 166     <add>1.6</add>
 167   </field>
 168   <field>
 169     <name>is_uf_link</name>
 170     <title>Show Link to CMS User</title>
 171     <type>boolean</type>
 172     <default>0</default>
 173     <comment>Should we display a link to the website profile in profile selector</comment>
 174     <add>1.7</add>
 175   </field>
 176   <field>
 177     <name>is_update_dupe</name>
 178     <title>Update on Duplicate</title>
 179     <type>boolean</type>
 180     <default>0</default>
 181     <comment>Should we update the contact record if we find a duplicate</comment>
 182     <add>1.7</add>
 183   </field>
 184   <field>
 185     <name>cancel_URL</name>
 186     <title>Profile Cancel URL</title>
 187     <type>varchar</type>
 188     <length>255</length>
 189     <comment>Redirect to URL when Cancle button clik .</comment>
 190     <add>1.4</add>
 191   </field>
 192   <field>
 193     <name>is_cms_user</name>
 194     <title>Create CMS User?</title>
 195     <type>boolean</type>
 196     <default>0</default>
 197     <comment>Should we create a cms user for this profile </comment>
 198     <add>1.8</add>
 199   </field>
 200   <field>
 201     <name>notify</name>
 202     <title>Notify on Profile Submit</title>
 203     <type>text</type>
 204     <add>1.8</add>
 205   </field>
 206   <field>
 207     <name>is_reserved</name>
 208     <title>Profile Is Reserved</title>
 209     <type>boolean</type>
 210     <comment>Is this group reserved for use by some other CiviCRM functionality?</comment>
 211     <add>3.0</add>
 212   </field>
 213   <field>
 214     <name>name</name>
 215     <title>Profile Name</title>
 216     <type>varchar</type>
 217     <length>64</length>
 218     <comment>Name of the UF group for directly addressing it in the codebase</comment>
 219     <add>3.0</add>
 220   </field>
 221   <index>
 222     <name>UI_name</name>
 223     <fieldName>name</fieldName>
 224     <unique>true</unique>
 225     <add>4.7</add>
 226   </index>
 227   <field>
 228     <name>created_id</name>
 229     <title>Profile Created By</title>
 230     <type>int unsigned</type>
 231     <comment>FK to civicrm_contact, who created this UF group</comment>
 232     <add>3.0</add>
 233   </field>
 234   <foreignKey>
 235     <name>created_id</name>
 236     <table>civicrm_contact</table>
 237     <key>id</key>
 238     <add>3.0</add>
 239     <onDelete>SET NULL</onDelete>
 240   </foreignKey>
 241   <field>
 242     <name>created_date</name>
 243     <type>datetime</type>
 244     <title>UF Group Created Date</title>
 245     <comment>Date and time this UF group was created.</comment>
 246     <add>3.0</add>
 247   </field>
 248   <field>
 249     <name>is_proximity_search</name>
 250     <title>Include Proximity Search?</title>
 251     <type>boolean</type>
 252     <default>0</default>
 253     <comment>Should we include proximity search feature in this profile search form?</comment>
 254     <add>3.2</add>
 255   </field>
 256   <field>
 257     <name>cancel_button_text</name>
 258     <title>Cancel Button Text</title>
 259     <type>varchar</type>
 260     <length>64</length>
 261     <comment>Custom Text to display on the Cancel button when used in create or edit mode</comment>
 262     <default>NULL</default>
 263     <localizable>true</localizable>
 264     <add>4.7</add>
 265   </field>
 266   <field>
 267     <name>submit_button_text</name>
 268     <title>Submit Button Text</title>
 269     <type>varchar</type>
 270     <length>64</length>
 271     <comment>Custom Text to display on the submit button on profile edit/create screens</comment>
 272     <default>NULL</default>
 273     <localizable>true</localizable>
 274     <add>4.7</add>
 275   </field>
 276 </table>