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