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