...
Note |
---|
title | Mandatory Requirements |
---|
|
The Mandatory Requirements must be met before proceeding with the instructions on this page. |
...
We recommend the following Sun Java Memory and Socket Timeout Parameters to override the default values:
...
Download the Transferology Connector
You can acquire the 4.3.x latest release from the the Connector Downloads page page.
Info |
---|
title | 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: ceg43ceg44-tomcat-xx.war - Tomcat distribution includes: log4j.jar and log4j.properties ceg43ceg44-gf-xx.war - Glassfish distribution includes: log4j.jar and log4j.properties ceg43ceg44-jboss-xx.war - JBoss distribution does NOT include: log4j.jar or log4j.properties ceg43ceg44-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 ceg43ceg44-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 ceg43ceg44.war before deploying it to your application server. |
...
Be sure to follow the correct instructions based on your degree audit implementation: DARwin or u.achieve uAchieve
DARwin daemon.cfg
...
Tip |
---|
|
Make a note of the above line with: Code Block |
---|
| server_name = osu_prod
|
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 u.achieve uAchieve version is 4.0.14. The default configuration for u.achieve uAchieve will not produce audits for Transferology. You need to must add a uachieve.daemon.RequestHandler for the Transferology audits. See daemonContext.xml for The RequestHandler for Transferology must only process audits for Transferology. See daemonContext.xml for complete information on the u.achieve uAchieve RequestHandler. 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 u.achieve uAchieve daemonContext.xml:
Code Block |
---|
|
<!-- *** begin copy *** -->
<bean id="tfoHandler" class="uachieve.daemon.RequestHandler" scope="prototype">
<property name="comKey">
<value>ONL</value>
</property>
<property name="serverName">
<value>USEL</value>
</property>
<property name="sleepTime">
<value>3</value>
</property>
<property name="enabledReports">
<util:map>
<entry key="TXT" value="TRUE" />
</util:map>
</property>
<!-- true/false -->
<property name="deleteRequest">
<value>false</value>
</property>
<!-- name of file in the ../config directory -->
<property name="fileNameIncludeTextTop">
<value></value>
</property>
<!-- name of file in the ../config directory -->
<property name="fileNameIncludeTextBottom">
<value></value>
</property>
<property name="loadLocalStudentData">
<value>false</value>
</property>
<property name="loadSISStudentData">
<value>false</value>
</property>
<lookup-method name="createAuditProcessor" bean="auditProcessor"/>
<property name="auditService"><ref bean="uachieve-slayer.auditService"/></property>
<property name="supportService"><ref bean="uachieve-slayer.supportService"/></property>
<property name="requestQueue"><ref local="jobRequestQueue"/></property>
</bean>
|
Tip |
---|
|
Make a note of the above line with:
Code Block |
---|
xml | xml | <value>USEL</value>
|
The value USEL is the correct value for you to specify 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
Code Block |
---|
title | Correct value for DARwin |
---|
|
daversion=darwin |
u.achieve
Code Block |
---|
title | Correct Value for u.achieve |
---|
|
daversion=uachieve |
...
<!-- ************************************************** -->
<!-- *** Edit the "value" elements of these proper- *** -->
<!-- *** ties as appropriate for your institution *** -->
<!-- ************************************************** -->
<property name="comKey">
<value>ONL</value>
</property>
<property name="serverName">
<value>USEL</value>
</property>
<property name="sleepTime">
<value>3</value>
</property>
<!--
The Transferology Connector 5.0.x, supports "HTM" and "PDF" report types.
If you're using the Connector 5.0.x or later and want to provide those
report types for audits requested from Transferology, add either or both as additional
entry elements in the enabledReports map:
<entry key="HTM" value="TRUE" />
<entry key="PDF" value="TRUE" />
-->
<property name="enabledReports">
<util:map>
<entry key="TXT" value="TRUE" />
</util:map>
</property>
<!-- true/false -->
<property name="deleteRequest">
<value>false</value>
</property>
<property name="loadLocalStudentData">
<value>false</value>
</property>
<property name="loadSISStudentData">
<value>false</value>
</property>
<!-- name of file in the ../config directory -->
<property name="fileNameIncludeTextTop">
<value></value>
</property>
<!-- name of file in the ../config directory -->
<property name="fileNameIncludeTextBottom">
<value></value>
</property>
<!-- Valid Options are:
OneFile, SepFiles, Database, OneFileAndDatabase, SepFilesAndDatabase
default (if blank) is Database
-->
<property name="reportSaveOptions">
<value>Database</value>
</property>
<!-- Path to save reports to File System
default (if blank) is ../reports
-->
<property name="reportSavePath">
<value></value>
</property>
<!-- If left blank, defaults to its standard location of /logs -->
<property name="logSavePath">
<value> </value>
</property>
<lookup-method name="createAuditProcessor" bean="auditProcessor"/>
<!-- ************************************************** -->
<!-- *** end of editable property values *** -->
<!-- ************************************************** -->
<!-- ************************************************** -->
<!-- *** Do not edit the properties below here *** -->
<!-- *** (unless you really know what you're doing) *** -->
<!-- ************************************************** -->
<property name="auditService"><ref bean="uachieve-slayer.auditService"/></property>
<property name="supportService"><ref bean="uachieve-slayer.supportService"/></property>
<property name="requestQueue"><ref bean="jobRequestQueue"/></property>
<property name="performanceMonitor" ref="performanceMonitor"/>
<!-- ************************************************** -->
<!-- *** End of non-editable properties *** -->
<!-- ************************************************** -->
</bean>
<!-- *** end copy *** --> |
Tip |
---|
|
Make a note of the above line with: Code Block |
---|
| <value>USEL</value>
|
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. |
Anchor |
---|
| cas4.properties |
---|
| cas4.properties |
---|
|
Create cas4.properties
The cas4.properties is required for the Transferology Connector, several properties must be defined for your school's specific environment.
Define the CollegeSource audit/equivalency product you are using with the daversion property of the cas4.properties file.
DARwin
Code Block |
---|
title | Correct value for DARwin |
---|
|
daversion=darwin |
uAchieve
Code Block |
---|
title | Correct Value for uAchieve |
---|
|
daversion=uachieve |
Hibernate Dialect
Please specify the correct db.dialect property based on your database server.
Oracle
Code Block |
---|
|
db.dialect=org.hibernate.dialect.Oracle10gDialect |
SQL Server
Code Block |
---|
|
db.dialect=org.hibernate.dialect.SQLServerDialect |
DB2
Code Block |
---|
|
db.dialect=org.hibernate.dialect.DB2Dialect |
Enable or Disable Connector's Degree Audit Integration
Schools that DO NOT want to use the Degree Audit functionality of the Transferology Connector need the following line in their cas4.properties:
Code Block |
---|
# disable audit polling
xservice.pollingEnabled=false |
Schools that DO want to use the Degree Audit functionality of the Transferology Connector need the following line in their cas4.properties:
Code Block |
---|
# disableenable audit polling
xservice.pollingEnabled=falsetrue |
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.
Note |
---|
title | 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! |
Schools that want to use the Equivalency functionality of the Transferology Connector must define additional information.
...
Code Block |
---|
|
# Required for audits
xservice.darwinDaemonServerName=osu_prod
# Required for equivalencies, single target school
ceg.webPrefix=http://
ceg.domainName=dars.osu.edu
ceg.serverPort=80
ceg.cgiPath=/ceg43ceg44
ceg.defaultUniq=OSU
ceg.uniq=OSU
ceg.instidq=72
ceg.instid=1592
ceg.instcd=
ceg.instFullName=Ohio State University
ceg.state=OH
ceg.zip=43210
|
...
Tip |
---|
|
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 fellowing 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.
Code Block |
---|
|
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:util="http://www.springframework.org/schema/util"
xmlns:cas="http://www.transfer.org/schema/cas"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
http://www.springframework.org/schema/util
http://www.springframework.org/schema/util/spring-util-2.0.xsd
http://www.transfer.org/schema/cas
http://www.transfer.org/schema/cas/cas.xsd">
<cas:server id="cegServer" webPrefix="http://" domainName="dars.osu.edu" cgiPath="/ceg43ceg44" serverPort="80" defaultUniq="OSU" >
<cas:institution id="i1" uniq="OSU" instidq="72" instid="1592" instcd=" " instFullName="Ohio State University"
state="OH" zip="43210" defTimeout="6000" />
<cas:institution id="i2" uniq="CSCC" instidq="73" instid="006867" instcd=" " instFullName="Columbus State Community College"
state="OH" zip="43216" defTimeout="6000" />
</cas:server>
</beans> |
...
Use your Web browser to view the Connector's home page. Using the above OSU example, the correct URL is: http://dars.osu.edu/ceg43ceg44/cegHome.htm
If everything is configured correctly, you should see a page that shows some of the information defined by your cas4.properties file.