Difference between revisions of "Import Utility"

From RCampus Wiki
Jump to: navigation, search
m
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
The import utility helps with integration or manually importing users, courses and classes, enrollments, demographics, programs, etc. Available in [[RCampus - Enterprise Edition|Enterprise Edition]] only.
 
The import utility helps with integration or manually importing users, courses and classes, enrollments, demographics, programs, etc. Available in [[RCampus - Enterprise Edition|Enterprise Edition]] only.
  
 +
= Importing Data to RCampus =
 +
 +
RCampus supports importing student, demographic, and program data from an institution's Student Information System (SIS). This allows assessment results to be analyzed and reported by student characteristics and academic program.
 +
 +
== Import Methods ==
 +
 +
Data can be delivered to RCampus in two ways:
 +
 +
; Automated (Panda SFTP Integration)
 +
: Files are exchanged on a scheduled basis between the institution's SIS and RCampus over a secure SFTP connection. RCampus publishes a list of students it expects data for, and the institution responds with the appropriate files. See [[Panda SFTP Integration]] for connection and scheduling details.
 +
 +
; Manual Upload
 +
: CSV files can be uploaded directly through the RCampus administrative interface. The same file formats and field rules apply regardless of delivery method.
 +
 +
== How Import Files Are Structured ==
 +
 +
All RCampus import files are plain CSV (comma-separated values) files. They share a consistent structure across all file types:
 +
 +
* '''No header row''' — the first line is always a data record.
 +
* '''Record type identifier in the first field''' — every row begins with a literal keyword that tells RCampus what kind of record it is. This keyword is the same on every row within a given file.
 +
* '''One record per line.'''
 +
* '''UTF-8 encoding, comma-delimited.'''
 +
* '''Values enclosed in double quotes where applicable.'''
 +
 +
=== The Record Type Identifier ===
 +
 +
The first field on every row is a hardcoded label identifying the record type. This means each row is self-describing — RCampus knows how to process it from the row itself, independent of the filename or any header.
 +
 +
For example, every row in <code>user.csv</code> begins with the literal word <code>user</code>:
 +
 +
<pre>
 +
user,"K9999999","mattiep","","Melinda","Legette","","2","1"
 +
user,"K9998888","jdoe","","John","Doe","","2","1"
 +
</pre>
 +
 +
And every row in <code>property.csv</code> begins with <code>Property</code>:
 +
 +
<pre>
 +
Property,RACE,Race,BL,"Black or African American"
 +
Property,RACE,Race,WH,"White"
 +
</pre>
 +
 +
The record type identifiers for each file are:
 +
 +
{| class="wikitable"
 +
! File !! Record Type Identifier
 +
|-
 +
| <code>user.csv</code> || <code>user</code>
 +
|-
 +
| <code>property.csv</code> || <code>Property</code>
 +
|-
 +
| <code>propertyuserbyid.csv</code> || <code>propertyuserbyId</code>
 +
|-
 +
| <code>program.csv</code> || <code>program</code>
 +
|-
 +
| <code>programuser.csv</code> || <code>programuser</code>
 +
|}
 +
 +
== Import Files Summary ==
 +
 +
Data is organized across five files, each serving a distinct purpose:
 +
 +
{| class="wikitable"
 +
! File !! Purpose !! Typical Frequency
 +
|-
 +
| <code>[[Importing Users|user.csv]]</code> || Creates or updates student and staff accounts || Daily
 +
|-
 +
| <code>[[Importing Properties and Demographics|property.csv]]</code> || Defines valid demographic lookup values (e.g. race, residency, level) || Monthly or semi-annually
 +
|-
 +
| <code>[[Importing Properties and Demographics|propertyuserbyid.csv]]</code> || Assigns demographic attributes to individual students || Daily
 +
|-
 +
| <code>[[Importing Programs and Degrees|program.csv]]</code> || Defines academic programs || Monthly or semi-annually
 +
|-
 +
| <code>[[Importing Programs and Degrees|programuser.csv]]</code> || Assigns students to programs || Daily
 +
|}
 +
 +
