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