Merge pull request #5047 from colemanw/CRM-15898
[civicrm-core.git] / 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 <add>3.4</add>
15 </field>
16 <primaryKey>
17 <name>id</name>
18 <autoincrement>true</autoincrement>
19 </primaryKey>
20 <field>
21 <name>name</name>
22 <title>Name</title>
23 <type>varchar</type>
24 <length>64</length>
25 <comment>Name of the action(reminder)</comment>
26 <add>3.4</add>
27 </field>
28 <field>
29 <name>title</name>
30 <title>Title</title>
31 <type>varchar</type>
32 <length>64</length>
33 <comment>Title of the action(reminder)</comment>
34 <add>3.4</add>
35 </field>
36 <field>
37 <name>recipient</name>
38 <type>varchar</type>
39 <length>64</length>
40 <comment>Recipient</comment>
41 <add>3.4</add>
42 </field>
43 <field>
44 <name>limit_to</name>
45 <type>boolean</type>
46 <comment>Is this the recipient criteria limited to OR in addition to?</comment>
47 <add>4.4</add>
48 </field>
49 <field>
50 <name>entity_value</name>
51 <type>varchar</type>
52 <length>255</length>
53 <comment>Entity value</comment>
54 <add>3.4</add>
55 </field>
56 <field>
57 <name>entity_status</name>
58 <type>varchar</type>
59 <length>64</length>
60 <comment>Entity status</comment>
61 <add>3.4</add>
62 </field>
63 <field>
64 <name>start_action_offset</name>
65 <type>int unsigned</type>
66 <comment>Reminder Interval.</comment>
67 <add>3.4</add>
68 </field>
69 <field>
70 <name>start_action_unit</name>
71 <type>varchar</type>
72 <length>8</length>
73 <comment>Time units for reminder.</comment>
74 <pseudoconstant>
75 <callback>CRM_Core_SelectValues::getScheduleReminderFrequencyUnits</callback>
76 </pseudoconstant>
77 <add>3.4</add>
78 <html>
79 <type>Select</type>
80 </html>
81 </field>
82 <field>
83 <name>start_action_condition</name>
84 <type>varchar</type>
85 <length>32</length>
86 <comment>Reminder Action</comment>
87 <add>3.4</add>
88 </field>
89 <field>
90 <name>start_action_date</name>
91 <type>varchar</type>
92 <length>64</length>
93 <comment>Entity date</comment>
94 <add>3.4</add>
95 </field>
96 <field>
97 <name>is_repeat</name>
98 <title>Repeat?</title>
99 <type>boolean</type>
100 <default>0</default>
101 <add>3.4</add>
102 </field>
103 <field>
104 <name>repetition_frequency_unit</name>
105 <type>varchar</type>
106 <length>8</length>
107 <comment>Time units for repetition of reminder.</comment>
108 <pseudoconstant>
109 <callback>CRM_Core_SelectValues::getScheduleReminderFrequencyUnits</callback>
110 </pseudoconstant>
111 <add>3.4</add>
112 <html>
113 <type>Select</type>
114 </html>
115 </field>
116 <field>
117 <name>repetition_frequency_interval</name>
118 <type>int unsigned</type>
119 <comment>Time interval for repeating the reminder.</comment>
120 <add>3.4</add>
121 </field>
122 <field>
123 <name>end_frequency_unit</name>
124 <type>varchar</type>
125 <length>8</length>
126 <comment>Time units till repetition of reminder.</comment>
127 <pseudoconstant>
128 <callback>CRM_Core_SelectValues::getScheduleReminderFrequencyUnits</callback>
129 </pseudoconstant>
130 <add>3.4</add>
131 <html>
132 <type>Select</type>
133 </html>
134 </field>
135 <field>
136 <name>end_frequency_interval</name>
137 <type>int unsigned</type>
138 <comment>Time interval till repeating the reminder.</comment>
139 <add>3.4</add>
140 </field>
141 <field>
142 <name>end_action</name>
143 <type>varchar</type>
144 <length>32</length>
145 <comment>Reminder Action till repeating the reminder.</comment>
146 <add>3.4</add>
147 </field>
148 <field>
149 <name>end_date</name>
150 <type>varchar</type>
151 <length>64</length>
152 <comment>Entity end date</comment>
153 <add>3.4</add>
154 </field>
155 <field>
156 <name>is_active</name>
157 <title>Schedule is Active?</title>
158 <type>boolean</type>
159 <default>1</default>
160 <comment>Is this option active?</comment>
161 <add>3.4</add>
162 </field>
163 <field>
164 <name>recipient_manual</name>
165 <title>Recipient Manual</title>
166 <type>varchar</type>
167 <length>128</length>
168 <comment>Contact IDs to which reminder should be sent.</comment>
169 <add>3.4</add>
170 </field>
171 <field>
172 <name>recipient_listing</name>
173 <title>Recipient Listing</title>
174 <type>varchar</type>
175 <length>128</length>
176 <comment>listing based on recipient field.</comment>
177 <add>4.1</add>
178 </field>
179 <field>
180 <name>body_text</name>
181 <title>Reminder Text</title>
182 <type>longtext</type>
183 <comment>Body of the mailing in text format.</comment>
184 <add>3.4</add>
185 </field>
186 <field>
187 <name>body_html</name>
188 <title>Reminder HTML</title>
189 <type>longtext</type>
190 <comment>Body of the mailing in html format.</comment>
191 <add>3.4</add>
192 </field>
193 <field>
194 <name>sms_body_text</name>
195 <title>SMS Reminder Text</title>
196 <type>longtext</type>
197 <comment>Content of the SMS text.</comment>
198 <add>4.5</add>
199 </field>
200 <field>
201 <name>subject</name>
202 <title>Reminder Subject</title>
203 <type>varchar</type>
204 <length>128</length>
205 <comment>Subject of mailing</comment>
206 <add>3.4</add>
207 </field>
208 <field>
209 <name>record_activity</name>
210 <title>Record Activity for Reminder?</title>
211 <type>boolean</type>
212 <default>NULL</default>
213 <comment>Record Activity for this reminder?</comment>
214 <add>3.4</add>
215 </field>
216 <field>
217 <name>mapping_id</name>
218 <title>Reminder Mapping</title>
219 <type>int unsigned</type>
220 <comment>FK to mapping which is being used by this reminder</comment>
221 <add>3.4</add>
222 </field>
223 <foreignKey>
224 <name>mapping_id</name>
225 <table>civicrm_action_mapping</table>
226 <key>id</key>
227 <onDelete>SET NULL</onDelete>
228 </foreignKey>
229 <field>
230 <name>group_id</name>
231 <title>Reminder Group</title>
232 <type>int unsigned</type>
233 <comment>FK to Group</comment>
234 <pseudoconstant>
235 <table>civicrm_group</table>
236 <keyColumn>id</keyColumn>
237 <labelColumn>title</labelColumn>
238 </pseudoconstant>
239 <html>
240 <type>Select</type>
241 </html>
242 <add>3.4</add>
243 </field>
244 <foreignKey>
245 <name>group_id</name>
246 <table>civicrm_group</table>
247 <key>id</key>
248 <onDelete>SET NULL</onDelete>
249 </foreignKey>
250 <field>
251 <name>msg_template_id</name>
252 <title>Reminder Template</title>
253 <type>int unsigned</type>
254 <comment>FK to the message template.</comment>
255 </field>
256 <foreignKey>
257 <name>msg_template_id</name>
258 <table>civicrm_msg_template</table>
259 <key>id</key>
260 <onDelete>SET NULL</onDelete>
261 </foreignKey>
262 <field>
263 <name>sms_template_id</name>
264 <title>SMS Reminder Template</title>
265 <type>int unsigned</type>
266 <comment>FK to the message template.</comment>
267 </field>
268 <foreignKey>
269 <name>msg_template_id</name>
270 <table>civicrm_msg_template</table>
271 <key>id</key>
272 <onDelete>SET NULL</onDelete>
273 </foreignKey>
274 <field>
275 <name>absolute_date</name>
276 <title>Fixed Date for Reminder</title>
277 <type>date</type>
278 <comment>Date on which the reminder be sent.</comment>
279 <add>4.1</add>
280 </field>
281 <field>
282 <name>from_name</name>
283 <title>Reminder from Name</title>
284 <type>varchar</type>
285 <length>255</length>
286 <comment>Name in "from" field</comment>
287 <add>4.5</add>
288 </field>
289 <field>
290 <name>from_email</name>
291 <title>Reminder From Email</title>
292 <type>varchar</type>
293 <length>255</length>
294 <comment>Email address in "from" field</comment>
295 <add>4.5</add>
296 </field>
297 <field>
298 <name>mode</name>
299 <title>Message Mode</title>
300 <default>"Email"</default>
301 <type>varchar</type>
302 <length>128</length>
303 <comment>Send the message as email or sms or both.</comment>
304 <pseudoconstant>
305 <optionGroupName>msg_mode</optionGroupName>
306 </pseudoconstant>
307 <html>
308 <type>Select</type>
309 </html>
310 <add>4.5</add>
311 </field>
312 <field>
313 <name>sms_provider_id</name>
314 <title>SMS Provider</title>
315 <type>int unsigned</type>
316 <add>4.5</add>
317 <html>
318 <type>Select</type>
319 </html>
320 </field>
321 <foreignKey>
322 <name>sms_provider_id</name>
323 <table>civicrm_sms_provider</table>
324 <key>id</key>
325 <onDelete>SET NULL</onDelete>
326 <add>4.5</add>
327 </foreignKey>
328 <field>
329 <name>used_for</name>
330 <type>varchar</type>
331 <length>64</length>
332 <comment>Used for repeating entity</comment>
333 <add>4.6</add>
334 </field>
335 </table>