JA-SIG Home

About uPortal

Documentation

Getting Started

Developers

Implementors

Users

Background

Release

Meeting Minutes

Setting up A Microsoft SQL Server Database

Overview

Microsoft SQL Server (MSSQL) is a commercial database product available from Microsoft at
http://www.microsoft.com/sql/default.asp

Obtaining the Driver

An MSSQL JDBC driver is available through Microsoft at:
http://www.microsoft.com/sql/downloads/default.asp

Once the Microsoft SQL Server 2000 Driver for JDBC package has been downloaded the jar file must be copied to a location accessible from uPortal (for example, /usr/local/java/mssql/lib/mssqlserver.jar).

Properties Configuration

The uPortal build.properties may need to be modifed. Find the property called jdbcDriver and change it to point to the MSSQL jar file, for example:

jdbcDriver.jar=./lib/mssqlserver.jar

The uPortal rdbm.properties file (in the properties directory) may need to modified to specify the driver properties. The rdbm.properties file contains several sample entries. Uncomment (or add) the lines for the MSSQL database and make whatever changes necessary to match your local database installation, For example:

#### Microsoft SQL Server
jdbcDriver=com.microsoft.jdbc.sqlserver.SQLServerDriver
jdbcUrl=jdbc:microsoft:sqlserver://localhost:1433
jdbcPassword=sa
jdbcPassword=

The dbloader.xml properties file (also in the properties directory) may also need to be modified. This file is used by the DbLoader tool to create the uPortal database tables and populate the database. It contains several sample entries which create db-type-mappings for different databases. Find the tags for an HypersonicSQL database and modify the db-version, driver-name, and driver-version as necessary. For example:

<db-type-mapping>
  <db-name>Microsoft SQL Server 2000</db-name>
  <db-version7.0</db-version>
  <driver-name>Microsoft SQL Server Driver for JDBC</driver-name>
  <driver-version>2.2</driver-version>
  <type><generic>INTEGER</generic><local>INTEGER</local></type>
  <type><generic>VARCHAR</generic><local>VARCHAR</local></type>
  <type><generic>LONGVARCHAR</generic><local>LONGVARCHAR</local></type>
  <!-- map more types here -->
</db-type-mapping>

The PersonDirs.xml file (also in the properties directory) may need to be modified; This file is used if the database is to be used to provide user directory information

<!-- JDBC Properties -->
<driver>jdbcDriver=com.microsoft.jdbc.sqlserver.SQLServerDriver</driver>
<url>jdbc:microsoft:sqlserver://localhost:1433</url>
<logonid>sa</logonid>
<logonpassword></logonpassword>,
<uidquery>SELECT FIRST_NAME||' '||LAST_NAME AS FIRST_LAST,
FIRST_NAME, LAST_NAME, EMAIL FROM UP_PERSON_DIR WHERE USER_NAME=?></uidquery>

Loading the Database

Loading the database requires a couple of steps

• Create the database: Refer to the Microsoft SQL Server database documentation for instructions regarding how to create an MSSQL database instances. The database name, port number, and driver information must reflect what was defined in the rdbm.properties file.
• Create the tables and populate the database: From the uPortal build directory, run "ant db" to execute the ant target which loads the database. The ant target uses the Dbloader tool.

Issues and Known Bugs