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