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     <comment>Is this form currently active? If false, hide all related fields for all sharing contexts.</comment>
  31     <add>1.1</add>
  32   </field>
  33   <field>
  34     <name>group_type</name>
  35     <title>Profile Group Type</title>
  36     <type>varchar</type>
  37     <length>255</length>
  38     <import>true</import>
  39     <comment>Comma separated list of the type(s) of profile fields.</comment>
  40     <serialize>COMMA</serialize>
  41     <add>2.1</add>
  42   </field>
  43   <field>
  44     <name>title</name>
  45     <title>Profile Name</title>
  46     <type>varchar</type>
  47     <length>64</length>
  48     <localizable>true</localizable>
  49     <required>true</required>
  50     <html>
  51       <type>Text</type>
  52     </html>
  53     <comment>Form title.</comment>
  54     <add>1.1</add>
  55   </field>
  56   <field>
  57     <name>frontend_title</name>
  58     <title>Public Title</title>
  59     <type>varchar</type>
  60     <length>64</length>
  61     <localizable>true</localizable>
  62     <comment>Profile Form Public title</comment>
  63     <html>
  64       <type>Text</type>
  65     </html>
  66     <add>4.7</add>
  67   </field>
  68   <field>
  69     <name>description</name>
  70     <type>text</type>
  71     <title>Profile Description</title>
  72     <html>
  73       <type>TextArea</type>
  74       <rows>2</rows>
  75       <cols>60</cols>
  76     </html>
  77     <comment>Optional verbose description of the profile.</comment>
  78     <add>4.4</add>
  79   </field>
  80   <field>
  81     <name>help_pre</name>
  82     <type>text</type>
  83     <localizable>true</localizable>
  84     <comment>Description and/or help text to display before fields in form.</comment>
  85     <html>
  86       <type>TextArea</type>
  87       <rows>4</rows>
  88       <cols>80</cols>
  89     </html>
  90     <add>1.2</add>
  91   </field>
  92   <field>
  93     <name>help_post</name>
  94     <title>Profile Post Text</title>
  95     <type>text</type>
  96     <localizable>true</localizable>
  97     <comment>Description and/or help text to display after fields in form.</comment>
  98     <html>
  99       <type>TextArea</type>
 100       <rows>4</rows>
 101       <cols>80</cols>
 102     </html>
 103     <add>1.2</add>
 104   </field>
 105   <field>
 106     <name>limit_listings_group_id</name>
 107     <title>Search Limit Group ID</title>
 108     <type>int unsigned</type>
 109     <comment>Group id, foreign key from civicrm_group</comment>
 110     <html>
 111       <label>Search Limit Group</label>
 112     </html>
 113     <add>1.4</add>
 114   </field>
 115   <foreignKey>
 116     <name>limit_listings_group_id</name>
 117     <table>civicrm_group</table>
 118     <key>id</key>
 119     <add>1.4</add>
 120     <onDelete>SET NULL</onDelete>
 121   </foreignKey>
 122   <field>
 123     <name>post_URL</name>
 124     <type>varchar</type>
 125     <length>255</length>
 126     <comment>Redirect to URL.</comment>
 127     <add>1.4</add>
 128   </field>
 129   <field>
 130     <name>add_to_group_id</name>
 131     <title>Add Contact To Group ID</title>
 132     <type>int unsigned</type>
 133     <comment>foreign key to civicrm_group_id</comment>
 134     <html>
 135       <label>Add Contact To Group</label>
 136     </html>
 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>Created By Contact ID</title>
 230     <type>int unsigned</type>
 231     <comment>FK to civicrm_contact, who created this UF group</comment>
 232     <html>
 233       <label>Created By</label>
 234     </html>
 235     <add>3.0</add>
 236   </field>
 237   <foreignKey>
 238     <name>created_id</name>
 239     <table>civicrm_contact</table>
 240     <key>id</key>
 241     <add>3.0</add>
 242     <onDelete>SET NULL</onDelete>
 243   </foreignKey>
 244   <field>
 245     <name>created_date</name>
 246     <type>datetime</type>
 247     <title>UF Group Created Date</title>
 248     <comment>Date and time this UF group was created.</comment>
 249     <add>3.0</add>
 250   </field>
 251   <field>
 252     <name>is_proximity_search</name>
 253     <title>Include Proximity Search?</title>
 254     <type>boolean</type>
 255     <default>0</default>
 256     <comment>Should we include proximity search feature in this profile search form?</comment>
 257     <add>3.2</add>
 258   </field>
 259   <field>
 260     <name>cancel_button_text</name>
 261     <title>Cancel Button Text</title>
 262     <type>varchar</type>
 263     <length>64</length>
 264     <comment>Custom Text to display on the Cancel button when used in create or edit mode</comment>
 265     <default>NULL</default>
 266     <localizable>true</localizable>
 267     <add>4.7</add>
 268     <html>
 269       <type>Text</type>
 270     </html>
 271   </field>
 272   <field>
 273     <name>submit_button_text</name>
 274     <title>Submit Button Text</title>
 275     <type>varchar</type>
 276     <length>64</length>
 277     <comment>Custom Text to display on the submit button on profile edit/create screens</comment>
 278     <default>NULL</default>
 279     <localizable>true</localizable>
 280     <add>4.7</add>
 281     <html>
 282       <type>Text</type>
 283     </html>
 284   </field>
 285   <field>
 286     <name>add_cancel_button</name>
 287     <title>Include Cancel Button</title>
 288     <type>boolean</type>
 289     <default>1</default>
 290     <comment>Should a Cancel button be included in this Profile form.</comment>
 291     <add>5.0</add>
 292   </field>
 293 </table>