xml/schema/Campaign/Survey.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2 <table>
   3   <base>CRM/Campaign</base>
   4   <class>Survey</class>
   5   <name>civicrm_survey</name>
   6   <comment>Campaign Survey Details.</comment>
   7   <add>3.2</add>
   8   <icon>fa-clipboard</icon>
   9   <labelField>title</labelField>
  10   <component>CiviCampaign</component>
  11   <field>
  12     <name>id</name>
  13     <title>Survey ID</title>
  14     <type>int unsigned</type>
  15     <required>true</required>
  16     <comment>Survey id.</comment>
  17     <html>
  18       <type>Number</type>
  19     </html>
  20     <add>3.3</add>
  21   </field>
  22   <primaryKey>
  23     <name>id</name>
  24     <autoincrement>true</autoincrement>
  25   </primaryKey>
  26
  27   <field>
  28       <name>title</name>
  29       <title>Survey Title</title>
  30       <type>varchar</type>
  31       <length>255</length>
  32       <required>true</required>
  33       <localizable>true</localizable>
  34       <comment>Title of the Survey.</comment>
  35       <import>true</import>
  36       <add>3.3</add>
  37   </field>
  38
  39   <field>
  40     <name>campaign_id</name>
  41     <title>Campaign ID</title>
  42     <type>int unsigned</type>
  43     <default>NULL</default>
  44     <comment>Foreign key to the Campaign.</comment>
  45     <html>
  46       <type>EntityRef</type>
  47       <label>Campaign</label>
  48     </html>
  49     <add>3.3</add>
  50     <pseudoconstant>
  51       <table>civicrm_campaign</table>
  52       <keyColumn>id</keyColumn>
  53       <labelColumn>title</labelColumn>
  54       <prefetch>FALSE</prefetch>
  55     </pseudoconstant>
  56   </field>
  57   <foreignKey>
  58     <name>campaign_id</name>
  59     <table>civicrm_campaign</table>
  60     <key>id</key>
  61     <add>3.3</add>
  62     <onDelete>SET NULL</onDelete>
  63   </foreignKey>
  64
  65   <field>
  66     <name>activity_type_id</name>
  67     <title>Activity Type</title>
  68     <type>int unsigned</type>
  69     <default>NULL</default>
  70     <comment>Implicit FK to civicrm_option_value where option_group = activity_type</comment>
  71     <import>true</import>
  72     <add>3.3</add>
  73     <pseudoconstant>
  74       <optionGroupName>activity_type</optionGroupName>
  75     </pseudoconstant>
  76     <html>
  77       <type>Select</type>
  78     </html>
  79   </field>
  80   <index>
  81     <name>UI_activity_type_id</name>
  82     <fieldName>activity_type_id</fieldName>
  83     <add>3.3</add>
  84   </index>
  85
  86   <field>
  87     <name>recontact_interval</name>
  88     <title>Follow up Interval</title>
  89     <type>text</type>
  90     <comment>Recontact intervals for each status.</comment>
  91     <html>
  92       <type>TextArea</type>
  93       <rows>20</rows>
  94       <cols>80</cols>
  95     </html>
  96     <add>3.3</add>
  97   </field>
  98
  99   <field>
 100     <name>instructions</name>
 101     <title>Instructions</title>
 102     <type>text</type>
 103     <localizable>true</localizable>
 104     <comment>Script instructions for volunteers to use for the survey.</comment>
 105     <html>
 106       <type>TextArea</type>
 107       <rows>20</rows>
 108       <cols>80</cols>
 109     </html>
 110     <add>3.3</add>
 111   </field>
 112
 113   <field>
 114     <name>release_frequency</name>
 115     <title>Survey Hold Duration</title>
 116     <type>int unsigned</type>
 117     <default>NULL</default>
 118     <comment>Number of days for recurrence of release.</comment>
 119     <add>3.3</add>
 120   </field>
 121
 122   <field>
 123     <name>max_number_of_contacts</name>
 124     <title>Maximum number of contacts</title>
 125     <type>int unsigned</type>
 126     <default>NULL</default>
 127     <comment>Maximum number of contacts to allow for survey.</comment>
 128     <add>3.3</add>
 129   </field>
 130
 131   <field>
 132     <name>default_number_of_contacts</name>
 133     <title>Default number of contacts</title>
 134     <type>int unsigned</type>
 135     <default>NULL</default>
 136     <comment>Default number of contacts to allow for survey.</comment>
 137     <add>3.3</add>
 138   </field>
 139
 140   <field>
 141     <name>is_active</name>
 142     <title>Survey Is Active</title>
 143     <type>boolean</type>
 144     <default>1</default>
 145     <comment>Is this survey enabled or disabled/cancelled?</comment>
 146     <add>3.3</add>
 147   </field>
 148
 149   <field>
 150     <name>is_default</name>
 151     <title>Is Default Survey</title>
 152     <type>boolean</type>
 153     <default>0</default>
 154     <comment>Is this default survey?</comment>
 155     <add>3.3</add>
 156   </field>
 157
 158   <field>
 159     <name>created_id</name>
 160     <title>Created By Contact ID</title>
 161     <type>int unsigned</type>
 162     <comment>FK to civicrm_contact, who created this Survey.</comment>
 163     <html>
 164       <label>Created By</label>
 165     </html>
 166     <add>3.3</add>
 167   </field>
 168   <foreignKey>
 169     <name>created_id</name>
 170     <table>civicrm_contact</table>
 171     <key>id</key>
 172     <add>3.3</add>
 173     <onDelete>SET NULL</onDelete>
 174   </foreignKey>
 175
 176   <field>
 177     <name>created_date</name>
 178     <type>datetime</type>
 179     <title>Campaign Created Date</title>
 180     <comment>Date and time that Survey was created.</comment>
 181     <add>3.3</add>
 182   </field>
 183
 184   <field>
 185     <name>last_modified_id</name>
 186     <title>Modified By Contact ID</title>
 187     <type>int unsigned</type>
 188     <comment>FK to civicrm_contact, who recently edited this Survey.</comment>
 189     <html>
 190       <label>Modified By</label>
 191     </html>
 192     <add>3.3</add>
 193   </field>
 194   <foreignKey>
 195     <name>last_modified_id</name>
 196     <table>civicrm_contact</table>
 197     <key>id</key>
 198     <add>3.3</add>
 199     <onDelete>SET NULL</onDelete>
 200   </foreignKey>
 201
 202   <field>
 203     <name>last_modified_date</name>
 204     <title>Survey Modified On</title>
 205     <type>datetime</type>
 206     <comment>Date and time that Survey was edited last time.</comment>
 207     <add>3.3</add>
 208   </field>
 209
 210   <field>
 211     <name>result_id</name>
 212     <title>Survey Result</title>
 213     <type>int unsigned</type>
 214     <default>NULL</default>
 215     <comment>Used to store option group id.</comment>
 216     <add>3.3</add>
 217   </field>
 218   <field>
 219     <name>bypass_confirm</name>
 220     <title>No Email Verification</title>
 221     <type>boolean</type>
 222     <default>0</default>
 223     <comment>Bypass the email verification.</comment>
 224     <add>4.2</add>
 225   </field>
 226   <field>
 227     <name>thankyou_title</name>
 228     <title>Thank-you Title</title>
 229     <type>varchar</type>
 230     <length>255</length>
 231     <localizable>true</localizable>
 232     <comment>Title for Thank-you page (header title tag, and display at the top of the page).</comment>
 233     <add>4.2</add>
 234   </field>
 235   <field>
 236     <name>thankyou_text</name>
 237     <title>Thank-you Text</title>
 238     <type>text</type>
 239     <html>
 240       <type>TextArea</type>
 241       <rows>8</rows>
 242       <cols>60</cols>
 243     </html>
 244     <localizable>true</localizable>
 245     <comment>text and html allowed. displayed above result on success page</comment>
 246     <add>4.2</add>
 247   </field>
 248   <field>
 249     <name>is_share</name>
 250     <title>Is shared through social media</title>
 251     <type>boolean</type>
 252     <default>1</default>
 253     <comment>Can people share the petition through social media?</comment>
 254     <add>4.4</add>
 255   </field>
 256 </table>