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