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