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>This column will store a comma separated list of the type(s) of profile fields.</comment>
  37     <add>2.1</add>
  38   </field>
  39   <field>
  40     <name>form_type</name>
  41     <type>enum</type>
  42     <values>CiviCRM Profile</values>
  43     <comment>Type of form.</comment>
  44     <drop>2.1</drop>
  45   </field>
  46   <field>
  47     <name>title</name>
  48     <type>varchar</type>
  49     <length>64</length>
  50     <localizable>true</localizable>
  51     <required>true</required>
  52     <comment>Form title.</comment>
  53     <add>1.1</add>
  54   </field>
  55   <field>
  56     <name>description</name>
  57     <type>text</type>
  58     <title>Profile Description</title>
  59     <html>
  60       <type>TextArea</type>
  61       <rows>2</rows>
  62       <cols>60</cols>
  63     </html>
  64     <comment>Optional verbose description of the profile.</comment>
  65     <add>4.4</add>
  66   </field>
  67   <field>
  68     <name>collapse_display</name>
  69     <type>int unsigned</type>
  70     <default>0</default>
  71     <comment>Will this group be in collapsed or expanded mode on initial display ?</comment>
  72     <add>1.1</add>
  73     <drop>2.2</drop>
  74   </field>
  75   <field>
  76     <name>help_pre</name>
  77     <type>text</type>
  78     <localizable>true</localizable>
  79     <comment>Description and/or help text to display before fields in form.</comment>
  80     <html>
  81       <type>TextArea</type>
  82       <rows>4</rows>
  83       <cols>80</cols>
  84     </html>
  85     <add>1.2</add>
  86   </field>
  87   <field>
  88     <name>help_post</name>
  89     <title>Profile Post Text</title>
  90     <type>text</type>
  91     <localizable>true</localizable>
  92     <comment>Description and/or help text to display after fields in form.</comment>
  93     <html>
  94       <type>TextArea</type>
  95       <rows>4</rows>
  96       <cols>80</cols>
  97     </html>
  98     <add>1.2</add>
  99   </field>
 100   <field>
 101     <name>weight</name>
 102     <title>Profile Weight</title>
 103     <type>int</type>
 104     <required>true</required>
 105     <default>1</default>
 106     <comment>Controls display order when multiple user framework groups are setup for concurrent display.</comment>
 107     <add>1.2</add>
 108     <drop>1.3</drop>
 109   </field>
 110   <field>
 111     <name>limit_listings_group_id</name>
 112     <title>Profile Search Limit Group</title>
 113     <type>int unsigned</type>
 114     <comment>Group id, foriegn key from civicrm_group</comment>
 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     <add>1.4</add>
 130   </field>
 131   <field>
 132     <name>add_to_group_id</name>
 133     <title>Add Contact To Group</title>
 134     <type>int unsigned</type>
 135     <comment>foreign key to civicrm_group_id</comment>
 136   </field>
 137   <foreignKey>
 138     <name>add_to_group_id</name>
 139     <table>civicrm_group</table>
 140     <key>id</key>
 141     <onDelete>SET NULL</onDelete>
 142   </foreignKey>
 143   <field>
 144     <name>add_captcha</name>
 145     <title>Show Captcha On Profile</title>
 146     <type>boolean</type>
 147     <default>0</default>
 148     <comment>Should a CAPTCHA widget be included this Profile form.</comment>
 149     <add>1.1</add>
 150   </field>
 151   <field>
 152     <name>is_map</name>
 153     <title>Map Profile</title>
 154     <type>boolean</type>
 155     <default>0</default>
 156     <comment>Do we want to map results from this profile.</comment>
 157     <add>1.5</add>
 158   </field>
 159   <field>
 160     <name>is_edit_link</name>
 161     <title>Show Edit Link?</title>
 162     <type>boolean</type>
 163     <default>0</default>
 164     <comment>Should edit link display in profile selector</comment>
 165     <add>1.6</add>
 166   </field>
 167   <field>
 168     <name>is_uf_link</name>
 169     <title>Show Link to CMS User</title>
 170     <type>boolean</type>
 171     <default>0</default>
 172     <comment>Should we display a link to the website profile in profile selector</comment>
 173     <add>1.7</add>
 174   </field>
 175   <field>
 176     <name>is_update_dupe</name>
 177     <title>Update on Duplicate</title>
 178     <type>boolean</type>
 179     <default>0</default>
 180     <comment>Should we update the contact record if we find a duplicate</comment>
 181     <add>1.7</add>
 182   </field>
 183   <field>
 184     <name>cancel_URL</name>
 185     <title>Profile Cancel URL</title>
 186     <type>varchar</type>
 187     <length>255</length>
 188     <comment>Redirect to URL when Cancle button clik .</comment>
 189     <add>1.4</add>
 190   </field>
 191   <field>
 192     <name>is_cms_user</name>
 193     <title>Create CMS User?</title>
 194     <type>boolean</type>
 195     <default>0</default>
 196     <comment>Should we create a cms user for this profile </comment>
 197     <add>1.8</add>
 198   </field>
 199   <field>
 200     <name>notify</name>
 201     <title>Notify on Profile Submit</title>
 202     <type>text</type>
 203     <add>1.8</add>
 204   </field>
 205   <field>
 206     <name>is_reserved</name>
 207     <title>Profile Is Reserved</title>
 208     <type>boolean</type>
 209     <comment>Is this group reserved for use by some other CiviCRM functionality?</comment>
 210     <add>3.0</add>
 211   </field>
 212   <field>
 213     <name>name</name>
 214     <title>Profile Name</title>
 215     <type>varchar</type>
 216     <length>64</length>
 217     <comment>Name of the UF group for directly addressing it in the codebase</comment>
 218     <add>3.0</add>
 219   </field>
 220   <field>
 221     <name>created_id</name>
 222     <title>Profile Created By</title>
 223     <type>int unsigned</type>
 224     <comment>FK to civicrm_contact, who created this UF group</comment>
 225     <add>3.0</add>
 226   </field>
 227   <foreignKey>
 228     <name>created_id</name>
 229     <table>civicrm_contact</table>
 230     <key>id</key>
 231     <add>3.0</add>
 232     <onDelete>SET NULL</onDelete>
 233   </foreignKey>
 234   <field>
 235     <name>created_date</name>
 236     <type>datetime</type>
 237     <title>UF Group Created Date</title>
 238     <comment>Date and time this UF group was created.</comment>
 239     <add>3.0</add>
 240   </field>
 241   <field>
 242     <name>is_proximity_search</name>
 243     <title>Include Proximity Search?</title>
 244     <type>boolean</type>
 245     <default>0</default>
 246     <comment>Should we include proximity search feature in this profile search form?</comment>
 247     <add>3.2</add>
 248   </field>
 249 </table>