Skip to main content
CollegeSource Support

udirect-yearTermTemplate-ctx.xml

 

This file defines the terms that make up an institution's academic year, including how terms and years are combined to create the term ID for a school's auditing system. It also sets the friendly name that users will see throughout the system. This file is in the XML format with extensive comments in it to help you set up the configuration. The file also comes preconfigured with an example for additional assistance.

Instead of explicitly specifying each semester and year combination, use this file to describe how to display the term in the application and the generated ID is currently stored. The following is a list of properties defined with each term:

Property

Description

startMonth

A Number (1-12) The calendar month in which the semester begins. (For those familiar with Java, calendar months begin at 0 for January. That is NOT the case with this property. January is 1, February 2, etc.)

termCode

Any text value. The identifier for the code. This value is appended to the year to formulate the term ID in most, if not all, auditing systems. (If Fall has a term code of "08", the term ID for Fall 2007 would be "200708".)

yearOffset

A number. Sometimes schools will want to associate a semester with a different display year than stored year. For example, a school may wish to say Fall 2008 which is actually stored with 2007. Therefore, Fall semester (with a term code of "01") should have a saved ID of 200701 instead of 200801. The yearOffset will be subtracted from the display year in order to generate the ID. (For the example given, the Fall yearOffset would be "-1".)

calendarOffset

A number. Value used to determine the calendar year the semester actually falls in based on stored value. Use 1, 0, or -1. Set to 1 if stored term is 200701, but falls in calendar year 2008.

displayName

Text value. This is the name that would show up in the Student Plan tree. If you are creating the Fall semester with a termCode of "08", the display name would just be "Fall". It will then be stored in the database as 200708, but it will be displayed to the student using the friendly name.

defaultTerm

True/false. This indicates that by default, when a plan is initially created for the student, this particular term should be included for each year of the plan. For example, Fall and Spring are typically considered default terms. When plans are created for students, they have Fall and Spring semesters for every year. However, Summer I and Summer II will usually have defaultTerm set to "false".

order

A number. This is the order in which the terms fall within the calendar year. It is important that you give the first term the value of "0". The order should mimic the ascending order of the defined termCodes.

show

Determines whether to show the term in menus as a valid term option. Some terms that are defined are not intended to be visible for users to select from. This offers a way to remove it from the view. Defaults to true.

 regCutoffMonth

A Number (1-12). The calendar month in which the last day of the month is the closest to when registration ends, it establishes the line between past term and present term. A term is no longer considered "current" once date is past last day of registration cutoff month. (For those familiar with Java, calendar months begin at 0 for January). That is NOT the case with this property: January ("Spring") is 1, July is 7 ("Summer) etc. Set this to month prior to start of next term month if you want the behavior to be the same as in releases prior to 4.2. Default is ZERO if not set. This means the current term will be treated as a past (static) term until set.

(green star) New in 4.3.0.4 Users can  configure regCutoffMonth to control Course Availability. Course availability will show until registration is no longer available.

The current term will show as long as the current month precedes the regCutoffMonth.

(green star) New in 4.3.0.4 Users can configure regCutoffMonth to determine the catalog year setting when the student has no declared program.

Consider the regCutoffMonth for the current term; if past it, bump up to the next term.

 

 

For example:

 

  • Was this article helpful?