Appboard/2.4/builder/data sources/web service - Revision history

imported>Mike.berman at 23:22, 30 January 2014

2014-01-30T23:22:36Z

← Older revision		Revision as of 23:22, 30 January 2014
Line 21:		Line 21:
	\|-		\|-
	\|'''URL'''		\|'''URL'''
	\|Base URL for the web service from which to fetch data. This can also be the complete URL, if you want to include any needed parameters here instead of as separate settings. Sample CSV files have been included with this distribution and are located within various folders under <tt>${application.home}/data/</tt>. On a Windows server, these can be accessed using a URL like file:///${application.home}/data/path_to_CSV (on UNIX, the URL would start as file://). Please see http://en.wikipedia.org/wiki/File_URI_scheme for more details on using file:/// (or file://) URLs. Alternatively, the sample CSV files can be copied to a custom folder in the enportal directory and accessed via http://host:port/enportal/custom_folder/path_to_CSV.		\|Base URL for the web service from which to fetch data. This can also be the complete URL, if you want to include any needed parameters here instead of as separate settings. Sample CSV files have been included with this distribution and are located within various folders under <tt>${application.home}/data/</tt>. On a Windows server, these can be accessed using a URL like file:///${application.home}/data/path_to_CSV (on UNIX, the URL would start as file://). Please see http://en.wikipedia.org/wiki/File_URI_scheme for more details on using file:/// (or file://) URLs. Alternatively, the sample CSV files can be copied to a custom folder in the enportal directory and accessed via http://host:port/enportal/custom_folder/path_to_CSV.<br><br>Example URL: <tt>file:///${application.home}/data/pkg/appboard/test/timeline_sample_data.csv</tt>
	\|-		\|-
	\|'''HTTP Auth Username'''		\|'''HTTP Auth Username'''
Line 79:		Line 79:
	\|-		\|-
	\|'''URL'''		\|'''URL'''
	\|Base URL for the web service from which to fetch data. This can also be the complete URL, if you want to include any needed parameters here instead of as separate settings. The distribution contains sample JSON files located within <tt>${application.home}/data/JSON/</tt>. The following section in the documentation also includes links to copies of these sample JSON files which demonstrate valid formatting. Any JSON files placed on the AppBoard server can go either within <tt>${application.home}/data/</tt> or within a custom folder in the enportal directory. Just like with the CSV files, these can be accessed using URLs like file:///${application.home}/data/path_to_JSON or http://host:port/enportal/custom/path_to_JSON.		\|Base URL for the web service from which to fetch data. This can also be the complete URL, if you want to include any needed parameters here instead of as separate settings. The distribution contains sample JSON files located within <tt>${application.home}/data/JSON/</tt>. The following section in the documentation also includes links to copies of these sample JSON files which demonstrate valid formatting. Any JSON files placed on the AppBoard server can go either within <tt>${application.home}/data/</tt> or within a custom folder in the enportal directory. Just like with the CSV files, these can be accessed using URLs like file:///${application.home}/data/path_to_JSON or http://host:port/enportal/custom/path_to_JSON. <br><br>Example URL: <tt>file:///${application.home}/data/JSON/data.json</tt>
	\|-		\|-
	\|'''HTTP Auth Username'''		\|'''HTTP Auth Username'''
Line 141:		Line 141:
	\|-		\|-
	\|'''URL'''		\|'''URL'''
	\|This is the location of the information file used for your data source. Included in the distribution are some sample XML files which can be accessed by using file:/// (on Windows) or file:// (on UNIX) URL. For example, on Windows it would look like file:///${application.home}/data/pkg/sample/atlas/atlas.xml and on UNIX it would look like file://${application.home}/data/pkg/sample/atlas/atlas.xml. As with the CSV and JSON adapters, XML files can also be placed within a custom folder in the enportal directory and accessed via http://host:port/enportal/custom_folder/path_to_XML. Normally you will be using http:// to reference the RESTful Web service.		\|This is the location of the information file used for your data source. Included in the distribution are some sample XML files which can be accessed by using file:/// (on Windows) or file:// (on UNIX) URL. For example, on Windows it would look like file:///${application.home}/data/pkg/sample/atlas/atlas.xml and on UNIX it would look like file://${application.home}/data/pkg/sample/atlas/atlas.xml. As with the CSV and JSON adapters, XML files can also be placed within a custom folder in the enportal directory and accessed via http://host:port/enportal/custom_folder/path_to_XML. Normally you will be using http:// to reference the RESTful Web service.<br><br>Example URL: <tt>file:///${application.home}/data/pkg/sample/atlas/atlas.xml</tt><br>Example Stylesheet: <tt>${application.home}/stylesheets/sample/atlas-to-adapter.xsl</tt>
	\|-		\|-
	\|'''Style Sheet Path'''		\|'''Style Sheet Path'''

