Admission Letter Parameters

The following, Admission System Letter Parameters, are available for Acknowledgment and Outcome Letters. Map Letter Parameters to the System Letter Parameter, including the Letter Parameter in the System Letter Definition (CORF2520). By including the Letter Parameter on the template, the required data from Callista will be displayed. See Admission Letter Template Production, for further advice. The column 'Usage in Standard Delivery Set' applies particularly to the parameters that return data from the rules system

System Letter Parameter

 Description

Returns

 Format

Usage in Standard Delivery Set

ADM_COURSE

Admissions Course Detail

PREFERENCE, COURSE CODE, SHORT TITLE, LOCATION, ATT. MODE, ATT. TYPE, YEAR For example,

1 M300 Bachelor of Commerce G F U 2004/2

Each field is separated by a Tab.

As determined by the values of each field

Must be included in every letter definition in CORF2520. Not necessary to use on template. Must also be included in every repeating group definition that includes course information, in letter definitions, in CORF2520.

ADM_CRS_CD

Admissions Course Code

COURSE CODE For example, M300

Up to 6 characters

 

ADM_CRS_TI

Admissions Course Title

COURSE TITLE

Up to 90 characters

 
ADM_LOC_D Location Description Return the LOC.DESCRIPTION for the LOCATION_CD derived from the ACAI record 60 characters Not used

ADM_RUL_1

Admissions Status and Completion Rule 1

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Used to return the appropriate text for the status of the acknowledgment or the offer. For example, returns the general acceptance advice or the general offer advise, as determined by the rules.

ADM_RUL_2

Admissions Status and Completion Rule 2

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_RUL_3

Admissions Status and Completion Rule 3

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Used to return whether or not an encumbrance of effect type 'revoke services' or 'suspend services' exists for the student.

ADM_RUL_4

Admissions Status and Completion Rule 4

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Used to return whether or not additional documentation is required. Uses the status of unsatisfactory or incomplete documentation.

ADM_RUL_5

Admissions Status and Completion Rule 5

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Used to return whether or not a fee assessment, exemption has been undertaken.

ADM_RUL_6

Admissions Status and Completion Rule 6

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_RUL_7

Admissions Status and Completion Rule 7

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_RUL_8

Admissions Status and Completion Rule 8

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Used to return additional instructions for offered/conditional offers and deferments.

ADM_RUL_9

Admissions Status and Completion Rule 9

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Used to return acceptance advice check boxes for offers/conditional offers.

ADM_RUL_10

Admissions Status and Completion Rule 10

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_RUL_11

Admissions Status and Completion Rule 11

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_RUL_12

Admissions Status and Completion Rule 12

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_RUL_13

Admissions Status and Completion Rule 13

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_RUL_14

Admissions Status and Completion Rule 14

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_RUL_15

Admissions Status and Completion Rule 15

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_RUL_16

Admissions Status and Completion Rule 16

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_RUL_17

Admissions Status and Completion Rule 17

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_RUL_18

Admissions Status and Completion Rule 18

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_RUL_19

Admissions Status and Completion Rule 19

PHRASE TEXT RELATING TO RULES FOR STATUSES AND COMPLETION

Up to 2000 characters

Not used

ADM_TA_AS Advanced Standing Total Approved Credit Points Return AS.TOTAL_EXMPTN_ APPROVED for the PERSON_ID, COURSE_CD, and VERSION_NUMBER derived from Advanced Standing based on the ACAI record in context As determined by the values of each field Not used
ADM_UD_AS Advanced Standing Unit Detail Return ASU.UNIT_CD and UV.SHORT_TITLE for the PERSON_ID, COURSE_CD, and VERSION_NUMBER - Derived from Advanced Standing, based on the ACAI record in context.  Rather than use a repeating group, return all results in a single block of text, with carriage returns between multiple records

UNIT_VERSION.UNIT_CD = 20 characters

