Merge pull request #23210 from eileenmcnaughton/cancel
[civicrm-core.git] / xml / schema / Core / Job.xml
CommitLineData
6a488035
TO
1<?xml version="1.0" encoding="iso-8859-1" ?>
2
3<table>
4 <base>CRM/Core</base>
5 <class>Job</class>
6 <name>civicrm_job</name>
7 <comment>Scheduled job.</comment>
8 <add>4.1</add>
9 <log>false</log>
10 <field>
8f069c03 11 <name>id</name>
32ac94e8 12 <title>Job ID</title>
8f069c03
EM
13 <type>int unsigned</type>
14 <required>true</required>
047c5009 15 <comment>Job ID</comment>
0481e12c
A
16 <html>
17 <type>Number</type>
18 </html>
8f069c03 19 <add>4.1</add>
6a488035
TO
20 </field>
21 <primaryKey>
8f069c03
EM
22 <name>id</name>
23 <autoincrement>true</autoincrement>
6a488035
TO
24 </primaryKey>
25 <field>
8f069c03 26 <name>domain_id</name>
047c5009 27 <title>Domain ID</title>
8f069c03
EM
28 <type>int unsigned</type>
29 <required>true</required>
30 <pseudoconstant>
31 <table>civicrm_domain</table>
32 <keyColumn>id</keyColumn>
33 <labelColumn>name</labelColumn>
34 </pseudoconstant>
35 <comment>Which Domain is this scheduled job for</comment>
57e94608 36 <html>
047c5009 37 <label>Domain</label>
57e94608 38 </html>
8f069c03 39 <add>4.1</add>
6a488035
TO
40 </field>
41 <foreignKey>
8f069c03
EM
42 <name>domain_id</name>
43 <table>civicrm_domain</table>
44 <key>id</key>
45 <add>4.1</add>
6a488035
TO
46 </foreignKey>
47 <field>
8f069c03 48 <name>run_frequency</name>
32ac94e8 49 <title>Job Frequency</title>
8f069c03
EM
50 <type>varchar</type>
51 <length>8</length>
52 <default>"Daily"</default>
53 <comment>Scheduled job run frequency.</comment>
54 <pseudoconstant>
55 <callback>CRM_Core_SelectValues::getJobFrequency</callback>
56 </pseudoconstant>
57 <add>4.1</add>
58 <html>
59 <type>Select</type>
60 </html>
6a488035
TO
61 </field>
62 <field>
8f069c03 63 <name>last_run</name>
4387c66f 64 <type>timestamp</type>
8f069c03 65 <default>NULL</default>
4387c66f 66 <required>false</required>
8f069c03 67 <comment>When was this cron entry last run</comment>
1662d426
A
68 <html>
69 <label>Last Run</label>
70 </html>
8f069c03 71 <add>4.1</add>
6a488035 72 </field>
e8f61813 73 <field>
d7bace22 74 <name>scheduled_run_date</name>
e8f61813
DRJ
75 <type>timestamp</type>
76 <default>NULL</default>
777717cf 77 <required>false</required>
d7bace22 78 <comment>When is this cron entry scheduled to run</comment>
1662d426
A
79 <html>
80 <label>Scheduled Run Date</label>
81 </html>
e8f61813
DRJ
82 <add>4.7</add>
83 </field>
6a488035 84 <field>
8f069c03 85 <name>name</name>
32ac94e8 86 <title>Job Name</title>
8f069c03
EM
87 <type>varchar</type>
88 <length>255</length>
89 <comment>Title of the job</comment>
90 <add>4.1</add>
6a488035
TO
91 </field>
92 <field>
8f069c03 93 <name>description</name>
32ac94e8 94 <title>Job Description</title>
8f069c03
EM
95 <type>varchar</type>
96 <length>255</length>
97 <comment>Description of the job</comment>
98 <add>4.1</add>
6a488035 99 </field>
6a488035 100 <field>
8f069c03 101 <name>api_entity</name>
32ac94e8 102 <title>API Entity</title>
8f069c03
EM
103 <type>varchar</type>
104 <length>255</length>
105 <comment>Entity of the job api call</comment>
106 <add>4.1</add>
6a488035
TO
107 </field>
108 <field>
8f069c03 109 <name>api_action</name>
32ac94e8 110 <title>API Action</title>
8f069c03
EM
111 <type>varchar</type>
112 <length>255</length>
113 <comment>Action of the job api call</comment>
114 <add>4.1</add>
6a488035
TO
115 </field>
116 <field>
8f069c03 117 <name>parameters</name>
32ac94e8 118 <title>API Parameters</title>
8f069c03
EM
119 <type>text</type>
120 <comment>List of parameters to the command.</comment>
121 <html>
122 <type>TextArea</type>
123 <rows>4</rows>
124 <cols>60</cols>
125 </html>
126 <add>4.1</add>
6a488035
TO
127 </field>
128 <field>
8f069c03 129 <name>is_active</name>
32ac94e8 130 <title>Job Is Active?</title>
8f069c03
EM
131 <type>boolean</type>
132 <comment>Is this job active?</comment>
c1e814c7
MD
133 <default>1</default>
134 <required>true</required>
8f069c03 135 <add>4.1</add>
6a488035
TO
136 </field>
137</table>