Skip to main content
CollegeSource Support

Audit Settings


 

General Settings

uachieve.selfservice.audit.auditDeleteStrategy

String
Versions 4.0.0-4.0.1.  Replaced by uachieve.selfservice.audit.auditDisplayCount in Version 4.0.2.
Determines how audits are deleted.
If you want to let users delete their own audits, set it "manual."
If you want audits to be deleted automatically instead, set it to "auto:<count>," where <count> is the number of audits you want preserved.

Examples:
Deletes audits automatically, leaving the 5 most recent audits:

uachieve.selfservice.audit.auditDeleteStrategy=auto:5

Allows users to delete their audits:

uachieve.selfservice.audit.auditDeleteStrategy=manual

uachieve.selfservice.audit.auditDisplayCount

Integer
Version 4.0.2-current
Determines how many completed audit requests will be displayed in the list of completed audit requests.
If the total number of audits is less than the audit preserve count, all audits will be displayed. To display all completed audits, set audit preserve count to -1. As of Version 4.0.2, Self-Service will no longer automatically delete audits. Schools are encouraged to configure batch audit deletion using the u.achieve Server.

(green star) New config in 4.3.0.3

uachieve.selfservice.audit.default.comKey

Version 4.3.0.3-current
Determines that Program Matcher should fallback to the default COM since the application has seven COM settings for matching. Empty string checks added to the addComValues method in ProgramMatcherThread.java revert to a default COM value if empty in the user COM.

(green star) New config in 4.3.0.4

uachieve.selfservice.audit.exception.restrictToDprog

Boolean
Version 4.3.0.4-current
Allows for setting the default of the 'Restrict to Degree Program' checkbox to selected or unselected, thereby eliminating the need to select manually.

(green star) New config in 4.3.0.4

uachieve.selfservice.audit.exception.restrictToReq

Boolean
Version 4.3.0.4-current
Allows for setting the default of the 'Restrict to Requirement' checkbox to be selected or unselected, thereby eliminating the need to select manually.

uachieve.selfservice.audit.showJobId

Boolean
Version 4.0.0-current
Determines if the jobid will be displayed when viewing an audit.

uachieve.selfservice.audit.showCharts

Boolean
Version 4.0.0-current
Determines if the interactive charts are displayed.

uachieve.selfservice.audit.showMarkers

Boolean
Version 4.0.13-current
Determines if markers are displayed on the audit results screen.

Example with uachieve.selfservice.audit.showMarkers = true

Example with uachieve.selfservice.audit.showMarkers = false 

View Settings

uachieve.selfservice.audit.student.comKey

String
Versions 4.0.0-current
Sync, dropdown, mapped, and static options available in Versions 4.0+. instidMapped option available in Versions 4.0.8+.
Configures which COM key should be used when running audits as a student.
There are five different strategies available for resolving the appropriate comKey to use when running audits:

  • sync- the comKey used will be the current user's instcd. A user's instcd is determined as followed:
    • If a user selects an instcd from the dropdown when they login, that is the user's instcd
    • If a user only has permissions to access to one instcd, that is the user's instcd
    • Typically, schools do not allow the student access the page with the institution dropdown after logging in. If a student has permissions to access more than one instcd, Self-Service considers the first one defined in selfservice-general.properties to be the 'default' one, so the com key for that instcd will be used.
  • dropdown - the comKey used will be chosen by the user from a dropdown
  • mapped - the comKey used will be determined by the user's instcd via a lookup
  • static - the comKey used will be the one configured
  • instidMapped - the comKey used will be determined by the user's instid and instcd via a lookup

 

Examples:
Use the sync option:

uachieve.selfservice.audit.student.comKey=sync

Use the dropdown option:

uachieve.selfservice.audit.student.comKey=dropdown:999:DARSweb,\
                                                  BUS:Business,\
                                                  ENG:Engineering,\
                                                  WIP:No IP Courses

Use the mapped option:

uachieve.selfservice.audit.student.comKey=mapped:TST:999,\
                                                MU:MU,\
                                                BUS:BUS,\
                                                ENG:ENG

Use the static option:

uachieve.selfservice.audit.student.comKey=BUS

Use the instid mapped option:

uachieve.selfservice.audit.studentr.comKey=instidMapped:TEST40-\ :SSIKE,TEST40-TST:SSIKE,TEST40-MU:SSIKE,TEST40-BUS:SSIKE,\
										TEST40-ENG:SSIKE,007104-\ :SSFER

 

uachieve.selfservice.audit.advisor.comKey

String
Versions 4.0.0-current
Configures which COM key should be used when running audits as an advisor.
For examples, see uachieve.selfservice.audit.student.comKey

uachieve.selfservice.audit.auditPollingRate

Integer
Versions 4.0.0-current
Determines how often the "Manage Audits" and "Audit Loading" pages will automatically refresh.
Time specified is in seconds.

uachieve.selfservice.audit.maxPollCount

