Difference between revisions of "CGI Setup"

From CrossRoad
Jump to: navigation, search
(→‎Faculty Services)
(→‎= Student Registration Review/Approval)
Line 602: Line 602:
 
=== Faculty Services ===
 
=== Faculty Services ===
  
−
==== Student Registration Review/Approval ===
+
==== Student Registration Review/Approval ====
 
<table border=1 cellspacing=0 cellpadding=0>
 
<table border=1 cellspacing=0 cellpadding=0>
 
<tr><td valign="top">ADVISCMT.REL</td><td valign="top">Commlog category for advising comments</td></tr>
 
<tr><td valign="top">ADVISCMT.REL</td><td valign="top">Commlog category for advising comments</td></tr>

Revision as of 17:34, 4 February 2011

Setting up CGI Services for CrossRoad

This is a brief overview of the setup for CGI services for CrossRoad, including Services for Students, Services for Faculty, and Electronic Applications.

General process

  1. Setup underlying OS. This can be Windows 2000, or 2003.
  2. Install Apache.
  3. Apache runs under a particular Win2K user. Ensure that this user can:
    1. Connect to the network which has the Advantage Database Server on it
    2. Can see the folders which hold the data for CrossRoad
    3. Has appropriate rights to the cgi-bin folder under Apache.
  4. Install a certificate and change apache’s settings to enable SSL. All of CrossRoad’s CGI processes expect https: calls.
  5. Use the CGISetup.exe to install the various CGI programs, images and javascript files.
  6. In the cgi-bin folder add a text file called webini.txt. The contents of that should be a UNC path to the folder that holds the current CrossRoad databases.
  7. In the current data folder ensure that three data tables and associated support files exist: webini.dbf, relfile.dbf (relfile.ntx), and htmlfile.dbf (htmlfile.dbt, htmlfile.ntx).
  8. Correctly populate webini.dbf. It uses only record numbers to refer to data, and these are outlined below. Note that this is probably best edited with the DBU utility.
  9. Correctly populate relfile.dbf. Relfile grants access to many different aspects of these services. These are outlined below. This can be edited with the EAS program that is installed with CrossRoad.
  10. Correctly populate htmlfile.dbf. This provides quite a bit of html text that is used by these services. The kind’s of contents are outlined below. This can be edited with the EAS program that is installed with CrossRoad.
  11. Ensure that subsidiary databases that support the on-line application system are available and up to date. Most of these are directly maintained in CrossRoad but some are outside. There are WEBDATES.DBF CCINVAL.DBF MINORS.DBF WEBAID.DBF. These are described below.

Webini.dbf Contents

The sample below indicates the contents as used by King’s. Note that EAS refers to the on-line application system.

LINEDESCRIPTIO
\\kingsnet\reg\apps\sis\dbf.mm\ Current Database location
\\kingsnet\reg\apps\sis\arc.mm\ ArchiveDatabase location
https://registry.kingsu.ca/cgi-bin/login.exe Student login URL
https://registry.kingsu.ca/kinglogo.gif Institution Logo URL
https://registry.kingsu.ca/cgi-bin/weblkup.exe? Student Advising Available Courses URL
https://registry.kingsu.ca/cgi-bin/webadvis.exe Faculty Advising URL
C- Threshold Mark for inclusion in major for transfer credit
https://registry.kingsu.ca/cgi-bin/webadvis.exe Faculty Advising URL
https://registry.kingsu.ca/cgi-bin/weblkup.exe? Faculty Advising Available Courses URL
https://registry.kingsu.ca/cgi-bin/mainmenu.exe Student Mainmenu

