How to add clearance checks
Clearance checks are defined by the reference data Clearance check type. Clearance check types must have In use selected for the clearance check to be available.
On adding a clearance check type, you must select the clearance check category that defines where the clearance check is used and whether the clearance check is visible on the applicant portal. For example, clearance checks with the category Conditional offer evidence require evidence to be uploaded by applicants to meet the requirements of a conditional offer.
On Admissions settings, go to Reference data and then Applications and then Clearance check type. Then, select and define the following:
Unique value, such as FSQ, that must not exceed the maximum length of the corresponding field in an integrated system, such as a student management system.
After saving, the value cannot be edited.
Description that is used to select clearance checks, such as Fee status questionnaire, and full description that is used for administrative purposes only.
The description can be translated.
Defines where the clearance check is used and whether the clearance check is visible on the applicant portal.
After saving the clearance check, the clearance check type category cannot be changed.
The clearance check categories are as follows:
- Conditional offer evidence
-
Conditional offer evidence clearance checks define checks that require evidence to be uploaded by applicants to meet the requirements of a conditional offer. For example, to upload evidence of qualifications. Conditional offer evidence clearance checks are also used to define personalised offers. Clearance checks with this category are shown on the applicant portal.
After selecting the category Conditional offer evidence, you need to select whether the clearance check is a Document task or Non-tasked based then define the following:
-
Document task: select the Document placeholder to create and then enter the Applicant facing description.
-
Non-task based: enter the Applicant facing description.
-
- Other evidence
-
Other evidence clearance checks define checks that require the applicant to provide evidence for things that are not requirements of a conditional offer. For example, to upload evidence of their vaccination status. Clearance checks with this category are shown on the applicant portal.
After selecting the category Other offer evidence, you need to select whether the clearance check is a Document task or Non-tasked based then define the following:
-
Document task: select the Document placeholder to create and then enter the Applicant facing description.
-
Non-task based: enter the Applicant facing description.
-
- Internal
-
Internal clearance checks define checks related to the application that do not require action or evidence from the applicant. Clearance checks with this category are not shown on the applicant portal.
After selecting the category Other offer evidence, enter the Applicant facing description.
- Unknown
-
Attention.
Do not use. The category Unknown was the default category for clearance checks when categories were first added and should no longer be used.
- All clearance checks should now have a suitable category. If not, you must add clearance checks to replace the clearance checks with the category Unknown. Clearance checks with category Unknown are not shown on the applicant portal.
For clearance checks with the category Conditional offer evidence or Other evidence only.
The Document placeholder to create is a document type from the Documents reference data Document type, such as Passport. The document type GeneralOfferEvidence defines a document placeholder for general offer evidence.
To avoid a duplicate document placeholder being created, ensure that any workflows that create a document placeholder for the document type are removed.
Additional information about the documents that applicants need to submit to pass the clearance check, such as Upload a copy of a valid passport and ensure that the passport number and photo are clearly visible.
If defined, applicants can view the description by selecting for the document placeholder on the Documents page of the applicant portal.
The applicant facing description can be translated.
If selected, the clearance check is applied to all applications automatically when the applications are created.
Options to use the clearance checks for academic and financial clearance.
Not used.
If defined, the clearance check has a field with a label of the value prompt such as Amount.
If defined, the clearance check has a field with a label of the value of the notes prompt such as Add notes.
If defined, the clearance check has the toolbar with icons to add or edit the name and address , phone number , email address , and documents .
If defined, sets the required by date of the clearance check from the date the clearance check was added to the application.
Optional. Additional information about the clearance check for administrative purposes only.
If selected, the entity or field can have the value. If cleared after the value has been selected for the entity or field, the entity or field keeps the value. However, the value is no longer available for selection.