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