Install and Configure
Mandatory Requirements
The Mandatory Requirements must be met before proceeding with the instructions on this page.
Java Memory and Socket Timeout Parameters
We recommend the following Sun Java Memory and Socket Timeout Parameters to override the default values:
|
Download the Transferology Connector
You can acquire the latest release from the Connector Downloads page.
Technical documentation for the Transferology Connector, including Connector Downloads, are still maintained in the Support Center at this time.
- Don't have a Support Center account? Request an account here
Transferology Connector Distribution Filenames
To assist schools, CollegeSource currently provides three variations of the Transferology Connector release that are based on the different application server treatment of the log4j logging framework and Xerces XML parser.
The Transferology Connector release filename follows one of these patterns:
ceg44-tomcat-xx.war - Tomcat distribution includes: log4j.jar and log4j.properties
ceg44-gf-xx.war - Glassfish distribution includes: log4j.jar and log4j.properties
ceg44-jboss-xx.war - JBoss distribution does NOT include: log4j.jar or log4j.properties
ceg44-oas-xx.war - Oracle Application Server distribution includes: log4j.jar but does NOT include: log4j.properties, xercesImpl-2.0.2.jar and xml-apis-1.0.b2.jar
ceg44-weblogic-xx.war - Weblogic Server distribution
xx is an internal build number
Once the file is downloaded, we suggest you rename it to ceg4.war or ceg44.war before deploying it to your application server.
Logging Framework and Necessary Files
The Connector relies on the log4j framework for logging. This framework depends on the log4j.properties file for its configuration. Each application server requires different instructions to enable logging for the Connector.
Overview of Included Logging Files for Each Connector Distribution
- Tomcat - Distribution includes log4j.properties and log4j-1.2.12.jar, pre-configured with default logging to stdout only. No further downloads required.
- GlassFish - Distribution includes log4j.properties and log4j-1.2.12.jar, pre-configured with default logging to stdout only. No further downloads required.
- JBoss - Distribution does NOT include any log4j files since JBoss already provides a log4j service. No further downloads required.
- OAS - Distribution includes only log4j-1.2.12.jar, you must download the log4j.properties file from here: http://clients.collegesource.com/home/download/attachments/56951841/log4j.properties
- Weblogic - Distribution includes log4j.properties and log4j-1.2.12.jar. No further downloads required.
Identify CollegeSource Audit Daemon
If you are not using the Degree Audit functionality, you can proceed to the next section: Create cas4.properties
The Transferology Connector uses the CollegeSource job_queue_list table to exchange audit requests and results with a degree audit daemon. For this to work successfully, the Transferology Connector must be configured with the correct value from the daemon's server_name property.
Be sure to follow the correct instructions based on your degree audit implementation: DARwin or uAchieve:
DARwin daemon.cfg
For example, assume your DARwin daemon.cfg has the following daemon entry:
|
server_name
Make a note of the above line with:
|
The value osu_prod is the correct value for you to specify for the xservice.darwinDaemonServerName property in the cas4.properties. Proceed to Create cas4.properties.
uAchieve daemonContext.xml
The minimum uAchieve version is 4.0.14. The default configuration for uAchieve will not produce audits for Transferology. You must add a uachieve.daemon.RequestHandler for the Transferology audits. The RequestHandler for Transferology must only process audits for Transferology. See daemonContext.xml for complete information on the uAchieve RequestHandler.
The daemonContext.xml documentation is still maintained in the Support Center at this time.
- Don't have a Support Center account? Request an account here
The key points for the new RequestHandler are as follows:
- Specify the appropriate comKey property
- Specify a unique serverName property
- Enable text report audit output
- Disable loading local student data
- Disable loading SIS student data
- Disable student data mutators
The following is an example RequestHandler that you can add into the uAchieve daemonContext.xml:
|
server_name
Make a note of the above line with:
|
The value USEL is the correct value for you to specify for the xservice.darwinDaemonServerName property in the cas4.properties. Proceed to Create cas4.properties.
Create cas4.properties
The cas4.properties is required for the Transferology Connector.
Define the CollegeSource audit/equivalency product you are using with the daversion property of the cas4.properties file.
DARwin
Correct value for DARwin:
|
uAchieve
Correct Value for uAchieve:
|
Schools that DO NOT want to use the Degree Audit functionality of the Transferology Connector need the following line in their cas4.properties:
|
Schools that DO want to use the Degree Audit functionality of the Transferology Connector must have the xservice.darwinDaemonServerName property. It must equal the server_name value that was identified above in the Identify CollegeSource daemon section.
Max Size of xservice.darwinDaemonServerName
The xservice.darwinDaemonServerName property defines the value that will be inserted into the job_queue_list table's servername column. That column has a max size of 10 characters, meaning you cannot use a value that is longer than 10 characters!
Equivalency Properties
Schools that want to use the Equivalency functionality of the Transferology Connector must define additional information.
- Schools that want to provide equivalencies for only one school define several additional properties in the cas4.properties file
- Schools that want to provide equivalencies for more than one school must define and use a ceg-model.xml file
Connector Provides Equivalencies for a Single Target School
Equivalencies for a single school must define the following properties:
- ceg.webPrefix - The correct protocol for links to your Transferology Connector
- ceg.domainName - The correct domain for links to your Transferology Connector
- ceg.serverPort - The correct server port for links to your Transferology Connector
- ceg.cgiPath - The correct web context for links to your Transferology Connector
- ceg.uniq - The Transferology UNIQ for your school
- ceg.defaultUniq - The Transferology UNIQ for your school
- ceg.instFullName - The full name of your school
- ceg.instid - Your DARwin instid value
- ceg.instidq - Your DARwin instidq value
- ceg.instcd - Your DARwin instcd value
- ceg.zip - The zip code for your school's main address
- ceg.state - The state abbreviation for your school's main address
Using Ohio State University and the above DARwin daemon.cfg as an example, below is what their cas4.properties would look like:
|
Connector Provides Equivalencies for Multiple Target Schools
Equivalencies for multiple target schools must define the following property:
- xservice.model - Instructs the Connector to use the ceg-model.xml file
Assuming that Ohio State hosts a Connector with target equivalencies for all Ohio schools and the above DARwin daemon.cfg as an example, below what their cas4.properties would look like:
|
Using the ceg-model.xml
Only use ceg-model.xml when equivalencies will be shown for more than one target school.
The ceg-model.xml needs to be in the same directory as the cas4.properties; the correct directory depends upon your application server and is identified in the install application server-specific install instructions. Keep the following in mind regarding the id attributes:
- The cas:server id attribute MUST be "cegServer"
- Any values can be used for the cas:institution id attributes, although they must be unique within the file
The following is an example of the ceg-model.xml for more than one school. The descriptions of the cas:server and cas:institution attributes are the same as in the previous section's ceg. prefixed properties.
|
Install on your Application Server
Follow the instructions below that are specific to your application server:
- Install Connector on Tomcat
- Install Connector on JBoss
- Install Connector on OAS
- Install Connector on Weblogic
View Home page
Use your Web browser to view the Connector's home page. Using the above OSU example, the correct URL is: http://dars.osu.edu/ceg44/cegHome.htm
If everything is configured correctly, you should see a page that shows some of the information defined by your cas4.properties file.