Importing Properties and Demographics

From RCampus Wiki
Revision as of 16:05, 6 May 2026 by Admin (talk | contribs) (Created page with "= Importing Properties and Demographics = Demographic data in RCampus is managed through two files that work together: * <code>property.csv</code> — defines the valid demo...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Importing Properties and Demographics

Demographic data in RCampus is managed through two files that work together:

  • property.csv — defines the valid demographic attributes and their allowed values (the lookup table).
  • propertyuserbyid.csv — assigns those attribute values to individual students.

Important: Values must be defined in property.csv before they can be assigned to students in propertyuserbyid.csv. Upload property.csv first if you are introducing new attributes or codes.

For a general explanation of how RCampus import files are structured, see Importing Data to RCampus.

File 1: property.csv

This file defines the demographic categories (called properties) and the valid coded values within each category. Examples of properties include race, academic level, residency status, and citizenship.

This file changes infrequently and is typically uploaded monthly or semi-annually rather than daily.

Record Format

Each row contains 5 fields:

Property,{KeyID},{Key},{ValueID},{Value}

Example

Property,RACE,Race,BL,"Black or African American"
Property,RACE,Race,WH,"White"
Property,LEVEL,Level,UG,"Undergraduate"
Property,RESIDENT,Resident,R,"Resident"

Field Reference

Position Field Description Notes
1 Record type Literal value: Property Hardcoded; same on every row
2 KeyID Property group identifier Examples: RACE, LEVEL, RESIDENT, CITIZENSHIP. This is the value referenced in propertyuserbyid.csv.
3 Key Human-readable label for the property group Typically the same as KeyID
4 ValueID Coded value from the SIS Examples: BL, WH, UG, R. This is the value referenced in propertyuserbyid.csv.
5 Value Description of the coded value Examples: Black or African American, Undergraduate

Key Points

  • Multiple rows share the same KeyID — one row per allowed value within that property group.
  • The KeyID and ValueID in this file are what you will reference when assigning demographics to students.
  • This file only defines the lookup table. It does not assign values to any student.

File 2: propertyuserbyid.csv

This file assigns demographic attribute values to individual students. Each row represents a single property assignment for one student. A student with multiple demographic attributes (e.g. race, level, and residency) will have one row per attribute.

This file is typically uploaded daily.

Record Format

Each row contains 4 fields:

propertyuserbyId,{UserID},{KeyID},{ValueId}

Example

propertyuserbyId,"K9999999","RACE","BL"
propertyuserbyId,"K9999999","LEVEL","UG"
propertyuserbyId,"K9999999","RESIDENT","R"

Field Reference

Position Field Description Notes
1 Record type Literal value: propertyuserbyId Hardcoded; same on every row
2 UserID Student's unique identifier Must match a UserID in user.csv
3 KeyID Property group identifier Must match a KeyID defined in property.csv
4 ValueId Coded value to assign to the student Must match a ValueID defined under the given KeyID in property.csv

Key Points

  • One row per property assignment. A single student will typically appear on multiple rows (one per demographic attribute).
  • Both KeyID and ValueId must already exist in property.csv or the record will not be processed.
  • UserID must match a user already in RCampus.

See Also