Step 1: Obtain the MS JDBC driver
...
Since the MS SQL Server JDBC driver
...
is not available in the central Maven repository, it must be placed into the local repository of each machine on which you wish to build uPortal.
Info | ||
---|---|---|
| ||
As an alternative to this, you could set up a maven repository for use by multiple machines. |
- Download MS JDBC driver directly from Microsift, here: http://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=11774
...
- Follow the installation instructions, noting where the driver JAR file is located
- Note the location of the driver JAR file and the version
Install the driver into the local Maven repository
Code Block language bash title Install MS SQL Server driver mvn install:install-file -DgroupId=com.microsoft.sqlserver -DartifactId=sqljdbc4 -Dversion=<version> -Dpackaging=jar -DgeneratePom=true -Dfile=<driver JAR file>
- Again, note the groupId, artifactId and version. These will be used in Step 2.
Step 2: Add the
...
Dependency
- From the uPortal source directory, open the uPortal-4.x.x/pom.xml
...
- Add file and add the sqljdbc4.jar dependency to your pom.xml (Version 4 of the sqljdbc driver is required).
Code Block |
---|
<jdbc.groupId>com.microsoft.sqlserver</jdbc.groupId> <jdbc.artifactId>sqljdbc4</jdbc.artifactId> <jdbc.version>4.0</jdbc.version> <dependencies> ... <dependency> <groupId>com.microsoft.sqlserver</groupId> <artifactId>sqljdbc4</artifactId> <version>4.0</version> </dependency> ... </dependencies> |
Step 3:
...
Configure the Database Filter
- From the uPortal source directory, open the uPortal-4.x.x/filters/local.properties file and add your database information (Note: for ease of development we generally suggest leaving local.properties with hsql and adjusting dev.properties, test.properties, and prod.properties to your chosen DB. If you do this, pass "-Denv=dev" or whatever on your ant commands; e.g. "ant -Denv=dev dbtest").
Code Block |
---|
## HSQL Configuration environment.build.hsql.port=8887 ## Database Connection Settings (Uncomment the Maven Filters section in rdbm.properties) environment.build.hibernate.connection.driver_class=com.microsoft.sqlserver.jdbc.SQLServerDriver environment.build.hibernate.connection.url=jdbc:sqlserver://<servername>:<port>;databaseName=<databasename> environment.build.hibernate.connection.username=username environment.build.hibernate.connection.password=password environment.build.hibernate.dialect=org.hibernate.dialect.SQLServerDialect |
Step 4:
...
Test the Configuration
Running the dbtest
ant target will tell you if you have configured the database connection properly.
Code Block |
---|
ant dbtest
|
Step 5: Build and Deploy
Following a successful test, you can execute the command below to build the database tables and copy files to your servlet container.
Warning | ||
---|---|---|
| ||
Note: Executing the command "ant clean initportal" will drop and recreate the database tables and all existing data will be lost. This will result in a clean uPortal database structure. If you want to keep the contents of your existing database, use "ant clean deploy-war" |
Code Block |
---|
ant clean deploy-war |
...
initportal |
Step 6: Restart Tomcat
Info | ||||
---|---|---|---|---|
| ||||
...