xml/schema/Core/Job.xml

   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>
  11     <name>id</name>
  12     <title>Job ID</title>
  13     <type>int unsigned</type>
  14     <required>true</required>
  15     <comment>Job ID</comment>
  16     <html>
  17       <type>Number</type>
  18     </html>
  19     <add>4.1</add>
  20   </field>
  21   <primaryKey>
  22     <name>id</name>
  23     <autoincrement>true</autoincrement>
  24   </primaryKey>
  25   <field>
  26     <name>domain_id</name>
  27     <title>Domain ID</title>
  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>
  36     <html>
  37       <label>Domain</label>
  38     </html>
  39     <add>4.1</add>
  40   </field>
  41   <foreignKey>
  42     <name>domain_id</name>
  43     <table>civicrm_domain</table>
  44     <key>id</key>
  45     <add>4.1</add>
  46   </foreignKey>
  47   <field>
  48     <name>run_frequency</name>
  49     <title>Job Frequency</title>
  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>
  61   </field>
  62   <field>
  63     <name>last_run</name>
  64     <type>timestamp</type>
  65     <default>NULL</default>
  66     <required>false</required>
  67     <comment>When was this cron entry last run</comment>
  68     <html>
  69       <label>Last Run</label>
  70     </html>
  71     <add>4.1</add>
  72   </field>
  73   <field>
  74     <name>scheduled_run_date</name>
  75     <type>timestamp</type>
  76     <default>NULL</default>
  77     <required>false</required>
  78     <comment>When is this cron entry scheduled to run</comment>
  79     <html>
  80       <label>Scheduled Run Date</label>
  81     </html>
  82     <add>4.7</add>
  83   </field>
  84   <field>
  85     <name>name</name>
  86     <title>Job Name</title>
  87     <type>varchar</type>
  88     <length>255</length>
  89     <comment>Title of the job</comment>
  90     <add>4.1</add>
  91   </field>
  92   <field>
  93     <name>description</name>
  94     <title>Job Description</title>
  95     <type>varchar</type>
  96     <length>255</length>
  97     <comment>Description of the job</comment>
  98     <add>4.1</add>
  99   </field>
 100   <field>
 101     <name>api_entity</name>
 102     <title>API Entity</title>
 103     <type>varchar</type>
 104     <length>255</length>
 105     <comment>Entity of the job api call</comment>
 106     <add>4.1</add>
 107   </field>
 108   <field>
 109     <name>api_action</name>
 110     <title>API Action</title>
 111     <type>varchar</type>
 112     <length>255</length>
 113     <comment>Action of the job api call</comment>
 114     <add>4.1</add>
 115   </field>
 116   <field>
 117     <name>parameters</name>
 118     <title>API Parameters</title>
 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>
 127   </field>
 128   <field>
 129     <name>is_active</name>
 130     <title>Job Is Active?</title>
 131     <type>boolean</type>
 132     <comment>Is this job active?</comment>
 133     <add>4.1</add>
 134   </field>
 135 </table>