Appboard/old/custom data adapter - Revision history

imported>Jason.nicholls: /* Advanced Adapter Concepts */

2014-07-17T11:09:15Z

Advanced Adapter Concepts

← Older revision		Revision as of 11:09, 17 July 2014
Line 322:		Line 322:
	== Advanced Adapter Concepts ==		== Advanced Adapter Concepts ==

	This example has demonstrated to use of fetchRecords() to retrieve and replace all records for an entity on update. For many uses, this is adequate and the most expedient solution. However, for some adapters with large data sets, more efficient data retrieval techniques need to be employed. Examples can be found on the [[~~AppBoard_Advanced_Data_Adapter~~\|AppBoard Advanced Data Adapter]] page.		This example has demonstrated to use of fetchRecords() to retrieve and replace all records for an entity on update. For many uses, this is adequate and the most expedient solution. However, for some adapters with large data sets, more efficient data retrieval techniques need to be employed. Examples can be found on the [[appboard/old/advanced_data_adapter\|AppBoard Advanced Data Adapter]] page.

imported>Jason.nicholls: /* Completion and Validation */

2014-07-17T11:04:56Z

Completion and Validation

← Older revision		Revision as of 11:04, 17 July 2014
Line 318:		Line 318:
	== Completion and Validation ==		== Completion and Validation ==

	Once the above steps are completed, the adapter needs to be formalized. The adapter developer must go through the [[~~Adapter_Checklist~~\|Adapter Checklist]] to confirm that all activities are complete.		Once the above steps are completed, the adapter needs to be formalized. The adapter developer must go through the [[appboard/old/data_adapter_checklist\|Adapter Checklist]] to confirm that all activities are complete.


	== Advanced Adapter Concepts ==		== Advanced Adapter Concepts ==

	This example has demonstrated to use of fetchRecords() to retrieve and replace all records for an entity on update. For many uses, this is adequate and the most expedient solution. However, for some adapters with large data sets, more efficient data retrieval techniques need to be employed. Examples can be found on the [[AppBoard_Advanced_Data_Adapter\|AppBoard Advanced Data Adapter]] page.		This example has demonstrated to use of fetchRecords() to retrieve and replace all records for an entity on update. For many uses, this is adequate and the most expedient solution. However, for some adapters with large data sets, more efficient data retrieval techniques need to be employed. Examples can be found on the [[AppBoard_Advanced_Data_Adapter\|AppBoard Advanced Data Adapter]] page.

imported>Jason.nicholls at 11:02, 17 July 2014

2014-07-17T11:02:32Z

← Older revision		Revision as of 11:02, 17 July 2014
Line 1:		Line 1:
			{{DISPLAYTITLE:Custom Data Adapter}}
			[[Category:AppBoard old]]
	== Environment ==		== Environment ==

imported>Jason.nicholls: moved Creating An AppBoard Data Adapter to appboard/old/custom data adapter

2014-07-17T11:01:27Z

moved Creating An AppBoard Data Adapter to appboard/old/custom data adapter

← Older revision	Revision as of 11:01, 17 July 2014
(No difference)

imported>Jason.nicholls at 12:24, 5 July 2013

2013-07-05T12:24:24Z

← Older revision		Revision as of 12:24, 5 July 2013
Line 18:		Line 18:
	Extract the contents of the AppBoard release into desired directory, referenced as <tt><AB-Home></tt> from here on. Run <tt><AB-Home>/server/bin/startup.bat</tt> to start Tomcat, and then browse to <tt>http://localhost:8080/</tt>. You should see the following:		Extract the contents of the AppBoard release into desired directory, referenced as <tt><AB-Home></tt> from here on. Run <tt><AB-Home>/server/bin/startup.bat</tt> to start Tomcat, and then browse to <tt>http://localhost:8080/</tt>. You should see the following:

	[[File:da-login.png\|center\|546px]]		[[File:Da-login.png\|center\|546px]]

	Login with the default administrator credentials:		Login with the default administrator credentials:
