[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>
    <html>
      <type>Number</type>
    </html>
    <add>2.2</add>
  </field>
  <primaryKey>
    <name>id</name>
    <autoincrement>false</autoincrement>
  </primaryKey>
  <field>
    <name>domain_id</name>
    <title>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>
    <html>
      <label>Domain</label>
    </html>
    <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>
    <default>1</default>
    <required>true</required>
    <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>Created By Contact ID</title>
    <comment>FK to contact table.</comment>
    <html>
      <label>Created By</label>
    </html>
    <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>Owned By Contact ID</title>
    <comment>FK to contact table.</comment>
    <html>
      <label>Owned By</label>
    </html>
    <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>
    <html>
      <label>Navigation</label>
    </html>
    <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>
    <html>
      <label>Drilldown Report</label>
    </html>
    <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>
    <required>true</required>
    <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>
0481e12c A	18	<html>
	19	<type>Number</type>
	20	</html>
5435b737	21	<add>2.2</add>
6a488035 TO	22	</field>
6a488035 TO	23	<primaryKey>
5435b737 EM	24	<name>id</name>
5435b737 EM	25	<autoincrement>false</autoincrement>
6a488035 TO	26	</primaryKey>
6a488035 TO	27	<field>
5435b737	28	<name>domain_id</name>
047c5009	29	<title>Domain ID</title>
5435b737 EM	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>
57e94608	38	<html>
047c5009	39	<label>Domain</label>
57e94608	40	</html>
5435b737	41	<add>3.1</add>
6a488035 TO	42	</field>
6a488035 TO	43	<foreignKey>
5435b737 EM	44	<name>domain_id</name>
	45	<table>civicrm_domain</table>
	46	<key>id</key>
	47	<add>3.1</add>
6a488035 TO	48	</foreignKey>
6a488035 TO	49	<field>
5435b737 EM	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>
30878e6e	64	<length>512</length>
5435b737 EM	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>
b31aa78e	130	<type>longtext</type>
5435b737 EM	131	<import>true</import>
5435b737 EM	132	<comment>Submitted form values for this report</comment>
2a5c9b4d	133	<serialize>PHP</serialize>
5435b737 EM	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>
c1e814c7 MD	140	<default>1</default>
c1e814c7 MD	141	<required>true</required>
5435b737 EM	142	<comment>Is this entry active?</comment>
	143	<html>
	144	<type>CheckBox</type>
	145	</html>
	146	<add>2.2</add>
	147	</field>
f8bb273f	148	<field>
	149	<name>created_id</name>
	150	<type>int unsigned</type>
047c5009	151	<title>Created By Contact ID</title>
f8bb273f	152	<comment>FK to contact table.</comment>
57e94608	153	<html>
047c5009	154	<label>Created By</label>
57e94608	155	</html>
f8bb273f	156	<add>4.6</add>
	157	</field>
	158	<foreignKey>
	159	<name>created_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>owner_id</name>
	167	<type>int unsigned</type>
047c5009	168	<title>Owned By Contact ID</title>
f8bb273f	169	<comment>FK to contact table.</comment>
57e94608	170	<html>
047c5009	171	<label>Owned By</label>
57e94608	172	</html>
f8bb273f	173	<add>4.6</add>
	174	</field>
	175	<foreignKey>
	176	<name>owner_id</name>
	177	<table>civicrm_contact</table>
	178	<key>id</key>
	179	<add>4.6</add>
	180	<onDelete>SET NULL</onDelete>
	181	</foreignKey>
5435b737 EM	182	<field>
	183	<name>email_subject</name>
	184	<title>Report Instance email Subject</title>
	185	<type>varchar</type>
	186	<length>255</length>
	187	<comment>Subject of email</comment>
	188	<html>
	189	<type>Text</type>
	190	</html>
	191	</field>
	192	<field>
	193	<name>email_to</name>
	194	<title>Email Report Instance To</title>
	195	<type>text</type>
	196	<comment>comma-separated list of email addresses to send the report to</comment>
	197	<html>
	198	<type>Text</type>
	199	</html>
	200	<add>2.2</add>
	201	</field>
	202	<field>
	203	<name>email_cc</name>
	204	<title>cc Email Report Instance To</title>
	205	<type>text</type>
	206	<comment>comma-separated list of email addresses to send the report to</comment>
	207	<html>
	208	<type>Text</type>
	209	</html>
	210	<add>2.2</add>
	211	</field>
	212	<field>
	213	<name>header</name>
	214	<title>Report Instance Header</title>
	215	<type>text</type>
	216	<comment>comma-separated list of email addresses to send the report to</comment>
	217	<html>
	218	<type>TextArea</type>
	219	<rows>4</rows>
	220	<cols>60</cols>
	221	</html>
	222	<add>2.2</add>
	223	</field>
	224	<field>
	225	<name>footer</name>
	226	<title>Report Instance Footer</title>
	227	<type>text</type>
	228	<comment>comma-separated list of email addresses to send the report to</comment>
	229	<html>
	230	<type>TextArea</type>
	231	<rows>4</rows>
	232	<cols>60</cols>
	233	</html>
	234	<add>2.2</add>
	235	</field>
	236	<field>
	237	<name>navigation_id</name>
	238	<title>Navigation ID</title>
	239	<type>int unsigned</type>
	240	<import>true</import>
	241	<comment>FK to navigation ID</comment>
57e94608 A	242	<html>
	243	<label>Navigation</label>
	244	</html>
5435b737	245	<add>3.0</add>
c798ac7a	246	</field>
c798ac7a	247	<foreignKey>
5435b737 EM	248	<name>navigation_id</name>
	249	<table>civicrm_navigation</table>
	250	<key>id</key>
	251	<add>3.0</add>
	252	<onDelete>SET NULL</onDelete>
c798ac7a	253	</foreignKey>
c798ac7a	254	<field>
5435b737 EM	255	<name>drilldown_id</name>
	256	<title>Drilldown Report ID</title>
	257	<type>int unsigned</type>
	258	<import>true</import>
	259	<comment>FK to instance ID drilldown to</comment>
57e94608 A	260	<html>
	261	<label>Drilldown Report</label>
	262	</html>
5435b737	263	<add>4.3</add>
c798ac7a	264	</field>
c798ac7a	265	<foreignKey>
5435b737 EM	266	<name>drilldown_id</name>
	267	<table>civicrm_report_instance</table>
	268	<key>id</key>
	269	<add>4.3</add>
	270	<onDelete>SET NULL</onDelete>
c798ac7a	271	</foreignKey>
6a488035 TO	272	<field>
6a488035 TO	273	<name>is_reserved</name>
c798ac7a	274	<title>Instance is Reserved</title>
6a488035 TO	275	<type>boolean</type>
6a488035 TO	276	<default>0</default>
c1e814c7	277	<required>true</required>
7a6ecdb4	278	<html>
	279	<type>CheckBox</type>
	280	</html>
6a488035 TO	281	<add>4.2</add>
	282	</field>
	283	</table>