Quercus Control Centre Parameters Reference<>

Parameter reference

OpenCampus

Parameter

Description

Group

Notes

ADMISSION_​PLUS_​FLAG

Admission Plus flag

-

Purpose

Specifies whether Admissions Plus is in use.

Format

0 — Admission Plus OFF

1 — Admission Plus ON

If set to 1 (ON) students whose UCAS applications have been accepted will appear in Admissions Plus.

Warning: if you switch the parameter from 0 to 1 it means that you have decided to use the new QuercusPlus Admissions system and you MUST NOT switch the parameter back to 0. If you do so the old Admissions functionality will not be compatible with new data generated for the Admissions system.

APEX_​URL

Application Express URL

-

Purpose

Specifies where the APEX URL is located — what database to look up and where to find it.

Format

An Oracle Application Express URL (DAD).

Example

http://cit-test10g-as/qdoc/apex

http://reg.university.ac.uk/quercus

DEBUG_​TRACE_​LEVEL

Debug Trace Level

-

Purpose

Specifies the operational mode of the OC_TRACE function.

OC_TRACE creates an event log which can be used for debugging purposes.

OC_TRACE can collect five different levels of trace 1-5 from ‘from ‘error’ to ‘fine’, including debug and warning.

Format

The parameter accepts a number between 1 and 255:

128 = ERROR

64 = WARNING

32 = SECURITY

16 = INFO

8 = PERFORMANCE

4 = DEBUG

2 = FINE DEBUG

1 = X-FINE DEBUG

0 = DEBUG OFF

Only messages with appropriate severity level will be logged.

Levels can be combined by adding them together.

Example

If you wanted ERROR and WARNING you would enter 192 (= 128 + 64)

HTTP_​PROXY_​NO_​PROXY

HTTP Proxy Excluded Domains

-

Purpose

Specifies the sites for which you do not want to use the proxy server defined in HTTP_PROXY_SERVER, below.

Format

A comma or semi-colon delimited list of hosts and domains for which no proxy should be used for all requests.

Leave blank when proxy server is not used.

HTTP_​PROXY_​SERVER

HTTP Proxy Server

-

Purpose

Specifies the address of the proxy server used by Quercus.

CampusIT maintains information about the update status of a client’s database (such as patch level, database version). An example is shown in the screenshot.

This information is synchronised when an software update is installed. This is usually done on Port 80, but if this option is not available, a pull mechanism is used — this mechanism requires the use of a http proxy server.

Format

The syntax is [username:password@]host[:port]

Leave blank when no proxy server is required.

Example

user:pwd@proxy:8080

HTTP_​WALLET

Wallet

-

Purpose

Specifies the location of the Oracle HTTP Wallet.

The Oracle HTTP Wallet is a resource which stores the application server’s authentication credentials, such as security certificates. For example a security certificate provided by a payment gateway such as Realex (see QuercusLive Payments).

Format

Path relative to the database to the wallet.

Must begin with file:

Leave blank when outbound SSL communication is not required.

Example

file:d:\wallet

HTTP_​WALLET_​PASSWORD

Oracle Wallet Password

-

Purpose

Stores the password for the Oracle HTTP Wallet. See HTTP_WALLET, above.

MAIL_​SERVER_​HOST

SMTP Server Host

-

Purpose

Specifies the location of the SMTP mail server used by Quercus.

Format

IP address or DNS name

MAIL_​SERVER_​PASSWORD

Mail Server Password

-

Purpose

Stores the password required by the SMTP mail server.

MAIL_​SERVER_​PORT

SMTP Server Port

-

Purpose

Specifies the SMTP Mail server port number.

Default

25

MAIL_​SERVER_​USER

Mail Server User

-

Purpose

Specifies the username required by the SMTP mail server. Leave blank when authentication is not required by SMTP server.

MAIL_​TEST_​ADDRESS

Mail Test Email Address

-

Purpose

Specifies the email address(es) to which all emails generated by the system will be sent when the system is in development or test mode.

This parameter works in conjunction with the MAIL_TEST_MODE parameter (below). When MAIL_TEST_MODE is set to TRUE, all system-generated emails will be sent out to the address(es) entered in this field.

This ensures that real users (who may have been set up prior to go-live) do not receive emails during testing.

Format

Enter one or more email addresses.

Delimit multiple addresses with semi-colons.

Example

jane123@here.com;bob456@there.com;jack789@everywhere.com

MAIL_​TEST_​MODE

Mail Test Mode

-

Purpose

Allows the application to be switched to and from mail test mode.

When the value is TRUE all mail will be sent to the MAIL_TEST_ADDRESS (above)

Format

TRUE

FALSE

QAS_​SERVER_​TYPE

QAS Server Type

-

Purpose

Specifies the type of server used to provide the postcode lookup web-service (the parameter is named after QAS who provided the first postcode lookup service integrated with Quercus).

Format

CA

see http://www.capscan.co.uk/

QAS

see http://www.qas.co.uk/

AFD

see http://www.afd.co.uk/

QAS_​SERVER_​URL

QAS Server URL

-

Purpose

Specifies the URL for the postcode lookup web-service (see above).

Examples

http://qas.server.ie:2021

http://cit-dev-as5:7778/cgi-bin/mcxquery.exe?PoolName=PAF&UserName=Anonymous&#ACTION#

SMS_​PROVIDER

SMS Provider

-

Purpose

Specifies the name of the provider of the SMS gateway.

The SMS gateway sends out any SMS messages created through Quercus (e.g. via Students > Communication in QuercusPlus).

Format

Quercus currently supports integration with two SMS providers — the options are:

CLICKATELL

see http://www.clickatell.com/

PAGEONE

see http://www.pageone.co.uk/

SMS_​SERVER_​PASSWORD

SMS Server Password

-

Purpose

Stores the password required by the SMS gateway (see above).

SMS_​SERVER_​REQUEST

SMS Server URL

-

Purpose

Specifies the URL for the SMS server (see above). May include substitution strings #USER#, #PASSWORD#, #FROM#, #TO#, #MESSAGE#

SMS_​SERVER_​USER

SMS Server User

-

Purpose

Specifies the username for the SMS server (see above).

SMS_​SOURCE_​MSISDN

SMS Source MSISDN

-

Purpose

Specifies the SMS source MSISDN number (required for PageOne SMS integration).

SMS_​TEST_​MODE

SMS Test Mode

-

Purpose

Allows the application to be switched to and from SMS test mode.

When this mode is TRUE all SMSes will be sent to the SMS_TEST_NUMBER.

Format

TRUE

FALSE

SMS_​TEST_​NUMBER

SMS Test Number

-

Purpose

Specifies the phone number to which all SMSes generated by the system will be sent when the system is in development or test mode.

This parameter works in conjunction with the SMS_TEST_MODE parameter. When SMS_TEST_MODE is set to TRUE, all system-generated SMSes will be sent out to the number entered in this field.

This ensures that real users (who may have been set up prior to go-live) do not receive SMSes during testing.

Format

Single phone number

Example

+3531245678

URL_​ABOUT_​REGULAR_​EXPRESSION

Regular Expression URL

-

Purpose

Specifies a link to online help resources relating to regular expressions.

Default

http://www.regular-expressions.info

WALLET

Wallet

-

WALLET_​ACCESS

Wallet Access

-

not used

LDAP_​ADMIN_​PASSWORD

LDAP Admin Password

LDAP

Purpose

Stores the LDAP server password for the user defined in LDAP_ADMIN_USER_NAME (below).

Note: does not have be an actual admin-level user — a user with sufficient access privileges to perform the lookups is sufficient.

LDAP_​ADMIN_​USER_​NAME

LDAP Admin User Name

LDAP

Purpose

Specifies where the LDAP ‘admin’ user is located within the LDAP directory structure.

In the example below cn=orcladmin is the lowest level node, dc=net the highest. A fragment of a corresponding structure from an LDAP server is shown in the screenshot

Example

cn=orcladmin,cn=Users,dc=campusit-int,dc=net

Leave blank when LDAP server doesn’t require authentication.

