xml/schema/Campaign/Campaign.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2 <table>
   3   <base>CRM/Campaign</base>
   4   <class>Campaign</class>
   5   <name>civicrm_campaign</name>
   6   <comment>Campaign Details.</comment>
   7   <add>3.3</add>
   8   <icon>fa-bullhorn</icon>
   9   <labelField>title</labelField>
  10   <component>CiviCampaign</component>
  11   <paths>
  12     <add>civicrm/campaign/add?reset=1</add>
  13     <update>civicrm/campaign/add?reset=1&amp;action=update&amp;id=[id]</update>
  14     <delete>civicrm/campaign/add?reset=1&amp;action=delete&amp;id=[id]</delete>
  15   </paths>
  16   <field>
  17     <name>id</name>
  18     <title>Campaign ID</title>
  19     <type>int unsigned</type>
  20     <required>true</required>
  21     <comment>Unique Campaign ID.</comment>
  22     <import>true</import>
  23     <html>
  24       <type>Number</type>
  25     </html>
  26     <add>3.3</add>
  27   </field>
  28   <primaryKey>
  29     <name>id</name>
  30     <autoincrement>true</autoincrement>
  31   </primaryKey>
  32
  33   <field>
  34     <name>name</name>
  35     <title>Campaign Name</title>
  36     <type>varchar</type>
  37     <length>255</length>
  38     <required>true</required>
  39     <comment>Name of the Campaign.</comment>
  40     <import>true</import>
  41     <html>
  42       <type>Text</type>
  43     </html>
  44     <add>3.3</add>
  45   </field>
  46   <index>
  47     <name>UI_campaign_name</name>
  48     <fieldName>name</fieldName>
  49     <add>5.34</add>
  50   </index>
  51   <field>
  52     <name>title</name>
  53     <title>Campaign Title</title>
  54     <type>varchar</type>
  55     <length>255</length>
  56     <comment>Title of the Campaign.</comment>
  57     <import>true</import>
  58     <html>
  59       <type>Text</type>
  60     </html>
  61     <add>3.3</add>
  62   </field>
  63
  64   <field>
  65     <name>description</name>
  66     <title>Campaign Description</title>
  67     <type>text</type>
  68     <html>
  69       <type>TextArea</type>
  70       <rows>8</rows>
  71       <cols>60</cols>
  72     </html>
  73     <comment>Full description of Campaign.</comment>
  74     <add>3.3</add>
  75   </field>
  76
  77   <field>
  78     <name>start_date</name>
  79     <title>Campaign Start Date</title>
  80     <type>datetime</type>
  81     <headerPattern>/^start|(s(tart\s)?date)$/i</headerPattern>
  82     <comment>Date and time that Campaign starts.</comment>
  83     <import>true</import>
  84     <html>
  85       <type>Select Date</type>
  86       <formatType>activityDateTime</formatType>
  87     </html>
  88     <add>3.3</add>
  89   </field>
  90
  91   <field>
  92     <name>end_date</name>
  93     <title>Campaign End Date</title>
  94     <type>datetime</type>
  95     <headerPattern>/^end|(e(nd\s)?date)$/i</headerPattern>
  96     <comment>Date and time that Campaign ends.</comment>
  97     <import>true</import>
  98     <html>
  99       <type>Select Date</type>
 100       <formatType>activityDateTime</formatType>
 101     </html>
 102     <add>3.3</add>
 103   </field>
 104
 105   <field>
 106     <name>campaign_type_id</name>
 107     <title>Campaign Type</title>
 108     <type>int unsigned</type>
 109     <default>NULL</default>
 110     <comment>Campaign Type ID.Implicit FK to civicrm_option_value where option_group = campaign_type</comment>
 111     <import>true</import>
 112     <pseudoconstant>
 113       <optionGroupName>campaign_type</optionGroupName>
 114     </pseudoconstant>
 115     <html>
 116       <type>Select</type>
 117     </html>
 118     <add>3.3</add>
 119   </field>
 120   <index>
 121     <name>UI_campaign_type_id</name>
 122     <fieldName>campaign_type_id</fieldName>
 123     <add>3.3</add>
 124   </index>
 125
 126   <field>
 127     <name>status_id</name>
 128     <title>Campaign Status</title>
 129     <type>int unsigned</type>
 130     <default>NULL</default>
 131     <comment>Campaign status ID.Implicit FK to civicrm_option_value where option_group = campaign_status</comment>
 132     <import>true</import>
 133     <pseudoconstant>
 134       <optionGroupName>campaign_status</optionGroupName>
 135     </pseudoconstant>
 136     <html>
 137       <type>Select</type>
 138     </html>
 139     <add>3.3</add>
 140   </field>
 141   <index>
 142     <name>UI_campaign_status_id</name>
 143     <fieldName>status_id</fieldName>
 144     <add>3.3</add>
 145   </index>
 146
 147   <field>
 148     <name>external_identifier</name>
 149     <type>varchar</type>
 150     <title>Campaign External ID</title>
 151     <length>32</length>
 152     <headerPattern>/external\s?id/i</headerPattern>
 153     <dataPattern>/^\d{11,}$/</dataPattern>
 154     <comment>Unique trusted external ID (generally from a legacy app/datasource). Particularly useful for deduping operations.</comment>
 155     <import>true</import>
 156     <add>3.3</add>
 157     <html>
 158       <type>Text</type>
 159     </html>
 160   </field>
 161   <index>
 162     <name>UI_external_identifier</name>
 163     <unique>true</unique>
 164     <fieldName>external_identifier</fieldName>
 165     <add>3.3</add>
 166   </index>
 167
 168   <field>
 169     <name>parent_id</name>
 170     <title>Parent Campaign ID</title>
 171     <type>int unsigned</type>
 172     <default>NULL</default>
 173     <comment>Optional parent id for this Campaign.</comment>
 174     <import>true</import>
 175     <add>3.3</add>
 176     <html>
 177       <type>EntityRef</type>
 178       <label>Parent Campaign</label>
 179     </html>
 180   </field>
 181   <foreignKey>
 182     <name>parent_id</name>
 183     <table>civicrm_campaign</table>
 184     <key>id</key>
 185     <add>3.3</add>
 186     <onDelete>SET NULL</onDelete>
 187   </foreignKey>
 188
 189   <field>
 190     <name>is_active</name>
 191     <title>Is Campaign Active?</title>
 192     <type>boolean</type>
 193     <default>1</default>
 194     <comment>Is this Campaign enabled or disabled/cancelled?</comment>
 195     <add>3.3</add>
 196     <html>
 197       <type>CheckBox</type>
 198     </html>
 199   </field>
 200
 201   <field>
 202     <name>created_id</name>
 203     <type>int unsigned</type>
 204     <title>Created By Contact ID</title>
 205     <comment>FK to civicrm_contact, who created this Campaign.</comment>
 206     <html>
 207       <label>Created By</label>
 208     </html>
 209     <add>3.3</add>
 210   </field>
 211   <foreignKey>
 212     <name>created_id</name>
 213     <table>civicrm_contact</table>
 214     <key>id</key>
 215     <add>3.3</add>
 216     <onDelete>SET NULL</onDelete>
 217   </foreignKey>
 218
 219   <field>
 220     <name>created_date</name>
 221     <type>datetime</type>
 222     <title>Campaign Created Date</title>
 223     <comment>Date and time that Campaign was created.</comment>
 224     <add>3.3</add>
 225     <html>
 226       <type>Select Date</type>
 227       <formatType>activityDateTime</formatType>
 228     </html>
 229   </field>
 230
 231   <field>
 232     <name>last_modified_id</name>
 233     <type>int unsigned</type>
 234     <title>Modified By Contact ID</title>
 235     <comment>FK to civicrm_contact, who recently edited this Campaign.</comment>
 236     <html>
 237       <label>Modified By</label>
 238     </html>
 239     <add>3.3</add>
 240   </field>
 241   <foreignKey>
 242     <name>last_modified_id</name>
 243     <table>civicrm_contact</table>
 244     <key>id</key>
 245     <add>3.3</add>
 246     <onDelete>SET NULL</onDelete>
 247   </foreignKey>
 248
 249   <field>
 250     <name>last_modified_date</name>
 251     <type>datetime</type>
 252     <title>Campaign Modified Date</title>
 253     <comment>Date and time that Campaign was edited last time.</comment>
 254     <add>3.3</add>
 255   </field>
 256   <field>
 257     <name>goal_general</name>
 258     <type>text</type>
 259     <title>Campaign Goals</title>
 260     <comment>General goals for Campaign.</comment>
 261     <add>3.4</add>
 262     <html>
 263       <type>RichTextEditor</type>
 264     </html>
 265   </field>
 266   <field>
 267     <name>goal_revenue</name>
 268     <type>decimal</type>
 269     <comment>The target revenue for this campaign.</comment>
 270     <add>3.4</add>
 271     <html>
 272       <type>Text</type>
 273       <label>Goal Revenue</label>
 274     </html>
 275   </field>
 276 </table>