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   <title>Report</title>
  10   <icon>fa-bar-chart</icon>
  11   <component>CiviReport</component>
  12   <field>
  13     <name>id</name>
  14     <title>Report Instance ID</title>
  15     <type>int unsigned</type>
  16     <required>true</required>
  17     <comment>Report Instance ID</comment>
  18     <html>
  19       <type>Number</type>
  20     </html>
  21     <add>2.2</add>
  22   </field>
  23   <primaryKey>
  24     <name>id</name>
  25     <autoincrement>false</autoincrement>
  26   </primaryKey>
  27   <field>
  28     <name>domain_id</name>
  29     <title>Domain ID</title>
  30     <type>int unsigned</type>
  31     <pseudoconstant>
  32       <table>civicrm_domain</table>
  33       <keyColumn>id</keyColumn>
  34       <labelColumn>name</labelColumn>
  35     </pseudoconstant>
  36     <required>true</required>
  37     <comment>Which Domain is this instance for</comment>
  38     <html>
  39       <label>Domain</label>
  40     </html>
  41     <add>3.1</add>
  42   </field>
  43   <foreignKey>
  44     <name>domain_id</name>
  45     <table>civicrm_domain</table>
  46     <key>id</key>
  47     <add>3.1</add>
  48   </foreignKey>
  49   <field>
  50     <name>title</name>
  51     <title>Report Instance Title</title>
  52     <type>varchar</type>
  53     <length>255</length>
  54     <comment>Report Instance Title.</comment>
  55     <html>
  56       <type>Text</type>
  57     </html>
  58     <add>2.2</add>
  59   </field>
  60   <field>
  61     <name>report_id</name>
  62     <title>Report template ID</title>
  63     <type>varchar</type>
  64     <length>512</length>
  65     <required>true</required>
  66     <comment>FK to civicrm_option_value for the report template</comment>
  67     <html>
  68       <type>Select</type>
  69     </html>
  70     <add>2.2</add>
  71   </field>
  72   <field>
  73     <name>name</name>
  74     <title>Report instance Name</title>
  75     <type>varchar</type>
  76     <length>255</length>
  77     <comment>when combined with report_id/template uniquely identifies the instance</comment>
  78     <html>
  79       <type>Text</type>
  80     </html>
  81     <add>3.2</add>
  82   </field>
  83   <field>
  84     <name>args</name>
  85     <title>Report Instance Arguments</title>
  86     <type>varchar</type>
  87     <length>255</length>
  88     <comment>arguments that are passed in the url when invoking the instance</comment>
  89     <add>3.2</add>
  90     <html>
  91       <type>Text</type>
  92     </html>
  93   </field>
  94   <field>
  95     <name>description</name>
  96     <title>Report Instance description</title>
  97     <type>varchar</type>
  98     <length>255</length>
  99     <comment>Report Instance description.</comment>
 100     <html>
 101       <type>Text</type>
 102     </html>
 103     <add>2.2</add>
 104   </field>
 105   <field>
 106     <name>permission</name>
 107     <title>Report Instance Permissions</title>
 108     <type>varchar</type>
 109     <length>255</length>
 110     <comment>permission required to be able to run this instance</comment>
 111     <html>
 112       <type>Text</type>
 113     </html>
 114     <add>2.2</add>
 115   </field>
 116   <field>
 117     <name>grouprole</name>
 118     <title>Report Instance Assigned to Roles</title>
 119     <type>varchar</type>
 120     <length>1024</length>
 121     <comment>role required to be able to run this instance</comment>
 122     <add>4.1</add>
 123     <html>
 124       <type>Text</type>
 125     </html>
 126   </field>
 127   <field>
 128     <name>form_values</name>
 129     <title>Submitted Form Values</title>
 130     <type>longtext</type>
 131     <import>true</import>
 132     <comment>Submitted form values for this report</comment>
 133     <serialize>PHP</serialize>
 134     <add>2.2</add>
 135   </field>
 136   <field>
 137     <name>is_active</name>
 138     <title>Report Instance is Active</title>
 139     <type>boolean</type>
 140     <comment>Is this entry active?</comment>
 141     <html>
 142       <type>CheckBox</type>
 143     </html>
 144     <add>2.2</add>
 145   </field>
 146   <field>
 147     <name>created_id</name>
 148     <type>int unsigned</type>
 149     <title>Created By Contact ID</title>
 150     <comment>FK to contact table.</comment>
 151     <html>
 152       <label>Created By</label>
 153     </html>
 154     <add>4.6</add>
 155   </field>
 156   <foreignKey>
 157     <name>created_id</name>
 158     <table>civicrm_contact</table>
 159     <key>id</key>
 160     <add>4.6</add>
 161     <onDelete>SET NULL</onDelete>
 162   </foreignKey>
 163   <field>
 164     <name>owner_id</name>
 165     <type>int unsigned</type>
 166     <title>Owned By Contact ID</title>
 167     <comment>FK to contact table.</comment>
 168     <html>
 169       <label>Owned By</label>
 170     </html>
 171     <add>4.6</add>
 172   </field>
 173   <foreignKey>
 174     <name>owner_id</name>
 175     <table>civicrm_contact</table>
 176     <key>id</key>
 177     <add>4.6</add>
 178     <onDelete>SET NULL</onDelete>
 179   </foreignKey>
 180   <field>
 181     <name>email_subject</name>
 182     <title>Report Instance email Subject</title>
 183     <type>varchar</type>
 184     <length>255</length>
 185     <comment>Subject of email</comment>
 186     <html>
 187       <type>Text</type>
 188     </html>
 189   </field>
 190   <field>
 191     <name>email_to</name>
 192     <title>Email Report Instance To</title>
 193     <type>text</type>
 194     <comment>comma-separated list of email addresses to send the report to</comment>
 195     <html>
 196       <type>Text</type>
 197     </html>
 198     <add>2.2</add>
 199   </field>
 200   <field>
 201     <name>email_cc</name>
 202     <title>cc Email Report Instance To</title>
 203     <type>text</type>
 204     <comment>comma-separated list of email addresses to send the report to</comment>
 205     <html>
 206       <type>Text</type>
 207     </html>
 208     <add>2.2</add>
 209   </field>
 210   <field>
 211     <name>header</name>
 212     <title>Report Instance Header</title>
 213     <type>text</type>
 214     <comment>comma-separated list of email addresses to send the report to</comment>
 215     <html>
 216       <type>TextArea</type>
 217       <rows>4</rows>
 218       <cols>60</cols>
 219     </html>
 220     <add>2.2</add>
 221   </field>
 222   <field>
 223     <name>footer</name>
 224     <title>Report Instance Footer</title>
 225     <type>text</type>
 226     <comment>comma-separated list of email addresses to send the report to</comment>
 227     <html>
 228       <type>TextArea</type>
 229       <rows>4</rows>
 230       <cols>60</cols>
 231     </html>
 232     <add>2.2</add>
 233   </field>
 234   <field>
 235     <name>navigation_id</name>
 236     <title>Navigation ID</title>
 237     <type>int unsigned</type>
 238     <import>true</import>
 239     <comment>FK to navigation ID</comment>
 240     <html>
 241       <label>Navigation</label>
 242     </html>
 243     <add>3.0</add>
 244   </field>
 245   <foreignKey>
 246     <name>navigation_id</name>
 247     <table>civicrm_navigation</table>
 248     <key>id</key>
 249     <add>3.0</add>
 250     <onDelete>SET NULL</onDelete>
 251   </foreignKey>
 252   <field>
 253     <name>drilldown_id</name>
 254     <title>Drilldown Report ID</title>
 255     <type>int unsigned</type>
 256     <import>true</import>
 257     <comment>FK to instance ID drilldown to</comment>
 258     <html>
 259       <label>Drilldown Report</label>
 260     </html>
 261     <add>4.3</add>
 262   </field>
 263   <foreignKey>
 264     <name>drilldown_id</name>
 265     <table>civicrm_report_instance</table>
 266     <key>id</key>
 267     <add>4.3</add>
 268     <onDelete>SET NULL</onDelete>
 269   </foreignKey>
 270   <field>
 271     <name>is_reserved</name>
 272     <title>Instance is Reserved</title>
 273     <type>boolean</type>
 274     <default>0</default>
 275     <html>
 276       <type>CheckBox</type>
 277     </html>
 278     <add>4.2</add>
 279   </field>
 280 </table>