Integer
Versions 4.0.0-current
Determines how many times an audit will be polled for completion before an error screen is shown that warns the audit is taking a long time.

uachieve.selfservice.audit.specialEffects

Boolean
Versions 4.0.0-current
Determines if the audit view will use special effects when expanding and collapsing requirements.
If set to true, requirements will smoothly "fade out" when closed. If set to false, requirements will disappear with no animation.
Experimental.

uachieveapi.audit.request.tries

Integer
Versions 4.0.0-current
How many times to check for a complete audit before throwing an error.
This property works in tandem with the sleepBetweenTries property below. For example, if tries is set to 5 and sleepBetweenTries is set to 2000 (2 seconds), an error will be thrown if the requested audit does not complete in 10 seconds.

uachieveapi.audit.request.sleepBetweenTries

Integer
Versions 4.0.0-current
How long to wait between checks for audit completion (in milliseconds, so 1000=1 second).
Tune this according to the specific environment u.achieve is running in. This property works in tandem with the tries property above.

uachieve.selfservice.audit.allowDefaultDegreePrograms

Boolean
Versions 4.0.0-current
Allow users to run audits using the student's default degree programs.

uachieve.selfservice.audit.allowWhatIfDegreePrograms

Boolean
Versions 4.0.0-current
Allow users to run What-if audits.

uachieve.selfservice.audit.allowWhatIfMajorMinor

Boolean
Versions 4.3-current
Allows dprogs to have TYPE_CODE turned on or off.

uachieve.selfservice.audit.degreeProgramEntry

String
Version 4.0.0-current
Determines how the degree program will be selected by the user when submitting an audit.
There are three settings: manual, dropdown, and cascade. The dropdown and cascade settings allow additional settings that influence what data is displayed in the dropdown(s).
The first extra setting determines the dpstatus value(s) that degree programs must have to be included in the dropdown list. Available options are WPT, and A. You may use as many of these as you like by separating each one with a comma.   Note: When including A, only users designated as Advisor will see the degree programs with a dpstatus of A.
The second extra setting determines which columns of the degree program will be displayed in the dropdown. Available options are: dprogdptitle1dptitle2, and webtitle. You may use as many of these as you like by separating each one with a comma.
The final extra setting only applies to the cascade option. It determines the dropdowns that will be displayed. Available options are: collegemajor, and degree. You may use as many of these as you like by separating each one with a comma.

  • manual: user must manually type in a degree program code. Example:

    uachieve.selfservice.audit.degreeProgramEntry=manual
    

  • dropdown: user can choose a degree program from a dropdown list generated based on the current instcd. Example:

    uachieve.selfservice.audit.degreeProgramEntry=dropdown:P,A:dptitle1,dprog
    

 

Catalog Year

(green star) New config in 4.3! 

 The Catalog Year for the audit request defaults to the current term when none or only one is configured. If an option is configured and it is blank, then the Catalog Year defaults to the Catalog Year of the student's declared program.

 

The new options name required for determining catalog years for Audit Request: auditRequestYearTerms

 

A new options name was necessary so that yearTerms can still be configured as options separate from the audit request, since yearTerms are used by default when adding courses.

 

  • If you want the currentYearTerm value to be determined and submitted with the audit request, configure the option auditRequestYearTerms as the following:
<options name="auditRequestYearTerms">
</options>
  • If you want the student's declared program catalog year value to be determined and submitted with the audit request, configure the option auditRequestYearTerms as the following:
<options name="auditRequestYearTerms">
  	 <option name=" " label="Default" />
</options>

If no student declared program is found, the audit request is submitted with currentYearTerm. If the student declared program is found but not catalog year is defined on it, an audit request is submitted with currentYearTerm. If more than one declared program is found and each has a declared catalog year, the first catalog year is submitted with audit request.

  • cascade: user can choose a degree program from a series of hierarchical dropdown lists (college/major/degree). Example:

    uachieve.selfservice.audit.degreeProgramEntry=cascade:W,P,T:webtitle:dprog,college,major,degree
    

uachieve.selfservice.audit.standardView.autoCollapse

Boolean
Version 4.0.8-current
Determines whether the audit requirements should be collapsed when the audit initially loads (standard view).

uachieve.selfservice.audit.printerView.autoCollapse

Boolean
Version 4.0.8-current
Determines whether the audit requirements should be collapsed when the audit initially loads (printer-friendly view).

uachieve.selfservice.audit.dpTitles

String
Version 4.1.4-current
Determines which titles to display above audit results.  Possible choices are dptitle1, dptitle2, and webtitle.

uachieve.selfservice.audit.ignoreCONDC

String
Version
 4.3-current
Determines which condition codes will trigger Program Matcher to ignore a course. They should not be separated by any character.  

Submit Settings

uachieve.selfservice.audit.evalsw.student

String
Versions 4.0.0-current
Determines what type of audit to run for students.
In versions 4.0.0-4.0.5, this field is a single character:

  • A will run an audit and evaluate transfer courses.
  • D will run an audit only.
  • E will evaluate transfer courses only.

