xml/schema/Report/ReportInstance.xml

   1 <?xml version="1.0" encoding="iso-8859-1" ?>
   2
   3 <table>
   4   <base>CRM/Report</base>
   5   <class>ReportInstance</class>
   6   <name>civicrm_report_instance</name>
   7   <comment>Users can save their report instance and put in a cron tab etc.</comment>
   8   <add>2.2</add>
   9   <field>
  10       <name>id</name>
  11       <title>Report Instance ID</title>
  12       <type>int unsigned</type>
  13       <required>true</required>
  14       <comment>Report Instance ID</comment>
  15        <add>2.2</add>
  16   </field>
  17   <primaryKey>
  18        <name>id</name>
  19        <autoincrement>false</autoincrement>
  20   </primaryKey>
  21   <field>
  22       <name>domain_id</name>
  23       <title>Report Instance Domain ID</title>
  24       <type>int unsigned</type>
  25       <required>true</required>
  26       <comment>Which Domain is this instance for</comment>
  27       <add>3.1</add>
  28   </field>
  29   <foreignKey>
  30        <name>domain_id</name>
  31        <table>civicrm_domain</table>
  32        <key>id</key>
  33        <add>3.1</add>
  34   </foreignKey>
  35   <field>
  36        <name>title</name>
  37        <title>Report Instance Title</title>
  38        <type>varchar</type>
  39        <length>255</length>
  40        <comment>Report Instance Title.</comment>
  41        <html>
  42         <type>Text</type>
  43       </html>
  44        <add>2.2</add>
  45   </field>
  46   <field>
  47       <name>report_id</name>
  48       <title>Report template ID</title>
  49       <type>varchar</type>
  50       <length>64</length>
  51       <required>true</required>
  52       <comment>FK to civicrm_option_value for the report template</comment>
  53       <html>
  54         <type>Select</type>
  55       </html>
  56       <add>2.2</add>
  57   </field>
  58   <field>
  59       <name>name</name>
  60       <title>Report instance Name</title>
  61       <type>varchar</type>
  62       <length>255</length>
  63       <comment>when combined with report_id/template uniquely identifies the instance</comment>
  64       <html>
  65         <type>Text</type>
  66       </html>
  67       <add>3.2</add>
  68   </field>
  69   <field>
  70       <name>args</name>
  71       <title>Report Instance Arguments</title>
  72       <type>varchar</type>
  73       <length>255</length>
  74       <comment>arguments that are passed in the url when invoking the instance</comment>
  75       <add>3.2</add>
  76       <html>
  77         <type>Text</type>
  78       </html>
  79   </field>
  80   <field>
  81        <name>description</name>
  82        <title>Report Instance description</title>
  83        <type>varchar</type>
  84        <length>255</length>
  85        <comment>Report Instance description.</comment>
  86        <html>
  87         <type>Text</type>
  88       </html>
  89        <add>2.2</add>
  90   </field>
  91   <field>
  92        <name>permission</name>
  93        <title>Report Instance Permissions</title>
  94        <type>varchar</type>
  95        <length>255</length>
  96        <comment>permission required to be able to run this instance</comment>
  97        <html>
  98         <type>Text</type>
  99       </html>
 100        <add>2.2</add>
 101   </field>
 102   <field>
 103        <name>grouprole</name>
 104        <title>Report Instance Assigned to Roles</title>
 105        <type>varchar</type>
 106        <length>1024</length>
 107        <comment>role required to be able to run this instance</comment>
 108        <add>4.1</add>
 109        <html>
 110         <type>Text</type>
 111       </html>
 112   </field>
 113   <field>
 114        <name>form_values</name>
 115        <title>Submitted Form Values</title>
 116        <type>text</type>
 117        <import>true</import>
 118        <comment>Submitted form values for this report</comment>
 119        <add>2.2</add>
 120   </field>
 121   <field>
 122        <name>is_active</name>
 123        <title>Report Instance is Active</title>
 124        <type>boolean</type>
 125        <comment>Is this entry active?</comment>
 126        <html>
 127          <type>CheckBox</type>
 128        </html>
 129        <add>2.2</add>
 130   </field>
 131   <field>
 132        <name>email_subject</name>
 133        <title>Report Instance email Subject</title>
 134        <type>varchar</type>
 135        <length>255</length>
 136        <comment>Subject of email</comment>
 137        <html>
 138          <type>Text</type>
 139        </html>
 140   </field>
 141   <field>
 142       <name>email_to</name>
 143       <title>Email Report Instance To</title>
 144       <type>text</type>
 145       <comment>comma-separated list of email addresses to send the report to</comment>
 146       <html>
 147         <type>Text</type>
 148       </html>
 149       <add>2.2</add>
 150   </field>
 151   <field>
 152       <name>email_cc</name>
 153       <title>cc Email Report Instance To</title>
 154       <type>text</type>
 155       <comment>comma-separated list of email addresses to send the report to</comment>
 156       <html>
 157         <type>Text</type>
 158       </html>
 159       <add>2.2</add>
 160   </field>
 161   <field>
 162       <name>header</name>
 163       <title>Report Instance Header</title>
 164       <type>text</type>
 165       <comment>comma-separated list of email addresses to send the report to</comment>
 166       <html>
 167         <type>TextArea</type>
 168         <rows>4</rows>
 169         <cols>60</cols>
 170       </html>
 171       <add>2.2</add>
 172   </field>
 173   <field>
 174       <name>footer</name>
 175       <title>Report Instance Footer</title>
 176       <type>text</type>
 177       <comment>comma-separated list of email addresses to send the report to</comment>
 178       <html>
 179         <type>TextArea</type>
 180         <rows>4</rows>
 181         <cols>60</cols>
 182       </html>
 183       <add>2.2</add>
 184   </field>
 185   <field>
 186       <name>navigation_id</name>
 187       <title>Navigation ID</title>
 188       <type>int unsigned</type>
 189       <import>true</import>
 190       <comment>FK to navigation ID</comment>
 191       <add>3.0</add>
 192   </field>
 193   <foreignKey>
 194        <name>navigation_id</name>
 195        <table>civicrm_navigation</table>
 196        <key>id</key>
 197        <add>3.0</add>
 198        <onDelete>SET NULL</onDelete>
 199   </foreignKey>
 200   <field>
 201       <name>drilldown_id</name>
 202       <title>Drilldown Report ID</title>
 203       <type>int unsigned</type>
 204       <import>true</import>
 205       <comment>FK to instance ID drilldown to</comment>
 206       <add>4.3</add>
 207   </field>
 208   <foreignKey>
 209        <name>drilldown_id</name>
 210        <table>civicrm_report_instance</table>
 211        <key>id</key>
 212        <add>4.3</add>
 213        <onDelete>SET NULL</onDelete>
 214   </foreignKey>
 215   <field>
 216     <name>is_reserved</name>
 217     <title>Instance is Reserved</title>
 218     <type>boolean</type>
 219     <default>0</default>
 220     <html>
 221       <type>CheckBox</type>
 222     </html>
 223     <add>4.2</add>
 224   </field>
 225 </table>