Information System Integration Updates for D2L Standard CSV
About this article
D2L Standard CSV is one of the many Information System Integration options that are used by our customers to typically load and manage courses, semesters, users and enrollments into Brightspace from an Information System source via a series of CSV files with some level or automation.
D2L Standard CSV is the third iteration in our family of CSV source system options within our Integration Pack for Information Systems (IPSIS). Previous CSV source systems are now our legacy solution.
- IPSIS Integration 1.0 (legacy)
- Standard CSV (legacy)
- D2L Standard CSV
This article is to provide information on capabilities of new features, next steps for customers already using our latest CSV source system and wish to plan to use some of the new features and migration paths for customers interested in moving to D2L Standard CSV from a legacy CSV source system.
This article is relevant for Brightspace Administrators, Registrar, HRIS and SIS Administrators and supporting IT folks who help with any Course of User information sharing between customer systems and Brightspace.
D2L Standard CSV 2.0 New Features
D2L Standard CSV Version 2.0 is an updated file format that extends D2L Standard CSV functionality and adds additional features in Brightspace to be controlled using a Student Information System (SIS). This feature adds support for:
- Auditors [What is an Auditor?]
- Preferred names [What are preferred names?]
- Custom org units, and unique org structures
- Updated formatting for parent relationships
- It also removes non-functioning options from the user interface.
By adding support for custom org units, this feature removes the need for manual intervention for organizations using an upper org structure above the department level. This type of org structure can facilitate advanced reporting, customers using custom login logic, and the competency tool.
Feature Comparison
Figure: An image of a chart comparing CSV features.
Identifying Your CSV System
Over the years, D2L has iterated on its CSV source systems commonly referred to as "IPSIS CSV". As of today, we have three D2L proprietary CSV source systems, all unique in their all way, but have similar names which has led to a lot of confusion.
Before we jump into capabilities and next steps, let's refresh on what exactly is IPSIS?
IPSIS stands for Integration Pack for Student Information System. Don’t let the name mislead you, we integrate data with many systems, not just Student Information Systems (Learner Information Systems, HRIS, etc.). IPSIS is the family name, within IPSIS there are products, these products have their own identity, with unique product names and features. This article will only focus on the exclusive D2L CSV products, but if you want to learn more about other products, visit this page in our Community.
D2L has three “IPSIS CSV” source systems that use a D2L standard specification vs. the IMS Global Specification. These systems are:
- IPSIS Integration 1.0 (legacy)
- Standard CSV (legacy)
- D2L Standard CSV
IPSIS Integration 1.0 – our first source system. Originally designed to support LIS, an IMS Global Standard specification. Was expanded to support D2L defined CSV files, but was limited to standard set up in Brightspace .
UI was not user friendly; the configuration screen has handlers and translators that needed to be placed in the correct order to achieve the desired result.
Capabilities:
- Individual CSV files are uploaded to an SFTP
- Scheduled task: once nightly
- Role support: 2 role types
- Org structure support: Standard D2L org structure
How to identify - IPSIS Administration:
Figure: The IPSIS-CSV dashboard.
Standard CSV – Similar to IPSIS Integration 1.0 but straightforward questions replace complex management of translators and handlers, simplifying configuration and troubleshooting.
Capabilities:
- Individual CSV files are uploaded to an SFTP
- Scheduled task: once nightly
- Role support: 2 role types
- Org structure support: Standard D2L org structure
- Introduces
- Updated user-friendly UI with default configurations
Identification - IPSIS Administration:
Figure: The Standard CSV dashboarding showing as Enabled.
D2L Standard CSV - There are three versions within this source system that are defined by the presence, or lack of a manifest file. It is easy to migrate to new formats within this source system.
D2L Standard CSV 1.0 - CSV file format remains the same, but files are uploaded in a zip archive. We decoupled the rules and requirements from the LIS specification.
UI Is similar to Standard CSV, but questions have been slightly modified to remove options that were not supported (for instance, course code cannot be modified as it is the sourced id for the record).
Introduces a drag and drop UI to run on demand files, plus an SFTP that is monitored every 10 minutes for automatic file processing.
Capabilities:
- Org structure support: Standard D2L org structure
- Introduces:
- Individual CSV files are uploaded in a zip archive to an SFTP that is monitored every 10 minutes
- Role support: unlimited role types
- Ability to include Manager Dashboard Attributes CSV in zip archive streamlining processing of data into one upload
- Refreshed UI
- Drag and drop UI functionality
- Ability to update a User Sourced Id (aka OrgDefinedID) via a new tab. Note, the OrgDefinedId is expected to be a constant id that will not change or be reused. This tab offers the ability to update OrgDefinedId’s one at a time for one off circumstances.
D2L Standard CSV Version 1.1 – Iterates off V1.0 by adding the ability to assign parent/child relationships in the User file to support Brightspace for Parent (BfP) via a new column. This new column is considered a breaking change, so we introduced a manifest to announce in the zip archive which version you are using.
Capabilities:
- Individual CSV files are uploaded in a zip archive to an SFTP that is monitored every 10 minutes
- Role support: unlimited role types
- Org structure support: Standard D2L org structure
- Ability to include Manager Dashboard Attributes CSV in zip archive streamlining processing of data into one upload
- Introduces:
- Separate manifest file to announce version
- Ability to create, update, delete BfP relationships (formatted as JSON block)
D2L Standard CSV Version 2.0 – Loaded with new features based off of client requests, checkout capabilities for more info.
This was a major version bump as changes were required to both the Org Unit and User files.
Capabilities:
- Individual CSV files are uploaded in a zip archive to an SFTP that is monitored every 10 minutes
- Role support: unlimited role types
- Ability to include Manager Dashboard Attributes CSV in zip archive streamlining processing of data into one upload
- Introduces:
- Extended org structure support: Custom and Standard D2L Org Structure
- Can create, update, delete BfP relationships (updated JSON object to pipe separated)
- Preferred first and last name support
- Auditor role support
- Assign multiple org parents by adding pipe separation
- Enrollment into org units outside of Sections (ie. Enrollment into a School org for Custom Login Logic)
Identification - IPSIS Administration:
Figure: The D2L Standard CSV dashboard showing as Enabled with the option to browse and drop a ZIP file.
Hopefully this clears up which product you are using, even more, I hope you’re intrigued by all the new features and excited to migrate from a legacy source system to D2L Standard CSV!
Next Steps: How to Migrate
I am already using D2L Standard CSV
If you are already on D2L Standard CSV, it is possible to plan and migrate to the new format independently.
It is recommended that testing necessary changes in your test environment before moving to production to verify file formats, and ensure any automation and file transforming from your Information system is adjusted as required. In all D2L CSV testing - Standard practice is to run a single file at a time with only a couple rows to easily review the IPSIS Administration Audit and System Logs.
You will typically already have a functional D2L Standard CSV Source system on your test site. Any issues with D2L Standard CSV Source system on your test site can be directed to D2L Support.
I am using a Legacy CSV Source System
- Identify which legacy product you are on. You will need to engage with our Implementation team for a successful migration. This can be done through you Customer Success Manager / Technical Account Manager.
- Identify which version of D2L Standard CSV you would like to migrate to:
- If V1.0:
- You will need to include your daily CSV files into a zip archive (individual CSV files will not be processed if uploaded separately
- All files contain only delta
- You will be provided updated SFTP credentials to upload you zip archive to
- Your Implementation consultant will migrate the data from your legacy source system to your production source system
- It is recommended to complete these steps on your test environment before moving to your production environment
- If V2.0:
- If V1.1:
- All of the above
- File should be sorted to include parents before the child (child declares parents)
- User file includes new relationship column, parent/child relationships must be formatted using JSON.
- Manifest.json file has to be present in the zip archive (V1.1)
- All of the above
- Org file(s) include new custom_code column
- User file includes new pref_first_name and pref_last_name column, relationship column uses pipe separation instead of JSON
- Manifest.json file has to be present in the zip archive (V2.0)
