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