Skip directly to searchSkip directly to the site navigationSkip directly to the page's main content

Data Admin System Documentation - System Configuration

This page provides an overview on how to configure the application. Since this application deployable into any Java enabled application server it is not prudent to document all the various options. Tomcat with MySQL is presented in this document and even then there are many options on how to configure the MySQL JDBC driver and JNDI lookup. This page assumes that Tomcat, MySQL and the IBIS-PH Data Administration System have already been installed and working. It is also assumed that any database tools are also installed and setup properly. Listed below are the main items that should be configured to enable this system to function:
  • Create the IBIS-PH database table space(s) and account
  • Create the IBIS-PH Data Admin database tables
  • Optionally, populate/seed the IBIS-PH Data Admin database tables with the Utah data using MS-Access
  • Install the MySQL JDBC drivers into the Tomcat common/lib directory
  • Setup Tomcat's JNDI configuration (jdbc/doh_ibisph_admin)
  • Edit the application's site specific global.properties file
  • Set the default page request

Create the IBIS-PH Data Admin Database Tables

Go to the repository and download the "tab_c.sql" file for the appropriate database. For MySQL the URL is:

http://www.ibisph.org/trac/browser/trunk/admin/db/scripts/mysql/tab_c.sql

Save the file and open it with the "MySQL Query Browser" tool (or any tool that allows execution of a SQL script file). Execute the file to create the tables.
Assumptions:
  • RDBMS is setup,
  • the connection has been setup,
  • logged in as the appropriate IBIS account/user,
  • and user has the privs to create tables

Populate/Seed the Data Admin Tables with Utah Data via MS-Access


Again there are many ways and tools to do this. The method described below is simply one way using a tool that most people have access to. The repository may also contain a database export which will create the tables and insert the records directly. This would be a text file which enables easier search and replaces. However, this method only 100% portable between a given vendor's database. MS-Access allows the data to be copied into any ODBC database.

  1. Go to the repository and download the Utah MS-Access .mdb data file the URL is (or something like):

    http://www.ibisph.org/trac/browser/trunk/admin/db/doh_ibisph_owner.mdb

  2. Create a new MS-Access db file and create a "link" to all of the newly created tables via ODBC.
  3. Open the downloaded .mdb in MS-Access.
  4. Open one of the Utah data tables and the corresponding new data table.
  5. Arrange the columns of both table views to be in the same order
  6. Go to the Utah table view that contains the source data
  7. Select "Edit/Select All" rows from the table and select "copy"
  8. Switch to the new linked table and select "Edit/Paste Append"
  9. Search and replace "Utah" with the appropriate text
  10. Repeat the above steps for all tables

Install the MySQL JDBC Driver

Download the appropriate JDBC driver .jar file from the vendor (MySQL) in this case. Copy the file into the "[tomcat]/common/lib" directory.

Setup Tomcat's JNDI Configuration (jdbc/doh_ibisph_admin)

If the deployment tool was used for if auto deploy is enabled in Tomcat the META-INF/context.xml file will have been auto deployed for Tomcat which sets up the resource JNDI link needed. If not or the names do not match those that Utah uses then Tomcat's server.xml file will need to be modified (see Tomcat Admin Context). There is also documentation within the webapp/ibisph-admin/META-INF/*.xml files.

Next, edit the "[tomcat]/conf/server.xml" file and enter the following element definition (assumes default install of MySQL with the apporp username, password, JDBD driver etc.):
 <GlobalNamingResources>

  . . .

  <Resource name="jdbc/doh_ibisph_admin" auth="Container" 
    type="javax.sql.DataSource"
    driverClassName="com.mysql.jdbc.Driver"
    maxActive="10" maxIdle="30" maxWait="10000"
    username="the_ibisph_account" password="the_account_password" 
    url="jdbc:mysql://127.0.0.1:3306/the_ibisph_tablespace_name"
  />
</GlobalNamingResources>
		
The above is very specific to the database being connected to as well as the database vendor. If in doubt, contact your DBA or google the database, app server, with "JDBC setup".

Update the Site Specific "WEB-INF/global.properties" file

This property file contains URL addresses, log settings, and other site specific values. Please see the file's internal documentation for more information about these properties and their values. Typically to open the system comment out the headerAdminRoleKey property line or clear or change its value to blank. Other items include the view system's IP address which is used for security and the view system addresses which are used for publishing and preview. Another important property is the database specific date function. Shown below is what the property file looks like when opened to the world.
		




#--- Siteminder placed, HttpServletRequest header values.  Clear the 
#    headerAdminRoleKey value to open the system to the world.
headerFullNameKey     =fullname
headerEmailAddressKey =email
headerAdminRoleKey    =
headerAdminRoleValue  =Admin
		


Default Index Page

The application deployment provides a default index.html redirection page that directs to the main request dispatcher servlet (DataAdmin). This is also defined within the app's web.xml file. For almost all installations this does not need to be modified.

The information provided was retrieved on: Wed, 18 September 2019 16:45:45.

Content updated: Wed, 4 Nov 2015 09:26:28 MST