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     <add>4.1</add>
  17   </field>
  18   <primaryKey>
  19     <name>id</name>
  20     <autoincrement>true</autoincrement>
  21   </primaryKey>
  22   <field>
  23     <name>domain_id</name>
  24     <title>Job Domain</title>
  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>
  34   </field>
  35   <foreignKey>
  36     <name>domain_id</name>
  37     <table>civicrm_domain</table>
  38     <key>id</key>
  39     <add>4.1</add>
  40   </foreignKey>
  41   <field>
  42     <name>run_frequency</name>
  43     <title>Job Frequency</title>
  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>
  55   </field>
  56   <field>
  57     <name>last_run</name>
  58     <type>datetime</type>
  59     <default>NULL</default>
  60     <comment>When was this cron entry last run</comment>
  61     <add>4.1</add>
  62   </field>
  63   <field>
  64     <name>next_scheduled_run</name>
  65     <type>timestamp</type>
  66     <default>NULL</default>
  67     <comment>When is this cron entry scheduled to run next</comment>
  68     <add>4.7</add>
  69   </field>
  70   <field>
  71     <name>name</name>
  72     <title>Job Name</title>
  73     <type>varchar</type>
  74     <length>255</length>
  75     <comment>Title of the job</comment>
  76     <add>4.1</add>
  77   </field>
  78   <field>
  79     <name>description</name>
  80     <title>Job Description</title>
  81     <type>varchar</type>
  82     <length>255</length>
  83     <comment>Description of the job</comment>
  84     <add>4.1</add>
  85   </field>
  86   <field>
  87     <name>api_prefix</name>
  88     <type>varchar</type>
  89     <length>255</length>
  90     <default>"civicrm_api3"</default>
  91     <comment>Prefix of the job api call</comment>
  92     <add>4.1</add>
  93     <drop>4.3</drop>
  94   </field>
  95   <field>
  96     <name>api_entity</name>
  97     <title>API Entity</title>
  98     <type>varchar</type>
  99     <length>255</length>
 100     <comment>Entity of the job api call</comment>
 101     <add>4.1</add>
 102   </field>
 103   <field>
 104     <name>api_action</name>
 105     <title>API Action</title>
 106     <type>varchar</type>
 107     <length>255</length>
 108     <comment>Action of the job api call</comment>
 109     <add>4.1</add>
 110   </field>
 111   <field>
 112     <name>parameters</name>
 113     <title>API Parameters</title>
 114     <type>text</type>
 115     <comment>List of parameters to the command.</comment>
 116     <html>
 117       <type>TextArea</type>
 118       <rows>4</rows>
 119       <cols>60</cols>
 120     </html>
 121     <add>4.1</add>
 122   </field>
 123   <field>
 124     <name>is_active</name>
 125     <title>Job Is Active?</title>
 126     <type>boolean</type>
 127     <comment>Is this job active?</comment>
 128     <add>4.1</add>
 129   </field>
 130 </table>