UNIT_VERSION.SHORT_TITLE = 40 characters
Not used
ADM_ULD_AS Advanced Standing Unit Level Detail Return ASUL.CREDIT_POINTS and ASUL.UNIT_LEVEL for the PERSON_ID, COURSE_CD, and VERSION_NUMBER derived from Advanced Standing based on the ACAI record in context.  If the ASUL.UNIT_LEVEL character is a number, spell the number in words (e.g. 1 = One, 2 = Two, etc).  Rather than use a repeating group, return all results in a single block of text, with carriage returns between multiple records As determined by the values of each field Not used

ADM_UNIT

Admissions Unit Detail

UNIT CODE, SHORT TITLE, LOCATION, UNIT MODE, UNIT CLASS, COMMENCEMENT PERIOD, STATUS For example,

ALJ112 Comparative Journalism Studies G - D 2004/2 APPLIED

As determined by the values of each field

 

ADM_US_CD

Unit Set Code

THE CODE OF THE UNIT SET

Up to 10 characters

 

ADM_US_STI

Unit Set Short Title

THE SHORT TITLE OF THE UNIT SET

Up to 40 characters

 

ADM_US_TI

Unit Set Title

THE TITLE OF THE UNIT SET

Up to 90 characters

 

AGENT_ADDR

International Agent Name and Address

INTERNATIONAL AGENT NAME AND ADDRESS. E.g.

Mr John Stephens

1/121 Sunset Strip

New York 33333

As determined by the values of each field

 

AGENT_PH

International Agent Phone Numbers

ALL PHONE NUMBERS FOR AN INTERNATIONAL AGENT. Contains the field name and the field, separated by a Tab. For example,

Phone 0011 1 33 44444

Business Phone 0011 1 33 444

Fax 0105 1 33 44455

 

As determined by the values of each field

 

ALL_PHONE

All Phone Numbers From Correspondence Address

ALL PHONE NUMBERS FOR A PERSON.

Contains the field name and the field, separated by a Tab. For example,

Phone 0011 1 33 44444

Business Phone 0011 1 33 444

Fax 0105 1 33 44455

As determined by the values of each field

 

CHNG_PREF

Offer Change of Preference Date

FINAL DAY FOR CHANGE OF PREFERENCES

For example, 29/07/2004

DD/MM/YYYY

 

COMM_PERD

Admission Application Commencement Period

COMMENCEMENT PERIOD. For example,

2004/2

Up to 21 characters

 

CRICOS_CD

Course Version Cricos Code

THE CODE GIVEN TO A COURSE VERSION FROM THE COMMONWEALTH REGISTER OF INSTITUTIONS AND COURSES FOR OVERSEAS STUDENTS. - Multiple codes may be included in admission letters for a single course version. This occurs if multiple reference code types are mapped back to the system reference code type of ‘CRICOS’. Each value returned to the letter will be separated by a comma and a space. For example if three records were found the string returned will be of the form ‘ABC123, EFG456, HIJ789’.

Up to 240 characters

 
CRS_DUR Course Duration

Course duration must be calculated for both applicants with and without Advanced Standings. To calculate the course duration, the following information is required:

Get CRV.STD_FT_COMPLETION_TIME for a given COURSE_CD and VERSION_NUMBER. Note: A value of 30 corresponds to 3 years, i.e. STD_FT_COMPLETION_TIME / 10 = Course Duration in years (no need to calculate this yet though).

Get the Credit Points for the course with CRV.CREDIT_POINTS_REQUIRED.

