Overview

This setting determines whether Classter automatically evaluates and updates the Residence Permit requirement for each student, based on their assigned Nationality or Citizenship. When enabled, the system reads the configuration of the selected Nationality or Citizenship to decide whether a student is required to hold a Residence Permit — without any manual input from staff.

This automation reduces the risk of incorrect or missing data entry and ensures consistent application of the institution’s enrollment rules across all student records.

 

 

What This Setting Does

Setting label: The compulsory Residence Permit requirement at Student level will be automatically updated based on

This is a single-select setting with three options:

• None — No automatic update. The Residence Permit requirement must be set manually by staff for each student.
• Nationality — When a student’s Nationality is assigned or changed, the system checks whether that Nationality is configured as one that requires a Residence Permit. The student’s Residence Permit status is updated automatically.
• Citizenship — Same behavior as Nationality, but driven by the student’s Citizenship field instead.

The setting is configured per institution. Each institution in the system can have a different value.

 

 

Where It Is Used

This setting affects two areas of the application:

Student Demographic Profile (Staff View)

When a staff member opens a student’s demographic profile and assigns or updates the student’s Nationality or Citizenship, the system immediately evaluates the Residence Permit requirement.

• If the selected Nationality or Citizenship is configured as requiring a Residence Permit, the Residence Permit Status field on the student profile is enabled and ready for staff to complete (e.g., status, expiry date).
• If the selected Nationality or Citizenship is not configured as requiring a Residence Permit, the Residence Permit Status field is automatically set to ‘Not Required’ and locked. Staff cannot override this value manually.

 

Admission Form (Applicant Portal)

During the admission process, when applicants enter their Nationality or Citizenship in their personal data form, the same logic applies. When this setting is active (set to Nationality or Citizenship), the manual ‘Requires Residence Permit’ field is hidden from the form, since the system manages the requirement automatically based on the selected Nationality or Citizenship.

 

 

Business Logic / Behavior

How the Automatic Evaluation Works

Each entry in the Nationality and Citizenship dropdown lists has a configurable property that indicates whether holders of that nationality or citizenship are required to have a Residence Permit. This property is set by the institution’s administrator in the dropdown list configuration (Configuration > Dropdown Lists > Nationality or Citizenship).

When a student’s Nationality or Citizenship is assigned or changed, the following steps occur automatically:

• Step 1: The system reads the ‘Requires Residence Permit’ flag on the selected Nationality or Citizenship entry.
• Step 2: If the flag is enabled (the nationality or citizenship requires a Residence Permit), the Residence Permit Status field on the student profile becomes active and editable. Staff can then record the permit status and expiry date.
• Step 3: If the flag is not enabled (no Residence Permit required), the Residence Permit Status is automatically set to ‘Not Required’ and the field is locked.

 

Multiple Nationalities or Citizenships

If a student has more than one Nationality or Citizenship assigned, the system checks all of them. The Residence Permit Status field becomes active as soon as at least one of the assigned entries is marked as requiring a Residence Permit.

 

Manual Mode (Setting = None)

When the setting is set to ‘None,’ no automatic evaluation takes place. Staff must decide and set manually whether each student requires a Residence Permit. The Residence Permit Status field remains editable regardless of the student’s Nationality or Citizenship.

 

K-12 Mode vs. Higher Education Mode

There is no difference in the technical behavior of this setting between K-12 mode and Higher Education mode. The logic works identically in both configurations.

However, the business context differs:

• K-12 Mode (Higher Education configuration disabled): In a school environment, international students — and in some cases their parents or guardians — may be required to present Residence Permit documentation as part of enrollment. Institutions can configure non-local nationalities to automatically trigger the Residence Permit requirement for such students, reducing the chance of missing documentation.
• Higher Education Mode (Higher Education configuration enabled): Universities and colleges typically enroll larger numbers of international students from a variety of countries. Automating the Residence Permit requirement based on Nationality or Citizenship significantly reduces manual effort, prevents inconsistencies, and supports compliance with institutional enrollment and visa-tracking policies.

In both modes, the prerequisite is the same: the Nationality or Citizenship dropdown entries must be pre-configured to indicate which ones require a Residence Permit before this setting takes effect.

 

 

Examples

Example 1 — Automatic Requirement Triggered by Nationality (Setting = Nationality)

An institution has configured its Nationality dropdown so that the nationality ‘Arcadian’ (representing a non-EU country) is marked as requiring a Residence Permit, while ‘Novaean’ (representing an EU country) is not.

