Report JSON API - Revision history

Sagecrmw at 12:18, 23 June 2023

2023-06-23T12:18:30Z

← Older revision		Revision as of 13:18, 23 June 2023
Line 63:		Line 63:
	myreport.reportdetails.push(_companyboxlong);		myreport.reportdetails.push(_companyboxlong);

	a. Here we show how to display a List based on an array of items		b. Here we show how to display a List based on an array of items

	var samplelist=JSON.clone(_reportItem);		var samplelist=JSON.clone(_reportItem);
Line 71:		Line 71:
	samplelist.data=getListSection(qsamplelist, "company", ["comp_name","comp_website"]);		samplelist.data=getListSection(qsamplelist, "company", ["comp_name","comp_website"]);
	myreport.reportdetails.push(samplelist);		myreport.reportdetails.push(samplelist);

			c. You can also add in raw HTML (since 5.2.2.1)
			var _reportdetails=JSON.clone(_reportItem);
			_reportdetails.name='rawreportdetailshtml';
			_reportdetails.componenttype='html';
			_reportdetails.element="div";
			_reportdetails.data="<span style=\"background-Color:red\">this is raw html in the details area</span>";
			myreport.reportdetails.push(_reportdetails);

	FOOTER		FOOTER

Sagecrmw at 12:17, 23 June 2023

2023-06-23T12:17:14Z

← Older revision		Revision as of 13:17, 23 June 2023
Line 83:		Line 83:
	myreport.reportfooter.push(_footer);		myreport.reportfooter.push(_footer);



	~~...coming in Autumn 2023~~

	Ability to add a "title"		Ability to add a "title"

Sagecrmw at 16:54, 19 June 2023

2023-06-19T16:54:17Z

← Older revision		Revision as of 17:54, 19 June 2023
Line 82:		Line 82:
	_footer.data="<span style=\"background-Color:blue\">this is raw html in the footer</span>";		_footer.data="<span style=\"background-Color:blue\">this is raw html in the footer</span>";
	myreport.reportfooter.push(_footer);		myreport.reportfooter.push(_footer);



			...coming in Autumn 2023

			Ability to add a "title"

			var sampletitlex=JSON.clone(_reportItem);
			sampletitlex.name='sampletitlex';
			sampletitlex.componenttype='title';
			sampletitlex.data="sampletitlex text";
			myreport.reportdetails.push(sampletitlex);

Sagecrmw at 14:21, 19 June 2023

2023-06-19T14:21:32Z

← Older revision		Revision as of 15:21, 19 June 2023
Line 5:		Line 5:
	Example		Example

	.~~..image here...~~		[[File:graph sample.png]]

	Any JSON API file must have the name		Any JSON API file must have the name
Line 15:		Line 15:
	The should include the "reportobjects.js" file		The should include the "reportobjects.js" file

			[[File:include reportobjects.png]]

	CONTEXT		CONTEXT

Sagecrmw at 14:20, 19 June 2023

2023-06-19T14:20:53Z

← Older revision		Revision as of 15:20, 19 June 2023
Line 15:		Line 15:
	The should include the "reportobjects.js" file		The should include the "reportobjects.js" file

	EG
	~~<!-- #include file ="reportobjects.js" -->~~

	CONTEXT		CONTEXT

Sagecrmw at 14:18, 19 June 2023

2023-06-19T14:18:25Z

← Older revision		Revision as of 15:18, 19 June 2023
Line 12:		Line 12:

	The "_js.asp" tells the system that this data is JSON so it parses it correctly. If not then the page will just display as normal.		The "_js.asp" tells the system that this data is JSON so it parses it correctly. If not then the page will just display as normal.

			The should include the "reportobjects.js" file

			EG
			<!-- #include file ="reportobjects.js" -->

	CONTEXT		CONTEXT

Sagecrmw at 14:17, 19 June 2023

2023-06-19T14:17:29Z

