Importing Person Types

Overview

Person Types differentiate between the type of people that can be targeted within SS&E. An SS&E person record can be associated with multiple person types. Valid person types include:

  • Student
  • Prospect
  • Applicant
  • Staff
  • Faculty

Person Types will only import successfully into SS&E via the SIS Import process on the Person data feed when:

  1. The person type import setting (personTypeImportEnabled) in Application Administration is set to True.
  2. The person record in the person data extract import file includes a valid Person Type.

What happens when the Person Type Import setting is set to False?

  • When the Application Administration person type import setting (personTypeImportEnabled) is set to False, person type is determined by the roles displayed on each person record.

What happens when the Person Type Import setting is set to True?

  1. When the Application Administration person type import setting (personTypeImportEnabled) is set to True, every person record included in the Person data extract import file must have at least one valid person type.
  2. Otherwise, if a person record is not associated with any valid person types in the Person data extract import file, then the following Import Error will be created "If personTypeImportEnabled is true, each Person imported must have a PersonType."

What happens when the Person Type Import setting is set to True and a person record is importing with multiple valid/invalid person types?

Only person records that do not have any valid person types importing on the Person data feed will be filtered out of the SIS Import process. In addition, the system will log an Import Error explaining why the person was not imported successfully into SS&E.

However, if a person record is importing with multiple person types that include both valid and invalid person types, only the valid person type(s) will be assigned and display on the person record (in People Administration) within SS&E. In addition, the invalid person type(s) will trigger an import error.

  • A person record will import successfully into SS&E if at least one valid person type is included in the Person data extract import file.

Note: When importing person records, SS&E determines if the person type(s) included on a person record in the Person data extract import file is a valid person type by converting the personType value to an all lowercase string and checking if the results include any of the following person types: student, prospect, applicant, staff, faculty. All other person type values are invalid and will trigger an import error.

Invalid Person Type Import Error Example

The Person data extract (person.json) includes a person record that is importing the following PersonType value: ‘student::wrong::wrongagain’.

  • In this example, the above person record is associated with one valid and two invalid person types.
  • Here, the system will produce an Import Error, while successfully importing the person record with a Student Person Type.
  • In SIS Integration Administration, on the Import Errors page, the Person data feed will include the following error: "Invalid PersonType(s) found: wrong, wrongagain. Acceptable values are: student, prospect, applicant, staff, faculty"

The following screenshot displays four Person data feed Import Error records, the second and third records still successfully imported the person record with a student person type. The errors exist to troubleshoot any invalid person type values included in the Person data feed import.

2023-12-01 08_59_51-DEV - Student Success & Engagement_ 9.14.0 - Jira.png

 

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more
How to Contact Support
There are many ways to reach out! Click here for our support options.
Watermark Academy
Click to access the Watermark Academy for consultation, training, and implementation companion courses.