In versions 4.0.6+, evalsw settings are defined using an actual evalsw value, plus a name to describe that setting to the user (like "A" and "Audit and Evaluation"). The value and name are seperated by a colon (:) and each value/name pair is separated by a comma (,). Optionally, you can have a single evalsw/name pair per line by using the backslash (\) to continue the definitions on the next line. 
Here's the formal syntax:

<evalsw1>:<name1>,<evalsw2>:<name2>, etc...

Here's an example of several settings configured:

uachieve.selfservice.audit.evalsw.student=D:Degree Audit,A:Audit and Evaluation,H:Home Articulation
  • A will run an audit and evaluate transfer courses.
  • D will run an audit only.
  • E will evaluate transfer courses only.
  • S will run an audit with a course sort.
  • C will run a course gpa and credit conversion.
  • H will run a home articulation.

uachieve.selfservice.audit.evalsw.advisor

String
Versions 4.0.0-current
Determines what type of audit to run for advisors.
In versions 4.0.0-4.0.5, this field is a single character:

  • A will run an audit and evaluate transfer courses.
  • D will run an audit only.
  • E will evaluate transfer courses only.

In versions 4.0.6+, evalsw settings are defined using an actual evalsw value, plus a name to describe that setting to the user (like "A" and "Audit and Evaluation"). The value and name are seperated by a colon (:) and each value/name pair is separated by a comma (,). Optionally, you can have a single evalsw/name pair per line by using the backslash () to continue the definitions on the next line. 
Here's the formal syntax:

<evalsw1>:<name1>,<evalsw2>:<name2>, etc...

Here's an example of several settings configured:

uachieve.selfservice.audit.evalsw.advisor=D:Degree Audit,A:Audit and Evaluation,H:Home Articulation

A will run an audit and evaluate transfer courses.
D will run an audit only.
E will evaluate transfer courses only.
S will run an audit with a course sort
C will run a course gpa and credit conversion
H will run a home articulation

uachieve.selfservice.audit.produceDump

Boolean
Versions 4.0.0-4.0.11. Replaced by uachieve.selfservice.audit.serverLogLevel in 4.0.12
Set this to true to produce a dump when the audit runs.

uachieve.selfservice.audit.serverLogLevel

Boolean
Versions 4.0.12-current
The log level that the u.achieve server will use for audits submitted from Self-Service. It will not affect the logs produced by Self-Service. Set to T or D to produce dumps. Corresponds to the 'Log Level' option on the Run Bar of the u.achieve client:

  • T - Trace
  • D - Debug
  • I - Info
  • W - Warn
  • E - Error
  • F - Fatal
  • O - Off

uachieve.selfservice.audit.soprid.student

String
Versions 4.0.0-current
The operator ID to use when running an audit for a student. Users will only be able to see audits run by this operator ID.
Set to * to allow students to see audits run by any operator ID.
Starting in Version 4.1.3, this property can be overridden using the SECURE_SOPRID property in the CollegeSource Security application/Dashboard.

Below is a summary of how the different combinations of soprids work in Self-Service. A user will always be able to see the audits that he or she has run, unless the soprid id settings for that user change. Self-Service's security prevents any student from seeing another student's audit, regardless of what the student soprid is set to.

uachieve.selfservice.audit.soprid.advisor

uachieve.selfservice.audit.soprid.student

Results

*

*

Advisors can see audits run by other advisors and by students. Students can see audits run by advisors.

selfsrvA

*

Advisors can see audits run by advisors, but not those run by students. Students can see audits run by advisors.

*

selfsrvS

Advisors can see audits run by advisors and students. Students can only see audits run by themselves.

selfsrvA

selfsrvS

Advisors can see audits run by advisors, but not those run by students. Students can only see audits run by themselves.

uachieve.selfservice.audit.soprid.advisor

String
Versions 4.0.0-current
The operator ID to use when running an audit for an advisor. Users can only see audits run by the same operator ID.
Set to * to allow advisors to see audits run by any operator ID. See the description of uachieve.selfservice.audit.soprid.student for more details.
Starting in Version 4.1.3, this property can be overridden using the SECURE_SOPRID property in the CollegeSource Security application/Dashboard  

uachieve.selfservice.audit.serverName

String
Versions 4.0.0-current
The same name as your u.achieve Server daemon server name.

uachieve.selfservice.audit.startingStatus

String
Versions 4.0.6-current
The status of the audit when it enters the job_queue_list table. This should be set to N unless you need to do custom preprocessing.

uachieve.selfservice.audit.plannedCourse.code

String
Version 4.0.13-4.1.2.1
The condition code used in your COM table to mark planned courses. Defaults to W.  Starting in Version 4.1.3, this property is no longer necessary; planned courses in the output tables will automatically be detected by Self-Service.

uachieve.selfservice.audit.priority

Integer
Version 4.0.13-current
The priority of audits submitted through Self-Service

  • Was this article helpful?