<a href=mailto:registrar@kingsu.ca>The Registry @ 465-8330</a>		 Trouble mailto setting
https://registry.kingsu.ca/cgi-bin/classlst.exe Faculty Classlist URL
https://registry.kingsu.ca/cgi-bin/easkuc_a.exe EAS Admissions URL
https://registry.kingsu.ca/cgi-bin/easkuc_r.exe EAS Rez URL
https://registry.kingsu.ca/cgi-bin/easkuc_f.exe EAS Financial Aid URL
http://luke.kingsu.ca/cgi-bin/easkuc_s EAS Submissions URL
http://luke.kingsu.ca/cgi-bin/easkuc_m EAS Menu URL
http://www.alis.gov.ab.ca/cgi-bin/eas_main.pl EAS Main Callback URL
Glenn.Keeler@kingsu.ca,Registry.EAS@kingsu.ca EAS Applications Email Addresses
Registry.EAS@kingsu.ca,Glenn.Keeler@kingsu.ca EAS Rez Applications Email Addresses
glenn.keeler@kingsu.ca,Registry.EAS@kingsu.ca EAS FinAid Applications Email Addresses
http://luke.kingsu.ca/eas/easkucerr.html EAS Error Url
1~2~ Web Advising "<st1:place w:st="on">Normal</st1:place>" Terms
300 Web Advising Senior Course Threshold
3.5 Web Advising With Distinction GPA
http://luke.kingsu.ca/cgi-bin/CGImail Email handler for address changes
x:\apps\pmail\winpm-32
mailgate1.kingsu.ca Email server for CrossRoad on the Road
admissions@kingsu.ca Enrollment Services Email for CrossRoad on the Road
registrar@kingsu.ca Email address for address changes
https://registry.kingsu.ca/cgi-bin/WebReg.exe URL for Web Registration
registrar@kingsu.ca Web Registration Email Address
https://registry.kingsu.ca/cgi-bin/WebAdvis.exe Student Advising URL
https://registry.kingsu.ca/cgi-bin/ChgFPW.exe Web Password Change URL
https://registry.kingsu.ca/cgi-bin/FacMenu.exe Faculty Menu
https://registry.kingsu.ca/cgi-bin/WebReview.exe Faculty On-line Registration Review and Approval
registrar@kingsu.ca From Address for most communication
registrar@kingsu.ca Academic Warning Address
https://registry.kingsu.ca/cgi-bin/CourseEval.exe Course Evaluation URL
\\kingsnet\app\apps\evalsys\ Course Evaluation File Path
https://registry.kingsu.ca/cgi-bin/WebContact.exe New Advisee Contact URL

Relfile.dbf Contents

Here are the contents of this file. Entries appear in the file in the order of the RELFILE field, but below are grouped by applications that are affected.

Application Related

Admission Application


ADMFEE.REL
2006/0750.00;2007/0850.00~2006/07100.00;2007/08100.00~2006/07100.00;2007/08100.00~


This field specifies the application fee based on year applied for. The structure is that the first set is the standard fee (years are distinguished by semi-colons) the second is the late application fee, and the third is the

international application fee.

ADMTAB.REL


NM|Name~AD|Address~EM|Emergency Contact~BG|Biographical~HS|High School~L30|Grade 12 Courses~PS|Previous Post-Secondary~KUC-1|Program Information~KUC-4|Further

Information~KUC-2|Reference~KUC-3|Declaration~KUC-5|Payment~


This determine which tabs from the application process are available. The coded name appears

before the pipe character with the display name after that.

APPLDDAT.REL
2006/072:20070112~2006/073:20070501~2006/074:20070525~2007/081:20070815~2007/082:20071201~


These are the

deadeline dates for each year and term.

APPLDEAD.REL


Fall Term 15 August~ Winter Term 12 January~BEd Applications 2007/08 will release

decisions on approximately 31 March 2007 and 15 May 2007.~


This is a text statement of the application dates for fall,winter and a special statement.

This would need to be customized for users other than King’s.

APPLIC.REL
2006/073~2006/074~2007/081~


This is a

definition of the available application year and terms.

APPLNOTE.REL


This allows the insertion of a special note about applications, such as the extension of a

deadline.

CARDTYPE.REL


MASTERCARD|MasterCard~VISA|Visa~CHEQUE|Cheque to be mailed~FUNDSTRANSFER|Funds Transfer~INPERSON|Will pay in person at

TKUC~


These are the definitions of acceptable payment types, with the code followed by a pipe

character followed by the text displayed.

LANGREQ.REL


