udirect.properties
General
instidq |
The national encoding scheme used by the university |
||||||||
---|---|---|---|---|---|---|---|---|---|
|
\ - Indicates a blank value is to be used |
||||||||
instid |
Identifies the code used to recognize your institution nationwide |
||||||||
|
\ - Indicates a blank value is to be used |
||||||||
instcd |
An internal code to identify a part of your internal organization |
||||||||
|
\ - Indicates a blank value is to be used |
||||||||
hour |
Default is Hour |
||||||||
|
Configurable text to identify course hours. Examples: Unit, Credit. |
||||||||
termCodeLength |
Default is 2. A year term value can be up to 6 characters (200901). You may want to display terms in u.direct, but your encoding is not set up to have terms. |
||||||||
|
0 - Allows users to specify use of the first 4 characters of the year term from u.direct when submitting audits |
||||||||
|
1 - Use only the first 5 characters of year term value from u.direct when submitting audits |
||||||||
|
2 - Use the full year and term value from u.direct when submitting audit requests |
||||||||
daversion |
Default is DARwin. Tells u.direct what back end degree audit system implementation code to load at start-up for requesting and receiving audits. Each setting has its own additional configuration files specific to its implementation. |
||||||||
|
darwin - DARwin 3.5.x implementation |
||||||||
|
uachieve - u.achieve 4.0.x implementation |
||||||||
Configuration options currently available for daversion=uachieve ONLY
|
|||||||||
|
peoplesoft - PeopleSoft 8.9.x implementation |
||||||||
formWhatIfAuditSelection |
True-Toggles the What-if audit view to Self-Service | ||||||||
udirect.welcomeText | Default is blank. Configurable text to display on the Staff Home page, displayed when logging in. | ||||||||
courseCatalog.departmentLength |
Number of characters representing a course's department |
||||||||
|
3 - given "ENG1001", "ENG" represents the department length with the correct value of 3 |
||||||||
courseCatalog.courseLength |
Number of characters representing a course's length |
||||||||
|
4 - given "ENG1001", "1001" represents the course length with the correct value of 4 |
||||||||
courseCatalog.showDepartment |
Should the department be shown? true or false |
||||||||
courseCatalog.showCourseNumber |
Should the course number be shown? true or false |
||||||||
courseCatalog.showHours |
Should the hours be shown? true or false |
||||||||
courseCatalog.showDescription |
Should the course's description be shown? true or false |
||||||||
courseCatalog.showAvailability |
Should the course's availability be shown? true or false |
||||||||
courseCatalog.showPreCoReqDisplay |
Should the course's pre coreq be shown on the course availability table? true or false | ||||||||
courseCatalog.customProperty1 (1-4) |
When defined, will be the label for the data populated in the associated column (DCP_CAT_CRS.COLUMN_1 (1-4), displayed on the course description window. If no value is set, column will not show. |
||||||||
wildcard.character |
Specify the character you use to indicate, any character applies to the course name. For example, if any MTH course can be taken, it would be indicated as MTH**, in which case the '' is the wildcard character. If no value is specified, it defaults to '*'. |
||||||||
default.course.hours |
The default number of hours to use for a course from an audit when no hours value is present - 3, for example |
||||||||
defaultGrade |
The default Grade to assign to a planned course, to be submitted with audit request, if left unchanged |
||||||||
dprog.column.name |
Determines the column that is used to get the degree program's name from. For DARwin/u.achieve implementation, should be one of |
||||||||
requirement.column.name |
Indicates what to use for the name of the requirement |
||||||||
|
For DARwin/u.achieve implementation, the audit representation in the roadmap builder, by default, has used the 'rname' for the requirements. At some schools, this value is very verbose and not suitable to fit in the u.direct tree structure. If you want to use a web title, then set a label for the requirement because if not found it will use RNAME. For u.achieve schools, use the same requirement title used in the output of the audit. |
||||||||
|
rname |
||||||||
|
label |
||||||||
reqtitle - For DARwin schools, it will parse the requirement text from darout to display. For u.achieve schools, it will use what is in the JOB_QUEUE_REQ_TEXT table to display. If no text is found for the requirement, it will default to the RNAME. |
|||||||||
subrequirement.column.name |
Indicates what to use for the name of the sub-requirement |
||||||||
|
Similar to the requirement name, this is an alternate name to use for the sub-requirement text. For DARwin/u.achieve implementation, the one difference with this property is that it will check to ensure the name is not blank. If the label comes back as blank or 0 characters, then it will revert back to using the DARout text (DARwin) or JOB_QUEUE_SUBREQ_TEXT (u.achieve). If there is no text found, it will default to 'Subrequirement' |
||||||||
|
darout - Will parse the sub-requirement text from darout, to display for DARwin users. For u.achieve users, will display the text from JOB_QUEUE_SUBREQ_TEXT table. |
||||||||
|
label - Will use the label column that was set in job_queue_subreq |
||||||||
roadmap.defaultnumberoftermsperyear |
Default number of academic terms per year to use when creating a blank roadmap |
||||||||
|
2 |
||||||||
audit.student.number |
Student number for DARS to use when running all audits (should be a "fake" student) |
||||||||
|
1 |
||||||||
udirect.antisamyFileName |
Default is: antisamy-slashdot-1.4.4.xml |
||||||||
|
Policy to control input validation for the comments text field. See AntiSamy documentation for more details. |
||||||||
plan.maxYearTermCode |
Future Year and term code you want u.direct to check availability of courses for on the plan. Looks at current term up to this max year term setting. Example: 201510. Setting this to 201510 checks all terms on the plan from current term up to 201510 to see if the courses are available in the terms they are planned for. Setting to 000000 will disable the checking of course availability. See Plan Builder for functional details. |
||||||||
|
000000 |
||||||||
udirect.year.header | Year | ||||||||
udirect.term.header | Term |
Student Menu Settings
student.label |
Default is Student: |
---|---|
Configurable text to display on menu identifying student information for current selected student. | |
student.displayName | Default is true |
|
True - Display the current selected student's name on the menu |
|
False - Do not display the current selected student's name on the menu |
student.displayNumber | Default is true |
True - Display the current selected student's ID on the menu | |
False - Do not display the current selected student's ID on the menu | |
student.landingPageURL | Default is /plan/manage/display-plans.html |
Configurable destination page for students to be directed to after logging in |
Enable/Disable Options
removeAllButton |
Default is true |
---|---|
|
True - Allows users building plans to remove all courses in future terms from the plan with a single click |
|
False - Does not display the button to allow for removing all courses in future terms from the plan |
moveAllButton |
Default is true |
|
True - Allows users building plans to move all the courses from the roadmap to the plan with a single click |
|
False - Does not display the button to allow for moving all the courses from the roadmap to the plan |
movePreferredButton |
Default is true |
|
True - Allows users building plans to move courses with a marked status, and any course where no choice is given, from the roadmap to the plan with a single click |
|
False - Does not display the button to allow for moving courses with a marked status, and any course where no choice is given, from the roadmap to the plan |
roadmap.copyEnabled |
Default is true |
|
True - Allow users building roadmaps to copy roadmap requirements from within the roadmap |
|
False - Do not allow users to copy roadmap requirements |
plan.registerEnabled |
Default is false |
|
False - When right-clicking on a course on the plan, do not display the 'Schedule' option |
|
True - Display the 'Schedule' option on a plan. Should only be set to true if you have implemented everything required for the Schedule Builder piece of u.direct. |
restrict.roadmaps.by.dprog |
Default is false |
True - Only allow plans to be built from the user's declared major roadmaps/degree program | |
False - Allow plans to be built from any roadmap/degree program | |
Default is false |
|
|
True - Filters out the roadmaps available to a student to select to plan against based upon the catalog year returned with the student's declared major. NOTE: SQL statement for returning declared major for student is configured in the Dashboard application. |
|
False - Displays all published roadmaps for a student to choose from for planning |
filter.roadmaps.include.future.catalog.createPlan |
Default is true, but is only used when filter.roadmaps.by.catalog=true |
|
True - Show future catalog roadmaps when creating a plan |
|
False - Do not Show future catalog roadmaps when creating a plan |
filter.roadmaps.include.future.catalog.changeRoadmap |
Default is true, but is only used when filter.roadmaps.by.catalog=true |
|
True - Show future catalog roadmaps when changing roadmap |
|
False - Do not Show future catalog roadmaps when changing roadmap |
filter.roadmaps.include.future.catalog.manageRoadmaps |
Default is true, but is only used when filter.roadmaps.by.catalog=true |
|
True - Show future catalog roadmaps in manage/manage all roadmaps |
|
False - Do not Show future catalog roadmaps in manage/manage all roadmaps. |
udirect.enableComments |
Default is true |
|
True - Display everything relating to adding, editing, deleting comments |
|
False - Do not Show Comments or any options for comments |
udirect.enablePlanApproval |
Default is true |
True - Display option to Approve and Un-Approve plans to those users with Approval permission | |
False - Do not provide option to Approve and Un-Approve plans, regardless of permission | |
udirect.enableRequestPlanApproval |
Default is true |
|
True - Show Request/Cancel options for plan approval/unapproval based upon permissions |
|
False - Do not Show Request for Approval/Unapproval or Cancel Request options |
udirect.enableRequestRoadmapPublish |
Default is true |
|
True - Show Request/Cancel options for roadmap publishing/un-publishing based on permissions |
|
False - Do not Show Request for Publishing/Un-publishing or Cancel Request options |
enableFlagCourseDoesNotCompleteIntendedSubreq |
Default is false |
|
True - Check if the planned course satisfies the sub-requirement on the audit that the roadmap requirement it was planned from is linked to. If it does not, flag the course indicating it does not. |
|
False - Do not flag a course that does not satisfy the same sub-requirement the roadmap requirement it was planned from is linked to |
URL and Link Definitions
help.baseUrl |
URL to online help documentation. Default is uAchieve Planner Guide. |
|
---|---|---|
darwinia.baseUrl |
The URL pattern for the online application installation used to view audits. For DARwinIA, the pattern should replace the job sequence number with $1 and the job id with $2. For u.achieve Self-Service, the pattern should replace the job sequence number with $1, jobid with $2, (optional) username with $3, (optional) password with $4, and stuno with $5. URL would look similar to: http://server.name:8080/selfserviceW...id=$2&stuno=$5 See the following for more specific details on configuring to directly link out to a u.achieve Self-Service audit: Linking Directly to an Audit |
|
|
http://www.onlinephd.edu/darwinia/ |
|
security.baseUrl |
The URL pattern for the CollegeSource Security installation |
|
|
Since the security application is now included as a separate web deployment, u.direct will need to know what the URL is to the security app so that menu links will work properly. State the whole URL starting with the 'http'. Possible Value: full URL of the security app. Example: http://www.somehost.com/security NOTE: This URL should NOT be configured if using the Dashboard application. |
|
plan.printableView.externalLink |
Set this property if your institution wishes to link to an external printable plan, other than the provided PDF, using {0} to represent the plan id. Leaving this parameter blank will tell u.direct to generate the default PDF.
|
|
format.courselist.link |
Set this property if your institution has course lists defined on the web. Using this link and the course list name value, set as <courseListName> in configured URL, udirect will build a link to display a list of courses to be manually added to the plan. Leaving this parameter blank will just allow a course to be flagged as a courseList by being represented with a courseList icon and will have no functionality behind it.
|
|
schedule.builder.baseUrl |
The URL pattern for the CollegeSource Schedule Builder installation, making sure to include /sec/rwremotelogin to the URL definition |
|
|
|
|
selfService.baseUrl |
The URL pattern for the CollegeSource u.achieve Self-Service installation |
|
u.direct will need to know what the URL is to the u.achieve web application so that menu links will work properly. State the whole URL starting with the 'http'. Possible Value: full URL of the u.achieve web application. Example: http://www.somehost.com/selfservice |
||
dashboard.baseUrl |
The URL pattern for the CollegeSource Dashboard installation |
|
u.direct will need to know what the URL is to the Dashboard application so that menu links will work properly. State the whole URL starting with the 'http'. Possible Value: full URL of the Dashboard application. Example: http://www.somehost.com/dashboard NOTE: This application replaces the need for the CollegeSource Security application. Do not configure this URL if using the CollegeSource Security application (the Dashboard) |
Labeling Options
textViewOnlyLabel |
Text to display for 508-compliant view. Default is Accessible View. |
---|---|
|
There has been several opinions on what to call the accessible 508-compliant view. In the preferences section, a user can choose which view they want. The accessible view's label is configurable to whatever you put in this property. |
udirect.declared.label |
Default is Preferred |
|
Configurable text to identify a plan the student is intending to follow |
studentPlan.label |
Default is Student Plan |
|
Replace the word Plan with a different terminology that better fits with your institution meaning, e.g., Schedule |
roadmap.term.label |
Default is Term |
|
Replace the word Term with a different terminology that better fits with your institution meaning, e.g., Semester |
roadmap.year.label |
Default is Year |
|
Replace the word Year with a different terminology that better fits with your institution meaning |
planComment.label |
Default is Comment |
|
Replace the word Comment with a different terminology that better fits with your institution meaning |
planCommentDesc.label |
Default is: Enter your comments for your plan. Select the "Share with" field to share the comment with others or the "Private" field to create a private note. |
|
Replace the descriptive text with something that better fits with your institution meaning |
plan.registerEnabled.label |
Default is Schedule |
|
Configurable text to be displayed when right-clicking on a term in the plan to redirect users to Schedule Builder |
courseDoesNotCompleteIntendedSubreqWarningText |
Default is: Course does not complete intended sub-requirement |
|
This is the message that will be displayed when a course is flagged when not meeting the intended sub-requirement that it was planned from |
courseCatalog.availability | Default is Course Availability |
This is the u.direct label for the availability of courses area in the Course Catalog Details window. |
E-Mail Setup
smtpServer |
|
---|---|
|
ServerName address for SMTP server |
port |
|
|
The port the SMTP server is configured to use |
login |
|
|
Login ID to use if the SMTP server requires it |
password |
|
|
Password to use if the SMTP server requires it |
emailCommentSubjectText |
Default is: You have a new comment from |
emailCommentIntroText |
Default is: You have a new comment from u.direct: |
emailFooterText |
Default is: To reply to this message, please log on to |
udirectLink |
Default is: http://localhost:8080/udirect/ |
udirectLinkText |
Default is: udirect |
emailFrom |
Default is: donotreply@udirect.com |
emailRequestPlanApprovalSubjectText |
Default is: You have a Plan Approval Request from |
emailRequestPlanApprovalIntroText |
Default is: You have a new u.direct request for plan approval for |
emailRequestFooterText |
Default is: To review the plan, please log on to |
emailRequestPlanUnapprovalSubjectText |
Default is: You have a Request to Unapprove a Plan from |
emailRequestPlanUnapprovalIntroText |
Default is: You have a new u.direct request to unapprove a plan for: |
emailRequestCancelSubjectText |
Default is: You have a Cancelled Request from |
emailRequestCancelIntroText |
Default is: The last u.direct request has been cancelled for: |
emailRequestRoamapPublishSubjectText |
Default is: You have a Request to Publish a Roadmap from |
emailRequestRoadmapPublishIntroText |
Default is: The request to publish the roadmap is for |
emailRequestRoamapUnpublishSubjectText |
Default is: You have a Request to Unpublish a Roadmap from |
emailRequestRoadmapUnpublishIntroText |
Default is: The request to unpublish the roadmap is for |
emailRequestDeclineSubjectText |
Default is: You have a Declined Request from |
emailRequestDeclineIntroText |
Default is: The last u.direct request has been declined for: |
emailRequestAcceptSubjectText |
Default is: Your request has been accepted by |
emailRequestAcceptIntroText |
Default is: The last u.direct request has been accepted for: |
studentGroupName |
Default is: Students |
advisorsGroupName |
Default is: Advisors |
planApproversGroupName |
Default is: Approvers |
roadmapApproversGroupName |
Default is: Approvers |
GPA Calculator Set-up
udirect.enableGpaCalculation |
Default is: true |
---|---|
True: Display GPA Calculator and GPA calculated from audit processing | |
False: Do not display any of the GPA calculation functionality | |
udirect.enablePlanCourseHoursEditing |
Default is: true |
True: When GPA Calculation is enabled, allow editing of the planned grades | |
False: When GPA Calculation is enabled, do not allow editing of the planned grades | |
gpa.label |
Default is: GPA |
max.gpa |
Default is: 4.0 |
gpa.calculator.label |
Default is: Goal GPA Calculator |
current.gpa.label |
Default is: Projected Cumulative GPA |
current.credits.label |
Default is: Current GPA Hours |
remaining.credits.label |
Default is: Remaining GPA Hours |
desired.gpa.label |
Default is: Graduation Goal GPA |
required.gpa.label |
Default is: Average GPA needed per term |
max.gpa.label |
Default is: Max Goal GPA |
required.max.gpa.label |
Default is: Average GPA needed per term |
gpa.calculator.warning |
Default is: Disclaimer\: The GPA calculator provides unofficial GPA projections and is provided to help you plan your grades as you plan your courses. It may not account for institutional repeat policies or transfer grade policies. Be sure to see your university catalog or your academic advisor for specific information on planning your GPA. |
Database
udirect.jdbc.driver |
JDBC driver class name |
---|---|
|
net.sourceforge.jtds.jdbc.Driver (MS SQL) |
|
oracle.jdbc.OracleDriver (Oracle) |
udirect.jdbc.url |
JDBC URL |
|
jdbc:jtds:sqlserver://[DCP:server name]:1433/[DCP:database name] (MS SQL) |
|
jdbc:oracle:thin:@[DCP:server name]:1521/[DCP:database name] (Oracle) |
udirect.jdbc.username |
JDBC user name |
udirect.jdbc.password |
JDBC password |
udirect.jdbc.jndi |
If using JNDI, name of JNDI connection to use |
udirect.jdbc.initialNumberOfConnections |
Initial number of connections in database connection pool |
|
5 |
udirect.jdbc.maxActiveConnections |
Max number of connections in database connection pool |
|
20 |
udirect.jdbc.minIdleConnections |
Minimum number of connections at any time in database connection pool |
|
3 |
udirect.jdbc.validationQuery |
The SQL query that will be used to validate connections from this pool before returning them to the caller. If specified, this query MUST be an SQL SELECT statement that returns at least one row. |
|
MSSQL: select 1 |
|
DB/2: select 1 |
|
Oracle: select 'validationQuery' from dual |
udirect.hibernate.dialect |
Type of database |
|
org.hibernate.dialect.SQLServerDialect |
|
org.hibernate.dialect.OracleDialect |
|
org.hibernate.dialect.DB2Dialect |
udirect.hibernate.show_sql |
Should SQL statements be printed to STDOUT? |
|
True - prints SQL statements to STDOUT (Be careful: this can decrease performance) |
|
False - do not print out SQL statements |
dcpapi.hibernate.bytecode |
|
|
True - always set to true |
dcpapi.hibernate.generate_statistics |
Generate performance statistics useful for performance tuning (advanced) |
|
True - generate statistics (Be careful: this can decrease performance) |
|
False - set to false in a production environment |
udirect.hibernate.second_level_cache |
Should Course catalog information be cached? |
|
(Default) true - Cache course catalog information to minimize hits to the database |
|
False - Do not cache course catalog information |
udirect.hibernate.second_level_cache.loadOnStartup |
Do you want the course catalog information to be cached during servlet container startup? |
|
True - Caches course catalog information during servlet container startup |
|
(Default) false - Does not cache course catalog information at startup, waits to cache during first calls to the database |