Appboard/old/configuration database: Difference between revisions

imported>Jason.nicholls
No edit summary
imported>Jason.nicholls
No edit summary
Line 9: Line 9:
* enPortal Single Sign-on tokens
* enPortal Single Sign-on tokens
* AppBoard (versions 2.3 or later) Stacks, Boards, Widgets, filter rules, etc...
* AppBoard (versions 2.3 or later) Stacks, Boards, Widgets, filter rules, etc...
This database is ''only'' used for configuration data and is very lightweight.


The instructions below are for establishing a connection between the AppBoard/enPortal server and a database.  For instructions regarding the internal configuration of the database itself, please see [[Configuring_Databases|Configuring Databases]].
This database is ''only'' used for configuration data and the resource requirements are very minimal if using an external database.




{{Note|The database referenced in this document is used only for storing enPortal and AppBoard configuration.  It is independent of any application databases that may house raw data that is being used in AppBoard Data Sources and visualizations.}}
== Using an External Configuration Database ==


{{Note|The appropriate JDBC driver must be installed before starting this process!}}


You can optionally configure your own database to store this information, rather than the default H2 database.  Once you do this, the database schema will be loaded into the specified database automatically when enPortal/AppBoard is started, and does not need to be pre-configured.
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:
 
 
To configure your own database, perform the following steps:
 
{{Note|The appropriate JDBC driver must be installed before starting this process.}}


# Run the "portal dbsetup" command in ${INSTALL_HOME}/bin directory.  When you run this command, there is a GUI that assists with selecting the database type and configuring the database connection.  This tool saves changes to the file: /server/webapps/enportal/WEB-INF/config/persist.properties, with the specific configuration details that you provide for you database connection.  If your server does not have a graphical display, you can modify this file directly in lieu of running the dbsetup command.
# Run the "portal dbsetup" command in ${INSTALL_HOME}/bin directory.  When you run this command, there is a GUI that assists with selecting the database type and configuring the database connection.  This tool saves changes to the file: /server/webapps/enportal/WEB-INF/config/persist.properties, with the specific configuration details that you provide for you database connection.  If your server does not have a graphical display, you can modify this file directly in lieu of running the dbsetup command.
Line 32: Line 27:
## Test the Connection by clicking the Test button to verify the database connection settings.
## Test the Connection by clicking the Test button to verify the database connection settings.
## Select Ok to save the changes and exit the tool.
## Select Ok to save the changes and exit the tool.
If you need to actually install/create the external database the following guide may be of assistance [[Configuring_Databases|Configuring Databases]].

Revision as of 17:21, 4 June 2014


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:

  • enPortal users
  • enPortal channel configuration
  • enPortal Single Sign-on tokens
  • AppBoard (versions 2.3 or later) Stacks, Boards, Widgets, filter rules, etc...

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


Using an External Configuration Database

Template-note.png
The appropriate JDBC driver must be installed before starting this process!

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:

  1. Run the "portal dbsetup" command in ${INSTALL_HOME}/bin directory. When you run this command, there is a GUI that assists with selecting the database type and configuring the database connection. This tool saves changes to the file: /server/webapps/enportal/WEB-INF/config/persist.properties, with the specific configuration details that you provide for you database connection. If your server does not have a graphical display, you can modify this file directly in lieu of running the dbsetup command.
  2. Configure a database connection in the dbsetup GUI, by completing the following:
    1. Click the Database button and select your type of database from the selection list (e.g. Oracle)
    2. Set the Host and Port fields to match the IP location of your database (as resolved from the enPortal/AppBoard server).
    3. Set the Database Name field to match the name of the database created to store the enPortal/AppBoard data.
    4. Set the User and Password fields to match the database user and password that were configured on your database to control access.
    5. Test the Connection by clicking the Test button to verify the database connection settings.
    6. Select Ok to save the changes and exit the tool.


If you need to actually install/create the external database the following guide may be of assistance Configuring Databases.

Retrieved from "http://ab.edge-technologies.com/docs/index.php?title=Appboard/old/configuration_database&oldid=2149"