Scenario A: A staff member creates a new student profile and assigns the Nationality ‘Arcadian.’ As soon as the Nationality is saved, the Residence Permit Status field on the student’s demographic profile becomes active. The staff member can now record the permit status (e.g., ‘Active’) and enter the expiry date (e.g., 31/12/2026).

Scenario B: Another student is registered with the Nationality ‘Novaean.’ When the Nationality is saved, the Residence Permit Status field is automatically set to ‘Not Required’ and is locked. No further action is needed for that student.

 

Example 2 — Automatic Requirement Triggered by Citizenship (Setting = Citizenship)

The institution decides that Citizenship is a more accurate indicator of permit requirements than Nationality. An administrator configures the Citizenship entry ‘Veloran’ as requiring a Residence Permit.

A student whose Nationality is ‘Novaean’ but whose Citizenship is ‘Veloran’ will still have the Residence Permit Status field activated automatically, because the trigger is based on Citizenship in this scenario.

 

Example 3 — No Automation (Setting = None)

The setting is left at ‘None.’ When a new student is created, the Residence Permit Status field is always editable, regardless of their Nationality or Citizenship. Staff must manually review each student and decide whether a Residence Permit is required, entering the appropriate status where applicable.

 

When to Use

When to Set to Nationality or Citizenship

• Your institution enrolls students from multiple countries and some nationalities or citizenships require Residence Permits while others do not.
• You want to reduce manual data entry and eliminate inconsistencies in how the Residence Permit requirement is recorded across student records.
• The Nationality or Citizenship dropdown lists have already been configured with the ‘Requires Residence Permit’ flag for the relevant entries.
• You want to prevent staff from accidentally marking students as requiring — or not requiring — a Residence Permit contrary to their nationality or citizenship.
• You want the Admission form to handle the requirement automatically, without showing the manual toggle to applicants.

 

When to Leave on None

• Your institution does not deal with Residence Permit requirements, or all students are treated the same regardless of their Nationality or Citizenship.
• The Residence Permit requirement is managed on a case-by-case basis and cannot be reliably predicted from nationality or citizenship alone.
• The Nationality or Citizenship dropdown has not yet been reviewed and configured with the ‘Requires Residence Permit’ property. Enabling the automation before completing the dropdown setup will produce incorrect results.

 

Residence Permit Status Values

When the Residence Permit requirement applies to a student, the Residence Permit Status field on the student profile becomes editable. The following status values are available:

• Not Required — The student is not required to hold a Residence Permit (set automatically when the nationality or citizenship is not flagged as requiring one).
• Application — A Residence Permit application has been submitted but the permit has not yet been issued.
• Given — The Residence Permit has been issued and is valid.
• Rejected — The Residence Permit application was rejected.

 

Residence Permit Fields on the Student Profile

When a Residence Permit is required, the following fields are available in the Residence Permit section of the student’s demographic profile:

• Status — The current Residence Permit status (see values above).
• Number — The Residence Permit document number.
• Issue Date — The date the Residence Permit was issued.
• Expiration Date — The date the Residence Permit expires. This date is also importable and exportable via the Mass Import / Update Students tools.
• Issuing Authority — The authority that issued the Residence Permit.

 

Notes

Related Settings

• Students will automatically be flagged as Foreigner based on (Main Settings > General Settings > Student Form — Students_Will_Be_Flagged_As_Foreigner_Based_On): Works with the same mechanism and the same options (None / Nationality / Citizenship). It automatically sets the ‘Foreigner’ flag on the student record based on the Nationality or Citizenship configuration. The two settings are independent but complementary — an institution may use one, both, or neither.

Pre-requisites

• Before activating this setting (selecting Nationality or Citizenship), ensure that the Nationality or Citizenship dropdown lists have been reviewed and that the ‘Requires Residence Permit’ flag is correctly set for all relevant entries. Go to Configuration > Dropdown Lists and edit each applicable Nationality or Citizenship entry. The automation produces incorrect results if the underlying data is incomplete or inaccurate.
• Students must have their Nationality or Citizenship field populated in their demographic profile for the automatic update to be triggered. Students with no Nationality or Citizenship assigned are not affected by this setting.

 

Impact on Existing Records

Changing this setting does not retroactively update existing student records. The automatic evaluation is triggered only when a student’s Nationality or Citizenship is modified after the setting has been activated. For existing student populations, a review of records may be needed when switching from ‘None’ to ‘Nationality’ or ‘Citizenship.’

 

Per-Institution Configuration

This setting is configured independently per institution (per company). In systems managing multiple institutions, each institution can have a different value for this setting without affecting the others.