Merge pull request #17170 from colemanw/optionValueDefault
[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>
15 <comment>Job Id</comment>
16 <add>4.1</add>
6a488035
TO
17 </field>
18 <primaryKey>
8f069c03
EM
19 <name>id</name>
20 <autoincrement>true</autoincrement>
6a488035
TO
21 </primaryKey>
22 <field>
8f069c03 23 <name>domain_id</name>
32ac94e8 24 <title>Job Domain</title>
8f069c03
EM
25 <type>int unsigned</type>
26 <required>true</required>
27 <pseudoconstant>
28 <table>civicrm_domain</table>
29 <keyColumn>id</keyColumn>
30 <labelColumn>name</labelColumn>
31 </pseudoconstant>
32 <comment>Which Domain is this scheduled job for</comment>
33 <add>4.1</add>
6a488035
TO
34 </field>
35 <foreignKey>
8f069c03
EM
36 <name>domain_id</name>
37 <table>civicrm_domain</table>
38 <key>id</key>
39 <add>4.1</add>
6a488035
TO
40 </foreignKey>
41 <field>
8f069c03 42 <name>run_frequency</name>
32ac94e8 43 <title>Job Frequency</title>
8f069c03
EM
44 <type>varchar</type>
45 <length>8</length>
46 <default>"Daily"</default>
47 <comment>Scheduled job run frequency.</comment>
48 <pseudoconstant>
49 <callback>CRM_Core_SelectValues::getJobFrequency</callback>
50 </pseudoconstant>
51 <add>4.1</add>
52 <html>
53 <type>Select</type>
54 </html>
6a488035
TO
55 </field>
56 <field>
8f069c03 57 <name>last_run</name>
4387c66f 58 <type>timestamp</type>
8f069c03 59 <default>NULL</default>
4387c66f 60 <required>false</required>
8f069c03
EM
61 <comment>When was this cron entry last run</comment>
62 <add>4.1</add>
6a488035 63 </field>
e8f61813 64 <field>
d7bace22 65 <name>scheduled_run_date</name>
e8f61813
DRJ
66 <type>timestamp</type>
67 <default>NULL</default>
777717cf 68 <required>false</required>
d7bace22 69 <comment>When is this cron entry scheduled to run</comment>
e8f61813
DRJ
70 <add>4.7</add>
71 </field>
6a488035 72 <field>
8f069c03 73 <name>name</name>
32ac94e8 74 <title>Job Name</title>
8f069c03
EM
75 <type>varchar</type>
76 <length>255</length>
77 <comment>Title of the job</comment>
78 <add>4.1</add>
6a488035
TO
79 </field>
80 <field>
8f069c03 81 <name>description</name>
32ac94e8 82 <title>Job Description</title>
8f069c03
EM
83 <type>varchar</type>
84 <length>255</length>
85 <comment>Description of the job</comment>
86 <add>4.1</add>
6a488035
TO
87 </field>
88 <field>
8f069c03
EM
89 <name>api_prefix</name>
90 <type>varchar</type>
91 <length>255</length>
92 <default>"civicrm_api3"</default>
93 <comment>Prefix of the job api call</comment>
94 <add>4.1</add>
95 <drop>4.3</drop>
6a488035
TO
96 </field>
97 <field>
8f069c03 98 <name>api_entity</name>
32ac94e8 99 <title>API Entity</title>
8f069c03
EM
100 <type>varchar</type>
101 <length>255</length>
102 <comment>Entity of the job api call</comment>
103 <add>4.1</add>
6a488035
TO
104 </field>
105 <field>
8f069c03 106 <name>api_action</name>
32ac94e8 107 <title>API Action</title>
8f069c03
EM
108 <type>varchar</type>
109 <length>255</length>
110 <comment>Action of the job api call</comment>
111 <add>4.1</add>
6a488035
TO
112 </field>
113 <field>
8f069c03 114 <name>parameters</name>
32ac94e8 115 <title>API Parameters</title>
8f069c03
EM
116 <type>text</type>
117 <comment>List of parameters to the command.</comment>
118 <html>
119 <type>TextArea</type>
120 <rows>4</rows>
121 <cols>60</cols>
122 </html>
123 <add>4.1</add>
6a488035
TO
124 </field>
125 <field>
8f069c03 126 <name>is_active</name>
32ac94e8 127 <title>Job Is Active?</title>
8f069c03
EM
128 <type>boolean</type>
129 <comment>Is this job active?</comment>
130 <add>4.1</add>
6a488035
TO
131 </field>
132</table>