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