Transferology Technical Documentation

QUICK LINKS

Support
Issue Tracker
[Services]
Questions
[uAchieve 4.5 Applications]
[uAchieve 5.0 Application]
[uAchieve 5.1 Application]
Transferology
TES
[Training & Conferences]
Accessibility

Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 29 Current »

Information for installing the Transferology Connector 4.4.x on Tomcat

1. Add JDBC Driver to classpath

You must have a JDBC driver in the server's classpath in order for the Transferology Connector to connect to the database.

  • Tomcat 6.0.x, 7.0.x and 8.0.x sites should copy their desired JDBC driver into the /TOMCAT_HOME/lib directory.
  • Tomcat 5.5 sites should copy their desired JDBC driver into the /TOMCAT_HOME/shared/lib directory.

2. Add Log4j Framework to classpath

No Longer Necessary

This is no longer necessary because the necessary log4j files are now included in the ceg44-xx.war, the Connector distribution specifically for Tomcat.

3. Configure Data Source

You must configure a JNDI Data Source for your CollegeSource database. The data source specifies a database and user that the Transferology Connector will use to access the database. For the specific CollegeSource tables that will be accessed by the Transferology Connector, see Required DARS Tables or Required uAchieve Tables, depending upon your CollegeSource Degree Audit product.

Keep the following points in mind when defining a data source in Tomcat:

  • Tomcat data sources are defined in a Tomcat web context xml file located in the /TOMCAT_HOME/conf/Catalina/localhost directory.
  • The Tomcat web context xml file name must match the base name of the application. 
    • For example, if you plan to deploy the Transferology Connector as ceg4.war, then you must define the data source in a file named ceg4.xml


Downloading a Tomcat Web Context file

Please use one of the download Tomcat web context links below. Don't copy the HTML page, since it contains hidden characters or spacing which are incompatible with the xml file.

Be sure to download the correct Tomcat web context xml file based on your Tomcat version and database type.

Keep in mind, you must always supply the correct values for your database in the following attributes: password, username, url, and driverclassname

Rename the downloaded Tomcat web context file to match the basename of the Transferology Connector war file.

3.1 Tomcat 5.5.x, 6.0.x, 7.0.x

Download the Tomcat-context-oracle-older.xml for an Oracle database.

