Merge pull request #23587 from civicrm/5.50
[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>
8f069c03 56 <add>4.4</add>
3e315abc 57 </field>
6a488035 58 <field>
8f069c03
EM
59 <name>entity_value</name>
60 <type>varchar</type>
f5da40c8 61 <length>255</length>
8f069c03 62 <comment>Entity value</comment>
d5851cf2 63 <serialize>SEPARATOR_TRIMMED</serialize>
1662d426
A
64 <html>
65 <label>Entity value</label>
66 </html>
8f069c03 67 <add>3.4</add>
6a488035
TO
68 </field>
69 <field>
8f069c03
EM
70 <name>entity_status</name>
71 <type>varchar</type>
72 <length>64</length>
73 <comment>Entity status</comment>
d5851cf2 74 <serialize>SEPARATOR_TRIMMED</serialize>
1662d426
A
75 <html>
76 <label>Entity Status</label>
77 </html>
8f069c03 78 <add>3.4</add>
6a488035
TO
79 </field>
80 <field>
8f069c03
EM
81 <name>start_action_offset</name>
82 <type>int unsigned</type>
83 <comment>Reminder Interval.</comment>
055c5fe6 84 <default>0</default>
1662d426
A
85 <html>
86 <label>Start Action Offset</label>
87 </html>
8f069c03
EM
88 <add>3.4</add>
89 </field>
6a488035 90 <field>
8f069c03
EM
91 <name>start_action_unit</name>
92 <type>varchar</type>
93 <length>8</length>
94 <comment>Time units for reminder.</comment>
95 <pseudoconstant>
0b642d60 96 <callback>CRM_Core_SelectValues::getRecurringFrequencyUnits</callback>
8f069c03
EM
97 </pseudoconstant>
98 <add>3.4</add>
99 <html>
100 <type>Select</type>
fd735f54 101 <label>Start Action Unit</label>
8f069c03 102 </html>
6a488035 103 </field>
8f069c03
EM
104 <field>
105 <name>start_action_condition</name>
106 <type>varchar</type>
c105ac4b 107 <length>64</length>
8f069c03 108 <comment>Reminder Action</comment>
1662d426
A
109 <html>
110 <label>Start Action condition</label>
111 </html>
8f069c03
EM
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>
1662d426
A
119 <html>
120 <label>Start Action Date</label>
121 </html>
8f069c03 122 <add>3.4</add>
6a488035
TO
123 </field>
124 <field>
8f069c03
EM
125 <name>is_repeat</name>
126 <title>Repeat?</title>
127 <type>boolean</type>
128 <default>0</default>
c1e814c7 129 <required>true</required>
8f069c03 130 <add>3.4</add>
6a488035
TO
131 </field>
132 <field>
8f069c03
EM
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>
4226026e 138 <callback>CRM_Core_SelectValues::getRecurringFrequencyUnits</callback>
8f069c03
EM
139 </pseudoconstant>
140 <add>3.4</add>
141 <html>
142 <type>Select</type>
fd735f54 143 <label>Repetition Frequency Unit</label>
8f069c03
EM
144 </html>
145 </field>
6a488035 146 <field>
8f069c03
EM
147 <name>repetition_frequency_interval</name>
148 <type>int unsigned</type>
055c5fe6 149 <default>0</default>
8f069c03 150 <comment>Time interval for repeating the reminder.</comment>
1662d426
A
151 <html>
152 <label>Repetition Frequency Interval</label>
153 </html>
8f069c03 154 <add>3.4</add>
6a488035
TO
155 </field>
156 <field>
8f069c03
EM
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>
0b642d60 162 <callback>CRM_Core_SelectValues::getRecurringFrequencyUnits</callback>
8f069c03
EM
163 </pseudoconstant>
164 <add>3.4</add>
165 <html>
166 <type>Select</type>
fd735f54 167 <label>End Frequency Unit</label>
8f069c03 168 </html>
6a488035
TO
169 </field>
170 <field>
8f069c03
EM
171 <name>end_frequency_interval</name>
172 <type>int unsigned</type>
173 <comment>Time interval till repeating the reminder.</comment>
1662d426
A
174 <html>
175 <label>End Frequency Interval</label>
176 </html>
8f069c03 177 <add>3.4</add>
055c5fe6 178 <default>0</default>
6a488035
TO
179 </field>
180 <field>
8f069c03
EM
181 <name>end_action</name>
182 <type>varchar</type>
183 <length>32</length>
184 <comment>Reminder Action till repeating the reminder.</comment>
1662d426
A
185 <html>
186 <label>End Action</label>
187 </html>
8f069c03 188 <add>3.4</add>
6a488035
TO
189 </field>
190 <field>
8f069c03
EM
191 <name>end_date</name>
192 <type>varchar</type>
193 <length>64</length>
194 <comment>Entity end date</comment>
1662d426
A
195 <html>
196 <label>End Date</label>
197 </html>
8f069c03 198 <add>3.4</add>
6a488035
TO
199 </field>
200 <field>
8f069c03 201 <name>is_active</name>
0d94665e 202 <title>Schedule is Active?</title>
8f069c03
EM
203 <type>boolean</type>
204 <default>1</default>
c1e814c7 205 <required>true</required>
8f069c03
EM
206 <comment>Is this option active?</comment>
207 <add>3.4</add>
6a488035
TO
208 </field>
209 <field>
8f069c03
EM
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>
d5851cf2 215 <serialize>COMMA</serialize>
8f069c03 216 <add>3.4</add>
6a488035 217 </field>
8f069c03
EM
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>
6a488035
TO
225 </field>
226 <field>
8f069c03 227 <name>body_text</name>
0d94665e 228 <title>Reminder Text</title>
8f069c03
EM
229 <type>longtext</type>
230 <comment>Body of the mailing in text format.</comment>
231 <add>3.4</add>
6a488035
TO
232 </field>
233 <field>
8f069c03 234 <name>body_html</name>
0d94665e 235 <title>Reminder HTML</title>
8f069c03
EM
236 <type>longtext</type>
237 <comment>Body of the mailing in html format.</comment>
238 <add>3.4</add>
6a488035 239 </field>
1e035d58 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>
8f069c03
EM
247 <field>
248 <name>subject</name>
0d94665e 249 <title>Reminder Subject</title>
8f069c03
EM
250 <type>varchar</type>
251 <length>128</length>
252 <comment>Subject of mailing</comment>
253 <add>3.4</add>
6a488035 254 </field>
8f069c03
EM
255 <field>
256 <name>record_activity</name>
0d94665e 257 <title>Record Activity for Reminder?</title>
8f069c03 258 <type>boolean</type>
c1e814c7
MD
259 <default>0</default>
260 <required>true</required>
8f069c03
EM
261 <comment>Record Activity for this reminder?</comment>
262 <add>3.4</add>
6a488035 263 </field>
8f069c03
EM
264 <field>
265 <name>mapping_id</name>
0d94665e 266 <title>Reminder Mapping</title>
4d5ef3de
TO
267 <type>varchar</type>
268 <length>64</length>
269 <comment>Name/ID of the mapping to use on this table</comment>
8f069c03 270 <add>3.4</add>
6a488035 271 </field>
6a488035 272 <field>
29494eef 273 <name>group_id</name>
047c5009 274 <title>Group ID</title>
29494eef
AS
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>
614d72ec 282 <html>
e0991796 283 <type>Select</type>
047c5009 284 <label>Group</label>
614d72ec 285 </html>
29494eef
AS
286 <add>3.4</add>
287 </field>
8f069c03
EM
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>
047c5009 296 <title>Message Template ID</title>
011aeb62 297 <type>int unsigned</type>
298 <comment>FK to the message template.</comment>
57e94608 299 <html>
047c5009 300 <label>Message Template</label>
57e94608 301 </html>
8f069c03
EM
302 </field>
303 <foreignKey>
304 <name>msg_template_id</name>
011aeb62 305 <table>civicrm_msg_template</table>
306 <key>id</key>
307 <onDelete>SET NULL</onDelete>
8f069c03 308 </foreignKey>
1e035d58 309 <field>
310 <name>sms_template_id</name>
047c5009 311 <title>SMS Template ID</title>
1e035d58 312 <type>int unsigned</type>
313 <comment>FK to the message template.</comment>
57e94608 314 <html>
047c5009 315 <label>SMS Template</label>
57e94608 316 </html>
1e035d58 317 </field>
318 <foreignKey>
ce62f51a 319 <name>sms_template_id</name>
1e035d58 320 <table>civicrm_msg_template</table>
321 <key>id</key>
322 <onDelete>SET NULL</onDelete>
323 </foreignKey>
8f069c03
EM
324 <field>
325 <name>absolute_date</name>
0d94665e 326 <title>Fixed Date for Reminder</title>
8f069c03
EM
327 <type>date</type>
328 <comment>Date on which the reminder be sent.</comment>
329 <add>4.1</add>
6a488035 330 </field>
1991bba1
DG
331 <field>
332 <name>from_name</name>
0d94665e 333 <title>Reminder from Name</title>
1991bba1
DG
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>
0d94665e 341 <title>Reminder From Email</title>
1991bba1
DG
342 <type>varchar</type>
343 <length>255</length>
344 <comment>Email address in "from" field</comment>
345 <add>4.5</add>
346 </field>
a3e3eea1 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>
57e94608 364 <title>SMS Provider ID</title>
a3e3eea1 365 <type>int unsigned</type>
366 <add>4.5</add>
367 <html>
368 <type>Select</type>
57e94608 369 <label>SMS Provider</label>
a3e3eea1 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>
62933949 379 <field>
380 <name>used_for</name>
381 <type>varchar</type>
382 <length>64</length>
881c2dfb 383 <comment>Used for repeating entity</comment>
1662d426
A
384 <html>
385 <label>Used For</label>
386 </html>
9d54f3a4 387 <add>4.6</add>
62933949 388 </field>
776a4216
SV
389 <field>
390 <name>filter_contact_language</name>
391 <type>varchar</type>
392 <length>128</length>
393 <comment>Used for multilingual installation</comment>
1662d426
A
394 <html>
395 <label>Filter Contact Language</label>
396 </html>
776a4216
SV
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>
1662d426
A
404 <html>
405 <label>Communication Language</label>
406 </html>
776a4216
SV
407 <add>4.7</add>
408 </field>
6a62a64e 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>
1662d426
A
426 <html>
427 <label>Modified Date</label>
428 </html>
6a62a64e 429 <add>5.34</add>
a0e733f3 430 <readonly>true</readonly>
6a62a64e 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>
6a488035 452</table>