Line 27:		Line 27:
	Once you have logged in, click on the AppBoard tab and you will be taken to the Visual Builder's main screen:		Once you have logged in, click on the AppBoard tab and you will be taken to the Visual Builder's main screen:

	[[File:da-initial-ab.png\|center\|546px]]		[[File:Da-initial-ab.png\|center\|546px]]

	To verify the demo adapter was loaded, select <tt>Data Sources</tt> and then <tt>Add</tt> from Visual Builder. Enter <tt>demo.demoadapter</tt> for <tt>Name</tt> and select <tt>Third Party</tt> and <tt>Demo Adapter</tt> for adapter type.		To verify the demo adapter was loaded, select <tt>Data Sources</tt> and then <tt>Add</tt> from Visual Builder. Enter <tt>demo.demoadapter</tt> for <tt>Name</tt> and select <tt>Third Party</tt> and <tt>Demo Adapter</tt> for adapter type.

	[[File:da-newsource.png\|center\|546px]]		[[File:Da-newsource.png\|center\|546px]]

	== Configuring Java Project ==		== Configuring Java Project ==
Line 103:		Line 103:
	The settings can be seen in the Builder by continuing with the data source addition by selecting <tt>Add Data Source</tt>, which will display the <tt>Connect</tt> screen in the <tt>Data Source Wizard</tt>, shown below:		The settings can be seen in the Builder by continuing with the data source addition by selecting <tt>Add Data Source</tt>, which will display the <tt>Connect</tt> screen in the <tt>Data Source Wizard</tt>, shown below:

	[[File:da-settings.png\|center\|546px]]		[[File:Da-settings.png\|center\|546px]]

	Note the settings defined in <tt>getSettingDefs()</tt> appear in order in the wizard.		Note the settings defined in <tt>getSettingDefs()</tt> appear in order in the wizard.
Line 136:		Line 136:
	Continuing in the wizard in the Builder, clicking on <tt>Next</tt> will display the two Entities under the <tt>Explore</tt> heading, as shown below:		Continuing in the wizard in the Builder, clicking on <tt>Next</tt> will display the two Entities under the <tt>Explore</tt> heading, as shown below:

	[[File:da-entities.png\|center\|546px]]		[[File:Da-entities.png\|center\|546px]]

	=== List Attributes for the adapter ===		=== List Attributes for the adapter ===
Line 189:		Line 189:
	Continuing the walk through in the Builder, expand the Entities <tt>Sine Wave</tt> and <tt>Associated Data</tt> to see the Attributes of each and compare with the code above.		Continuing the walk through in the Builder, expand the Entities <tt>Sine Wave</tt> and <tt>Associated Data</tt> to see the Attributes of each and compare with the code above.

	[[File:da-ents_attrs.png\|center\|546px]]		[[File:Da-ents_attrs.png\|center\|546px]]

	Note that the types of the Attributes are grayed out and not editable. This is specified in the adapter class by overriding the following method:		Note that the types of the Attributes are grayed out and not editable. This is specified in the adapter class by overriding the following method:
Line 237:		Line 237:
	Selecting <tt>Next</tt> in the wizard will continue to the Association(s) defined for the new Data Source, and the following screen shows the Association between the <tt>Key</tt> Attribute of <tt>Sine Wave</tt> and the <tt>Wave Key</tt> Attribute of <tt>Associated Data</tt>:		Selecting <tt>Next</tt> in the wizard will continue to the Association(s) defined for the new Data Source, and the following screen shows the Association between the <tt>Key</tt> Attribute of <tt>Sine Wave</tt> and the <tt>Wave Key</tt> Attribute of <tt>Associated Data</tt>:

	[[File:da-associations.png\|center\|546px]]		[[File:Da-associations.png\|center\|546px]]

	=== Retrieve data for the adapter ===		=== Retrieve data for the adapter ===
Line 301:		Line 301:
	The Entities exposed through the new Data Source created in the Builder using the DemoDataAdapter are exposed as Data Collections. Data Collections are the client-side representation of a single Entity, although multiple Data Collections may be backed by the same server-side Entity. This is needed as each client-side Data Collection may be filtered, and filtered and unfiltered views of data from a single Entity may be desired.		The Entities exposed through the new Data Source created in the Builder using the DemoDataAdapter are exposed as Data Collections. Data Collections are the client-side representation of a single Entity, although multiple Data Collections may be backed by the same server-side Entity. This is needed as each client-side Data Collection may be filtered, and filtered and unfiltered views of data from a single Entity may be desired.

	[[File:da-collections.png\|center\|546px]]		[[File:Da-collections.png\|center\|546px]]

	To see the data returned, click the icon under <tt>Preview</tt> for the <tt>Sine Wave</tt> Entity. Along with the defined Attributes of <tt>Key</tt>, <tt>Timestamp</tt>, and <tt>Value</tt>, notice the additional columns showing the generated <tt>id</tt> and the <tt>Associated Data</tt> Association.		To see the data returned, click the icon under <tt>Preview</tt> for the <tt>Sine Wave</tt> Entity. Along with the defined Attributes of <tt>Key</tt>, <tt>Timestamp</tt>, and <tt>Value</tt>, notice the additional columns showing the generated <tt>id</tt> and the <tt>Associated Data</tt> Association.

	[[File:da-previewcollection.png\|center\|546px]]		[[File:Da-previewcollection.png\|center\|546px]]

	== Demo AppBoard Stack ==		== Demo AppBoard Stack ==
