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