xml/schema/Core/ActionSchedule.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Core</base>
   5   <class>ActionSchedule</class>
   6   <name>civicrm_action_schedule</name>
   7   <comment>Table to store the reminders.</comment>
   8   <add>3.4</add>
   9   <field>
  10     <name>id</name>
  11     <title>Action Schedule ID</title>
  12     <type>int unsigned</type>
  13     <required>true</required>
  14     <html>
  15       <type>Number</type>
  16     </html>
  17     <add>3.4</add>
  18   </field>
  19   <primaryKey>
  20     <name>id</name>
  21     <autoincrement>true</autoincrement>
  22   </primaryKey>
  23   <field>
  24     <name>name</name>
  25     <title>Name</title>
  26     <type>varchar</type>
  27     <length>64</length>
  28     <comment>Name of the action(reminder)</comment>
  29     <add>3.4</add>
  30   </field>
  31   <field>
  32     <name>title</name>
  33     <title>Title</title>
  34     <type>varchar</type>
  35     <length>64</length>
  36     <comment>Title of the action(reminder)</comment>
  37     <add>3.4</add>
  38   </field>
  39   <field>
  40     <name>recipient</name>
  41     <type>varchar</type>
  42     <length>64</length>
  43     <comment>Recipient</comment>
  44     <html>
  45       <label>Recipient</label>
  46     </html>
  47     <add>3.4</add>
  48   </field>
  49   <field>
  50     <name>limit_to</name>
  51     <type>boolean</type>
  52     <comment>Is this the recipient criteria limited to OR in addition to?</comment>
  53     <html>
  54       <label>Limit To</label>
  55     </html>
  56     <add>4.4</add>
  57   </field>
  58   <field>
  59     <name>entity_value</name>
  60     <type>varchar</type>
  61     <length>255</length>
  62     <comment>Entity value</comment>
  63     <serialize>SEPARATOR_TRIMMED</serialize>
  64     <html>
  65       <label>Entity value</label>
  66     </html>
  67     <add>3.4</add>
  68   </field>
  69   <field>
  70     <name>entity_status</name>
  71     <type>varchar</type>
  72     <length>64</length>
  73     <comment>Entity status</comment>
  74     <serialize>SEPARATOR_TRIMMED</serialize>
  75     <html>
  76       <label>Entity Status</label>
  77     </html>
  78     <add>3.4</add>
  79   </field>
  80   <field>
  81     <name>start_action_offset</name>
  82     <type>int unsigned</type>
  83     <comment>Reminder Interval.</comment>
  84     <default>0</default>
  85     <html>
  86       <label>Start Action Offset</label>
  87     </html>
  88     <add>3.4</add>
  89   </field>
  90   <field>
  91     <name>start_action_unit</name>
  92     <type>varchar</type>
  93     <length>8</length>
  94     <comment>Time units for reminder.</comment>
  95     <pseudoconstant>
  96       <callback>CRM_Core_SelectValues::getRecurringFrequencyUnits</callback>
  97     </pseudoconstant>
  98     <add>3.4</add>
  99     <html>
 100       <type>Select</type>
 101       <label>Start Action Unit</label>
 102     </html>
 103   </field>
 104   <field>
 105     <name>start_action_condition</name>
 106     <type>varchar</type>
 107     <length>64</length>
 108     <comment>Reminder Action</comment>
 109     <html>
 110       <label>Start Action condition</label>
 111     </html>
 112     <add>3.4</add>
 113   </field>
 114   <field>
 115     <name>start_action_date</name>
 116     <type>varchar</type>
 117     <length>64</length>
 118     <comment>Entity date</comment>
 119     <html>
 120       <label>Start Action Date</label>
 121     </html>
 122     <add>3.4</add>
 123   </field>
 124   <field>
 125     <name>is_repeat</name>
 126     <title>Repeat?</title>
 127     <type>boolean</type>
 128     <default>0</default>
 129     <add>3.4</add>
 130   </field>
 131   <field>
 132     <name>repetition_frequency_unit</name>
 133     <type>varchar</type>
 134     <length>8</length>
 135     <comment>Time units for repetition of reminder.</comment>
 136     <pseudoconstant>
 137       <callback>CRM_Core_SelectValues::getRecurringFrequencyUnits</callback>
 138     </pseudoconstant>
 139     <add>3.4</add>
 140     <html>
 141       <type>Select</type>
 142       <label>Repetition Frequency Unit</label>
 143     </html>
 144   </field>
 145   <field>
 146     <name>repetition_frequency_interval</name>
 147     <type>int unsigned</type>
 148     <default>0</default>
 149     <comment>Time interval for repeating the reminder.</comment>
 150     <html>
 151       <label>Repetition Frequency Interval</label>
 152     </html>
 153     <add>3.4</add>
 154   </field>
 155   <field>
 156     <name>end_frequency_unit</name>
 157     <type>varchar</type>
 158     <length>8</length>
 159     <comment>Time units till repetition of reminder.</comment>
 160     <pseudoconstant>
 161       <callback>CRM_Core_SelectValues::getRecurringFrequencyUnits</callback>
 162     </pseudoconstant>
 163     <add>3.4</add>
 164     <html>
 165       <type>Select</type>
 166       <label>End Frequency Unit</label>
 167     </html>
 168   </field>
 169   <field>
 170     <name>end_frequency_interval</name>
 171     <type>int unsigned</type>
 172     <comment>Time interval till repeating the reminder.</comment>
 173     <html>
 174       <label>End Frequency Interval</label>
 175     </html>
 176     <add>3.4</add>
 177     <default>0</default>
 178   </field>
 179   <field>
 180     <name>end_action</name>
 181     <type>varchar</type>
 182     <length>32</length>
 183     <comment>Reminder Action till repeating the reminder.</comment>
 184     <html>
 185       <label>End Action</label>
 186     </html>
 187     <add>3.4</add>
 188   </field>
 189   <field>
 190     <name>end_date</name>
 191     <type>varchar</type>
 192     <length>64</length>
 193     <comment>Entity end date</comment>
 194     <html>
 195       <label>End Date</label>
 196     </html>
 197     <add>3.4</add>
 198   </field>
 199   <field>
 200     <name>is_active</name>
 201     <title>Schedule is Active?</title>
 202     <type>boolean</type>
 203     <default>1</default>
 204     <comment>Is this option active?</comment>
 205     <add>3.4</add>
 206   </field>
 207   <field>
 208     <name>recipient_manual</name>
 209     <title>Recipient Manual</title>
 210     <type>varchar</type>
 211     <length>128</length>
 212     <comment>Contact IDs to which reminder should be sent.</comment>
 213     <serialize>COMMA</serialize>
 214     <add>3.4</add>
 215   </field>
 216   <field>
 217     <name>recipient_listing</name>
 218     <title>Recipient Listing</title>
 219     <type>varchar</type>
 220     <length>128</length>
 221     <comment>listing based on recipient field.</comment>
 222     <add>4.1</add>
 223   </field>
 224   <field>
 225     <name>body_text</name>
 226     <title>Reminder Text</title>
 227     <type>longtext</type>
 228     <comment>Body of the mailing in text format.</comment>
 229     <add>3.4</add>
 230   </field>
 231   <field>
 232     <name>body_html</name>
 233     <title>Reminder HTML</title>
 234     <type>longtext</type>
 235     <comment>Body of the mailing in html format.</comment>
 236     <add>3.4</add>
 237   </field>
 238   <field>
 239     <name>sms_body_text</name>
 240     <title>SMS Reminder Text</title>
 241     <type>longtext</type>
 242     <comment>Content of the SMS text.</comment>
 243     <add>4.5</add>
 244   </field>
 245   <field>
 246     <name>subject</name>
 247     <title>Reminder Subject</title>
 248     <type>varchar</type>
 249     <length>128</length>
 250     <comment>Subject of mailing</comment>
 251     <add>3.4</add>
 252   </field>
 253   <field>
 254     <name>record_activity</name>
 255     <title>Record Activity for Reminder?</title>
 256     <type>boolean</type>
 257     <default>NULL</default>
 258     <comment>Record Activity for this reminder?</comment>
 259     <add>3.4</add>
 260   </field>
 261   <field>
 262     <name>mapping_id</name>
 263     <title>Reminder Mapping</title>
 264     <type>varchar</type>
 265     <length>64</length>
 266     <comment>Name/ID of the mapping to use on this table</comment>
 267     <add>3.4</add>
 268   </field>
 269   <field>
 270     <name>group_id</name>
 271     <title>Group ID</title>
 272     <type>int unsigned</type>
 273     <comment>FK to Group</comment>
 274     <pseudoconstant>
 275       <table>civicrm_group</table>
 276       <keyColumn>id</keyColumn>
 277       <labelColumn>title</labelColumn>
 278     </pseudoconstant>
 279     <html>
 280       <type>Select</type>
 281       <label>Group</label>
 282     </html>
 283     <add>3.4</add>
 284   </field>
 285   <foreignKey>
 286     <name>group_id</name>
 287     <table>civicrm_group</table>
 288     <key>id</key>
 289     <onDelete>SET NULL</onDelete>
 290   </foreignKey>
 291   <field>
 292     <name>msg_template_id</name>
 293     <title>Message Template ID</title>
 294     <type>int unsigned</type>
 295     <comment>FK to the message template.</comment>
 296     <html>
 297       <label>Message Template</label>
 298     </html>
 299   </field>
 300   <foreignKey>
 301     <name>msg_template_id</name>
 302     <table>civicrm_msg_template</table>
 303     <key>id</key>
 304     <onDelete>SET NULL</onDelete>
 305   </foreignKey>
 306   <field>
 307     <name>sms_template_id</name>
 308     <title>SMS Template ID</title>
 309     <type>int unsigned</type>
 310     <comment>FK to the message template.</comment>
 311     <html>
 312       <label>SMS Template</label>
 313     </html>
 314   </field>
 315   <foreignKey>
 316     <name>sms_template_id</name>
 317     <table>civicrm_msg_template</table>
 318     <key>id</key>
 319     <onDelete>SET NULL</onDelete>
 320   </foreignKey>
 321   <field>
 322     <name>absolute_date</name>
 323     <title>Fixed Date for Reminder</title>
 324     <type>date</type>
 325     <comment>Date on which the reminder be sent.</comment>
 326     <add>4.1</add>
 327   </field>
 328   <field>
 329     <name>from_name</name>
 330     <title>Reminder from Name</title>
 331     <type>varchar</type>
 332     <length>255</length>
 333     <comment>Name in "from" field</comment>
 334     <add>4.5</add>
 335   </field>
 336   <field>
 337     <name>from_email</name>
 338     <title>Reminder From Email</title>
 339     <type>varchar</type>
 340     <length>255</length>
 341     <comment>Email address in "from" field</comment>
 342     <add>4.5</add>
 343   </field>
 344   <field>
 345     <name>mode</name>
 346     <title>Message Mode</title>
 347     <default>"Email"</default>
 348     <type>varchar</type>
 349     <length>128</length>
 350     <comment>Send the message as email or sms or both.</comment>
 351     <pseudoconstant>
 352       <optionGroupName>msg_mode</optionGroupName>
 353     </pseudoconstant>
 354     <html>
 355       <type>Select</type>
 356     </html>
 357     <add>4.5</add>
 358   </field>
 359   <field>
 360     <name>sms_provider_id</name>
 361     <title>SMS Provider ID</title>
 362     <type>int unsigned</type>
 363     <add>4.5</add>
 364     <html>
 365       <type>Select</type>
 366       <label>SMS Provider</label>
 367     </html>
 368   </field>
 369   <foreignKey>
 370     <name>sms_provider_id</name>
 371     <table>civicrm_sms_provider</table>
 372     <key>id</key>
 373     <onDelete>SET NULL</onDelete>
 374     <add>4.5</add>
 375   </foreignKey>
 376   <field>
 377     <name>used_for</name>
 378     <type>varchar</type>
 379     <length>64</length>
 380     <comment>Used for repeating entity</comment>
 381     <html>
 382       <label>Used For</label>
 383     </html>
 384     <add>4.6</add>
 385   </field>
 386   <field>
 387     <name>filter_contact_language</name>
 388     <type>varchar</type>
 389     <length>128</length>
 390     <comment>Used for multilingual installation</comment>
 391     <html>
 392       <label>Filter Contact Language</label>
 393     </html>
 394     <add>4.7</add>
 395   </field>
 396   <field>
 397     <name>communication_language</name>
 398     <type>varchar</type>
 399     <length>8</length>
 400     <comment>Used for multilingual installation</comment>
 401     <html>
 402       <label>Communication Language</label>
 403     </html>
 404     <add>4.7</add>
 405   </field>
 406   <field>
 407     <name>created_date</name>
 408     <title>Created Date</title>
 409     <uniqueName>action_schedule_created_date</uniqueName>
 410     <type>timestamp</type>
 411     <comment>When was the scheduled reminder created.</comment>
 412     <required>false</required>
 413     <export>true</export>
 414     <default>CURRENT_TIMESTAMP</default>
 415     <add>5.34</add>
 416   </field>
 417   <field>
 418     <name>modified_date</name>
 419     <type>timestamp</type>
 420     <comment>When the reminder was created or modified.</comment>
 421     <required>false</required>
 422     <default>CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP</default>
 423     <html>
 424       <label>Modified Date</label>
 425     </html>
 426     <add>5.34</add>
 427     <readonly>true</readonly>
 428   </field>
 429   <field>
 430     <name>effective_start_date</name>
 431     <title>Effective start date</title>
 432     <uniqueName>action_schedule_effective_start_date</uniqueName>
 433     <type>timestamp</type>
 434     <comment>Earliest date to consider start events from.</comment>
 435     <required>false</required>
 436     <export>true</export>
 437     <add>5.34</add>
 438   </field>
 439   <field>
 440     <name>effective_end_date</name>
 441     <title>Effective end date</title>
 442     <uniqueName>action_schedule_effective_end_date</uniqueName>
 443     <type>timestamp</type>
 444     <comment>Latest date to consider end events from.</comment>
 445     <required>false</required>
 446     <export>true</export>
 447     <add>5.34</add>
 448   </field>
 449 </table>