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