Get Approved Credit Points for any Advanced Standing from AS.TOTAL_ EXMPTN_APPROVED for the course (rather than Granted, as at the time an Offer Letter is being generated, a Student Course Attempt won't exist, and this is required to Grant Advanced Standing). If no Advanced Standing record exists, this value should be zero.

Then perform the following calculation:

(((Credit Points for Course – Approved Credit Points)/Credit Points for Course) * (Course Duration/10)), rounded up to the nearest half or whole number.

Return the result of the calculation

Up to 10 characters Not used
CRS_END_DT Course End Date

To calculate the Course End Date, the following data is required:

  • Get the Course Start Date
  • Get the Course Duration.
  • Get the Academic Calendar Type derived from the AA record.

Then perform the following calculation:

Course Start Date + Course Duration = Actual Expected Course End Date

Then search the DAIV for Date Aliases nominated in each of the Completion Period Date Aliases Summer, Mid, and End. Then derive the previous Completion Period Alias Value before the Actual Expected Course End Date. (This will get the Alias Value as defined by the institution). e.g. Course Start Date = 01/03/2007, Course Duration = 2 years, and we have the Completion Period Alias Values S (Summer) = 31/01/2008, M (Mid) = 31/06/2008, and E (End) = 31/12/2008. Initially, Expected Course Date would be 01/03/2009.  However, when we derive the previous Completion Period Alias, we see that it is the 31/11/2008 – that’s when the student’s course finishes – not mid 2009.

Return the result of the calculation.

Up to 10 characters Not used
CRS_ST_DT Course Start Date

Using SACC.ADM_AGREED_STRT_DT_ALIAS and the AA.ADM_CAL_ TYPE and AA.ADM_CI_SEQUENCE_NUMBER (related to the ACAI record) – derive and return the DAIV.ALIAS_VAL

Up to 10 characters Not used

GIVEN_NAME

Preferred Given Name

PREFERRED GIVEN NAME For example,

Sarah

Up to 30 characters

 
GOVT_TA        
GTO_ADDR        
GTO_PHONE        
IND_CRSFEE Indicative Course Fees Return CAD.INDICATIVE_CRS_FEE for the COURSE_CD, VERSION_NUMBER, ADM_CAL_TYPE, and ADM_CI_SEQUENCE_ NUMBER derived from the ACAI record Up to 11 characters Not used
IND_HLTCRS Indicative Health Cover Course Duration

Get CAD.INDICATIVE_HEALTH_COVER for the COURSE_CD, VERSION_NUMBER, ADM_CAL_TYPE, and ADM_CI_SEQUENCE_ NUMBER derived from the ACAI record.

Get Course Duration taking Advanced Standing into consideration. Then perform the following calculation:

  • (Indicative Health Cover) * (Course Duration)
  • If Course Duration is greater than or equal to 24-months then apply a 10% discount.

Return the result of the calculation

Up to 11 characters Not used
IND_HLTHC Indicative Health Cover Annual Return CAD.INDICATIVE_HEALTH_COVER for the COURSE_CD, VERSION_NUMBER, ADM_CAL_TYPE, and ADM_CI_SEQUENCE_ NUMBER derived from the ACAI record Up to 11 characters Not used
IND_HLTHUS Indicative Health Cover Unit Set Duration

Get CAD.INDICATIVE_HEALTH_COVER for the COURSE_CD, VERSION_NUMBER, ADM_CAL_TYPE, and ADM_CI_SEQUENCE_ NUMBER derived from the ACAI record.

Get Unit Set Duration (in weeks).  If value is less than the equivalent of three months (13-weeks), then three months will still be charged as a minimum.

Then perform the following calculation:

  • (Indicative Health Cover) * (Unit Set Duration / 52)
  • If Course Duration is greater than, or equal to 24-months, then apply a 10% discount.

Return the result of the calculation

Up to 11 characters Not used
IND_USFEE Indicative Unit Set Fees

Return USAD.INDICATIVE_US_FEE for the UNIT_SET_CD and VERSION_ NUMBER derived from the ACAI record

Up to 11 characters Not used

INST_CD

Local Institution Code

THE CODE OF THE LOCAL INSTITUTION

Up to 10 characters

 

LET_TITLE

Letter Title

TITLE OF SYSTEM LETTER

For example, International Outcome Letter

Up to 200 characters

 

LETTERTEXT

Letter Text

LETTER TEXT as assigned to the parameter in CORF2510.

Up to 2000 characters

 

NAME_ADDR

Name and Address

CONCATENATION OF NAME AND ADDRESS (correspondence).

For example,

Ms Sally Jones

12 Gheringhap Street

North Shore NSW 2220

As determined by the values of each field

 
OSHC_ST_DT Overseas Health Cover Start Date

Take the override start date if it exists; otherwise use the derived start date

DD/MM/YYY  
OSHC_ED_DT Overseas Health Cover End Date

Take the override end date if it exists; otherwise use the derived end date

DD/MM/YYYY  
OSHC_DUR Overseas Health Cover Duration

The content of the duration will depend on the units of the duration display type. Depending on the display type used the duration will be displayed as either a week, month or year amount. If the override is used then that amount will be used otherwise it will be derived from the OSHC_ST_DT and OSHC_ED_DT amounts.

Whole Number  
OSHC_DUR_T Overseas Health Cover Duration Display Type

The units that the duration is to be displayed in:

  • Weeks
  • Months
  • Years.
   
OSHC_TYPE Overseas Health Cover Type

The type of Health Care. Usually ‘Single’ or ‘Family’ but is institution defined

   
OSHC_AMT Overseas Health Cover Amount

Use the override amount if it exists; otherwise use the derived amount

99990.00  
OSHC_CMT Overseas Health Cover Letter Display Comment      
OSHC_RATE Overseas Health Cover Letter Rate

Returns rate from ADMF03A0 based on duration.

   
OSHCCRS_CD Overseas Health Cover Course Code

If this is based on a SCA then use course code otherwise use the nominated_course_cd because it is based on an ACAI.

   
OSHCCRS_SD Overseas Health Cover Course Start Date

Take the course override start date if it exists; otherwise use the function to derive the start date

DD/MM/YYYY  
OSHCCRS_ED Overseas Health Cover Course End Date

Take the course override end date if it exists; otherwise use the function to derive the end date

DD/MM/YYYY  
OSHCCRS_DR Overseas Health Cover Course Duration

The content of the duration will depend on the units of the duration display type. Depending on the display type used the duration will be displayed as either a week, month or year amount. If the override is used then that amount will be used otherwise it will be derived from the OSHCCRS_SD and OSHCCRS_ED amounts.

Whole Number  
OSHCCRS_RT Overseas Health Cover Course Rate

Returns rate from ADMF03A0 based on duration.

   
OSHCCRS_AM Overseas Health Cover Course Amount

Take the override amount if it exists; otherwise use the derived amount

99990.00  
OSHCCRS_DT Overseas Health Cover Course Duration Display Type

The units that the duration is to be displayed in:

  • Weeks
  • Months
  • Years.
   

PERSON_ID

Person ID

PERSON ID NUMBER

For example, 98701020

Up to 10 digits

 

PHRASE

Phrase

PHRASE TEXT as assigned to the parameter in ADMF3900

Up to 2000 characters

 

RESP_DATE

Offer Response Date

THE FINAL DATE OF WHEN OFFERS MUST BE ACCEPTED/REJECT

DD/MM/YYYY

 

SALUT_FORM

Formal Salutation (Title Surname)

CONCATENATION OF TITLE AND SURNAME. For example,

Ms Jones

As determined by the values of each field

 

T_CS_NM_AD

Title Case Name and Address

THE STUDENTS TITLE, NAME AND ADDRESS

As determined by the values in each field

 

TAC_ID

Person TAC ID Number

TERTIARY ADMISSIONS CENTRE IDENTIFICATION NUMBER

Up to 20 characters

 
TCI        
US_DUR Unit Set Duration

Returns USAD.US_DURATION for a given COURSE_CD and VERSION_ NUMBER.

Note: No Advanced Standing is taken into account when calculating the Unit Set Duration

Up to three characters Not used
US_END_DT Unit Set End Date

To calculate the Unit Set End Date the following data is required:

Get the Course Start Date.

Get USAD.US_DURATION for the UNIT_SET_CD and VERSION_ NUMBER for the Unit Set Duration (in weeks), derived from the ACAI record.

Then perform the following calculation:

Course Start Date + Unit Set Duration = Unit Set End Date (and round up to the last Friday)

Return the result of the calculation.

Note: It is presumed that the Unit Set Duration value (manually calculated and entered by the institution in the USAD table), reflects a duration that includes the last Unit End Date of the Unit Set.

Up to 10 characters Not used

 

Last modified on 29 September, 2011 9:47 AM

History Information

Release Version Project Change to Document
13.1 1708 - Compliance Added new OSHC Letter Parameters
11.0.0.0.0.0 1460 ESOS Compliance 2008 Pt 1 Added new info for the CRICOS_CD parameter
10.1.0.0.0.0 1033 - Support Update with new parameters
10.1.0.0.0.0 C22318 Add sentence to reference to CORF2520