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