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