TOEP|TOEFL (paper-based version)~TOEC|TOEFL (computer-based version)~TOEI|TOEFL iBT (internet based)~MELA|MELAB~IELT|IELTS~ASPE|ASPECT~ELTC|The English Language Training College Program with a score of 9~EN30|Alberta English 30~IBHL|International Baccalaureate Higher Level English~APEN|Advanced Placement English~HERE|I have three years of formal full-time study in Canada or at an approved institution outside Canada as outlined above~TKUC|I have already taken TKUC's ENGL204 or 205~KEST|I am requesting the King's English

Language Studies Assessment Test~


This defines the

acceptable English proficiency demonstrations.

SOURCE.REL


BILLBOARD|Billboard Ad~FACSTAFF|Faculty or Staff Member~FAMILY|Family~FRIEND|Friend~NEWS|News coverage~ALUM|Previous King's Student~PRINT|Print Ad~RADIO|Radio or TV

Ad~SCHOOL|School Contact~INTERNET|Internet~


This defines the

accepted categories for the responses to the “I first heard about” question.

SPECIAL.REL


This allows the

definition of “Special” programs. Currently unused.

SPECTERM.REL


This defines valid

terms for the special program.

STDSTAT.REL
FT|Full-Time~PT|Part-Time~VS|Visiting~SS|Unclassified~


This defines the

possible student status types for the application.

SUBAPPS.REL


AIDAPP|Financial

Aid*~EMPAPP|Campus Employment*~MUSAPP|Music~APPATH|Athletics~


This defines

additional applications that can be requested.

REQMINOR.REL


BA4

ENVS~BSC4ENVS~


This defines

programs that has a required minor.

Residence Application


CLUBS.REL


ISA|International Student's Association~MSA|Mature Student Association~AAA|Action and Awareness Club~TKK|The King's Keepers/The Environmental Club~KEA|The King's Education Association~KGH|The King's Hands~KPH|The King's Players/Drama Club~KHC|TKUC Hockey Club~KMS|TKUC Men's Soccer Club~KWS|TKUC Women's Soccer Club~PHC|The Philosophy Club~PSC|The Political Studies Club~PYC|The Psychology Club~PSP|The Peer Support Program~SCC|The King's Science Society~SSC|The Snowboarding/Ski Club~IFC|The International Films Club~LDC|Liturgical

Dance Club~


This defines the

various student clubs that might be selected on the residence application.

MEALPLAN.REL


BASIC|Basic ($2600 deposit per year)~OPT1|Limited ($2200 deposit per

year)~APT1|Apartment, no meal plan required~


This defines the

available mealplans.

OCCUPANC.REL


2F|Tower Full Year Double occupancy : ($2200 for the full year)~1F|Tower Full Year Single occupancy : ($4000 for the full year)~6F|Apartment Full Year occupancy : ($2400 for the full

year)~


This defines the

available occupancies.

REZDEAD.REL
15 August


This defines the text

for the application deadline.

REZFEE.REL
2004/05400.00~2005/06400.00~2006/07400.00~2007/08400.00~


This defines the

required deposit by year of application.

REZINTER.REL


T|Team sports (volleyball, basketball, soccer, etc)~E|Extreme sports (mountain biking, snowboarding, skiing, etc)~M|Music~C|Computers~R|Reading and

Writing~O|Outdoor activities (hiking, camping, etc)~


This defines the

different interests that might be selected on the residence application.

REZMUSIC.REL


A|Alternative~P|Punk/ska~C|Country~H|Heavy

metal~L|Classical~J|Jazz~O|Pop~X|I am tolerant of all types of music~


This defines the

different

Financial Aid


FINAID.REL
01/02/2007~31/03/2007~


This defines the

period during which applications for financial aid will be accepted.

FINSTMT.REL