imported>David.moore: /* JSON Web */

2014-01-03T21:38:42Z

JSON Web

← Older revision		Revision as of 21:38, 3 January 2014
Line 79:		Line 79:
	\|-		\|-
	\|'''URL'''		\|'''URL'''
	\|Base URL for the web service from which to fetch data. This can also be the complete URL, if you want to include any needed parameters here instead of as separate settings. ~~Although the~~ distribution ~~itself does not include any~~ sample JSON files~~, the~~ following section in the documentation includes links to sample JSON files ~~that~~ demonstrate valid formatting. Any JSON files placed on the AppBoard server can go either within <tt>${application.home}/data/</tt> or within a custom folder in the enportal directory. Just like with the CSV files, these can be accessed using URLs like file:///${application.home}/data/path_to_JSON or http://host:port/enportal/custom/path_to_JSON.		\|Base URL for the web service from which to fetch data. This can also be the complete URL, if you want to include any needed parameters here instead of as separate settings. The distribution contains sample JSON files located within <tt>${application.home}/data/JSON/</tt>. The following section in the documentation also includes links to copies of these sample JSON files which demonstrate valid formatting. Any JSON files placed on the AppBoard server can go either within <tt>${application.home}/data/</tt> or within a custom folder in the enportal directory. Just like with the CSV files, these can be accessed using URLs like file:///${application.home}/data/path_to_JSON or http://host:port/enportal/custom/path_to_JSON.
	\|-		\|-
	\|'''HTTP Auth Username'''		\|'''HTTP Auth Username'''

imported>David.moore: /* Connecting with XML XSLT */

2014-01-03T19:01:41Z

Connecting with XML XSLT

← Older revision		Revision as of 19:01, 3 January 2014
Line 151:		Line 151:
	\|'''HTTP Auth Password'''		\|'''HTTP Auth Password'''
	\|Password to use for HTTP Auth (Basic, Digest, etc.). Ignored if HTTP Auth is not required.		\|Password to use for HTTP Auth (Basic, Digest, etc.). Ignored if HTTP Auth is not required.
	\|-
	~~\|'''Cache Timeout'''~~
	\|Time limit before re-loading results from the RESTful web service. Note: if a timeout is not specified, it will calculate the timeout based on the timeout specfied by the response header. If the request should be run on every request, then a value of '0' should be specified.
	\|-		\|-
	\|'''HTTP Headers'''		\|'''HTTP Headers'''
Line 160:		Line 157:
	\|'''HTTP Post Body'''		\|'''HTTP Post Body'''
	\|Optional POST body to send with request. If set, the request will be made via a POST; if not, the HTTP request will be a GET request.		\|Optional POST body to send with request. If set, the request will be made via a POST; if not, the HTTP request will be a GET request.
			\|-
			\|'''Cache Timeout'''
			\|Time limit before re-loading results from the RESTful web service. Note: if a timeout is not specified, it will calculate the timeout based on the timeout specfied by the response header. If the request should be run on every request, then a value of '0' should be specified.
	\|-		\|-
	\|'''Proxy URL'''		\|'''Proxy URL'''
	\|Optional URL for web proxy.		\|Optional URL for web proxy.
			\|-
			\|'''Use NTLM Authentication'''
			\|Optional Use NTLM Auth for Proxy.
			\|-
			\|'''Proxy Domain'''
			\|Optional Proxy NT Domain.
	\|-		\|-
	\|'''Proxy Username'''		\|'''Proxy Username'''
