View source for Importing Properties and Demographics

= Importing Properties and Demographics =

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

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

'''Important:''' Values must be defined in <code>property.csv</code> before they can be assigned to students in <code>propertyuserbyid.csv</code>. Upload <code>property.csv</code> 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:

<pre>
Property,{KeyID},{Key},{ValueID},{Value}
</pre>

=== Example ===

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

=== Field Reference ===

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

=== 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:

<pre>
propertyuserbyId,{UserID},{KeyID},{ValueId}
</pre>

=== Example ===

<pre>
propertyuserbyId,"K9999999","RACE","BL"
propertyuserbyId,"K9999999","LEVEL","UG"
propertyuserbyId,"K9999999","RESIDENT","R"
</pre>

=== Field Reference ===

{| class="wikitable"
! Position !! Field !! Description !! Notes
|-
| 1 || Record type || Literal value: <code>propertyuserbyId</code> || Hardcoded; same on every row
|-
| 2 || UserID || Student's unique identifier || Must match a UserID in <code>user.csv</code>
|-
| 3 || KeyID || Property group identifier || Must match a KeyID defined in <code>property.csv</code>
|-
| 4 || ValueId || Coded value to assign to the student || Must match a ValueID defined under the given KeyID in <code>property.csv</code>
|}

=== 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 <code>property.csv</code> or the record will not be processed.
* UserID must match a user already in RCampus.

==See Also==
*{{Import see also}}