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>512</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     <serialize>PHP</serialize>
 125     <add>2.2</add>
 126   </field>
 127   <field>
 128     <name>is_active</name>
 129     <title>Report Instance is Active</title>
 130     <type>boolean</type>
 131     <comment>Is this entry active?</comment>
 132     <html>
 133       <type>CheckBox</type>
 134     </html>
 135     <add>2.2</add>
 136   </field>
 137   <field>
 138     <name>created_id</name>
 139     <type>int unsigned</type>
 140     <title>Report Instance Created By</title>
 141     <comment>FK to contact table.</comment>
 142     <add>4.6</add>
 143   </field>
 144   <foreignKey>
 145     <name>created_id</name>
 146     <table>civicrm_contact</table>
 147     <key>id</key>
 148     <add>4.6</add>
 149     <onDelete>SET NULL</onDelete>
 150   </foreignKey>
 151   <field>
 152     <name>owner_id</name>
 153     <type>int unsigned</type>
 154     <title>Report Instance Owned By</title>
 155     <comment>FK to contact table.</comment>
 156     <add>4.6</add>
 157   </field>
 158   <foreignKey>
 159     <name>owner_id</name>
 160     <table>civicrm_contact</table>
 161     <key>id</key>
 162     <add>4.6</add>
 163     <onDelete>SET NULL</onDelete>
 164   </foreignKey>
 165   <field>
 166     <name>email_subject</name>
 167     <title>Report Instance email Subject</title>
 168     <type>varchar</type>
 169     <length>255</length>
 170     <comment>Subject of email</comment>
 171     <html>
 172       <type>Text</type>
 173     </html>
 174   </field>
 175   <field>
 176     <name>email_to</name>
 177     <title>Email Report Instance To</title>
 178     <type>text</type>
 179     <comment>comma-separated list of email addresses to send the report to</comment>
 180     <html>
 181       <type>Text</type>
 182     </html>
 183     <add>2.2</add>
 184   </field>
 185   <field>
 186     <name>email_cc</name>
 187     <title>cc Email Report Instance To</title>
 188     <type>text</type>
 189     <comment>comma-separated list of email addresses to send the report to</comment>
 190     <html>
 191       <type>Text</type>
 192     </html>
 193     <add>2.2</add>
 194   </field>
 195   <field>
 196     <name>header</name>
 197     <title>Report Instance Header</title>
 198     <type>text</type>
 199     <comment>comma-separated list of email addresses to send the report to</comment>
 200     <html>
 201       <type>TextArea</type>
 202       <rows>4</rows>
 203       <cols>60</cols>
 204     </html>
 205     <add>2.2</add>
 206   </field>
 207   <field>
 208     <name>footer</name>
 209     <title>Report Instance Footer</title>
 210     <type>text</type>
 211     <comment>comma-separated list of email addresses to send the report to</comment>
 212     <html>
 213       <type>TextArea</type>
 214       <rows>4</rows>
 215       <cols>60</cols>
 216     </html>
 217     <add>2.2</add>
 218   </field>
 219   <field>
 220     <name>navigation_id</name>
 221     <title>Navigation ID</title>
 222     <type>int unsigned</type>
 223     <import>true</import>
 224     <comment>FK to navigation ID</comment>
 225     <add>3.0</add>
 226   </field>
 227   <foreignKey>
 228     <name>navigation_id</name>
 229     <table>civicrm_navigation</table>
 230     <key>id</key>
 231     <add>3.0</add>
 232     <onDelete>SET NULL</onDelete>
 233   </foreignKey>
 234   <field>
 235     <name>drilldown_id</name>
 236     <title>Drilldown Report ID</title>
 237     <type>int unsigned</type>
 238     <import>true</import>
 239     <comment>FK to instance ID drilldown to</comment>
 240     <add>4.3</add>
 241   </field>
 242   <foreignKey>
 243     <name>drilldown_id</name>
 244     <table>civicrm_report_instance</table>
 245     <key>id</key>
 246     <add>4.3</add>
 247     <onDelete>SET NULL</onDelete>
 248   </foreignKey>
 249   <field>
 250     <name>is_reserved</name>
 251     <title>Instance is Reserved</title>
 252     <type>boolean</type>
 253     <default>0</default>
 254     <html>
 255       <type>CheckBox</type>
 256     </html>
 257     <add>4.2</add>
 258   </field>
 259 </table>