Line 169:		Line 175:
	\|'''Proxy Password'''		\|'''Proxy Password'''
	\|Optional Proxy Password.		\|Optional Proxy Password.
	\|-
	~~\|'''Use NTLM Authentication'''~~
	~~\|Optional Use NTLM Auth for Proxy.~~
	\|-
	~~\|'''Proxy Domain'''~~
	~~\|Optional Proxy NT Domain.~~
	\|-		\|-
	\|}		\|}

imported>David.moore: /* Connecting with JSON Web */

2014-01-03T18:35:07Z

Connecting with JSON Web

← Older revision		Revision as of 18:35, 3 January 2014
Line 86:		Line 86:
	\|'''HTTP Auth Password'''		\|'''HTTP Auth Password'''
	\|Password to use for HTTP Auth (Basic, Digest, etc.). Ignored if HTTP Auth is not needed.		\|Password to use for HTTP Auth (Basic, Digest, etc.). Ignored if HTTP Auth is not needed.
	\|-
	~~\|'''Cache Timeout'''~~
	~~\|Time limit before reloading results from the database.~~
	\|-		\|-
	\|'''HTTP Headers'''		\|'''HTTP Headers'''
Line 95:		Line 92:
	\|'''HTTP Post Body'''		\|'''HTTP Post Body'''
	\|Optional POST body to send with request. If set, the request will be made via a POST, if not, the HTTP request will be a GET request.		\|Optional POST body to send with request. If set, the request will be made via a POST, if not, the HTTP request will be a GET request.
			\|-
			\|'''Cache Timeout'''
			\|Time limit before reloading results from the database.
	\|-		\|-
	\|'''Proxy URL'''		\|'''Proxy URL'''
	\|Optional URL for web proxy.		\|Optional URL for web proxy.
	\|-
	~~\|'''Proxy Username'''~~
	~~\|Optional Proxy Username.~~
	\|-
	~~\|'''Proxy Password'''~~
	~~\|Optional Proxy Password.~~
	\|-		\|-
	\|'''Use NTLM Authentication'''		\|'''Use NTLM Authentication'''
Line 111:		Line 105:
	\|Optional Proxy NT Domain.		\|Optional Proxy NT Domain.
	\|-		\|-
			\|'''Proxy Username'''
			\|Optional Proxy Username.
			\|-
			\|'''Proxy Password'''
			\|Optional Proxy Password.
	\|}		\|}


	===Valid JSON Formats===		===Valid JSON Formats===

imported>David.moore: /* Connecting with CSV Web */

2014-01-03T18:19:35Z

Connecting with CSV Web

← Older revision		Revision as of 18:19, 3 January 2014
Line 28:		Line 28:
	\|'''HTTP Auth Password'''		\|'''HTTP Auth Password'''
	\|Password to use for HTTP Auth (Basic, Digest, etc.). Ignored if HTTP Auth is not needed.		\|Password to use for HTTP Auth (Basic, Digest, etc.). Ignored if HTTP Auth is not needed.
	\|-
	~~\|'''Cache Timeout'''~~
	~~\|Time limit before reloading results from the database.~~
	\|-		\|-
	\|'''HTTP Headers'''		\|'''HTTP Headers'''
Line 37:		Line 34:
	\|'''HTTP Post Body'''		\|'''HTTP Post Body'''
	\|Optional POST body to send with request. If set, the request will be made via a POST; if not, the HTTP request will be a GET request.		\|Optional POST body to send with request. If set, the request will be made via a POST; if not, the HTTP request will be a GET request.
			\|-
			\|'''Cache Timeout'''
			\|Time limit before reloading results from the database.
			\|-
			\|'''Data Delimiter'''
			\|Whether the data includes a delimiter to define the columns/field names.
	\|-		\|-
	\|'''Contains Header Line'''		\|'''Contains Header Line'''
Line 43:		Line 46:
	\|'''Header Meta Delimiter'''		\|'''Header Meta Delimiter'''
	\|Whether the header includes a delimiter.		\|Whether the header includes a delimiter.
	\|-
	~~\|'''Data Delimiter'''~~
	~~\|Whether the data includes a delimiter to define the columns/field names.~~
	\|-		\|-
	\|'''String Boundaries'''		\|'''String Boundaries'''
