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     <required>true</required>
 130     <add>3.4</add>
 131   </field>
 132   <field>
 133     <name>repetition_frequency_unit</name>
 134     <type>varchar</type>
 135     <length>8</length>
 136     <comment>Time units for repetition of reminder.</comment>
 137     <pseudoconstant>
 138       <callback>CRM_Core_SelectValues::getRecurringFrequencyUnits</callback>
 139     </pseudoconstant>
 140     <add>3.4</add>
 141     <html>
 142       <type>Select</type>
 143       <label>Repetition Frequency Unit</label>
 144     </html>
 145   </field>
 146   <field>
 147     <name>repetition_frequency_interval</name>
 148     <type>int unsigned</type>
 149     <default>0</default>
 150     <comment>Time interval for repeating the reminder.</comment>
 151     <html>
 152       <label>Repetition Frequency Interval</label>
 153     </html>
 154     <add>3.4</add>
 155   </field>
 156   <field>
 157     <name>end_frequency_unit</name>
 158     <type>varchar</type>
 159     <length>8</length>
 160     <comment>Time units till repetition of reminder.</comment>
 161     <pseudoconstant>
 162       <callback>CRM_Core_SelectValues::getRecurringFrequencyUnits</callback>
 163     </pseudoconstant>
 164     <add>3.4</add>
 165     <html>
 166       <type>Select</type>
 167       <label>End Frequency Unit</label>
 168     </html>
 169   </field>
 170   <field>
 171     <name>end_frequency_interval</name>
 172     <type>int unsigned</type>
 173     <comment>Time interval till repeating the reminder.</comment>
 174     <html>
 175       <label>End Frequency Interval</label>
 176     </html>
 177     <add>3.4</add>
 178     <default>0</default>
 179   </field>
 180   <field>
 181     <name>end_action</name>
 182     <type>varchar</type>
 183     <length>32</length>
 184     <comment>Reminder Action till repeating the reminder.</comment>
 185     <html>
 186       <label>End Action</label>
 187     </html>
 188     <add>3.4</add>
 189   </field>
 190   <field>
 191     <name>end_date</name>
 192     <type>varchar</type>
 193     <length>64</length>
 194     <comment>Entity end date</comment>
 195     <html>
 196       <label>End Date</label>
 197     </html>
 198     <add>3.4</add>
 199   </field>
 200   <field>
 201     <name>is_active</name>
 202     <title>Schedule is Active?</title>
 203     <type>boolean</type>
 204     <default>1</default>
 205     <required>true</required>
 206     <comment>Is this option active?</comment>
 207     <add>3.4</add>
 208   </field>
 209   <field>
 210     <name>recipient_manual</name>
 211     <title>Recipient Manual</title>
 212     <type>varchar</type>
 213     <length>128</length>
 214     <comment>Contact IDs to which reminder should be sent.</comment>
 215     <serialize>COMMA</serialize>
 216     <add>3.4</add>
 217   </field>
 218   <field>
 219     <name>recipient_listing</name>
 220     <title>Recipient Listing</title>
 221     <type>varchar</type>
 222     <length>128</length>
 223     <comment>listing based on recipient field.</comment>
 224     <add>4.1</add>
 225   </field>
 226   <field>
 227     <name>body_text</name>
 228     <title>Reminder Text</title>
 229     <type>longtext</type>
 230     <comment>Body of the mailing in text format.</comment>
 231     <add>3.4</add>
 232   </field>
 233   <field>
 234     <name>body_html</name>
 235     <title>Reminder HTML</title>
 236     <type>longtext</type>
 237     <comment>Body of the mailing in html format.</comment>
 238     <add>3.4</add>
 239   </field>
 240   <field>
 241     <name>sms_body_text</name>
 242     <title>SMS Reminder Text</title>
 243     <type>longtext</type>
 244     <comment>Content of the SMS text.</comment>
 245     <add>4.5</add>
 246   </field>
 247   <field>
 248     <name>subject</name>
 249     <title>Reminder Subject</title>
 250     <type>varchar</type>
 251     <length>128</length>
 252     <comment>Subject of mailing</comment>
 253     <add>3.4</add>
 254   </field>
 255   <field>
 256     <name>record_activity</name>
 257     <title>Record Activity for Reminder?</title>
 258     <type>boolean</type>
 259     <default>0</default>
 260     <required>true</required>
 261     <comment>Record Activity for this reminder?</comment>
 262     <add>3.4</add>
 263   </field>
 264   <field>
 265     <name>mapping_id</name>
 266     <title>Reminder Mapping</title>
 267     <type>varchar</type>
 268     <length>64</length>
 269     <comment>Name/ID of the mapping to use on this table</comment>
 270     <add>3.4</add>
 271   </field>
 272   <field>
 273     <name>group_id</name>
 274     <title>Group ID</title>
 275     <type>int unsigned</type>
 276     <comment>FK to Group</comment>
 277     <pseudoconstant>
 278       <table>civicrm_group</table>
 279       <keyColumn>id</keyColumn>
 280       <labelColumn>title</labelColumn>
 281     </pseudoconstant>
 282     <html>
 283       <type>Select</type>
 284       <label>Group</label>
 285     </html>
 286     <add>3.4</add>
 287   </field>
 288   <foreignKey>
 289     <name>group_id</name>
 290     <table>civicrm_group</table>
 291     <key>id</key>
 292     <onDelete>SET NULL</onDelete>
 293   </foreignKey>
 294   <field>
 295     <name>msg_template_id</name>
 296     <title>Message Template ID</title>
 297     <type>int unsigned</type>
 298     <comment>FK to the message template.</comment>
 299     <html>
 300       <label>Message Template</label>
 301     </html>
 302   </field>
 303   <foreignKey>
 304     <name>msg_template_id</name>
 305     <table>civicrm_msg_template</table>
 306     <key>id</key>
 307     <onDelete>SET NULL</onDelete>
 308   </foreignKey>
 309   <field>
 310     <name>sms_template_id</name>
 311     <title>SMS Template ID</title>
 312     <type>int unsigned</type>
 313     <comment>FK to the message template.</comment>
 314     <html>
 315       <label>SMS Template</label>
 316     </html>
 317   </field>
 318   <foreignKey>
 319     <name>sms_template_id</name>
 320     <table>civicrm_msg_template</table>
 321     <key>id</key>
 322     <onDelete>SET NULL</onDelete>
 323   </foreignKey>
 324   <field>
 325     <name>absolute_date</name>
 326     <title>Fixed Date for Reminder</title>
 327     <type>date</type>
 328     <comment>Date on which the reminder be sent.</comment>
 329     <add>4.1</add>
 330   </field>
 331   <field>
 332     <name>from_name</name>
 333     <title>Reminder from Name</title>
 334     <type>varchar</type>
 335     <length>255</length>
 336     <comment>Name in "from" field</comment>
 337     <add>4.5</add>
 338   </field>
 339   <field>
 340     <name>from_email</name>
 341     <title>Reminder From Email</title>
 342     <type>varchar</type>
 343     <length>255</length>
 344     <comment>Email address in "from" field</comment>
 345     <add>4.5</add>
 346   </field>
 347   <field>
 348     <name>mode</name>
 349     <title>Message Mode</title>
 350     <default>"Email"</default>
 351     <type>varchar</type>
 352     <length>128</length>
 353     <comment>Send the message as email or sms or both.</comment>
 354     <pseudoconstant>
 355       <optionGroupName>msg_mode</optionGroupName>
 356     </pseudoconstant>
 357     <html>
 358       <type>Select</type>
 359     </html>
 360     <add>4.5</add>
 361   </field>
 362   <field>
 363     <name>sms_provider_id</name>
 364     <title>SMS Provider ID</title>
 365     <type>int unsigned</type>
 366     <add>4.5</add>
 367     <html>
 368       <type>Select</type>
 369       <label>SMS Provider</label>
 370     </html>
 371   </field>
 372   <foreignKey>
 373     <name>sms_provider_id</name>
 374     <table>civicrm_sms_provider</table>
 375     <key>id</key>
 376     <onDelete>SET NULL</onDelete>
 377     <add>4.5</add>
 378   </foreignKey>
 379   <field>
 380     <name>used_for</name>
 381     <type>varchar</type>
 382     <length>64</length>
 383     <comment>Used for repeating entity</comment>
 384     <html>
 385       <label>Used For</label>
 386     </html>
 387     <add>4.6</add>
 388   </field>
 389   <field>
 390     <name>filter_contact_language</name>
 391     <type>varchar</type>
 392     <length>128</length>
 393     <comment>Used for multilingual installation</comment>
 394     <html>
 395       <label>Filter Contact Language</label>
 396     </html>
 397     <add>4.7</add>
 398   </field>
 399   <field>
 400     <name>communication_language</name>
 401     <type>varchar</type>
 402     <length>8</length>
 403     <comment>Used for multilingual installation</comment>
 404     <html>
 405       <label>Communication Language</label>
 406     </html>
 407     <add>4.7</add>
 408   </field>
 409   <field>
 410     <name>created_date</name>
 411     <title>Created Date</title>
 412     <uniqueName>action_schedule_created_date</uniqueName>
 413     <type>timestamp</type>
 414     <comment>When was the scheduled reminder created.</comment>
 415     <required>false</required>
 416     <export>true</export>
 417     <default>CURRENT_TIMESTAMP</default>
 418     <add>5.34</add>
 419   </field>
 420   <field>
 421     <name>modified_date</name>
 422     <type>timestamp</type>
 423     <comment>When the reminder was created or modified.</comment>
 424     <required>false</required>
 425     <default>CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP</default>
 426     <html>
 427       <label>Modified Date</label>
 428     </html>
 429     <add>5.34</add>
 430     <readonly>true</readonly>
 431   </field>
 432   <field>
 433     <name>effective_start_date</name>
 434     <title>Effective start date</title>
 435     <uniqueName>action_schedule_effective_start_date</uniqueName>
 436     <type>timestamp</type>
 437     <comment>Earliest date to consider start events from.</comment>
 438     <required>false</required>
 439     <export>true</export>
 440     <add>5.34</add>
 441   </field>
 442   <field>
 443     <name>effective_end_date</name>
 444     <title>Effective end date</title>
 445     <uniqueName>action_schedule_effective_end_date</uniqueName>
 446     <type>timestamp</type>
 447     <comment>Latest date to consider end events from.</comment>
 448     <required>false</required>
 449     <export>true</export>
 450     <add>5.34</add>
 451   </field>
 452 </table>