Appboard/2.4/builder/data sources/file - Revision history

imported>Andy.hopper: /* Configuration Options */

2014-06-05T15:25:39Z

Configuration Options

← Older revision		Revision as of 15:25, 5 June 2014
Line 38:		Line 38:
	\|-		\|-
	\|''String Boundaries''		\|''String Boundaries''
	\| For files that contain strings which could potentially include the data delimiter character the fields need to be further grouped by quotes so the parser doesn't incorrectly split the field. Typically this should be set to ''Delimited by Quotes'' even in the case quotes aren't used as this still behaves as expected. Setting this to ''Not Delimited'' will specifically ignore quotes and split on every data delimiter found.		\| For files that contain strings which could potentially include the data delimiter character the fields need to be further grouped by quotes so the parser doesn't incorrectly split the field. Typically this should be set to ''Delimited by Quotes'' even in the case quotes aren't used as this still behaves as expected (note that this approach is compliant with [http://tools.ietf.org/html/rfc4180 RFC 4180]). Setting this to ''Not Delimited'' will specifically ignore quotes and split on every data delimiter found.
	\|}		\|}

imported>Jason.nicholls at 07:03, 14 December 2013

2013-12-14T07:03:15Z

← Older revision		Revision as of 07:03, 14 December 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:File Based Data Adapters}}		{{DISPLAYTITLE:File Based Data Adapters}}
			[[Category:AppBoard 2.4]]

	File based data adapters allow AppBoard to consume data from any files the server process has permissions to read, including network mounted filesystems.		File based data adapters allow AppBoard to consume data from any files the server process has permissions to read, including network mounted filesystems.

imported>Jason.nicholls: /* Configuration Options */

2013-11-05T17:00:08Z

Configuration Options

← Older revision		Revision as of 17:00, 5 November 2013
Line 31:		Line 31:
	\|-		\|-
	\|''Contains Header Line''		\|''Contains Header Line''
	\| Defines whether the file contains a header line, which should be the first row in the file. If no header is present the first row will ~~also~~ be used to define the field names.		\| Defines whether the file contains a header line, which should be the first row in the file. If no header is present the first row returned in discovery will be used to define the initial field names.
	\|-		\|-
	\|''Header Meta Delimiter''		\|''Header Meta Delimiter''

imported>Mike.berman at 23:37, 31 October 2013

2013-10-31T23:37:41Z

