Appboard/old/configuration database - Revision history

imported>Jason.nicholls: /* Creating an External Config DB */

2014-07-18T09:03:52Z

Creating an External Config DB

← Older revision		Revision as of 09:03, 18 July 2014
Line 54:		Line 54:
	== Creating an External Config DB ==		== Creating an External Config DB ==

	In cases where an external database is not ~~already~~ available it will be necessary to install and create one specifically for AppBoard. The following guides are '''examples''' only - please refer to the actual database product documentation for complete documentation.		In cases where an existing external database is not available it will be necessary to install and create one specifically for AppBoard. The following guides are '''examples''' only - please refer to the actual database product documentation for complete documentation.

			*[[appboard/old/configuration_database/example_sybase\|Sybase SQL Anywhere]]
			*[[appboard/old/configuration_database/example_oracle\|Oracle]]
			*[[appboard/old/configuration_database/example_mssql\|Microsoft SQL Server]]
			*[[appboard/old/configuration_database/example_db2\|IBM DB2]]

	In addition, once the database has been created, it will be necessary to run through the ''Using an External Config DB'' section to configure AppBoard to use it.		In addition, once the database has been created, it will be necessary to run through the ''Using an External Config DB'' section to configure AppBoard to use it.

imported>Jason.nicholls: /* Using an External Config DB */

2014-07-18T09:01:16Z

Using an External Config DB

← Older revision		Revision as of 09:01, 18 July 2014
Line 30:		Line 30:
	enPortal / AppBoard includes a utility to set up and configure an external configuration database. Please note this assumes the appropriate JDBC driver is installed, and you have an external database to connect to along with access credentials:		enPortal / AppBoard includes a utility to set up and configure an external configuration database. Please note this assumes the appropriate JDBC driver is installed, and you have an external database to connect to along with access credentials:

	# If you already have configured AppBoard and want to use the existing configuration, make sure to run a full backup before continuing. See the [[appboard/old/backup_and_restore\|Backup & Restore]] documentation for more information.		# If you already have configured AppBoard and want to use the existing configuration with an external config DB, make sure to run a full backup before continuing. See the [[appboard/old/backup_and_restore\|Backup & Restore]] documentation for more information.
	# The AppBoard server should be stopped.		# The AppBoard server should be stopped.
	# Open a terminal and change into the <tt>[INSTALL_HOME]/server/bin</tt> directory and run:		# Open a terminal and change into the <tt>[INSTALL_HOME]/server/bin</tt> directory and run:

imported>Jason.nicholls: /* Using an External Config DB */

2014-07-18T09:00:44Z

Using an External Config DB

← Older revision		Revision as of 09:00, 18 July 2014
Line 30:		Line 30:
	enPortal / AppBoard includes a utility to set up and configure an external configuration database. Please note this assumes the appropriate JDBC driver is installed, and you have an external database to connect to along with access credentials:		enPortal / AppBoard includes a utility to set up and configure an external configuration database. Please note this assumes the appropriate JDBC driver is installed, and you have an external database to connect to along with access credentials:

			# If you already have configured AppBoard and want to use the existing configuration, make sure to run a full backup before continuing. See the [[appboard/old/backup_and_restore\|Backup & Restore]] documentation for more information.
	# The AppBoard server should be stopped.		# The AppBoard server should be stopped.
	# Open a terminal and change into the <tt>[INSTALL_HOME]/server/bin</tt> directory and run:		# Open a terminal and change into the <tt>[INSTALL_HOME]/server/bin</tt> directory and run:

imported>Jason.nicholls: /* Using an External Config DB */

2014-07-18T08:59:06Z

Using an External Config DB

← Older revision		Revision as of 08:59, 18 July 2014
Line 45:		Line 45:
	#* To reset and create a stock database configuration run:		#* To reset and create a stock database configuration run:
	#*: <tt>> portal dbreset</tt>		#*: <tt>> portal dbreset</tt>
	#* To restore an archive run (and refer to the Backup & Restore documentation):		#* To restore an archive run (and refer to the [[appboard/old/backup_and_restore\|Backup & Restore]] documentation):
	#*: <tt>>portal Restore -jar ''<archive.jar>''</tt>		#*: <tt>> portal Restore -jar ''<archive.jar>''</tt>
	# Start AppBoard. If a dbreset or restore was performed than it is during startup the database will be configured.		# Start AppBoard. If a dbreset or restore was performed than it is during startup the database will be configured.

imported>Jason.nicholls: /* Using an External Config DB */

2014-07-18T08:58:21Z

Using an External Config DB

← Older revision		Revision as of 08:58, 18 July 2014
Line 42:		Line 42:
	## The ''Advanced...'' button can be used to configure some additional connection management settings.		## The ''Advanced...'' button can be used to configure some additional connection management settings.
	## Click the ''Ok'' button to save changes and exit the tool.		## Click the ''Ok'' button to save changes and exit the tool.
	# So far this process simply sets AppBoard to '''connect''' to an external configuration database. This may be OK if the database already contains configuration, but otherwise it will be necessary to either perform a database reset to create the initial default configuration, or to restore an archive to establish the configuration:		# So far this process simply sets AppBoard to '''connect''' to an external configuration database. This may be OK if the database already contains configuration (clustered or HA environment), but otherwise it will be necessary to either perform a database reset to create the initial default configuration, or to restore an archive to establish the configuration:
	#* To reset and create a stock database configuration run:		#* To reset and create a stock database configuration run:
	#*: <tt>> portal dbreset</tt>		#*: <tt>> portal dbreset</tt>

