Easy API - Revision history

Crmtogether at 15:25, 26 March 2020

2020-03-26T15:25:45Z

← Older revision		Revision as of 16:25, 26 March 2020
Line 1:		Line 1:

			UPDATE March 2020 - not to be used as this will be replaced -





















































































































	New Easy API - Designed to make "some" screens easy to provide in the interface		New Easy API - Designed to make "some" screens easy to provide in the interface

Crmtogether at 13:48, 12 November 2019

2019-11-12T13:48:04Z

← Older revision		Revision as of 14:48, 12 November 2019
Line 47:		Line 47:
	----		----

	Example showing how to add in a menu item on the footer		Example showing how to add in a menu item on the footer that then displays a web page

	1. Navigate to the 'Administration -> Advanced Customisation -> System Menus'		1. Navigate to the 'Administration -> Advanced Customisation -> System Menus'

Crmtogether at 21:47, 11 November 2019

2019-11-11T21:47:08Z

@@ Line 49: / Line 49: @@
 Example showing how to add in a menu item on the footer
 . Navigate to the 'Administration -> Advanced Customisation -> System Menus'
-. Open (or create) the menu 'MXFooterMenu'
+         <add name="website" />
-. Add menu item setting:
+     EG
-	   caption: site
+. Open the custompages/sagecrmws/js/plugins folder
-	   custom file: fa fa-bar-chart
+     var onDocumentReady = function () {
-	   sql: getwebsite('Site');
+          console.log('getPowerBI2 demo');
+          var pr_targetImage2 = Factory.createIFrame("pr_targetImage2");
-. Save this
+          pr_targetImage2.pr_height = "100%";
+          pr_targetImage2.pr_width = "100%";
-. Open the custompages/sagecrmws folder
+          pr_targetImage2.pr_src="https://crmtogether.com";
+          pr_targetImage2.pr_onclick = "";
-. open web.config
+          pr_targetImage2.draw("container");
+          pr_targetImage2.position(0, 0);
-. Add into 'CustomPlugins'

Crmtogether at 21:43, 11 November 2019

2019-11-11T21:43:43Z

← Older revision		Revision as of 22:43, 11 November 2019
Line 59:		Line 59:
	custom file: fa fa-bar-chart		custom file: fa fa-bar-chart

	sql: getwebsite('Site~~','https://crmtogether.com~~');		sql: getwebsite('Site');

	4. Save this		4. Save this
Line 102:		Line 102:
	var _websitecount=0;		var _websitecount=0;

	function getwebsite(_caption~~,_url~~)		function getwebsite(_caption)
	{		{
	~~_websitecount++;~~
	cApp.containerTop.clear();		cApp.containerTop.clear();
	cApp.container.clear();		cApp.container.clear();

			Factory.destroyComponent("powerbititle2");
			var powerbititle2 = Factory.createLabel("powerbititle2");
			powerbititle2.pr_caption = _caption;
			powerbititle2.draw("containerTop");
			powerbititle2.position(110, 10, true);

	var ~~_id~~="~~websitetitle~~"~~+_websitecount~~;		console.log('getPowerBI2 demo');
	~~Factory~~.~~destroyComponent(_id)~~;		var pr_targetImage2 = Factory.createIFrame("pr_targetImage2");
	~~var powerbititle~~ = ~~Factory~~.~~createLabel(_id)~~;		pr_targetImage2.pr_height = "100%";
	~~powerbititle~~.~~pr_caption~~ = ~~_caption~~;		pr_targetImage2.pr_width = "100%";
	~~powerbititle~~.draw("~~containerTop~~");		pr_targetImage2.pr_src="https://crmtogether.com";
	~~powerbititle~~.position(~~150, 10~~, ~~true~~);		pr_targetImage2.pr_onclick = "";
			pr_targetImage2.draw("container");
			pr_targetImage2.position(0, 0);

	~~console.log('getwebsite:'+_id);~~
	~~var pr_targetImage = Factory.createImage("pr_targetImage");~~
	~~pr_targetImage.pr_height = "100%";~~
	~~pr_targetImage.pr_width = Factory.deviceObject.pr_width;~~
	~~pr_targetImage.pr_src=_url;~~
	~~pr_targetImage.pr_onclick = "";~~
	~~pr_targetImage.draw("container");~~
	~~pr_targetImage.position(0, 0);~~
	}		}

Crmtogether at 21:31, 11 November 2019

2019-11-11T21:31:37Z

← Older revision		Revision as of 22:31, 11 November 2019
Line 50:		Line 50:

	1. Navigate to the 'Administration -> Advanced Customisation -> System Menus'		1. Navigate to the 'Administration -> Advanced Customisation -> System Menus'

	2. Open (or create) the menu 'MXFooterMenu'		2. Open (or create) the menu 'MXFooterMenu'

	3. Add menu item setting:		3. Add menu item setting:

	caption: site		caption: site

	custom file: fa fa-bar-chart		custom file: fa fa-bar-chart

	sql: getwebsite('Site','https://crmtogether.com');		sql: getwebsite('Site','https://crmtogether.com');

	4. Save this		4. Save this

	5. Open the custompages/sagecrmws folder		5. Open the custompages/sagecrmws folder

	6. open web.config		6. open web.config

	7. Add into 'CustomPlugins'		7. Add into 'CustomPlugins'

Line 66:		Line 75:
	<plugins>		<plugins>
	...		...

	'''<add name="website" />'''		'''<add name="website" />'''

	</plugins>		</plugins>
	</CustomPlugins>		</CustomPlugins>
Line 72:		Line 83:

	8. Open the custompages/sagecrmws/js/plugins folder		8. Open the custompages/sagecrmws/js/plugins folder

	9. Create a folder called 'website'		9. Create a folder called 'website'

	10. Create a folder called 'client'		10. Create a folder called 'client'

	11. Create a file called 'plugin.js'		11. Create a file called 'plugin.js'

	12. add the following contents to the file created in 11		12. add the following contents to the file created in 11

	var onDocumentReady = function () {		var onDocumentReady = function () {

	}		}

	var onContextChanged = function () {		var onContextChanged = function () {

	};		};

	var _websitecount=0;		var _websitecount=0;

	function getwebsite(_caption,_url)		function getwebsite(_caption,_url)
	{		{

Crmtogether at 21:30, 11 November 2019

2019-11-11T21:30:39Z

← Older revision		Revision as of 22:30, 11 November 2019
Line 49:		Line 49:
	Example showing how to add in a menu item on the footer		Example showing how to add in a menu item on the footer

	1. Navigate to the 'Administration -> Advanced Customisation -> System Menus'		1. Navigate to the 'Administration -> Advanced Customisation -> System Menus'
	2. Open (or create) the menu 'MXFooterMenu'		2. Open (or create) the menu 'MXFooterMenu'
	3. Add menu item setting:		3. Add menu item setting:
	caption: site		caption: site
	custom file: fa fa-bar-chart		custom file: fa fa-bar-chart
	sql: getwebsite('Site','https://crmtogether.com');		sql: getwebsite('Site','https://crmtogether.com');
	4. Save this		4. Save this
	5. Open the custompages/sagecrmws folder		5. Open the custompages/sagecrmws folder
	6. open web.config		6. open web.config
	7. Add into 'CustomPlugins'		7. Add into 'CustomPlugins'

	<add name="website" />		<add name="website" />

	EG		EG
	<CustomPlugins>		<CustomPlugins>
	<plugins>		<plugins>
	...		...
	'''<add name="website" />'''		'''<add name="website" />'''
	</plugins>		</plugins>
	</CustomPlugins>		</CustomPlugins>


	8. Open the custompages/sagecrmws/js/plugins folder		8. Open the custompages/sagecrmws/js/plugins folder
	9. Create a folder called 'website'		9. Create a folder called 'website'
	10. Create a folder called 'client'		10. Create a folder called 'client'
	11. Create a file called 'plugin.js'		11. Create a file called 'plugin.js'
	12. add the following contents to the file created in 11		12. add the following contents to the file created in 11

	var onDocumentReady = function () {		var onDocumentReady = function () {
	}		}
	var onContextChanged = function () {		var onContextChanged = function () {
	};		};
	var _websitecount=0;		var _websitecount=0;
	function getwebsite(_caption,_url)		function getwebsite(_caption,_url)
	{		{
	_websitecount++;		_websitecount++;
	cApp.containerTop.clear();		cApp.containerTop.clear();
	cApp.container.clear();		cApp.container.clear();

	var _id="websitetitle"+_websitecount;		var _id="websitetitle"+_websitecount;
	Factory.destroyComponent(_id);		Factory.destroyComponent(_id);
	var powerbititle = Factory.createLabel(_id);		var powerbititle = Factory.createLabel(_id);
	powerbititle.pr_caption = _caption;		powerbititle.pr_caption = _caption;
	powerbititle.draw("containerTop");		powerbititle.draw("containerTop");
	powerbititle.position(150, 10, true);		powerbititle.position(150, 10, true);

	console.log('getwebsite:'+_id);		console.log('getwebsite:'+_id);
	var pr_targetImage = Factory.createImage("pr_targetImage");		var pr_targetImage = Factory.createImage("pr_targetImage");
	pr_targetImage.pr_height = "100%";		pr_targetImage.pr_height = "100%";
	pr_targetImage.pr_width = Factory.deviceObject.pr_width;		pr_targetImage.pr_width = Factory.deviceObject.pr_width;
	pr_targetImage.pr_src=_url;		pr_targetImage.pr_src=_url;
	pr_targetImage.pr_onclick = "";		pr_targetImage.pr_onclick = "";
	pr_targetImage.draw("container");		pr_targetImage.draw("container");
	pr_targetImage.position(0, 0);		pr_targetImage.position(0, 0);
	}		}

Crmtogether at 21:30, 11 November 2019

2019-11-11T21:30:04Z

← Older revision		Revision as of 22:30, 11 November 2019
Line 46:		Line 46:

	----		----

			Example showing how to add in a menu item on the footer

			1. Navigate to the 'Administration -> Advanced Customisation -> System Menus'
			2. Open (or create) the menu 'MXFooterMenu'
			3. Add menu item setting:
			caption: site
			custom file: fa fa-bar-chart
			sql: getwebsite('Site','https://crmtogether.com');
			4. Save this
			5. Open the custompages/sagecrmws folder
			6. open web.config
			7. Add into 'CustomPlugins'

			<add name="website" />

			EG
			<CustomPlugins>
			<plugins>
			...
			'''<add name="website" />'''
			</plugins>
			</CustomPlugins>


			8. Open the custompages/sagecrmws/js/plugins folder
			9. Create a folder called 'website'
			10. Create a folder called 'client'
			11. Create a file called 'plugin.js'
			12. add the following contents to the file created in 11

			var onDocumentReady = function () {
			}
			var onContextChanged = function () {
			};
			var _websitecount=0;
			function getwebsite(_caption,_url)
			{
			_websitecount++;
			cApp.containerTop.clear();
			cApp.container.clear();

			var _id="websitetitle"+_websitecount;
			Factory.destroyComponent(_id);
			var powerbititle = Factory.createLabel(_id);
			powerbititle.pr_caption = _caption;
			powerbititle.draw("containerTop");
			powerbititle.position(150, 10, true);

			console.log('getwebsite:'+_id);
			var pr_targetImage = Factory.createImage("pr_targetImage");
			pr_targetImage.pr_height = "100%";
			pr_targetImage.pr_width = Factory.deviceObject.pr_width;
			pr_targetImage.pr_src=_url;
			pr_targetImage.pr_onclick = "";
			pr_targetImage.draw("container");
			pr_targetImage.position(0, 0);
			}

Crmtogether at 20:02, 11 November 2019

2019-11-11T20:02:45Z

← Older revision		Revision as of 21:02, 11 November 2019
Line 44:		Line 44:
	Example:		Example:
	getListScreen('ctproject');		getListScreen('ctproject');

			----

Crmtogether at 14:12, 19 September 2019

2019-09-19T14:12:23Z

← Older revision		Revision as of 15:12, 19 September 2019
Line 39:		Line 39:
	1. entityname		1. entityname
	- Notes		- Notes
	1. Expects view "~~ventitynamesummary~~" to exist and must contain fields "pers_firstname,pers_lastname,pers_personid,comp_name,comp_companyid".		1. Expects view "vENTITYnamesummary" to exist and must contain fields "pers_firstname,pers_lastname,pers_personid,comp_name,comp_companyid".
			2. Expects screen "ENTITYOfficeIntSmall"

	Example:		Example:
	getListScreen('ctproject');		getListScreen('ctproject');

Crmtogether at 13:56, 19 September 2019

2019-09-19T13:56:42Z

← Older revision		Revision as of 14:56, 19 September 2019
Line 2:		Line 2:
	New Easy API - Designed to make "some" screens easy to provide in the interface		New Easy API - Designed to make "some" screens easy to provide in the interface


			----

	* showScreens - screens with optional edit		* showScreens - screens with optional edit
			- Parameters
			1. Entity - name of the entity
			2. EntityIdField - id field of the entity
			3. Screens - Comma seperated list of CRM screens
			4. EntityToUse - name field to make ContextEntityfield value to
			5. ContextEntityfield - name of the entity context (tab) we are in
			6. allowEdit - boolean - set to true to show edit button

			Example:
			showScreens(cApp.EntityName, cApp.EntityId,'CustomCompanyScreenMX1,CustomCompanyScreenMX2', 'company', 'comp_companyid','comp_companyid',true);

			----

	* cugetList – Table style lists		* cugetList – Table style lists
Line 16:		Line 29:
	7. CRMListToUse - optional - name of a list in CRM alternatively use displayfields		7. CRMListToUse - optional - name of a list in CRM alternatively use displayfields

	cugetList('ctproject','ctpr_companyid','ctpr_createddate','',true,'','mxcustomlist');		Example:
			cugetList('ctproject','ctpr_companyid','ctpr_createddate','',true,'','mxcustomlist');


			----

	* getListScreen – repeating screens style list		* getListScreen – repeating screens style list
Line 23:		Line 40:
	- Notes		- Notes
	1. Expects view "ventitynamesummary" to exist and must contain fields "pers_firstname,pers_lastname,pers_personid,comp_name,comp_companyid".		1. Expects view "ventitynamesummary" to exist and must contain fields "pers_firstname,pers_lastname,pers_personid,comp_name,comp_companyid".

			Example:
			getListScreen('ctproject');