Line 52:		Line 52:
	\|'''Proxy URL'''		\|'''Proxy URL'''
	\|Optional URL for web proxy.		\|Optional URL for web proxy.
	\|-
	~~\|'''Proxy Username'''~~
	~~\|Optional Proxy Username.~~
	\|-
	~~\|'''Proxy Password'''~~
	~~\|Optional Proxy Password.~~
	\|-		\|-
	\|'''Use NTLM Authentication'''		\|'''Use NTLM Authentication'''
Line 65:		Line 59:
	\|Optional Proxy NT Domain.		\|Optional Proxy NT Domain.
	\|-		\|-
			\|'''Proxy Username'''
			\|Optional Proxy Username.
			\|-
			\|'''Proxy Password'''
			\|Optional Proxy Password.
	\|}		\|}

imported>David.moore at 13:28, 23 December 2013

2013-12-23T13:28:39Z

← Older revision		Revision as of 13:28, 23 December 2013
Line 16:		Line 16:


	{\|class="wikitable" border="1" style="~~text-align:center;~~ background-color:#eeeeee;"		{\|class="wikitable" border="1" style="background-color:#eeeeee;"
	!Name		!Name
	!Description		!Description
Line 75:		Line 75:
	The Data Source Wizard begins with the "Connect" step. Here you must fill in the necessary information to connect AppBoard to your JSON data source. These are the possible elements you will need to provide:		The Data Source Wizard begins with the "Connect" step. Here you must fill in the necessary information to connect AppBoard to your JSON data source. These are the possible elements you will need to provide:

	{\|class="wikitable" border="1" style="~~text-align:center;~~ background-color:#eeeeee;"		{\|class="wikitable" border="1" style="background-color:#eeeeee;"
	!Name		!Name
	!Description		!Description
Line 139:		Line 139:
	The Data Source Wizard begins with the "Connect" step. Here you must fill in the necessary information to connect AppBoard with your XML XSLT data source. These are the possible elements you will need to provide:		The Data Source Wizard begins with the "Connect" step. Here you must fill in the necessary information to connect AppBoard with your XML XSLT data source. These are the possible elements you will need to provide:

	{\|class="wikitable" border="1" style="~~text-align:center;~~ background-color:#eeeeee;"		{\|class="wikitable" border="1" style="background-color:#eeeeee;"
	!Name		!Name
	!Description		!Description

imported>David.moore: /* JSON Web Service */

2013-12-20T20:35:27Z

JSON Web Service

← Older revision		Revision as of 20:35, 20 December 2013
Line 67:		Line 67:
	\|}		\|}

	==JSON Web ~~Service~~==		==JSON Web==

	This data source adapter is for web services that provide JavaScript Object Notation (JSON) formatted responses.		This data source adapter is for web services that provide JavaScript Object Notation (JSON) formatted responses.

	===Connecting with JSON Web ~~Service~~===		===Connecting with JSON Web===

	The Data Source Wizard begins with the "Connect" step. Here you must fill in the necessary information to connect AppBoard to your JSON data source. These are the possible elements you will need to provide:		The Data Source Wizard begins with the "Connect" step. Here you must fill in the necessary information to connect AppBoard to your JSON data source. These are the possible elements you will need to provide:

imported>David.moore at 20:34, 20 December 2013

2013-12-20T20:34:49Z

← Older revision		Revision as of 20:34, 20 December 2013
Line 4:		Line 4:


	==CSV ~~WebService~~==		==CSV Web==


	This data source adapter is for web services that provide Comma Separated Value (CSV) formatted responses.		This data source adapter is for web services that provide Comma Separated Value (CSV) formatted responses.

	===Connecting with CSV ~~WebService~~===		===Connecting with CSV Web===


	The Data Source Wizard begins with the "Connect" step. Here you must fill in the necessary information to connect AppBoard to your CSV ~~WebService~~ data source. These are the possible elements you will need to provide:		The Data Source Wizard begins with the "Connect" step. Here you must fill in the necessary information to connect AppBoard to your CSV Web data source. These are the possible elements you will need to provide:


Line 128:		Line 128:
	* Named objects within objects will be created as a separate entity, so it's important that each of these named objects have a consistent set of keys.		* Named objects within objects will be created as a separate entity, so it's important that each of these named objects have a consistent set of keys.

	==XML XSLT==		==XML XSLT Web==

	The XML Web Service Adapter supports data retrieval from HTTP REST services. XML data returned from the REST service is transformed to the AppBoard internal data structure using XSLT. Hierarchical relationships between XML data elements can be represented within AppBoard through associations within the AppBoard data model.		The XML Web Service Adapter supports data retrieval from HTTP REST services. XML data returned from the REST service is transformed to the AppBoard internal data structure using XSLT. Hierarchical relationships between XML data elements can be represented within AppBoard through associations within the AppBoard data model.
Line 144:		Line 144:
	\|-		\|-
	\|'''URL'''		\|'''URL'''
	\|This is the location of the information file used for your data source. Included in the distribution are some sample XML files which can be accessed by using file:/// (on Windows) or file:// (on UNIX) URL. For example, on Windows it would look like file:///${application.home}/data/pkg/sample/atlas/atlas.xml and on UNIX it would look like file://${application.home}/data/pkg/sample/atlas/atlas.xml. As with the CSV and JSON adapters, XML files can also be placed within a custom folder in the enportal directory and accessed via http://host:port/enportal/custom_folder/path_to_XML. Normally you will be using http:// to reference the RESTful ~~WebService~~.		\|This is the location of the information file used for your data source. Included in the distribution are some sample XML files which can be accessed by using file:/// (on Windows) or file:// (on UNIX) URL. For example, on Windows it would look like file:///${application.home}/data/pkg/sample/atlas/atlas.xml and on UNIX it would look like file://${application.home}/data/pkg/sample/atlas/atlas.xml. As with the CSV and JSON adapters, XML files can also be placed within a custom folder in the enportal directory and accessed via http://host:port/enportal/custom_folder/path_to_XML. Normally you will be using http:// to reference the RESTful Web service.
	\|-		\|-
	\|'''Style Sheet Path'''		\|'''Style Sheet Path'''

imported>David.moore at 20:33, 20 December 2013

2013-12-20T20:33:26Z

← Older revision		Revision as of 20:33, 20 December 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:Web Service Data Adapters}}		{{DISPLAYTITLE:Web Service Data Adapters}}
	[[Category:AppBoard 2.4]]		[[Category:AppBoard 2.4]]
	There are several web service data adapters available to choose from in AppBoard: CSV ~~WebService~~, JSON ~~WebService~~, and XML XSLT. As each type of data adapter will require different information to connect to AppBoard, this page will assist you in understanding some of the specific options associated with web service data adapters.		There are several web service data adapters available to choose from in AppBoard: CSV Web, JSON Web, and XML XSLT Web. As each type of data adapter will require different information to connect to AppBoard, this page will assist you in understanding some of the specific options associated with web service data adapters.

imported>David.moore at 20:28, 20 December 2013

2013-12-20T20:28:43Z

← Older revision		Revision as of 20:28, 20 December 2013
Line 75:		Line 75:
	The Data Source Wizard begins with the "Connect" step. Here you must fill in the necessary information to connect AppBoard to your JSON data source. These are the possible elements you will need to provide:		The Data Source Wizard begins with the "Connect" step. Here you must fill in the necessary information to connect AppBoard to your JSON data source. These are the possible elements you will need to provide:

	{\|class="wikitable"		{\|class="wikitable" border="1" style="text-align:center; background-color:#eeeeee;"
	!Name		!Name
	!Description		!Description
Line 139:		Line 139:
	The Data Source Wizard begins with the "Connect" step. Here you must fill in the necessary information to connect AppBoard with your XML XSLT data source. These are the possible elements you will need to provide:		The Data Source Wizard begins with the "Connect" step. Here you must fill in the necessary information to connect AppBoard with your XML XSLT data source. These are the possible elements you will need to provide:

	{\|class="wikitable"		{\|class="wikitable" border="1" style="text-align:center; background-color:#eeeeee;"
	!Name		!Name
	!Description		!Description