LDAP_​GROUP_​BASE

LDAP Group Base

LDAP

Purpose

Specifies where the various LDAP groups (e.g QP_STUDENT_EDIT, HESA_ADMIN) are located within the LDAP directory structure.

If you create a new LDAP group, it will be located in the lowest level node of this path (in the example below, cn=Groups)

Example

cn=Groups,dc=campusit-int,dc=net

In the above example cn=Groups is the lowest level node, dc=net the highest.

When the application searches for a group, it will only search in (and below) the path specified by this parameter.

An example of a group node from an LDAP server is in the screenshot.

LDAP_​RAD_​BASE

RAD Base

LDAP

No longer used.

LDAP_​RAD_​NAME

RAD Name

LDAP

No longer used.

LDAP_​RAD_​TNS_​NAME

TNS Name

LDAP

No longer used.

LDAP_​SERVER

LDAP Server Type

LDAP

Purpose

Specifies which of the LDAP variants are in use.

Format

MICROSOFT_AD

See Microsoft Active Directory (http://en.wikipedia.org/wiki/Active_Directory)

ORACLE_OID

See Oracle Internet Directory (http://en.wikipedia.org/wiki/Oracle_Internet_Directory)

NOVELL_ED

See Novell’s eDirectory (http://en.wikipedia.org/wiki/Novell_eDirectory)

LDAP_​SERVER_​HOST

LDAP Server Hostname

LDAP

Purpose

Specifies the address of the LDAP server (see above).

Format

Fully-qualified URL

LDAP_​SERVER_​PORT

LDAP Server Port

LDAP

Purpose

Specifies the port on which the LDAP server is communicating.

Format

Common values are 389 or 636, default is 389.

LDAP_​USER_​BASE

LDAP User Base

LDAP

Purpose

Specifies where, in the LDAP directory structure, the users are located.

If you create a new LDAP user, the record will be located in the lowest level node of this path (in the example below, cn=QDOC)

Example

cn=QDOC,cn=Users,dc=campusit-int,dc=netn=Groups,dc=campusit-int,dc=net

In the above example cn=QDOC is the lowest level node, dc=net the highest.

When the application searches for a user, it will only search in (and below) the path specified by this parameter.

An example of a user from an LDAP server is in the screenshot.

LDAP_​USER_​ID_​NUMBER

LDAP User ID Number

LDAP

Purpose

Specifies the name of the LDAP property which links the LDAP user profile with the PERSON_LDAP.LDAP_ID field in QuercusPlus (see below).

QuercusPlus applications and services which utilise LDAP lookups, must be able to link an LDAP user record with records for the same user within the QuercusPlus database.

This is done using the LDAP_USER_ID_NUMBER parameter.

Example

employeenumber

LDAP_​WALLET

LDAP Wallet

LDAP

Purpose

Specifies the location of the Oracle LDAP Wallet.

The Oracle LDAP Wallet is a resource which stores the database’s authentication credentials, such as security certificates.

Format

Path to the wallet.

If entered, must begin with file:

Leave blank when SSL communication is not required.

Example

file:d:\wallet

LDAP_​WALLET_​PASSWORD

LDAP Wallet Password

LDAP

Purpose

Stores the password to the Oracle LDAP Wallet. See above.

SMART_​LINKS_​IMAGE_​CACHE

Smart Links Image Cache

SMART_LINKS

Purpose

Specifies the number of hours images for smart links are cached in the client browser.

Format

Integer (= number of hours)

To disable caching set to 0

Default

168 hours (7 days)

EMAIL_​PATTERN

Email Pattern

VALIDATION

Purpose

Checks that a text string corresponds to a valid pattern for an email address.

Can be invoked by any program or service with the appropriate access permissions.

Format

An Oracle database regular expression.

See http://download.oracle.com/docs/cd/B14117_01/appdev.101/b10795/adfns_re.htm#1007582

Default

^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,6}$

A range of more general or more specific alternatives can be found at http://regexlib.com/DisplayPatterns.aspx?cattabindex=0&categoryId=1

INT_​PATTERN

Integer Pattern

VALIDATION

Purpose

Specifies a regular expression for integer (.. −2, −1, 0, 1, 2,... ) validation.

Format

See EMAIL_PATTERN, above.

Default

^\-?[0-9]+$

PASSWORD_​PATTERN

Password Pattern

VALIDATION

Purpose

Specifies a regular expression used to check a password during password creation (validates the password pattern, not the password itself)

Can be invoked by any program or service with the appropriate access permissions.

Format

See EMAIL_PATTERN, above.

Default

No default value.

PHONE_​PATTERN

Phone Pattern

VALIDATION

Purpose

Specifies a regular expression used to check that a text string corresponds to a valid pattern for a phone number.

Can be invoked by any program or service with the appropriate access permissions.

Format

See EMAIL_PATTERN, above.

See also PHONE_NUMBER_FORMAT.

Default

^[0-9+ -]+$

(Note that the above expression rejects numbers containing parentheses e.g. +44 (0) 123 456789 and ‘ext' e.g. 0123 45678 ext 12345)

A range of more general or more specific alternatives can be found at http://regexlib.com/DisplayPatterns.aspx?cattabindex=0&categoryid=7

POSTCODE_​PATTERN

Postcode Pattern

VALIDATION

Purpose

Specifies a regular expression used to check that a text string is a valid postcode.

Can be invoked by any program or service with the appropriate access permissions.

Format

See EMAIL_PATTERN, above.

Default

No default value.

A range of more general or more specific alternatives can be found at http://regexlib.com/DisplayPatterns.aspx?cattabindex=0&categoryid=7

URL_​PATTERN

URL Pattern

VALIDATION

Purpose

Specifies a regular expression to check that a text string corresponds to a valid pattern for a URL.

Can be invoked by any program or service with the appropriate access permissions.

Default

^(https?://)[^ ]+\.[^ ]+\.[a-zA-Z]{2,6}[^ ]+$

(Note that the above rejects URLs containing only a single period, e.g. http://campusit.net/ rather than http://www.campusit.net/)

A range of more general or more specific alternatives can be found at http://regexlib.com/DisplayPatterns.aspx?cattabindex=0&categoryid=2

USERNAME_​PATTERN

Username Pattern

VALIDATION

Purpose

Specifies a regular expression to check that a username matches a specific pattern.

Can be invoked by any program or service with the appropriate access permissions.

Format

See EMAIL_PATTERN, above.

Default

No default value.

QuercusLive

Parameter

Description

Group

Notes

Messages

Purpose

The various message parameters are used to store text fragments which are displayed in response to program calls. The point at which the message is called will vary from implementation to implementation. A message may be called in several contexts. Some contexts may display more than one message.

Format

In contexts where the message is to be displayed within a web page you may enter plain text or XHTML.

If you enter plain text, hard returns will be treated as the start of a new p element.

If you use XHTML markup, elements must be valid XHTML 1.1 elements. They must be balanced and nested correctly. A root element is optional.

ACADEMIC_​SESSION

Academic Session

-

Purpose

Sets the default session for views of data that are organised by academic session.

Format

Year number e.g. 2011

APP_​SUBMITTED_​MESSAGE

Application Submitted Message

-

Purpose

Message displayed after application is submitted.

Format

See Messages (first note in this table).

CC_​FAIL_​MSG

Credit Card Failure Message

-

Purpose

Message displayed when a credit card payment has failed.

Format

See Messages (first note in this table).

CC_​NUMBER_​MASKING

CC Number Masking

-

Purpose

Normally credit card numbers are masked in the database. However these numbers can be shown for testing purposes.

Note: if set to FALSE the numbers can be viewed in the database. However they are not visible in the user interface.

Format

TRUE — mask the credit card number in the database (all figures except the last four are masked).

FALSE — show the credit card number in the database.

CC_​SUCCESS_​MSG

Credit Card Success Message

-

Purpose

Message to be displayed when a credit card payment has been submitted successfully.

Format

See Messages (first note in this table).

COURSECONF.EML_​01

COURSECONF.EML_​02

CourseConfirmation.EML_01 –

CourseConfirmation.EML_02

-

No longer used.

Fee Tolerance

-

No longer used.

COURSECONF.MSG_​01

COURSECONF.MSG_​07

CourseConfirmation.MSG_01 –

CourseConfirmation.MSG_07

-

No longer used.

DATA_​PROTECTION_​MESSAGE

Data Protection Message

-

Purpose

Message to be displayed when required by Data Protection Act.

Format

See Messages (first note in this table).

DEF_​FEE_​CATEGORY

Default Fee Category

-

Purpose

The fee category to which a course will be assigned in QuercusLive if there is no business logic which assigns the course to another category.

If a default fee category is not specified here the default fee category from QuercusPlus will be used.

DEFAULT_​DISABILITY

Default Disability

-

Purpose

Sets the default option wherever users are presented with selection lists in these categories in the registration and enrolment screens.

DEFAULT_​DOMICILE

Default Domicile

-

Format

Enter the value of the OBJECT_ID or leave blank.

DEFAULT_​ETHNIC_​ORIGIN

Default Ethnic Origin

-

DEFAULT_​LEARNING_​DIFFICULTY

Default Learning Difficulty

-

DEFAULT_​NATIONALITY

Default Nationality

-

DEFAULT_​NEW_​ENTRANT_​HE

Default New Entrant

-

DEFAULT_​RESTRICTED_​USE

Default Restricted Use

-

DOB_​LIMIT_​MAX

and

DOB_​LIMIT_​MIN

Maximal DOB

-

Purpose

Specifies minimum and maximum ages at which individuals may enroll on a course.

Format

Date e.g. 1-SEP-1992

Only students born after the MIN date or before MAX date may apply or register. Leave blank to disable this check.

EMAIL_​ACCOUNT_​MNG

Email Password

-

No longer used.

EMAIL_​FROM_​ADDRESS

Email From Address

-

Purpose

Defines the ‘from’ address of emails that originate from within the Quercus workflow.

Format

valid email address e.g. jane@everywhere.com

EML_​01 – EML_​20

Email 01 – Email 20

-

Purpose

Old-style plain-text emails that can be attached to the workflow. (Newer emails are created via QuercusLive > Set-up > Email Templates)

Format

See Messages (first note in this table).

FEE_​SCENARIO_​LOCKED

Fee Scenario Locked

-

Purpose

This parameter is specific to Galway — will not be reused in new contexts as it has proved problematic.

During the pre-registration process the student is asked a set of questions.

The answers the student gives to these questions determine what fees will be charged for the selected course (the ‘fee scenario’).

The FEE_SCENARIO_LOCKED parameter locks the mapping of the questions to the various fee scenarios so that the relationship cannot be changed.

Format

TRUE — mask the credit card number in the database (all figures except the last four are masked).

FALSE — show the credit card number in the database.

FEE_​TYPES

Fee Types

-

Purpose

Within a fee category there are usually three fees types: 1) registration 2) tuition 3) exam fee or materials fee.

You can exclude or include certain of these fee types (for example tuition fees) from the list of what is to be paid.

To locate a fee type code you have to query the database directly using SQL. This data is not exposed in the Quercus UI.

GROUP_​DETAILS

Group Details

-

No longer used

HELP_​URL

Help URL

-

Purpose

URL where help documentation is located.

Rarely used. More usual method is to put links into messages.

Example

#IMAGE_PREFIX#solar/solar_user_guide.pdf

Irish Domicile

-

Purpose

Used by the NCI where there is a need for some additional processing and validation relating to Irish course applicants (such as requesting a PPS number during the application process).

LOCK_​FEES

Lock Fees

-

MARKETING_​DOCUMENT_​NAME

Marketing Document Name

-

Associated with XML feeds and click-through links to prospectuses etc.

Create LDAP Account

-

Purpose

Determine whether an LDAP account is to be created when registering (or pre-registering) a student.

PAYMENT_​TIMEOUT

Payment Timeout (seconds)

-

No longer used.

PAYMENT_​URL

Payment URL

-

Purpose

Address of a payment page where students are directed if they need to make extra payments.

Format

URL

PHONE_​NUMBER_​FORMAT

Phone Number Mask

-

Purpose

A regular expression used to validate phone numbers.

Format

A regular expression — see also the OpenCampus PHONE_PATTERN parameter.

PRINT_​FORM_​URL

Print Form URL

-

Purpose

Allows users to generate a PDF containing the full details of a student’s application (this is the same PDF that is generated for the student’s own records at the end of the application process).

If this parameter is set, a link to the PDF appears at the bottom of the applicant’s record.

Currently used only by RCSI who print the PDFs and send them out to a third-party that organises their interviews.

Format

URL used to print a full version of an application form, use #APPLICATION_FORM#, #APPLICANT# and #SESSION# if you want to substitute the application form or applicant object_id or the session.

REFERENCE_​REQ_​MAIL

Reference Request Mail

-

Purpose

Text for boilerplate text for an email reference request (email sent to a student’s nominated referee seeking a reference).

Format

See Messages (first note in this table).

REFERENCE_​REQ_​URL

Reference Request URL

-

Purpose

Works in conjunction with REFERENCE_REQ_MAIL (above). Specifies a link that can be inserted into the request email. This link should point a destination where the referee can enter the reference details.

Format

Link for referee to provide support to application #APP_REFERENCE#,#APP_REFERENCE_NUM#

REPORT_​SERVER_​URL

Report Server URL

-

Purpose

The URL required to run reports from an APEX Application.

Format

Must include the #REPORT_FILE_NAME# substitution string.

Will be an application server and the root of the report.

http://cit-dev-as5:7778/reports/rwservlet?solar_proxy&report=#REPORT_FILE_NAME#&destype=cache&desformat=pdf#PARAMETERS#

RPT_​01_​FILE_​NAME

RPT_​06_​FILE_​NAME

Report 01 File Name –

Report 06 File Name

-

Purpose

Used as part of Assisted Enrolment. These identify the PDFs that are produced at the end of the process, giving you details of the choices you made and the data you entered as part of the enrolment.

SERVICE_​URL

Service URL

-

Purpose

Used by the Quercus XML feed — parameter inside the XML feed which sets the various customer-specific options.

This parameter allows one XML feed to be used by multiple customer applications.

Example

#APEX_URL#/f?p=ENROLL:201:::::P202_COURSE_INSTANCE_SERVICE:#ID#

In the string above ENROLL:201 is the customer application, P202_COURSE_INSTANCE_SERVICE is the page it should go to. #ID# will be replaced by the course instance service object ID.

TERMS_​CONDITIONS

Terms & Conditions

-

Purpose

Stores the terms and conditions text associated with a service.

Format

See Messages (first note in this table).

Send Image

-

Purpose

Controls whether images uploaded online are transferred to QuercusPlus.

No longer used.

UPLOAD_​PHOTO_​RULE

Upload photo rule

-

Purpose

Determines whether students can upload photographs. Used in contexts other than Reserve (= Confirm) Place and QuercusLive.

See also RESERVE_PLACE.UPLOAD_PHOTO and QL4S.UPLOAD_STUDENT_PHOTOS.

Format

0 — disabled

1 — enabled

2 — only if there is no image in the database, otherwise disabled

WALLET

Wallet

-

Purpose

No longer used — superseded by parameters in OpenCampus, e.g. HTTP_WALLET,, LDAP_WALLET.

WALLET_​ACCESS

Wallet Access

-

No longer used — superseded by parameters in OpenCampus, e.g. HTTP_WALLET, LDAP_WALLET.

WELCOME_​TEXT

Welcome Text

-

Purpose

Text of welcome message.

Purpose

See Messages (first note in this table).

XML_​LINK_​SECRET_​KEY

XML Link Secret Key

-

Purpose

Shared key for authorization of XML Link transactions. Leave blank to disable authorization.

Was used for integration in MyCampus2 — no longer used.

ASSISTED_​ENR.ERROR_​MESSAGE

Error Message

ASSISTED_ENR

Purpose

Specifies the message associated with error conditions in the assisted enrolment workflow.

Format

See Messages (first note in this table).

COURSE_​BROWSE.ERROR_​MESSAGE

Error Message

COURSE_BROWSE

Purpose

Specifies the message associated with error conditions when browsing courses.

Format

See Messages (first note in this table).

COURSECONF.ERROR_​MESSAGE

Error Message

COURSECONF

Purpose

Specifies the message associated with error conditions in the course confirmation workflow.

Format

See Messages (first note in this table).

CURR_​BUILD.ERROR_​MESSAGE

Error Message

CURR_BUILD

Purpose

Specifies the message associated with error conditions in the curriculum builder workflow.

Format

See Messages (first note in this table).

CURR_​BUILD.MSG_​01

CURR_​BUILD.MSG_​10

Message 01 –

Message 10

CURR_BUILD

See Messages (first note in this table).

EDITABLE_​COURSE_​SEMESTER

Editable Course Semester

CURR_BUILD

Purpose

Curriculum Build allows students to choose from optional modules.

Used by Galway.

Typical usage might be to define two time slots — the beginning of semester 1 and the beginning of semester 2. At the beginning of semenster 1 this parameter is set to 1,2. At the beginning of semester 2 it is set to 1.

Example

Modules ARCHPM and ARCHTECH are associated with semester 1.

Modules ANTIQUITY and CLASSICAL are associated with semester 2.

If the parameter is set to 1,2 at the start of semester 1, then the list of available options will be ARCHPM, ARCHTECH, ANTIQUITY and CLASSICAL.

If the parameter is set to 2 at the start of semester 2, then the list of available options will be ANTIQUITY and CLASSICAL.

Note: In the above scenario — if a student has already chosen a semester 1 module, the module cannot be removed once it is no longer selectable (in the above scenario, if the student had chosen ARCHPM and the parameter had been reset to 2, the student would not be able to unselect it).

EDITABLE_​MODULE_​TYPE

Editable Module Type

CURR_BUILD

Purpose

Defines which types of modules are selectable as optional modules when you are building a curriculum (the modules not highlighted in blue, in the screenshot).

Note: module types can be added via Classic Interface > Course Manager > Static Data Maintenance > Module Type.

Format

A comma-separated list of module types.

If you leave this parameter empty, then ALL module types except CORE will be selectable as optional.

If you enter a list of module types in this field, then ONLY the modules in the list will be selectable as optional.

EVENT_​REG Group parameters (below)

Purpose

Some institutions organise events (such as conferences, dinners) where invitations are sent out to groups. As part of the process a ‘group leader’ is identified. This is the individual in the group to whom the initial invitation is sent and who will subsequently act as the group’s representative. The group leader may then choose who to invite from within the group.

The various EVENT_GROUP parameters allow you to:

specify a URL for the event landing pages to which the group leader and group members are directed (these may be the same or different).

create the boilerplate text for the emails that will be sent out to group leaders and group members.

Used by the National College.

EVENT_​GROUP_​LEADER_​MAIL

Event Group Leader Mail

EVENT_REG

Purpose

Allows you to create boilerplate text for the emails that will be sent out to the group leaders.

Format

Plain text with embedded codes (‘Email Tags’) for text variables such as Name, Event Date, etc.

A list of email tags are listed on the right. Double-click (don’t drag) a code to add it to the email at the cursor position.

EVENT_​GROUP_​LEADER_​URL

Event Group Leader URL

EVENT_REG

Purpose

Specifies a URL for the event landing page to which the group leader is directed (see EVENT_REG Group parameters, above).

Format

URL

EVENT_​GROUP_​MEMBER_​MAIL

Event Group Invitation Mail

EVENT_REG

Purpose

Allows you to create boilerplate text for the emails that will be sent out to the group members (see EVENT_REG Group parameters, above and EVENT_GROUP_LEADER_MAIL, above).

Format

Plain text with embedded codes (‘Email Tags’) for text variables such as Name, Event Date, etc.

EVENT_​GROUP_​MEMBER_​URL

Event Group Membership URL

EVENT_REG

Purpose

Specifies a URL for the event landing page to which the group member is directed (see EVENT_REG Group parameters, above).

Format

URL

E_​TICKET

E-Ticket

GRADUATION

Purpose

Allows you to create boilerplate template for the e-Ticket that will be sent out to the graduates when confirming their place at the graduation ceremony.

Format

Plain text with embedded codes (‘Email Tags’) for text variables such as Name, Event Date etc. See the screenshot for EVENT_GROUP_LEADER_MAIL.

GRADUATION.DEADLINE

Booking Deadline

GRADUATION

Purpose

The graduation service has a start and end date in the service profile.

Some institutions need the service itself to remain available but want to prevent bookings after a certain date (this allows for late reallocation of capacity to match supply and demand for tickets).

The GRADUATION.DEADLINE parameter permits this by disabling the booking facilities component of the service a specified number days ahead of the conferring period.

Format

Number of days before the start of the conferring period that booking must be completed by.

GRADUATION.ERROR_​MESSAGE

Error Message

GRADUATION

Purpose

Specifies the message associated with error conditions in the graduation workflow.

Format

See Messages (first note in this table).

GRADUATION.MSG_​01

GRADUATION.MSG_​07

Message 1 –

Message 7

GRADUATION

Purpose

Various messages associated with graduation events.

Format

See Messages (first note in this table).

GROUP_​APP Group parameters (below)

Purpose

Some institutions (e.g. Southampton, the National College) allow group registrations for courses in situations where a group of people wish to learn together. Typical scenarios include the pupils of a particular teacher or a group of colleagues from a commercial organisation.

As part of the process a ‘group leader’ is identified. This is the individual in the group who makes the initial registration and who will subsequently act as the group’s representative. The group leader may then register other members of the group.

The various GROUP_ parameters allow you to:

specify a URL for the event landing pages to which the group leader and group members are directed (these may be the same or different)

create the boilerplate text for the emails that will be sent out to group leaders and group members

The GROUP_APP parameters function in the same way as the EVENT_REG Group parameters.

GROUP_​LEADER_​MAIL

Group Leader Mail

GROUP_APP

Purpose

Allows you to create boilerplate text for the emails that will be sent out to the group leader (see GROUP_APP Group parameters, above).

Format

Plain text with embedded codes (‘Email Tags’) for text variables such as Name, Event Date etc. See the screenshot for EVENT_GROUP_LEADER_MAIL.

GROUP_​LEADER_​URL

Group Leader URL

GROUP_APP

Purpose

Specifies a URL for the event landing page to which the group leader is directed (see GROUP_APP Group parameters, above).

Format

URL

GROUP_​MEMBER_​MAIL

Group Member Invitation Mail

GROUP_APP

Purpose

Allows you to create boilerplate text for the emails that will be sent out to the group member (see GROUP_APP Group parameters, above).

Format

Plain text with embedded codes (‘Email Tags’) for text variables such as Name, Event Date etc. See the screenshot for EVENT_GROUP_LEADER_MAIL.

GROUP_​MEMBER_​URL

Group Membership URL

GROUP_APP

Purpose

Specifies a URL for the event landing page to which the group member is directed (see GROUP_APP Group parameters, above).

Format

URL

ONLINE_​APP.ERROR_​MESSAGE

Error Message

ONLINE_APP

Purpose

Specifies the message associated with error conditions in the online applications.

Format

See Messages (first note in this table).

ONLINE_​APP.LOGIN_​MSG

Login Page Message

ONLINE_APP

Purpose

Specifies the message associated with online application logins.

Format

See Messages (first note in this table).

ONLINE_​APP.MSG_​01

ONLINE_​APP.MSG_​24

Message 1 –

Message 24

ONLINE_APP

Purpose

Various messages associated with online applications.

Format

See Messages (first note in this table).

ONLINE_​APP.UPDATE_​ON_​TRANSFER

Update on transfer

ONLINE_APP

Purpose

This parameter specifies whether or not a student’s data gathered during the online application process will be transferred to the main Quercus database when the student is accepted on a course. The data gathered during the online application is, at the time of collection, held in a staging area separate from the main database.

Most institutions will have this paramter set to TRUE, as the time interval between application and acceptance on a course is a matter of a few days and so the data will still be up-to-date. However, for some institutions, such as the National College, the application moderation process may take longer and there is a danger that the transferred information will not be up-to-date. In this situation changing the ONLINE_APP.UPDATE_ON_TRANSFER parameter value to FALSE ensures that the information is not updated automatically when the student is accepted onto the course. In these circumstances, the institution will rekey the data, updating it with any new information.

Format

TRUE | FALSE

ONLINE_​ENQ.MSG_​01

ONLINE_​ENQ.MSG_​03

Message 01 –

Message 03

ONLINE_ENQ

Purpose

Various messages associated with online enquiries.

Format

See Messages (first note in this table).

ONLINE_​PAYMENT.ERROR_​MESSAGE

Error Message

ONLINE_PAYMENT

Purpose

Specifies the message associated with error conditions in the online payment workflow.

Format

See Messages (first note in this table).

ONLINE_​PAYMENT.MSG_​01

ONLINE_​PAYMENT.MSG_​10

Message 1 –

Message 10

ONLINE_PAYMENT

Purpose

Various messages associated with online payments.

Format

See Messages (first note in this table).

ONLINE_​REG.ERROR_​MESSAGE

Error Message

ONLINE_REG

Purpose

Specifies the message associated with error conditions in the online registration workflow.

Format

See Messages (first note in this table).

QL4S parameters

Overview

These parameters affect the display of information in the Quercus Live for Students service.

The Quercus Live for Students service allows students to access information about their courses and their personal profile. It provides some functionality by default, other functionality is optional and must be enabled setting parameters correctly.

The list below indicates which options are enabled by default and which are disabled:

view course information — Enabled by default.

Note: only courses in the years specified by QL4S.LIST_OF_SESSIONS will be shown.

view exam information — Disabled by default. Use QL4S.SHOW_EXAM_RESULTS to enable.

view financial information — Disabled by default. Use QL4S.SHOW_FINANCIAL_DETAILS to enable.

view financial notes — Disabled by default. Use QL4S.SHOW_FINANCIAL_NOTES to enable.

view personal information — Enabled by default. Individual profile components (such as the student’s home address) can be shown or hidden. See QL4S.HOME_ADDRESS, QL4S.TERM_ADDRESS, QL4S.WORK_ADDRESS, QL4S.MAILING_LABEL

edit personal information — Disabled by default. See QL4S.PERSONAL_DETAILS_EDITABLE, QL4S.HOME_ADDRESS_EDITABLE, QL4S.MAILING_LABEL_EDITABLE, QL4S.TERM_ADDRESS_EDITABLE

upload student photo — Disabled by default. Use QL4S.UPLOAD_STUDENT_PHOTOS to enable.

Editing personal information

A student can edit personal information only if:

a Maintain Student Profile service has been enabled against at least one of the student’s course instances

the appropriate QL4S parameters have been set to TRUE

If none of the student’s course instances have the Maintain Student Profile service enabled then ― even if QL4S parameters such as QL4S.HOME_ADDRESS_EDITABLE have been set to TRUE — a student will be unable to edit his or her personal information.

To check if a course’s Maintain Student Profile service has been enabled

1Login to QuercusPlus with administrator permissions and select Control Centre.

2Select the Set-up tab.

3Select Service Assignments from the Basic option list.

The Service Assignments screen opens.

4Select Service Profiles.

The Service Profiles screen opens.

5To see a list of all course instances for which the Maintain Student Profile service is enabled select the following:

Service — Maintain Student Profile

Course — Leave empty

Session — (all)

Status — (All)

QL4S.COURSE_​BANNER

Default Course Banner

QL4S

Purpose

Allows you to upload the QuercusLive course banner graphic that will appear alongside the course header information.

This graphic is not specific to an individual course. It will appear against all courses that do not have a more specific banner uploaded.

You can also delete the graphic image by clicking the Reset button.

Note: You can upload a more specific graphic for an individual course through QuercusForms. To do this go to:

Course Manager > Course Maintenance > Course > Documents

QL4S.HOME_​ADDRESS

Home Address Displayed

QL4S

Purpose

Set to TRUE to show students’ home address in QuercusLive.

Format

TRUE | FALSE

QL4S.HOME_​ADDRESS_​EDITABLE

Home Address Editable

QL4S

Purpose

Set to TRUE to allow students to edit their home addresses in QuercusLive.

See the note Editing personal information in QL4S parameters.

Format

TRUE | FALSE

QL4S.LIST_​OF_​SESSIONS

List of Academic Sessions

QL4S

Purpose

The list of courses displayed to a student in the My Courses area of QuercusLive will be restricted to the specified academic sessions.

The courses shown in the My Courses area are only those which are are part of the student’s curriculum.

Format

Enter the sessions as a comma-separated list, e.g. 2007,2008,2009,2010

QL4S.LIST_​OF_​STATUSES

List of Statuses

QL4S

Purpose

Allows you to enter institution-specific student registration statuses.

Format

Enter the sessions as a comma-separated list, e.g. R,P

R — registered

P — pre-registered

QL4S.MAILING_​LABEL

Mailing Label Displayed

QL4S

Purpose

Set to TRUE to show students mailing address in QuercusLive.

See the note Editing personal information in QL4S parameters.

Format

TRUE | FALSE

QL4S.MAILING_​LABEL_​EDITABLE

Mailing Label Editable

QL4S

Purpose

Set to TRUE to allow students to edit their mailing address in QuercusLive.

See the note Editing personal information in QL4S parameters.

Format

TRUE | FALSE

QL4S.PERSONAL_​DETAILS_​EDITABLE

Personal Details Editable

QL4S

Purpose

Set to TRUE to allow students to edit their personal details in QuercusLive.

The following personal information is shown:

ID number, Name, Date of birth, Gender

See the note Editing personal information in QL4S parameters.

Format

TRUE | FALSE

QL4S.SHOW_​EXAM_​RESULTS

Show Exam Results

QL4S

Purpose

Set to TRUE to show students’ exam results in QuercusLive.

Note

Exam results will only be visible if module_instance_exam_board.publish_date is set and equals or is prior to today.

The modules component shows details of all the modules associated with the selected course.

QL4S.SHOW_​FINANCIAL_​DETAILS

Show Financial Details

QL4S

Purpose

Set to TRUE to show the My Finance tab in QuercusLive.

The Financial tab can be shown or hidden as a whole. You cannot show or hide components on an individual basis (with the exception of links to financial notes)

Format

TRUE | FALSE

QL4S.SHOW_​FINANCIAL_​NOTES

Show Financial Notes

QL4S

Purpose

Set to TRUE to links to Financial Notes on the My Finance tab in QuercusLive.

Quercus allows you to associate notes with financial transactions. You can show or hide these notes.

If a transaction has an associated note, a View Notes link appears in the Note column. Clicking the link opens a pop-up window containing the note.

Format

TRUE | FALSE

QL4S.SHOW_​STUDENT_​PHOTOS

Show Student Photos

QL4S

Purpose

Set to TRUE to display student photographs in QuercusLive.

Format

TRUE | FALSE

QL4S.TERM_​ADDRESS

Term Address Displayed

QL4S

Purpose

Set to TRUE to show students’ term address in QuercusLive.

Format

TRUE | FALSE

QL4S.TERM_​ADDRESS_​EDITABLE

Term Address Editable

QL4S

Purpose

Set to TRUE to allow students to edit their term address in QuercusLive.

Format

TRUE | FALSE

QL4S.UPLOAD_​STUDENT_​PHOTOS

Upload Student Photos

QL4S

Purpose

Set to TRUE to allow students to upload their photo via QuercusLive.

Format

TRUE | FALSE

QL4S.WORK_​ADDRESS

Work Address Displayed

QL4S

Purpose

Set to TRUE to show students’ work address in QuercusLive.

Format

TRUE | FALSE

QL4S.WORK_​ADDRESS_​EDITABLE

Work Address Editable

QL4S

Purpose

Set to TRUE to allow students to edit their work address in QuercusLive.

Format

TRUE | FALSE.

RESERVE_​PLACE parameters

All parameters

RESERVE_PLACE

These parameters relate to the Confirm Place (it is not called ‘Reserve Place’) workflow.

RESERVE_​PLACE.EML_​01

RESERVE_​PLACE.EML_​06

Reserve a Place Email 01 –

Reserve a Place Email 06

RESERVE_PLACE

Purpose

Allows you to create boilerplate templates for the emails that can be sent out as part of the Confirm Place workflow.

Format

Plain text with embedded codes (‘Email Tags’) for text variables such as Name, Event Date etc. See the screenshot for EVENT_GROUP_LEADER_MAIL.

RESERVE_​PLACE.ERROR_​MESSAGE

Error Message

RESERVE_PLACE

An error message used in the Confirm Place workflow.

See Messages (first note in this table).

RESERVE_​PLACE.FEE_​TOL_​RULE

Fee Tolerance Rule

RESERVE_PLACE

Purpose

This calculation is used by institutions where reservation fees may be paid for in a range of currencies. It allows a payment to be accepted or rejected depending on how close the amount is to the original fee in the base currency — after it has been converted using the exchange rate used by the institute.

This parameter is used in tandem with the RESERVE_PLACE.FEE_TOLERANCE parameter (below). RESERVE_PLACE.FEE_TOL_RULE specifies how the tolerance will be calculated. RESERVE_PLACE.FEE_TOLERANCE supplies the value to be used by the calculation.

Format

There are three fee tolerance modes:

0 — tolerance disabled

1 — absolute mode (fee tolerance = fee tolerance)

2 — percentage mode (fee tolerance = amt_due * fee_tolerance/100)

In absolute mode, you specify an absolute amount and if the paid fee is within this amount of the original fee it will be accepted.

In percentage mode, you specify a fee tolerance percentage. If the difference between paid fee and the original fee is within this percentage the fee will be accepted.

Example

Original fee in base currency: £1000

Fee paid: €1152

Exchange rate accepted by institution: £1 = €1.15302

Conversion at accepted rate: €1,153.02

Difference = €1.02

Difference in base currency at accepted conversion rate = £0.88

Case 0 — fee tolerance disabled

original fee ≠ converted fee ∴​ the payment is rejected

Case 1 — absolute mode

RESERVE_PLACE.FEE_TOL_RULE = 1

FEE_TOLERANCE = 10

∴​ tolerance = £10

tolerance > difference ∴​ the payment is accepted

Case 2 — percentage mode

RESERVE_PLACE.FEE_TOL_RULE = 2

FEE_TOLERANCE= 1

∴​ tolerance = £1000 * (1/100) = £10

tolerance > difference ∴​ the payment is accepted

RESERVE_​PLACE.FEE_​TOLERANCE

Fee Tolerance

RESERVE_PLACE

See RESERVE_PLACE.FEE_TOL_RULE, above.

RESERVE_​PLACE.HELP_​MSG_​01

RESERVE_​PLACE.HELP_​MSG_​03

Help Message 1 –

Help Message 3

RESERVE_PLACE

A help message used in the Confirm Place workflow.

See Messages (first note in this table).

RESERVE_​PLACE.IMAGE_​SIZE

Image Upload Size

RESERVE_PLACE

Purpose

Sets the maximum size of image a student is allowed to upload as part of the Confirm Place workflow.

RESERVE_​PLACE.MSG_​01

RESERVE_​PLACE.MSG_​20

Message 1 –

Message 20

RESERVE_PLACE

An on-screen message used in the Confirm Place workflow.

See Messages (first note in this table).

RESERVE_​PLACE.UPLOAD_​PHOTO

Upload Photo Rule

RESERVE_PLACE

Purpose

Setting to determine if students can upload an image of themselves.

Format

0 — disabled

1 — enabled

2 — only if there is no image in the database, otherwise disabled

STUDENT_​SURVEY_​NOTE_​TYPE

Object Note Type

STUDENT_SURVEY

Purpose

Object note type to be used to record acknowledgement.

No longer used

STUDENT_​SURVEY_​QUESTION

Survey Question

STUDENT_SURVEY

No longer used (used by Galway in MyCampus2)

STUDENT_​SURVEY.ERROR_​MESSAGE

Error Message

STUDENT_SURVEY

Purpose

An on-screen message used in the Student Survey workflow.

See Messages (first note in this table).

SURVEY_​DEFAULT_​MESSAGE

Survey Default Message

STUDENT_SURVEY

The default message that will appear in the email that is sent out informing the student about the survey.

SURVEY_​URL

Survey URL

STUDENT_SURVEY

Purpose

Part of the student survey service. This allows you to create a survey and then associate the survey with a service profile.

The service allows you to send out an email notification of the survey to all those who are eligible to take the survey (based on the service profile). The email will contain a link to the survey — this is the URL entered in this field.

UPDATE_​PROFILE.ERROR_​MESSAGE

Error Message

UPDATE_PROFILE

An on-screen error message used in the Update Profile workflow.

See Messages (first note in this table).

UPDATE_​PROFILE.MSG_​01

UPDATE_​PROFILE.MSG_​05

Message 1 –

Message 5

UPDATE_PROFILE

An on-screen message used in the Update Profile workflow.

See Messages (first note in this table).

WORK_​PLACEMENT.ERROR_​MESSAGE

Error Message

WORK_PLACEMENT

An on-screen error message used in the Work Placement workflow.

See Messages (first note in this table).

QuercusLive Payments

Parameter

Description

Group

Notes

Note: These parameters are used by any Quercus applications that need to process online payments.

The parameters specify the payment gateway used by the application and allow you to enter the values of various parameters used by the gateway.

At the moment three different gateways are in use: DHC, REALEX (see http://www.realexpayments.com/) and STREAMLINE (RBS WorldPay) (see http://www.streamline.com/)

PAYMENT_​PROVIDER

Payment provider

-

Purpose

Specifies the payment provider.

Format

REALEX

STREAMLINE

Note: DHC is only supported for custom implementations.

DHC_​PASSWORD

Password

DHC

Purpose

Stores the password required to access the DHC service.

DHC_​SUCCESS_​CODE

Success Code

DHC

Purpose

Stores the response code returned by the DHC service indicating that the payment has been approved

DHC_​URL

DHC URL

DHC

Purpose

Specifies the URL of the DHC service.

DHC_​USER

User name

DHC

Purpose

Stores the username required to access the DHC service.

ACCOUNT

Account

REALEX

Purpose

Specifies the account to which Realex transactions are to be posted.

CURRENCY

Currency

REALEX

Purpose

Specifies the currency in which Realex transactions are to be processed.

Format

ISO 4217 — See http://www.xe.com/iso4217.php

MERCHANT_​ID

Merchant ID

REALEX

Purpose

Stores the Merchant ID, used by Realex to identify the cutomer.

SHARED_​SECRET

Shared Secret

REALEX

Purpose

Provides additional verification credentials during the handshake between CampusIT systems and Realex.

SUCCESS_​CODE

Success Code

REALEX

Purpose

Stores the response code returned by the Realex service indicating that the payment has been approved

URL

URL

REALEX

Purpose

Specifies the URL of the Realex service.

STRMLN_​3D_​MESSAGE

3D Message

STREAMLINE

Purpose

Message associated with Streamline 3D verification.

STRMLN_​CURRENCY

Currency

STREAMLINE

Purpose

Specifies the currency in which Realex transactions are to be processed.

Format

ISO 4217 — See http://www.xe.com/iso4217.php

STRMLN_​DESCRIPTION

Description

STREAMLINE

Purpose

Description used for passing to Streamline. This description is used for distinguishing transactions originating in Quercus from Streamline transactions originating from other applications.

STRMLN_​EXP

Exponent

STREAMLINE

Purpose

Used to translate submitted transaction values to the correct numeric format.

Divides the number by 10n where n = the exponent value.

Format

Specifies where the decimal point or comma should be placed, counting from the right.

Example

number submitted = 8201

exponent = 2

value = 8201/102 = 8201/100 = 82.01

Default

2

STRMLN_​MERCHANT_​ID

Merchant ID

STREAMLINE

Purpose

Stores the Merchant ID, used by Streamline to identify the cutomer.

STRMLN_​PASSWORD

Password

STREAMLINE

Purpose

Stores the password required to access the Streamline service.

STRMLN_​SUCCESS_​CODE

Success Code

STREAMLINE

Purpose

Stores the response code returned by the Streamline service indicating that the payment has been approved

STRMLN_​URL

Stream Line URL

STREAMLINE

Purpose

Specifies the URL of the Streamline service.

STRMLN_​USER

User name

STREAMLINE

Purpose

Stores the username required to access the Streamline service.

STRMLN_​VERSION

Streamline version

STREAMLINE

Purpose

Specifies the version of the Streamline application in use.

QuercusPlus Admissions

Parameter

Description

Group

AGE_​IN_​MONTH

Age calculation month

-

Purpose

When calculating whether or not an applicant is eligible to apply for a course, the system needs to know the applicant’s age on the first day of a specified month in a specified year (usually the first day of the academic year). For example, was the application 18 on the 1st September 2010? In order to allow the system to make the calculation you must specify the month and year to be used in the calculation.

The AGE_IN_MONTH parameter specifies the month part of the date used in the calculation (using the example above you would enter 9 for September). It works in conjunction with the AGE_IN_YEAR parameter (below).

Using the applicant’s date-of-birth, the system can then calculate the applicant’s age at the specified point in time and apply any age-dependent processing logic.

In the screenshot (from the Admissions > Applications section of QuercusPlus) the field ‘Age on 1st September 2009’ is driven by the entries in the AGE_IN_MONTH and AGE_IN_YEAR fields.

DOB_LIMIT_MIN and DOB_LIMIT_MAX have a similar function.

AGE_​IN_​YEAR

Age calculation year

-

Purpose

Works together with the AGE_IN_MONTH parameter (above). Specifies the month part of the date used in the calculation (using the example above you would enter 2009).

APPLICATION_​YEAR

Application year

-

Purpose

This is academic year in which the system is currently receiving applications.

It is NOT the same as the year of the courses for which student are applying.

It does not have to coincide with a calendar year.

It does not have to run for twelve months.

Institutions must manually update this parameter every year before they download the new data from UCAS for the next academic session.

The parameter was created in response to a SIG requirement that institutions should be able to decide individually when the new admissions process starts for them.

Format

A year, e.g. 2011,2012

Example

The APPLICATION_YEAR value is set to 2011 between Sept 1st 2011 and August 31st 2012

The APPLICATION_YEAR value is set to 2012 between Sept 1st 2012 and August 31st 2013

If a student applied in December 2011 for a course beginning in 2013, the student’s application year is 2011

If a student applied in February 2012 for a course beginning in 2013, the student’s application year is 2011

If a student applied in October 2012 for a course beginning in 2013, the student’s application year is 2012

AP_​NOTE_​TYPE

Contact Transaction Note

-

Purpose

The parameter AP_NOTE_TYPE is used when you are creating a new note against person in AdmissionsPlus. You can select a new note from Notes Library (a template) and you can select the type of the note.

If you select the note from the library the note type is automatically defaulted to the value from the parameter and the additional record (Contact_Transaction_Type) is created.

Note: this functionality is irrelevant for most of the customers but it is an important feature for University of Portsmouth (and their reports).

UKPASS_​PASSWORD

UKPASS Access Password

-

Purpose

Stores the password that must be supplied as part of the authentication credentials when connecting to UCAS’s UKPASS service (see http://www.ukpass.ac.uk/).

LICENCE_​NUMBER

SMS Sponsor Licence Number

-

Purpose

The UKBA (UK Border Agency) Export option requires that a licence number is supplied. This parameter holds the licence number.

If you do not specify this number you will not be able to generate UKBA export in the Admissions system. If this is the case a message is displayed on the screen asking you to set this parameter.

REPORT_​SERVER_​URL

Report Server URL

-

Purpose

Specifies the URL where Oracle Reports server is running.

Format

It must include #REPORT_FILE_NAME# substitution string.

Example

http://cit-dev-as5:7778/reports/rwservlet?quercus&report=#REPORT_FILE_NAME#&destype=cache&desformat=pdf#PARAMETERS#

UKBA_​LOG_​FORMAT

UKBA log file format

Ukpass

Purpose

Specifies the output format of the UKBA log file format. This log records any errors during the UKBA Export.

Format

CSV or HTML

UKPASS_​INSTITUTION_​CODE

UKPASS Institution Code

Ukpass

Purpose

Stores the institution code that must be supplied as part of the authentication credentials when connecting to UCAS’s UKPASS service (see http://www.ukpass.ac.uk/).

UKPASS_​USER_​ID

UKPASS Access User ID

Ukpass

Purpose

Stores the user id that must be supplied as part of the authentication credentials when connecting to UCAS’s UKPASS service (see http://www.ukpass.ac.uk/).

QuercusPlus Global

Parameter

Description

Group

HESA_​REQUIRED

HESA required

Purpose

Specifies whether HESA is required.

Format

TRUEFALSE

CROSS_​SESSION_​CI_​FLAG

Cross-Sessional Course Inst.

Flexible Curriculum

Purpose

Allows you to enable or disable Cross-Sessional Course Instances.

Allows you to assign module Instances from different academic sessions to Cross-Sessional Course Instances.

Format

TRUE or FALSE

CROSS_​SESSION_​MI_​FLAG

Cross-Sessional Module Inst.

Flexible Curriculum

Purpose

Allows you to enable or disable

Allows you to.

Format

TRUEFALSE

PACKAGED_​INSTANCES_​FLAG

Personalized courses

Flexible Curriculum

Purpose

Specifies whether personalized courses (packaged instances) are in use.

Format

TRUE or FALSE

ADMISSIONS_​FORM

Admissions form

System

Purpose

Specifies the name of the Admissions form.

Format

File name without.FMX

ALUMNI_​REQUIRED

Alumni Required

System

Purpose

Specifies whether support for alumni is required.

Format

TRUE or FALSE

ATTENDANCE_​IN_​USE

Attendance in use

System

Purpose

Specifies whether support for attendance entry is required.

Format

TRUE or FALSE

BASE_​CURRENCY

Base currency

System

Purpose

Specifies the base currency in which financial transactions are recorded.

Format

BASEDATA_​REQUIRED

BASEDATA Required

System

Purpose

Specifies whether basedata is required.

Format

TRUE or FALSE

CLEARING_​HOUSE

Clearing House

System

Purpose

Specifies the clearing house for admissions.

Format

UCAS (UK)

CAO (Ireland)

None

CONFERRING_​IN_​USE

Conferring in use

System

Purpose

Specifies whether conferring is in use.

Format

TRUE or FALSE

CONTACTS_​IN_​USE

Contacts in use

System

Purpose

Specifies whether contacts are in use.

Format

TRUE or FALSE

CURRENCY_​SYMBOL

Currency symbol

System

Purpose

Specifies the

Format

UTF-8 character – not the HTML entity e.g. £ (not &pound;)

DEREGISTER_​FORM

Deregister form

System

Purpose

Specifies the name of the Deregister form.

Format

File name without.FMX

ESF_​MAINTENANCE_​IN_​USE

ESF maintenance in use

System

Purpose

Specifies whether ESF maintenance is in use.

Format

TRUEFALSE

ESF_​REQUIRED

ESF Required

System

Purpose

Specifies whether ESF is required.

Format

TRUEFALSE

EXAM_​ENTRY_​TYPE

Exam Entry Type

System

Purpose

Specifies the exam entry type.

Format

FE_UK (UK)

NCEA (Ireland)

FDR_​TYPE

FDR type

System

Purpose

Specifies the further destination return type (Ireland only).

Format

HEAFDR

None

GIROS_​IN_​USE

Giros in use

System

Purpose

Specifies whether Giros are in use.

Format

TRUEFALSE

HEA_​REQUIRED

HEA required

System

Purpose

Specifies whether HEA is required (Ireland only).

Format

TRUEFALSE

ISCED_​IN_​USE

ISCED in use

System

Purpose

Specifies whether ISCED is in use.

Format

TRUEFALSE

ISR_​REQUIRED

ISR Required

System

Purpose

Specifies whether ISR is required.

Format

TRUEFALSE

LIBRARY_​SYSTEM

Library system

System

Purpose

Specifies the library system in use.

Format

Talis Library

Generic Library

M_​AND_​S_​IN_​USE

Marks & Standards in use

System

Purpose

Specifies whether marks and standards are in use.

Format

TRUE or FALSE

MAINTAIN_​STUDENT_​FORM

Student maintenance form

System

Purpose

Specifies the name of the Student Maintenance form.

Format

File name without.FMX

MEMBERSHIP_​IN_​USE

Membership in use

System

Purpose

Specifies whether membership is in use.

Format

TRUE or FALSE

MENTORS_​IN_​USE

Mentors in use

System

Purpose

Specifies whether mentors are in use.

Format

TRUE or FALSE

NCEA_​REQUIRED

NCEA Required

System

Purpose

Specifies whether NCEA is required.

Format

TRUE or FALSE

POSTGRADUATE_​REQUIRED

Postgraduade required

System

Purpose

Specifies whether postgraduates are required.

Format

TRUE or FALSE

QPLUS TIMETABLE_​IN_​USE

Timetable in use

System

Purpose

Specifies whether the QuercusPlus timetable is in use.

Format

TRUE or FALSE

REGISTER_​FORM

Register form

System

Purpose

Specifies the name of the Register form.

Format

File name without.FMX

RESIDENTIAL_​STATUS_​IN_​USE

Residential status in use

System

Purpose

Specifies whether residential status is in use.

Format

TRUE or FALSE

SHORT_​COURSE_​FORM

Short course form

System

Purpose

Specifies the name of the Short Course form.

Format

File name without.FMX

STUDENT_​ENQUIRY_​FORM

Student enquiry form

System

Purpose

Specifies the name of the Student Enquiry form.

Format

File name without.FMX

SYSTEM_​TYPE

System Type

System

Purpose

Specifies the system type.

Format

QPLUS

FE (UK)

Use FE only if a FE UK institution

TOKARIO_​IN_​USE

Takario in use

System

Purpose

Specifies whether Takario is in use.

Format

TRUE or FALSE

Note: the parameter name is TOKARIO_IN_USE

UFI_​IN_​USE

UFI in use

System

Purpose

Specifies whether UFI is in use.

Format

TRUE or FALSE

WBL_​IN_​USE

WBL in use

System

Purpose

Specifies whether WBL is in use.

Format

TRUE or FALSE

QuercusPlus Menu

Parameter

Description

Group

CUSTOM_​FIELD_​1-3_​TYPE/

CUSTOM_​FIELD_​1-3_​CODE

Custom FIELD1-3 type

Purpose

These parameters determined what optional fields (in addition to the mandatory fields) will appear in the upper section of the QuercusPlus Student’s screen.

You can display three notes or reference numbers in these fields. For each field you enter:

NOTE or REF_NUMBER in the Value field of the CUSTOM_FIELD_n_TYPE parameter

the reference number type or note type in the Value field of the corresponding CUSTOM_FIELD_n_CODE parameter

Format

To view the list of valid Note types go to

CLASSIC INTERFACE > RECORDS > STATIC DATA MAINTENANCE > Note Types

To view the list of valid Reference Number types go to

CLASSIC INTERFACE > RECORDS > STATIC DATA MAINTENANCE > Reference Number Types

In the screenshot example (callout 1) the Fees Note and Exam Entry Special Requirements fields display notes; the UCAS Personal ID field displays a reference number.

AMENDMENT_​EMAIL

Amendments admin email address

-

Purpose

Specifies the email addresses of individuals who should be notified when amendments are made to a student’s curriculum — e.g. de-register a student from a course, transfer a student to a course.

Format

A semi-colon delimited list of email addresses of users to be notified of amendments made.

DEFAULT_​EMAIL

Default email address

-

Purpose

These parameters determine whether a student’s default Email, Phone and Mobile fields’ contact numbers (callout 1 in the screenshot) will derive from the home, term or work values.

Format

If you want the Phone field to show the term phone number you enter TERM in the DEFAULT_PHONE Value field.

The options for all three parameter values are HOME, TERM or WORK.

All three fields can be set to different values.

DEFAULT_​MOBILE

Default mobile number

-

DEFAULT_​PHONE

Default phone number

-

EMAIL_​FROM_​ADDRESS

Email From Address

-

EML_​01 – EML_​20

Email 01 – Email 20

-

HOME_​ADDRESS

Use home address

-

Purpose

Shows or hides the Home address on the QuercusPlus Students Contacts tab.

In QuercusPlus the Students Contacts tab displays contact information for the student.

By default the tab shows home, term, work and mailing addresses. You can show or hide any of the addresses by changing the HOME_ADDRESS, WORK_ADDRESS, TERM_ADDRESS or MAILING_LABEL parameters. The example in the screenshot above has the work address hidden.

Format

TRUE — show the home address

FALSE — hide the home address

LOGO.PRINT

Institution Logo (Print)

-

Logo of the institution for printed letters (JPG or GIF format).

MAILING_​LABEL

Use mailing label

-

Purpose

Shows or hides the mailing address on the QuercusPlus Students Contacts tab.

Format

TRUE — show the mailing address

FALSE — hide the mailing address

See HOME_ADDRESS

MSG_​01 – MSG_​20

Messages 01–20

-

STUDENT_​IMAGE

Display student image

-

Purpose

Enables the display of students’ photos in listings if set to TRUE.

Format

TRUE

FALSE

TERM_​ADDRESS

Use term address

-

Purpose

Shows or hides the term address on the QuercusPlus Students Contacts tab.

Format

TRUE — show the term address

FALSE — hide the term address

See HOME_ADDRESS

USE_​CHANGE_​OWN_​PASSWORD

Use Change Own Password

-

Purpose

Allows users to change their own passwords if set to TRUE.

In the My Profile screen below, the CHANGE MY PASSWORD link in the right-hand TASKS list is displayed because USE_CHANGE_OWN_PASSWORD is set to TRUE.

Format

TRUE — users can change their passwords

FALSE — users cannot change their passwords

USE_​PERSON_​INDICATORS

Use Person Indicator

-

Purpose

Specifies whether or not you are using person indicators. Person indicators is the name for a variety of data categories used for administrative and reporting purposes.

This parameter also has the effect of enabling or disabling the Personal tab on the Students screen (see callout 1 above).

Similarly, the Notes tab is enabled or disabled by the USE_PERSON_NOTES parameters (below). Other, corresponding functionality, such as the ability to maintain indicators and notes is also enabled or disabled.

Format

TRUE — enable the use of indicators

FALSE — disable the use of indicators

USE_​PERSON_​NOTES

Use Student Notes tab

-

Purpose

Specifies whether or not you are using person notes.

Notes have a variety of uses within the Quercus suite — in general they are used to enable or disable particular functionality for students who have a note of a particular type attached to their record.

If set to FALSE the Notes tab will not appear on the Students screen (see USE_PERSON_INDICATORS, above).

Format

TRUE — enable the use of person notes

FALSE — disable the use of person notes

USE_​STUDENT_​AMENDMENT
_​REQUEST

Use Student Amedment Request

-

Purpose

Option to define if the institution wants to use the amendment request functionality. This allows users send amendment emails regrading student course registration.

Format

TRUE — use request functionality

FALSE — do not use request functionality

WORK_​ADDRESS

Use work address

-

Purpose

Shows or hides the work address on the QuercusPlus Students Contacts tab.

Format

TRUE — show the work address

FALSE — hide the work address

See HOME_ADDRESS

Quercus Control Centre Parameters Reference

Introduction

Parameter reference