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