Connecting to ClassRanked via Data Warehouse
This document describes how ClassRanked integrates with an institution’s data warehouse or API-based data source. It is intended for university data warehouse teams and SIS/IT administrators responsible for providing structured academic data to downstream systems.
This integration allows ClassRanked to consume SIS data directly from a warehouse or API rather than via manually uploaded flat files.
Integration Models
ClassRanked supports two data delivery models:
Option A: CSV Export via SFTP
Institutions may export SIS-aligned CSV files from their data warehouse and deliver them to ClassRanked via SFTP. This model uses the same dataset schemas and behaviors as the standard SIS flat file integration. Refer to the SIS Flat File Import Formats documentation for schema definitions.
Option B: Direct Warehouse or API Access
ClassRanked is granted read-only access to warehouse views or API endpoints that expose the required datasets. This document focuses on this option.
Integration Contract Summary
ClassRanked requires the following to support a warehouse-based integration:
- Read-only access to warehouse views or API endpoints
- Seven logical datasets (listed below)
- Data scoped to the active academic term (optionally including the next upcoming term)
- Stable, externally meaningful identifiers (not internal surrogate keys)
- Periodic refresh of data (typically nightly)
ClassRanked does not write data back to institutional systems.
Required Datasets
ClassRanked consumes the following logical datasets. These align with the SIS Flat File Import found here. Formats and represent the same underlying entities.
| Dataset | Purpose |
|---|---|
| Terms | Defines academic terms and evaluation windows |
| Courses | Defines reporting and aggregation structure |
| Course Sections | Primary units for teaching, and related, survey distribution |
| Students | Survey respondents |
| Faculty and Staff | Subjects of evaluation and administrators viewing reports. |
| Student Enrollments | Links students to course sections |
| Instructor Assignments | Links instructors to course sections |
Dataset schemas are expected to match the SIS flat file specifications. Field-level definitions are not repeated here.
Data Scoping Rules
All datasets must be filtered to include only records associated with:
- The current active academic term
- Optionally, the next upcoming academic term
Historical terms and distant future terms must not be included in the integration views or API responses.
Connectivity and Authentication
ClassRanked supports read-only access via one of the following approaches:
- Secure access to database views (e.g., via SQL over TLS)
- REST or API-based access returning structured data (e.g., JSON)
- Credential-based authentication (service accounts, API tokens, or similar)
- Network controls such as IP allowlisting when required
Specific connection details are coordinated during implementation using a shared integration worksheet.
Data Semantics and Processing
Warehouse-sourced data follows the same logical processing rules as SIS flat file imports. This includes dataset replacement behavior and internal validation logic. Refer to the SIS Flat File Import Formats documentation for details on how datasets are processed once ingested.
ClassRanked validates data for structural consistency and referential integrity but assumes institutional ownership of data correctness.
Delivery and Refresh Expectations
Data is typically refreshed on a nightly cadence, though other schedules may be supported by agreement. ClassRanked pulls data according to the agreed refresh schedule and does not require real-time updates.
Related Documentation
- SIS Flat File Import Formats
- Setup SIS Sync
- Integrating with PeopleSoft