Line 311:		Line 311:
	Below is a Stack created with one Widget showing a Line Chart of the <tt>Sine Wave</tt> Data Collection and another showing a Table of the <tt>Associated Data</tt> Data Collection. The <tt>Associated Data</tt> is filtered via a selection action on the <tt>Sine Wave</tt> chart.		Below is a Stack created with one Widget showing a Line Chart of the <tt>Sine Wave</tt> Data Collection and another showing a Table of the <tt>Associated Data</tt> Data Collection. The <tt>Associated Data</tt> is filtered via a selection action on the <tt>Sine Wave</tt> chart.

	[[File:da-demostack.png\|center\|546px]]		[[File:Da-demostack.png\|center\|546px]]

imported>Jay.barr: /* Environment */

2011-09-01T14:21:43Z

Environment

← Older revision		Revision as of 14:21, 1 September 2011
Line 3:		Line 3:
	* Java SDK (ver 1.6 or greater) - Recommend adding the SDK's bin directory to your PATH.		* Java SDK (ver 1.6 or greater) - Recommend adding the SDK's bin directory to your PATH.
	* Eclipse (ver 3.6+ recommended) - Project works best with M2Eclipse plugin for Maven building, but it is not required.		* Eclipse (ver 3.6+ recommended) - Project works best with M2Eclipse plugin for Maven building, but it is not required.
	* AppBoard release with license (ver 2.0~~.5.32 for this walkthrough~~)		* AppBoard release with license (ver 2.1.0+)

	== Exercise Objective and Setup ==		== Exercise Objective and Setup ==

imported>Jay.barr: /* Completion and Validation */

2011-09-01T14:15:50Z

Completion and Validation

← Older revision		Revision as of 14:15, 1 September 2011
Line 317:		Line 317:

	Once the above steps are completed, the adapter needs to be formalized. The adapter developer must go through the [[Adapter_Checklist\|Adapter Checklist]] to confirm that all activities are complete.		Once the above steps are completed, the adapter needs to be formalized. The adapter developer must go through the [[Adapter_Checklist\|Adapter Checklist]] to confirm that all activities are complete.


			== Advanced Adapter Concepts ==

			This example has demonstrated to use of fetchRecords() to retrieve and replace all records for an entity on update. For many uses, this is adequate and the most expedient solution. However, for some adapters with large data sets, more efficient data retrieval techniques need to be employed. Examples can be found on the [[AppBoard_Advanced_Data_Adapter\|AppBoard Advanced Data Adapter]] page.

imported>Jay.barr: /* Environment */

2011-08-02T22:12:39Z

Environment

← Older revision		Revision as of 22:12, 2 August 2011
Line 3:		Line 3:
	* Java SDK (ver 1.6 or greater) - Recommend adding the SDK's bin directory to your PATH.		* Java SDK (ver 1.6 or greater) - Recommend adding the SDK's bin directory to your PATH.
	* Eclipse (ver 3.6+ recommended) - Project works best with M2Eclipse plugin for Maven building, but it is not required.		* Eclipse (ver 3.6+ recommended) - Project works best with M2Eclipse plugin for Maven building, but it is not required.
	* AppBoard release with license (ver 2.0.5 for this walkthrough)		* AppBoard release with license (ver 2.0.5.32 for this walkthrough)

	== Exercise Objective and Setup ==		== Exercise Objective and Setup ==

imported>Jay.barr: /* Retrieve data for the adapter */

2011-08-02T22:11:48Z

Retrieve data for the adapter

