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