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