← Older revision		Revision as of 22:11, 2 August 2011
Line 241:		Line 241:
	=== Retrieve data for the adapter ===		=== Retrieve data for the adapter ===

	Once all the Entities, Attributes, and Associations for the new Data Source have been exposed through the Data Adapter, the adapter must implement one or more methods for providing the data. For ~~adapters derived from <tt>CachingRecordAdapter</tt>~~, the single method <tt>~~refreshRecords~~</tt> must be implemented, which returns a full set of all data for a specified Entity.		Once all the Entities, Attributes, and Associations for the new Data Source have been exposed through the Data Adapter, the adapter must implement one or more methods for providing the data. The easiest approach, and often sufficient for data sets that are not big (e.g. more than 10,000 records), is to fully cache all data from the source. For this approach, the single method <tt>fetchRecords</tt> must be implemented, which returns a full set of all data for a specified Entity.

	The data is produced as a collection of <tt>GenericRecords</tt>, which store the Entity for the record and a map of data, where the keys are the names of Attributes and the values are Java Objects (typically String, Date, or Numeric types).		The data is produced as a collection of <tt>GenericRecords</tt>, which store the Entity for the record and a map of data, where the keys are the names of Attributes and the values are Java Objects (typically String, Date, or Numeric types).

	<code>[java,N]		<code>[java,N]
	~~protected Map<ObjectReference, GenericRecord> refreshRecords~~ (		public void fetchRecords(ServiceRequestFacade request,
	ServiceRequestFacade request) throws Exception {		ServiceResponseFacade response) throws Exception
			{
			String entityName = request.getEntity().getEntityName();

	~~String entityName = request.getEntity().getEntityName();~~
	~~ServiceResponseFacade response = new ServiceResponseFacade(request);~~
	List<GenericRecord> recordList = new ArrayList<GenericRecord>();		List<GenericRecord> recordList = new ArrayList<GenericRecord>();

Line 294:		Line 294:
	}		}

	~~// The list of GenericRecords is set on the response and retrieved from there to make sure~~		response.addGenericRecords(recordList);
	~~// all records have a proper identity attribute set. This process may change in a future release.~~
	~~Map<ObjectReference, GenericRecord> records = null;~~
	~~if (recordList != null) {~~
	response.addGenericRecords(recordList);
	~~records = response.getGenericRecords();~~
	}
	~~return records~~;
	}		}

imported>Jay.barr: /* Extending Base CachingRecordAdapter Class */

2011-08-02T22:05:37Z

Extending Base CachingRecordAdapter Class

← Older revision		Revision as of 22:05, 2 August 2011
Line 37:		Line 37:
	Data Adapters are implemented in Java and require the <tt>edge-apb-<version>.jar</tt> to be compiled, as well as any other JARs containing additional classes used in the adapter (e.g. log4j for logging). The AppBoard Java SDK includes a pre-configured Eclipse project that builds using the default Eclipse Java compiler and can have Maven support from the M2Eclipse plugin enabled via the project's content menu (Maven > Enable Dependency Management).		Data Adapters are implemented in Java and require the <tt>edge-apb-<version>.jar</tt> to be compiled, as well as any other JARs containing additional classes used in the adapter (e.g. log4j for logging). The AppBoard Java SDK includes a pre-configured Eclipse project that builds using the default Eclipse Java compiler and can have Maven support from the M2Eclipse plugin enabled via the project's content menu (Maven > Enable Dependency Management).

	== Extending Base ~~CachingRecordAdapter~~ Class ==		== Extending Base DataAdapter Class ==

	AppBoard Data Adapters extend the ~~abstract~~ class <tt>com.edgetech.services.DataAdapter</tt> (Note: package will probably be renamed to <tt>com.edgetech.appboard</tt> in a future release). For ease of implementation, a base class <tt>com.edgetech.services.impl.CachingRecordAdapter</tt> is used for development of Data Adapters that do not have large memory footprints from high numbers of records (approximately 10,000 records is probably the cutoff where caching the full data set is too high a use of memory and network bandwidth).		AppBoard Data Adapters extend the base class <tt>com.edgetech.services.DataAdapter</tt> (Note: package will probably be renamed to <tt>com.edgetech.appboard</tt> in a future release).

	Data Adapters must provide the following services, which will be described in detail in the subsequent sections:		Data Adapters must provide the following services, which will be described in detail in the subsequent sections:
Line 91:		Line 91:

	SettingDef cacheTimeout = new SettingDef(		SettingDef cacheTimeout = new SettingDef(
	~~CachingRecordAdapter~~.CACHE_TIMEOUT,		DataAdapter.CACHE_TIMEOUT,
	"Number of seconds to cache data..",		"Number of seconds to cache data..",
	AttributeType.NUMBER, "30");		AttributeType.NUMBER, "30");