Example Tomcat Context file with Data Source Definition for Oracle
<Context reloadable="true">

 <!-- Default set of monitored resources --> 
 <WatchedResource>WEB-INF/web.xml</WatchedResource> 
 <WatchedResource>WEB-INF/*</WatchedResource> 

   <Resource
      auth="Container"
      type="javax.sql.DataSource"
      driverClassName="oracle.jdbc.driver.OracleDriver"
      name="jdbc/DARS"
      password="thepassword"
      username="theuser"
      url="jdbc:oracle:thin:@localhost:1521:XE"
      validationQuery="select 1 from dual"
      maxIdle="4"
      maxActive="8"
      autoCommit="false" />
</Context>


Download the Tomcat-context-sqlserver-older.xml for a SQL Server database.

Example Tomcat Context file with Data Source Definition for SQL Server using the JTDS driver
<Context reloadable="true">

 <!-- Default set of monitored resources --> 
 <WatchedResource>WEB-INF/web.xml</WatchedResource> 
 <WatchedResource>WEB-INF/*</WatchedResource> 

   <Resource
      auth="Container"
      type="javax.sql.DataSource"
      driverClassName="net.sourceforge.jtds.jdbc.Driver" 
      name="jdbc/DARS"
      password="thepassword"
      username="theuser"
      url="jdbc:jtds:sqlserver://localhost/dars35"
      validationQuery="select 1"
      maxIdle="4"
      maxActive="8"
      autoCommit="false" />
</Context>


Download the Tomcat-context-db2-older.xml for a DB2 database.

Example Tomcat Context file with Data Source Definition for DB2
<Context reloadable="true">

<JarScanner>
<JarScanFilter tldScan="displaytag-1.1.jar,freemarker-2.3.15.jar,jawr-3.3.3.jar,jtidyservlet-r8.jar,sitemesh-2.4.2.jar,spring-modules-validation-0.8a.jar,spring-webmvc-3.0.6.RELEASE.jar,standard-1.1.2.jar,unstandard-1.0.jar"/>
</JarScanner>

<!-- Default set of monitored resources -->
<WatchedResource>WEB-INF/web.xml</WatchedResource>
<WatchedResource>WEB-INF/*</WatchedResource>
<Resource
auth="Container"
type="javax.sql.DataSource"
driverClassName="oracle.jdbc.driver.OracleDriver"
name="jdbc/DARS"
password="thepassword"
username="theuser"
url="jdbc:oracle:thin:@localhost:1521:XE"
validationQuery="select 1 from dual"
maxIdle="4"
maxActive="8"
autoCommit="false" />
</Context>


3.2 Tomcat 8.0.x, 8.5.x, 9.0.x

Choose one of the above Tomcat web context xml files based on your database type and add the following xml above the <WatchedResource> elements.

	<JarScanner>
		<JarScanFilter tldScan="displaytag-1.1.jar,freemarker-2.3.15.jar,jawr-3.3.3.jar,jtidyservlet-r8.jar,sitemesh-2.4.2.jar,spring-modules-validation-0.8a.jar,spring-webmvc-3.0.6.RELEASE.jar,standard-1.1.2.jar,unstandard-1.0.jar"/>
	</JarScanner>


Download the Tomcat-context-oracle.xml for an Oracle database.

<Context reloadable="true">
 
	<JarScanner>
		<JarScanFilter tldScan="displaytag-1.1.jar,freemarker-2.3.15.jar,jawr-3.3.3.jar,jtidyservlet-r8.jar,sitemesh-2.4.2.jar,spring-modules-validation-0.8a.jar,spring-webmvc-3.0.6.RELEASE.jar,standard-1.1.2.jar,unstandard-1.0.jar"/>
	</JarScanner>

 <!-- Default set of monitored resources --> 
 <WatchedResource>WEB-INF/web.xml</WatchedResource> 
 <WatchedResource>WEB-INF/*</WatchedResource> 
   <Resource
      auth="Container"
      type="javax.sql.DataSource"
      driverClassName="oracle.jdbc.driver.OracleDriver"
      name="jdbc/DARS"
      password="thepassword"
      username="theuser"
      url="jdbc:oracle:thin:@localhost:1521:XE"
      validationQuery="select 1 from dual"
      maxIdle="4"
      maxActive="8"
      autoCommit="false" />
</Context>


Download the Tomcat-context-sqlserver.xml for a SQL Server database.

Download the Tomcat-context-db2.xml for a DB2 database.

4. Deploy Transferology Connector

  • Revise the password, username, url, and driverclassname attributes of the downloaded Tomcat web context file.
  • Rename the downloaded Tomcat web context file to match the basename of the Transferology Connector war file, i.e. ceg4.xml.
  • Copy ceg4.xml to /TOMCAT_HOME/conf/Catalina/localhost/ directory
  • Copy ceg4.war to /TOMCAT_HOME/webapps/ directory
  • Start Tomcat if it is not already started
  • Tomcat will automatically create the /TOMCAT_HOME/webapps/ceg4/ directory structure
  • You must copy the files you initially created/edited while following instructions on the main Install and Configure page. Copy the following files into the /TOMCAT_HOME/webapps/ceg4/WEB-INF/classes/ directory:

cas4.properties

Deploy Errors on Tomcat 7

We have seen several schools encounter deployment errors on Tomcat 7. Follow these steps if you encounter deployment errors on Tomcat 7:

  1. Remove the catalina-5.5.23.jar and catalina-ant-5.5.23.jar files from the TOMCAT webapps/ceg4/WEB-INF/lib directory.
  2. Delete all lines in the TOMCAT webapps/ceg4/WEB-INF/jsp/req.jsp file and save the file. After saving, the file should have a size of 0 bytes.
  3. Stop and start Tomcat

5. Specify Path and File for Logging

Locate the log4j.properties file in this directory /TOMCAT_HOME/webapps/ceg4/WEB-INF/classes/

Follow the short steps on this page: Configure Connector Logging to a File


  • No labels