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