Merge pull request #21943 from mattwire/gccacheignore
[civicrm-core.git] / xml / schema / Core / ActionSchedule.xml
CommitLineData
6a488035
TO
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>
8f069c03 10 <name>id</name>
7cd3d797 11 <title>Action Schedule ID</title>
8f069c03
EM
12 <type>int unsigned</type>
13 <required>true</required>
0481e12c
A
14 <html>
15 <type>Number</type>
16 </html>
8f069c03 17 <add>3.4</add>
6a488035
TO
18 </field>
19 <primaryKey>
8f069c03
EM
20 <name>id</name>
21 <autoincrement>true</autoincrement>
6a488035
TO
22 </primaryKey>
23 <field>
8f069c03
EM
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>
6a488035
TO
30 </field>
31 <field>
8f069c03
EM
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>
6a488035 39 <field>
8f069c03
EM
40 <name>recipient</name>
41 <type>varchar</type>
42 <length>64</length>
43 <comment>Recipient</comment>
1662d426
A
44 <html>
45 <label>Recipient</label>
46 </html>
8f069c03 47 <add>3.4</add>
6a488035 48 </field>
3e315abc 49 <field>
8f069c03
EM
50 <name>limit_to</name>
51 <type>boolean</type>
8f069c03 52 <comment>Is this the recipient criteria limited to OR in addition to?</comment>
1662d426
A
53 <html>
54 <label>Limit To</label>
55 </html>
c1e814c7
MD
56 <default>1</default>
57 <required>true</required>
8f069c03 58 <add>4.4</add>
3e315abc 59 </field>
6a488035 60 <field>
8f069c03
EM
61 <name>entity_value</name>
62 <type>varchar</type>
f5da40c8 63 <length>255</length>
8f069c03 64 <comment>Entity value</comment>
d5851cf2 65 <serialize>SEPARATOR_TRIMMED</serialize>
1662d426
A
66 <html>
67 <label>Entity value</label>
68 </html>
8f069c03 69 <add>3.4</add>
6a488035
TO
70 </field>
71 <field>
8f069c03
EM
72 <name>entity_status</name>
73 <type>varchar</type>
74 <length>64</length>
75 <comment>Entity status</comment>
d5851cf2 76 <serialize>SEPARATOR_TRIMMED</serialize>
1662d426
A
77 <html>
78 <label>Entity Status</label>
79 </html>
8f069c03 80 <add>3.4</add>
6a488035
TO
81 </field>
82 <field>
8f069c03
EM
83 <name>start_action_offset</name>
84 <type>int unsigned</type>
85 <comment>Reminder Interval.</comment>
055c5fe6 86 <default>0</default>
1662d426
A
87 <html>
88 <label>Start Action Offset</label>
89 </html>
8f069c03
EM
90 <add>3.4</add>
91 </field>
6a488035 92 <field>
8f069c03
EM
93 <name>start_action_unit</name>
94 <type>varchar</type>
95 <length>8</length>
96 <comment>Time units for reminder.</comment>
97 <pseudoconstant>
0b642d60 98 <callback>CRM_Core_SelectValues::getRecurringFrequencyUnits</callback>
8f069c03
EM
99 </pseudoconstant>
100 <add>3.4</add>
101 <html>
102 <type>Select</type>
fd735f54 103 <label>Start Action Unit</label>
8f069c03 104 </html>
6a488035 105 </field>
8f069c03
EM
106 <field>
107 <name>start_action_condition</name>
108 <type>varchar</type>
c105ac4b 109 <length>64</length>
8f069c03 110 <comment>Reminder Action</comment>
1662d426
A
111 <html>
112 <label>Start Action condition</label>
113 </html>
8f069c03
EM
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>
1662d426
A
121 <html>
122 <label>Start Action Date</label>
123 </html>
8f069c03 124 <add>3.4</add>
6a488035
TO
125 </field>
126 <field>
8f069c03
EM
127 <name>is_repeat</name>
128 <title>Repeat?</title>
129 <type>boolean</type>
130 <default>0</default>
c1e814c7 131 <required>true</required>
8f069c03 132 <add>3.4</add>
6a488035
TO
133 </field>
134 <field>
8f069c03
EM
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>
4226026e 140 <callback>CRM_Core_SelectValues::getRecurringFrequencyUnits</callback>
8f069c03
EM
141 </pseudoconstant>
142 <add>3.4</add>
143 <html>
144 <type>Select</type>
fd735f54 145 <label>Repetition Frequency Unit</label>
8f069c03
EM
146 </html>
147 </field>
6a488035 148 <field>
8f069c03
EM
149 <name>repetition_frequency_interval</name>
150 <type>int unsigned</type>
055c5fe6 151 <default>0</default>
8f069c03 152 <comment>Time interval for repeating the reminder.</comment>
1662d426
A
153 <html>
154 <label>Repetition Frequency Interval</label>
155 </html>
8f069c03 156 <add>3.4</add>
6a488035
TO
157 </field>
158 <field>
8f069c03
EM
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>
0b642d60 164 <callback>CRM_Core_SelectValues::getRecurringFrequencyUnits</callback>
8f069c03
EM
165 </pseudoconstant>
166 <add>3.4</add>
167 <html>
168 <type>Select</type>
fd735f54 169 <label>End Frequency Unit</label>
8f069c03 170 </html>
6a488035
TO
171 </field>
172 <field>
8f069c03
EM
173 <name>end_frequency_interval</name>
174 <type>int unsigned</type>
175 <comment>Time interval till repeating the reminder.</comment>
1662d426
A
176 <html>
177 <label>End Frequency Interval</label>
178 </html>
8f069c03 179 <add>3.4</add>
055c5fe6 180 <default>0</default>
6a488035
TO
181 </field>
182 <field>
8f069c03
EM
183 <name>end_action</name>
184 <type>varchar</type>
185 <length>32</length>
186 <comment>Reminder Action till repeating the reminder.</comment>
1662d426
A
187 <html>
188 <label>End Action</label>
189 </html>
8f069c03 190 <add>3.4</add>
6a488035
TO
191 </field>
192 <field>
8f069c03
EM
193 <name>end_date</name>
194 <type>varchar</type>
195 <length>64</length>
196 <comment>Entity end date</comment>
1662d426
A
197 <html>
198 <label>End Date</label>
199 </html>
8f069c03 200 <add>3.4</add>
6a488035
TO
201 </field>
202 <field>
8f069c03 203 <name>is_active</name>
0d94665e 204 <title>Schedule is Active?</title>
8f069c03
EM
205 <type>boolean</type>
206 <default>1</default>
c1e814c7 207 <required>true</required>
8f069c03
EM
208 <comment>Is this option active?</comment>
209 <add>3.4</add>
6a488035
TO
210 </field>
211 <field>
8f069c03
EM
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>
d5851cf2 217 <serialize>COMMA</serialize>
8f069c03 218 <add>3.4</add>
6a488035 219 </field>
8f069c03
EM
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>
6a488035
TO
227 </field>
228 <field>
8f069c03 229 <name>body_text</name>
0d94665e 230 <title>Reminder Text</title>
8f069c03
EM
231 <type>longtext</type>
232 <comment>Body of the mailing in text format.</comment>
233 <add>3.4</add>
6a488035
TO
234 </field>
235 <field>
8f069c03 236 <name>body_html</name>
0d94665e 237 <title>Reminder HTML</title>
8f069c03
EM
238 <type>longtext</type>
239 <comment>Body of the mailing in html format.</comment>
240 <add>3.4</add>
6a488035 241 </field>
1e035d58 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>
8f069c03
EM
249 <field>
250 <name>subject</name>
0d94665e 251 <title>Reminder Subject</title>
8f069c03
EM
252 <type>varchar</type>
253 <length>128</length>
254 <comment>Subject of mailing</comment>
255 <add>3.4</add>
6a488035 256 </field>
8f069c03
EM
257 <field>
258 <name>record_activity</name>
0d94665e 259 <title>Record Activity for Reminder?</title>
8f069c03 260 <type>boolean</type>
c1e814c7
MD
261 <default>0</default>
262 <required>true</required>
8f069c03
EM
263 <comment>Record Activity for this reminder?</comment>
264 <add>3.4</add>
6a488035 265 </field>
8f069c03
EM
266 <field>
267 <name>mapping_id</name>
0d94665e 268 <title>Reminder Mapping</title>
4d5ef3de
TO
269 <type>varchar</type>
270 <length>64</length>
271 <comment>Name/ID of the mapping to use on this table</comment>
8f069c03 272 <add>3.4</add>
6a488035 273 </field>
6a488035 274 <field>
29494eef 275 <name>group_id</name>
047c5009 276 <title>Group ID</title>
29494eef
AS
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>
614d72ec 284 <html>
e0991796 285 <type>Select</type>
047c5009 286 <label>Group</label>
614d72ec 287 </html>
29494eef
AS
288 <add>3.4</add>
289 </field>
8f069c03
EM
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>
047c5009 298 <title>Message Template ID</title>
011aeb62 299 <type>int unsigned</type>
300 <comment>FK to the message template.</comment>
57e94608 301 <html>
047c5009 302 <label>Message Template</label>
57e94608 303 </html>
8f069c03
EM
304 </field>
305 <foreignKey>
306 <name>msg_template_id</name>
011aeb62 307 <table>civicrm_msg_template</table>
308 <key>id</key>
309 <onDelete>SET NULL</onDelete>
8f069c03 310 </foreignKey>
1e035d58 311 <field>
312 <name>sms_template_id</name>
047c5009 313 <title>SMS Template ID</title>
1e035d58 314 <type>int unsigned</type>
315 <comment>FK to the message template.</comment>
57e94608 316 <html>
047c5009 317 <label>SMS Template</label>
57e94608 318 </html>
1e035d58 319 </field>
320 <foreignKey>
ce62f51a 321 <name>sms_template_id</name>
1e035d58 322 <table>civicrm_msg_template</table>
323 <key>id</key>
324 <onDelete>SET NULL</onDelete>
325 </foreignKey>
8f069c03
EM
326 <field>
327 <name>absolute_date</name>
0d94665e 328 <title>Fixed Date for Reminder</title>
8f069c03
EM
329 <type>date</type>
330 <comment>Date on which the reminder be sent.</comment>
331 <add>4.1</add>
6a488035 332 </field>
1991bba1
DG
333 <field>
334 <name>from_name</name>
0d94665e 335 <title>Reminder from Name</title>
1991bba1
DG
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>
0d94665e 343 <title>Reminder From Email</title>
1991bba1
DG
344 <type>varchar</type>
345 <length>255</length>
346 <comment>Email address in "from" field</comment>
347 <add>4.5</add>
348 </field>
a3e3eea1 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>
57e94608 366 <title>SMS Provider ID</title>
a3e3eea1 367 <type>int unsigned</type>
368 <add>4.5</add>
369 <html>
370 <type>Select</type>
57e94608 371 <label>SMS Provider</label>
a3e3eea1 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>
62933949 381 <field>
382 <name>used_for</name>
383 <type>varchar</type>
384 <length>64</length>
881c2dfb 385 <comment>Used for repeating entity</comment>
1662d426
A
386 <html>
387 <label>Used For</label>
388 </html>
9d54f3a4 389 <add>4.6</add>
62933949 390 </field>
776a4216
SV
391 <field>
392 <name>filter_contact_language</name>
393 <type>varchar</type>
394 <length>128</length>
395 <comment>Used for multilingual installation</comment>
1662d426
A
396 <html>
397 <label>Filter Contact Language</label>
398 </html>
776a4216
SV
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>
1662d426
A
406 <html>
407 <label>Communication Language</label>
408 </html>
776a4216
SV
409 <add>4.7</add>
410 </field>
6a62a64e 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>
1662d426
A
428 <html>
429 <label>Modified Date</label>
430 </html>
6a62a64e 431 <add>5.34</add>
a0e733f3 432 <readonly>true</readonly>
6a62a64e 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>
6a488035 454</table>