← Older revision		Revision as of 23:37, 31 October 2013
Line 121:		Line 121:

	[[File:appboard-2.4-remote-file-browser.png\|frame\|Remote File Browser]]		[[File:appboard-2.4-remote-file-browser.png\|frame\|Remote File Browser]]


			==== Accessing Files External to the AppBoard Server ====
			AppBoard can connect to files that are not located on the AppBoard server. Sometimes it may take some experimentation to ensure that the path to the file is valid. There can be some trial and error involved to get a path that will work in a particular environment. For example, on a Windows server a path such as <tt>\\servername\path1\path2\filename.xls</tt> would work as long as that path mapping is valid.

			When specifying the file path or directory in the Data Source configuration wizard, by default the path shown is <tt>${application.home}/data/</tt>, which is the equivalent of <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/data/</tt>. If the purple magnifying glass is clicked, this will open the Remote File Browser dialog. This browser is restricted to browse under the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/data/</tt> directory only. However, the text input field will accept any valid file path or directory as long as the AppBoard process has permissions to read it. For example, on Windows systems a valid entry could be <tt>C:\mydata\file.csv</tt>, while on Linux and UNIX systems the following is valid <tt>/mydata/file.csv</tt>.

			As an advanced technique, a symbolic link, or symlink, is a reference to another file or directory in the form of an absolute or relative path that affects pathname resolution. By creating a symbolic link from the default /data/ directory to another path, you can actually have AppBoard show the files from that other path in the Remote File Browser dialog.

			For example, perform the following steps to create a Windows symlink to access a CSV data file from AppBoard:

			Note: The paths in the following example assume that you have installed AppBoard in the directory <tt>c:\AppBoard</tt> and you have a CSV file located in <tt>c:\MyData\Files\Data.csv</tt> that you want to use in an AppBoard CSV Data Source

			#Create the following folder in your AppBoard file system: <tt>C:\AppBoard\server\webapps\enportal\WEB-INF\data\custom\Files\</tt>
			#Create the symlink from <tt>C:\AppBoard\server\webapps\enportal\WEB-INF\data\custom\Files\</tt> to <tt>c:\MyData\Files\</tt>:
			##Run a command line console window (cmd.exe) as an administrator
			##Enter the following commands:
			###<tt>> cd C:\AppBoard\server\webapps\enportal\WEB-INF\data\custom\Files\</tt>
			###<tt>> mklink /d "C:\AppBoard\server\webapps\enportal\WEB-INF\data\custom\Files\AppBoard_CSV_Data" "C:\MyData\Files"</tt>
			##Observe the message: <tt>symbolic link created for C:\AppBoard\server\webapps\enportal\WEB-INF\data\custom\Files\AppBoard_CSV_Data <<===>> C:\MyData\Files</tt>
			#Configure the AppBoard Data Source
			##Follow the standard instructions for creating a CSV File Data Source
			##When prompted for the data file name, enter: <tt>${application.home}/data/custom/Files/AppBoard_CSV_Data/Data.csv</tt>

			{{Note\|To have your data files automatically included with full archives, place them under the <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/data/custom/</tt> directory. Files outside of the AppBoard file system are not preserved by the AppBoard backup utility. When upgrading AppBoard, or migrating AppBoard to another server, such files would need to be manually moved and configured so that any Data Source referencing the files will continue to function correctly.}}

imported>Jason.nicholls: /* Configuration Options */

2013-09-19T14:42:54Z

Configuration Options

← Older revision		Revision as of 14:42, 19 September 2013
Line 101:		Line 101:
	\|-		\|-
	\|''Environment Variables''		\|''Environment Variables''
	\| Define or override the environment provided to the script one variable per line in the format <tt>KEY=value</tt>. These can include SHIM expressions.		\| Define or override the environment provided to the script '''one variable per line''' in the format <tt>KEY=value</tt>. These can include SHIM expressions.
	\|-		\|-
	\|''Inherit Server Environment''		\|''Inherit Server Environment''

imported>Jason.nicholls: /* Configuration Options */

2013-09-19T14:41:23Z

Configuration Options

← Older revision		Revision as of 14:41, 19 September 2013
Line 95:		Line 95:
	\|-		\|-
	\|''Command Line Parameters''		\|''Command Line Parameters''
	\|		\| One or more command line parameters, these can include SHIM expressions.
	\|-		\|-
	\|''Handle Standard Error (stderr)''		\|''Handle Standard Error (stderr)''
	\|		\| Only command output to STDOUT is captured by AppBoard as the data response, while anything to STDERR is considered error messages and logged. This option determines the behaviour of the data adapter where by default this is set to ''Log and continue'', in other words the response is always valid regardless of STDERR. The ''Log and break'' option means that on any STDERR output the response will be considered invalid.
	\|-		\|-
	\|''Environment Variables''		\|''Environment Variables''
	\|		\| Define or override the environment provided to the script one variable per line in the format <tt>KEY=value</tt>. These can include SHIM expressions.
	\|-		\|-
	\|''Inherit Server Environment''		\|''Inherit Server Environment''
	\|		\| By default the executed command will inherit the complete environment from the AppBoard server along with any changes in the ''Environment Variables'' configuration. Setting this switch to ''No'' means '''only''' the environment defined in ''Environment Variables'' will be passed to the script. Using environment variables to pass sensitive information such as passwords is a better method than command line parameters.
	\|-		\|-
	\|''Cache Timeout''		\|''Cache Timeout''
	\|		\| How long the cache manager will keep a response before re-running the command.
	\|}		\|}

imported>Jason.nicholls: /* Shell Command */

