Appboard/2.4/admin/configuration database - Revision history

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

2014-07-18T11:16:16Z

Creating an External Config DB

← Older revision		Revision as of 11:16, 18 July 2014
Line 56:		Line 56:
	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.		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/2.4/admin/configuration_database/example_sybase\|Sybase SQL Anywhere]]
	*[[appboard/~~old~~/configuration_database/example_oracle\|Oracle]]		*[[appboard/2.4/admin/configuration_database/example_oracle\|Oracle]]
	*[[appboard/~~old~~/configuration_database/example_mssql\|Microsoft SQL Server]]		*[[appboard/2.4/admin/configuration_database/example_mssql\|Microsoft SQL Server]]
	*[[appboard/~~old~~/configuration_database/example_db2\|IBM DB2]]		*[[appboard/2.4/admin/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:50:58Z

Using an External Config DB

← Older revision		Revision as of 09:50, 18 July 2014
Line 46:		Line 46:
	#* 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 [[appboard/2.4/admin/~~backup_and_restore~~\|Backup & ~~Restore~~]] documentation):		#* To restore an archive run (and refer to the [[appboard/2.4/admin/backup_and_recovery\|Backup & Recovery]] 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-18T09:50:36Z

Using an External Config DB

← Older revision		Revision as of 09:50, 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 with an external config DB, make sure to run a full backup before continuing. See the [[appboard/2.4/admin/~~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/2.4/admin/backup_and_recovery\|Backup & Recovery]] 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:49:36Z

Using an External Config DB

← Older revision		Revision as of 09:49, 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 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.		# 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/2.4/admin/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:
Line 46:		Line 46:
	#* 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 [[appboard/~~old~~/backup_and_restore\|Backup & Restore]] documentation):		#* To restore an archive run (and refer to the [[appboard/2.4/admin/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: Created page with '{{DISPLAYTITLE:Configuration Database}} Category:AppBoard 2.4 TOC == Overview == A default installation of AppBoard / enPortal will use an in-memory H2 database that runs…'

2014-07-18T09:47:52Z

Created page with '{{DISPLAYTITLE:Configuration Database}} Category:AppBoard 2.4 __TOC__ == Overview == A default installation of AppBoard / enPortal will use an in-memory H2 database that runs…'

New page

{{DISPLAYTITLE:Configuration Database}}
[[Category:AppBoard 2.4]]
__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.

The configuration database is used to store a variety of system configuration:

* AppBoard Stacks, Boards, Widgets, filter rules, etc...
* AppBoard / enPortal domains, users, roles, content assignment
* enPortal channel configuration
* enPortal Single Sign On (SSO) tokens

This database is ''only'' used for configuration data and the resource requirements are very minimal if using an external database.

{{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.}}

== Using an External Config DB ==

{{Note|
* The appropriate JDBC driver must be installed before starting this process!
* The external DB should exist and you need to have access credentials with a database user that has the ability to create tables.
* The external DB should be for the exclusive use of AppBoard / enPortal
}}

[[File:appboard-2.4-dbsetup.png|right|frame|DB Setup Tool]]

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 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.
# Open a terminal and change into the <tt>[INSTALL_HOME]/server/bin</tt> directory and run:
#: <tt>> portal dbsetup</tt>
# This will launch a graphical user interface to assist with the configuration as shown to the right.
## Use the ''Database'' button to select from a list of pre-configured templates, such as MySQL.
## Adjust the ''Host'' and ''Port'' fields to match the database host and port. After making a database selection the port will default to the default for that database type.
## Set the ''Database Name'' field to match the name of the database created to store the AppBoard configuration data.
## Set the ''User'' and ''Password'' used to authenticate against the database.
## Click the ''Test'' button to establish a connection and ensure the details are correct.
## The ''Advanced Url...'' button can be used to set specific JDBC connection parameters.
## The ''Advanced...'' button can be used to configure some additional connection management settings.
## 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 (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:
#*: <tt>> portal dbreset</tt>
#* To restore an archive run (and refer to the [[appboard/old/backup_and_restore|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.}}

== Creating an External Config DB ==

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.

Appboard/2.4/admin/configuration database - Revision history

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

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

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

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

imported>Jason.nicholls: Created page with '{{DISPLAYTITLE:Configuration Database}} Category:AppBoard 2.4 __TOC__ == Overview == A default installation of AppBoard / enPortal will use an in-memory H2 database that runs…'

imported>Jason.nicholls: Created page with '{{DISPLAYTITLE:Configuration Database}} Category:AppBoard 2.4 TOC == Overview == A default installation of AppBoard / enPortal will use an in-memory H2 database that runs…'