XTNCMT|Statement of Christian Commitment
Speak of your commitment to Christianity or your faith. What does your faith mean to you?~INVOLV|Statement of Involvement in University Activities
Tell the effect you have had on the King's student community in past years of study. What activities have you been involved in?~MUSICACH|Statement of Musical Achievement
Speak of your musical achievements, including all awards, recognition, honours and activities.~DISABILITY|Statement of Disability
In order to award the Mephiboschet Scholarship, the awarding committee must be aware of your condition and its limitations on your studies.~STEWARD|Statement of Commitment to Stewardship of God's Creation
Tell of your commitment to the environment and its stewardship. Have you beeninvolved in environmental programs in your community? Have you implemented any programs to increase/impact stewardship?~CAREERINT|Statement of Career Intent and/or Activities Post-Graduation
Explain your plans after graduation. What will you be doing with the degree you will receive from The King's <st1:place w:st="on"><st1:PlaceType w:st="on">University</st1:PlaceType> <st1:PlaceType w:st="on">College</st1:PlaceType></st1:place>?~GRADINT|Statement of Graduation Intentions
What are your goals for your studies? Do you intend to graduate from The King's <st1:place w:st="on"><st1:PlaceType w:st="on">University</st1:PlaceType> <st1:PlaceType w:st="on">College</st1:PlaceType></st1:place>? Will you further your studies elsewhere?~MRWCRS|List of Courses taken through ADLC
Please list high school courses you have taken through the

Alberta Distance Learning Centre.~


This defines the code and the text description of the various possible statements that might

be requested.

Student Services

There are several sub services here. The items are clustered by those services.

STUMENU.REL FINALEXAM~MARKS~ADVISOR~ACCOUNTS~CHANGEADDRESS~REGISTER~COURSEEVAL~ These items define the various possible student menu entries. At the time of the writing of this document the options are (*d items are in development):


REGISTER = What Am I Registered In? and On-line Registration
FINALEXAM = What is My Final Exam Schedule?
MARKS = What are My Marks?
ADVISOR = Program Advisor Report
ACCOUNTS = What is the status of my Account?
CHANGEADDRESS = Change Address Information
COURSEEVAL = On-line Course Evaluation
TRANREQ = Request your Academic Transcript
LETTERREQ = Request a letter of confirmation
*PROGCHANGE = Request a change in program
TUTORREQ = Request a tutor
TAXRECEIPT = Retrieve T2202A
WEBDOX = Retrieve important documents released to the student
WEBAPPTyyyy/yyt = Make a confirmation appointment for a specific year and term
SEATyyyy/yyt = CUC ONLY seat reservation for a specific year and term
ADRPyyyy/yyt = CUC ONLY add/drop available for a specific year and term
CUCBUD = CUC ONLY budget submission
CONFyyyy/yyt = On-line confirmation of registration for a specific year and term
DECyyyy/yy = Student Contractual Obligations for a specific year
REZLEASEyyyy/yy = Accept Residence Lease Agreement for a specific year
Note that the items with a specific year and term generally disappear once the student has completed the activity



Reminders

CHECKLST.REL REG2010/112~DEP2010/11~REZ2010/11~FIN2010/11~JOB2010/11~DEC2010/11~WEBAPPT2010/112~ REGyyyy/yyt Registration reminder for a specific year and term

DEPyyyy/yy Tuition Deposit reminder for a specific year
REZyyyy/yy Residence application reminder for a specific year
FINyyyy/yy Financial Aid application reminder for a specific year
JOByyyy/yy Campus Employment application reminder for a specific year
DECyyyy/yy Student Contractual Obligations reminder for a specific year
WEBAPPTyyyy/yyt Registration Confirmation appointment reminder for a specific year and term
REZLEASEyyyy/yy Acceptance of Residence Lease for a specific year and term
Note that these items only appear if the student still needs to complete them.

What are my Final Exams?


FINAL.REL
2006/071~2006071~2006072~2006/072~


This is a tilde delimited list of final exam schedules that have been released to be seen

through web services.

What are my Grades?


MARK.REL
2004054~2004053~2005061~2005062~2005063~2005064~2006071~2006072~


This is a tilde delimited list of the grades that have been released to be viewed through

these services.

On-line Registration


REGISTER.REL
2006/073~2006/074~2007/081~2007/082~


This is the tilde delmited list of terms open for registration. This should be set when a term is ready for registration and not removed until after the withdraw deadline

at least.

CONFIRM.REL
2006/073~


This is the tilde delimited list of terms for which a student may confirm registration (that

is, have the charges made against the accounts receivable account).

NOAUDIT.REL
*~


This defines course codes (using wildcards) for courses that cannot be audited. As written