Note that <code>property.csv</code> and <code>program.csv</code> define lookup values that must exist before they can be referenced in the assignment files. These definition files are uploaded less frequently since the underlying data changes infrequently.
 +
 +
== Data Matching and Updates ==
 +
 +
* Student IDs must exactly match those on record in RCampus.
 +
* Re-sending a record for an existing student '''updates''' that student's data.
 +
* Sending a record for a new ID '''creates''' a new account.
 +
* Demographic property values must be defined in <code>property.csv</code> before they can be assigned via <code>propertyuserbyid.csv</code>.
 +
* Program values must be defined in <code>program.csv</code> before they can be assigned via <code>programuser.csv</code>.
  
 
==Accessing the Import Utility==
 
==Accessing the Import Utility==
Line 10: Line 95:
  
 
==See Also==
 
==See Also==
 +
*{{Import see also}}
 
*{{Admin see also}}
 
*{{Admin see also}}

Latest revision as of 15:52, 6 May 2026

The import utility helps with integration or manually importing users, courses and classes, enrollments, demographics, programs, etc. Available in Enterprise Edition only.

Importing Data to RCampus

RCampus supports importing student, demographic, and program data from an institution's Student Information System (SIS). This allows assessment results to be analyzed and reported by student characteristics and academic program.

Import Methods

Data can be delivered to RCampus in two ways:

Automated (Panda SFTP Integration)
Files are exchanged on a scheduled basis between the institution's SIS and RCampus over a secure SFTP connection. RCampus publishes a list of students it expects data for, and the institution responds with the appropriate files. See Panda SFTP Integration for connection and scheduling details.
Manual Upload
CSV files can be uploaded directly through the RCampus administrative interface. The same file formats and field rules apply regardless of delivery method.

How Import Files Are Structured

All RCampus import files are plain CSV (comma-separated values) files. They share a consistent structure across all file types:

  • No header row — the first line is always a data record.
  • Record type identifier in the first field — every row begins with a literal keyword that tells RCampus what kind of record it is. This keyword is the same on every row within a given file.
  • One record per line.
  • UTF-8 encoding, comma-delimited.
  • Values enclosed in double quotes where applicable.

The Record Type Identifier

The first field on every row is a hardcoded label identifying the record type. This means each row is self-describing — RCampus knows how to process it from the row itself, independent of the filename or any header.

For example, every row in user.csv begins with the literal word user:

user,"K9999999","mattiep","","Melinda","Legette","","2","1"
user,"K9998888","jdoe","","John","Doe","","2","1"

And every row in property.csv begins with Property:

Property,RACE,Race,BL,"Black or African American"
Property,RACE,Race,WH,"White"

The record type identifiers for each file are:

File Record Type Identifier
user.csv user
property.csv Property
propertyuserbyid.csv propertyuserbyId
program.csv program
programuser.csv programuser

Import Files Summary

Data is organized across five files, each serving a distinct purpose:

File Purpose Typical Frequency
user.csv Creates or updates student and staff accounts Daily
property.csv Defines valid demographic lookup values (e.g. race, residency, level) Monthly or semi-annually
propertyuserbyid.csv Assigns demographic attributes to individual students Daily
program.csv Defines academic programs Monthly or semi-annually
programuser.csv Assigns students to programs Daily

Note that property.csv and program.csv define lookup values that must exist before they can be referenced in the assignment files. These definition files are uploaded less frequently since the underlying data changes infrequently.

Data Matching and Updates

  • Student IDs must exactly match those on record in RCampus.
  • Re-sending a record for an existing student updates that student's data.
  • Sending a record for a new ID creates a new account.
  • Demographic property values must be defined in property.csv before they can be assigned via propertyuserbyid.csv.
  • Program values must be defined in program.csv before they can be assigned via programuser.csv.

Accessing the Import Utility

  1. Login as an admin
  2. Select more… > manage > admin workspace
  3. Select Import CSV
  4. Follow the instructions for import types and format


See Also