imported>Jason.nicholls: /* Using an External Config DB */

2014-07-18T08:57:32Z

Using an External Config DB

← Older revision		Revision as of 08:57, 18 July 2014
Line 30:		Line 30:
	enPortal / AppBoard includes a utility to set up and configure an external configuration database. Please note this assumes the appropriate JDBC driver is installed, and you have an external database to connect to along with access credentials:		enPortal / AppBoard includes a utility to set up and configure an external configuration database. Please note this assumes the appropriate JDBC driver is installed, and you have an external database to connect to along with access credentials:

			# The AppBoard server should be stopped.
	# Open a terminal and change into the <tt>[INSTALL_HOME]/server/bin</tt> directory and run:		# Open a terminal and change into the <tt>[INSTALL_HOME]/server/bin</tt> directory and run:
	#: <tt>> portal dbsetup</tt>		#: <tt>> portal dbsetup</tt>
Line 41:		Line 42:
	## The ''Advanced...'' button can be used to configure some additional connection management settings.		## The ''Advanced...'' button can be used to configure some additional connection management settings.
	## Click the ''Ok'' button to save changes and exit the tool.		## Click the ''Ok'' button to save changes and exit the tool.
			# So far this process simply sets AppBoard to '''connect''' to an external configuration database. This may be OK if the database already contains configuration, but otherwise it will be necessary to either perform a database reset to create the initial default configuration, or to restore an archive to establish the configuration:
			#* To reset and create a stock database configuration run:
			#*: <tt>> portal dbreset</tt>
			#* To restore an archive run (and refer to the Backup & Restore documentation):
			#*: <tt>>portal Restore -jar ''<archive.jar>''</tt>
			# Start AppBoard. If a dbreset or restore was performed than it is during startup the database will be configured.

	{{Note\|The dbsetup tool can be re-run to make changes to the configuration as needed. Also the actual configuration information is stored in <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/persist.properties</tt> and can be modified directly however it is recommended to use the tool. In support situations this file may be requested for inspection.}}		{{Note\|The dbsetup tool can be re-run to make changes to the configuration as needed. Also the actual configuration information is stored in <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/persist.properties</tt> and can be modified directly however it is recommended to use the tool. In support situations this file may be requested for inspection.}}

imported>Jason.nicholls: /* Using an External Config DB */

2014-07-18T07:34:11Z

Using an External Config DB

← Older revision		Revision as of 07:34, 18 July 2014
Line 42:		Line 42:
	## Click the ''Ok'' button to save changes and exit the tool.		## Click the ''Ok'' button to save changes and exit the tool.

	{{Note\|The dbsetup tool can be re-run to make changes to the configuration as needed. Also the actual configuration information is stored in <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/persist.properties</tt> and can be modified directly however it is recommended to use the tool. In support situations this file may be requested for inspection.}}		{{Note\|The dbsetup tool can be re-run to make changes to the configuration as needed. Also the actual configuration information is stored in <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/persist.properties</tt> and can be modified directly however it is recommended to use the tool. In support situations this file may be requested for inspection.}}


	== Creating an External Config DB ==		== Creating an External Config DB ==

imported>Jason.nicholls at 06:37, 18 July 2014

2014-07-18T06:37:46Z

← Older revision		Revision as of 06:37, 18 July 2014
Line 2:		Line 2:
	[[Category:AppBoard old]]		[[Category:AppBoard old]]
	__TOC__		__TOC__
			== Overview ==
	A default installation of AppBoard / enPortal will use an in-memory H2 database that runs within the same process as the main application. This is the easiest and most convenient configuration but in clustered and/or high availability environments it may be necessary to configure an external shared database.		A default installation of AppBoard / enPortal will use an in-memory H2 database that runs within the same process as the main application. This is the easiest and most convenient configuration but in clustered and/or high availability environments it may be necessary to configure an external shared database.

imported>Jason.nicholls at 06:37, 18 July 2014

2014-07-18T06:37:27Z

← Older revision		Revision as of 06:37, 18 July 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:Configuration Database}}		{{DISPLAYTITLE:Configuration Database}}
	[[Category:AppBoard old]]		[[Category:AppBoard old]]
			__TOC__
	A default installation of AppBoard / enPortal will use an in-memory H2 database that runs within the same process as the main application. This is the easiest and most convenient configuration but in clustered and/or high availability environments it may be necessary to configure an external shared database.		A default installation of AppBoard / enPortal will use an in-memory H2 database that runs within the same process as the main application. This is the easiest and most convenient configuration but in clustered and/or high availability environments it may be necessary to configure an external shared database.

imported>Jason.nicholls at 06:37, 18 July 2014

2014-07-18T06:37:07Z

← Older revision		Revision as of 06:37, 18 July 2014
Line 13:		Line 13:
	This database is ''only'' used for configuration data and the resource requirements are very minimal if using an external database.		This database is ''only'' used for configuration data and the resource requirements are very minimal if using an external database.

	{{Tip\|~~For smaller and simpler deployments it~~ is recommended to use the default embedded and in-memory H2 database as this does not require any maintenance.}}		{{Tip\|It is recommended to use the default embedded and in-memory H2 database as this does not require any maintenance - unless there is a specific requirement for clustering and/or high-availability environments.}}