in the example, no courses may be selected for audit.

NODROP.REL
INST*~ENGL2*~


These are courses which may not be dropped on the web –

usually theses are mandatory courses for all students.

On-line Course Evaluation


CRSEVCRS.REL
PSYC492*~


This states the

courses, using wildcards, that are available for evaluation.

CRSEVYR.REL
2006/072~


This is the list of terms available for evaluation. Normally only one term would be entered

here at a time.

Alumni Services

Faculty Services

Student Registration Review/Approval

ADVISCMT.RELCommlog category for advising comments

Class Lists/Grade Submission


ACADWARN.REL
2006/072~


This “releases” a term or terms to have instructors issue academic warnings for individual

students.

WARNCAT.REL


This defines the

communication log category for academic warnings.

GRADESUB.REL


This “releases” a

term or terms to have instructors submit grades.

MARKSAU.REL
AU~


This defines

grades for audit registrations.

MARKSCR.REL
A+~A~A-~B+~B~B-~C+~C~C-~D+~D~F~


This defines

grades for credit registrations.

MARKSMT.REL
M~


This defines

grades for midterm courses (ie the first half of full year courses).

MARKSNC.REL
N~


This defines

grades for non-credit registrations.

MARKSPA.REL
PA~FA~


This defines

grades for pass/fail courses.

MTCRS.REL
BIOL395~BIOL495~BIOL497~CHEM395~CHEM495~CHEM497~ENGL398~ENGL498~MUSI376~THEO376~


This defines

courses that should be marked as mid-term.

PFCRS.REL
INST200~INST210~INST300~INST310~INST400~INST410~BIOL395~BIOL495~EDUC305~ENVS490~


This defines

courses that should be marked pass/fail.

New Advisee Contact


WEBCONT.REL
2007/081FA~IA~


Defines the term applied for and the file status codes that determine which advisees appear on

the list for faculty to contact.

Web Payment

ADMITFEE.RELDefines admission fee in webpay
ATHLCAMP.RELDefines athletics camp fee in webpay
DONACODE.RELDefines donation code in webpay (deprecated)
DONATION.RELDefines donation "fee" in webpay
GRADFEE.RELDefines grad fee in webpay
LIBFINE.RELDefines library fine in webpay
LIBLIMIT.RELDefines the "lost book" limitation in webpay
PAYPURP.RELDefines the various payment items that may be selected in webpay
REZDEP.RELDefines the residence deposit in webpay

Htmlfile.dbf Contents

Htmlfile contains a number of html formatted fragments for insertion at various points for on-line services. These have no <head> or <body> tags, but are otherwise correct html.

EAS Admission Related

Note that this is deprecated with Apply Alberta coming on-line


HTMLFILEMeaning
StdDecl.htmDeclaration for Admission Applications

BEdDecl.htm
Declaration for King's BEd applications

FinDecl.htm
Declaration for Financial Aid Application

RezDecl.htm
Declaration for Residence Application

StdRec.htm
Personal Recommendation

BEdRec.htm


Personal Recommendation for BEd

Applications

LangReq.htm
English language proficiency statement

SupDoc.htm


List of supporting documents required for

application

Redirect.htm
Redirection to institutional homepage

ApplProc.htm
Application Procedure statement

RezApp.htm
Residence Applicant introductory text

FinApp.htm


Financial Aid Application Procedure

statement

RezAddr.htm


Application Address for Residence

Applications

RegAddr.htm


Application Address for Admission

Applications

MarkList.htm


Text describing offer of notification when grades are released (requires that the institution run such an email

list).

CalUrl.htm
HREF for the Academic Calendar on the Web

CalFnUrl.htm


HREF for Financial Aid information on the

web

FacMenu.htm
Faculty Menu static text and links

RezChoic.htm
Residence choice listing

RegnoteX.html

These are htmlized versions of the RegnoteX.rtf files that are used by windows CrossRoad. They are appended to course/fee sheets produced by on-line registration. Conversion utilities can be recommended by Keeler Services.

Retrieved from "https://registry.kingsu.ca/mediawiki/index.php?title=CGI_Setup&oldid=571"