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

Versions Compared

Old Version 25

changes.mady.by.user Unknown User (podnardb)

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (neighborsj)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 key points for the new RequestHandler are as follows:

  1. Specify the appropriate comKey property
  2. Specify a unique serverName property
  3. Enable text report audit output
  4. Disable loading local student data
  5. Disable loading SIS student data
  6. Disable student data mutators

The following is an example RequestHandler that you can add into the uAchieve daemonContext.xml:

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.

Code Block
xml
xml
<!-- *** 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
titleserver_name
Code Block
xmlxml
<value>USEL</value>

...

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
titleCorrect value for DARwin
daversion=darwin

uAchieve

Code Block
titleCorrect Value for uAchieve
 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
titleserver_name

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 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
titleCorrect value for DARwin
daversion=darwin

uAchieve

Code Block
titleCorrect Value for uAchieve
 daversion=uachieve

Hibernate Dialect

Please specify the correct db.dialect property based on your database server.

Oracle

Code Block
titleOracle dialect
db.dialect=org.hibernate.dialect.Oracle10gDialect


SQL Server

Code Block
titleSQL Server dialect
db.dialect=org.hibernate.dialect.SQLServerDialect


DB2

Code Block
titleDB2 dialect
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.

...

Tip
iconfalse

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.

...

If everything is configured correctly, you should see a page that shows some of the information defined by your cas4.properties file.