← Older revision		Revision as of 15:17, 19 June 2023
Line 49:		Line 49:
	DETAILS		DETAILS

	Here we		a. Here we show how to display a screen based on a CRM screen

	var _companyboxlong=JSON.clone(_reportItem);		var _companyboxlong=JSON.clone(_reportItem);
	_companyboxlong.name='companyboxlong';		_companyboxlong.name='companyboxlong';
	_companyboxlong.componenttype='screen';		_companyboxlong.componenttype='screen';
	var qCompany=CRM.Findrecord("company,vsummarycompany","comp_companyid=~~123~~");		var qCompany=CRM.Findrecord("company,vsummarycompany","comp_companyid="+Request.QueryString("id"));
	var companyboxlong=getScreenSection("company",qCompany,"companyboxlong","Some title");		var companyboxlong=getScreenSection("company",qCompany,"companyboxlong","Some title");
	_companyboxlong.data=companyboxlong;		_companyboxlong.data=companyboxlong;
	myreport.reportdetails.push(_companyboxlong);		myreport.reportdetails.push(_companyboxlong);

			a. Here we show how to display a List based on an array of items

			var samplelist=JSON.clone(_reportItem);
			samplelist.name='samplelist';
			samplelist.componenttype='list';
			var qsamplelist=CRM.Findrecord("company,vsummarycompany","comp_companyid<"+Request.QueryString("id"));
			samplelist.data=getListSection(qsamplelist, "company", ["comp_name","comp_website"]);
			myreport.reportdetails.push(samplelist);

			FOOTER

			Display some raw html in the footer

			var _footer=JSON.clone(_reportItem);
			_footer.name='rawfooterhtml';
			_footer.componenttype='html';
			_footer.element="div";
			_footer.data="<span style=\"background-Color:blue\">this is raw html in the footer</span>";
			myreport.reportfooter.push(_footer);

Sagecrmw: Created page with "A sample asp file is provided that has code demonstrating the details for the API. The file is an ASP page and it generates JSON that the app knows how to process. Example ...image here... Any JSON API file must have the name NAME_js.asp The "_js.asp" tells the system that this data is JSON so it parses it correctly. If not then the page will just display as normal. CONTEXT The requests come in the format NAME_js.asp?SID=324333&entity=company&id=46 And..."

2023-06-19T13:55:17Z

Created page with "A sample asp file is provided that has code demonstrating the details for the API. The file is an ASP page and it generates JSON that the app knows how to process. Example ...image here... Any JSON API file must have the name NAME_js.asp The "_js.asp" tells the system that this data is JSON so it parses it correctly. If not then the page will just display as normal. CONTEXT The requests come in the format NAME_js.asp?SID=324333&entity=company&id=46 And..."

New page

A sample asp file is provided that has code demonstrating the details for the API.

The file is an ASP page and it generates JSON that the app knows how to process.

Example

...image here...

Any JSON API file must have the name

NAME_js.asp

The "_js.asp" tells the system that this data is JSON so it parses it correctly. If not then the page will just display as normal.

CONTEXT

The requests come in the format

NAME_js.asp?SID=324333&entity=company&id=46

And the context is set with the "entity" and "id" querystring values

To create a report

var myreport= JSON.clone(_reportClass);
myreport.name="test101";
//title
myreport.title="Sample Report";

Reports have 3 sections

1. reportheader

2. reportdetails

3. reportfooter

HEADER

Here we show how to add in some raw html to the header

var _header=JSON.clone(_reportItem);
_header.name='rawheaderhtml';
_header.componenttype='html';
_header.element="div";
_header.data="<span style=\"background-Color:red\">this is raw html in the header</span>";
myreport.reportheader.push(_header);

DETAILS

Here we

var _companyboxlong=JSON.clone(_reportItem);
_companyboxlong.name='companyboxlong';
_companyboxlong.componenttype='screen';
var qCompany=CRM.Findrecord("company,vsummarycompany","comp_companyid=123");
var companyboxlong=getScreenSection("company",qCompany,"companyboxlong","Some title");
_companyboxlong.data=companyboxlong;
myreport.reportdetails.push(_companyboxlong);