[civicrm-core.git] / xml / schema / Report / ReportInstance.xml

<?xml version="1.0" encoding="iso-8859-1" ?>

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