2013-09-19T14:28:02Z

Shell Command

← Older revision		Revision as of 14:28, 19 September 2013
Line 79:		Line 79:
	=== Shell Command ===		=== Shell Command ===

	~~The~~ Shell Command data adapter allows AppBoard to execute a command and capture the response~~. The response~~ is expected to be in CSV format so this adapter shares the CSV specific configuration options including support for header meta data - please refer to the CSV documentation above for more information.		Typical usage for the Shell Command data adapter is to provide a generic integration method to AppBoard in cases where a more specific data adapter isn't appropriate. This adapter allows AppBoard to execute a command and capture the response which is expected to be in CSV format. As a result this adapter shares the CSV specific configuration options including support for header meta data - please refer to the CSV documentation above for more information.

	Both static and dynamic variables (query SHIMs) can be provided to the script via command line parameters and setting environment variables. The combination of dynamic variables and CSV responses with meta information allows for tight integration with AppBoard.		Both static and dynamic variables (query SHIMs) can be provided to the script via command line parameters and setting environment variables. The combination of dynamic variables and CSV responses with meta information allows for tight integration with AppBoard.

			{{Note\|Using the Shell Command data adapter means AppBoard will be spawning processes each time the data source needs to be queried. It's important to set reasonable cache timeouts to avoid excessive calls and factor in the additional load on the AppBoard server.}}

	==== Configuration Options ====		==== Configuration Options ====

imported>Jason.nicholls: /* Shell Command */

2013-09-19T09:49:32Z

Shell Command

← Older revision		Revision as of 09:49, 19 September 2013
Line 84:		Line 84:

	==== Configuration Options ====		==== Configuration Options ====

			{\|class="wikitable"
			!Option
			!Description
			\|-
			\|''Script''
			\| Defines the command to execute. See ''Specifying Files/Directories'' below for more information, however the default directory is <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/shell-script</tt>
			\|-
			\|''Command Line Parameters''
			\|
			\|-
			\|''Handle Standard Error (stderr)''
			\|
			\|-
			\|''Environment Variables''
			\|
			\|-
			\|''Inherit Server Environment''
			\|
			\|-
			\|''Cache Timeout''
			\|
			\|}

	=== Specifying Files/Directories ===		=== Specifying Files/Directories ===

imported>Jason.nicholls: /* Shell Command */

2013-09-19T09:41:17Z

Shell Command

← Older revision		Revision as of 09:41, 19 September 2013
Line 79:		Line 79:
	=== Shell Command ===		=== Shell Command ===

			The Shell Command data adapter allows AppBoard to execute a command and capture the response. The response is expected to be in CSV format so this adapter shares the CSV specific configuration options including support for header meta data - please refer to the CSV documentation above for more information.

			Both static and dynamic variables (query SHIMs) can be provided to the script via command line parameters and setting environment variables. The combination of dynamic variables and CSV responses with meta information allows for tight integration with AppBoard.

			==== Configuration Options ====

	=== Specifying Files/Directories ===		=== Specifying Files/Directories ===

imported>Jason.nicholls: /* Configuration Options */

2013-09-19T08:45:36Z

Configuration Options

← Older revision		Revision as of 08:45, 19 September 2013
Line 65:		Line 65:
	\|-		\|-
	\|''Directory''		\|''Directory''
	\| Only applicable to the XLS Directory data adapter and defines the path containing the files to be read. All files within this directory with the extention <tt>.xls</tt> are used.		\| Only applicable to the XLS Directory data adapter and defines the path containing the files to be read. All files within this directory with the extention <tt>.xls</tt> are used. See ''Specifying Files/Directories'' below for more information.
	\|-		\|-
	\|''File Path''		\|''File Path''
	\| Only applicable to the XLS File data adapter and defines the specific path and filename of the file to be read.		\| Only applicable to the XLS File data adapter and defines the specific path and filename of the file to be read. See ''Specifying Files/Directories'' below for more information.
	\|-		\|-
	\|''Sheet Name Regex''		\|''Sheet Name Regex''