Skip to main content

DSI (Delegated SIS Integrator)

Introduction​

Overview

The Delegated SIS Integrator is an administrative tool in Blackboard Learn that allows non-admin users (selected through institutional roles) to independently perform certain SIS integration actions by uploading plain text files. These actions include:

  1. User management
  2. Course management
  3. Enrollment management
  4. Term management

This application enables delegated integration management for specific users or institutions within Blackboard Learn without compromising data integrity in the instance.

tip

Need more information? Want a demo?
Write to us and we'll get in touch with you schedule a demo.

Preconfiguration​

The application operates based on institutional roles and Data Source Keys (DSKs) in Blackboard Learn.

A DSK is a "data tag" that allows integration operations to be performed affecting only a specific set of records, preserving the integrity of the remaining data in the Blackboard Learn instance.

Once the application is installed, a list of institutional roles and associated DSKs (Data Source Keys) must be provided to the eLearning Media team. This grants users with those roles access to the tool, enabling them to upload integration files to the DSKs they have access to.

Roles and DSKs must be created in Blackboard Learn by the client prior to using the tool. A single user can have access to multiple integration DSKs by configuring several institutional roles as secondary roles.

User roles

Accessing the Tool​

Access to the tool can be enabled from several placements within the platform:

  1. Access via the Admin Panel, under Tools and Utilities. This is ideal for users with admin panel access.
  2. Access via Tools in the main platform menu. This is ideal for users without admin panel access.

Access via Tools

Application Overview​

General view

The application's interface allows uploading integration files to a previously configured DSK. If multiple DSKs exist, the user must select the one they intend to operate on.

At the bottom of the application, file templates are available for each entity (users, courses, enrollments, terms), showing the required fields.

Each file, once filled, should be uploaded in the corresponding section by clicking the upload button. Administrators will receive a confirmation message once files are uploaded, which are processed through the SIS Integration Framework.

Confirmation message

The confirmation code allows calling the Blackboard SIS Logs endpoint to verify the integration result in detail:
(/learn/api/public/v1/logs/sis/dataSets/{id})

Template Fields​

Users​

The following fields must be specified:

  1. EXTERNAL_PERSON_KEY - Required. Unique external user identifier.
  2. USER_ID - Required. User ID used to log into the platform.
  3. FIRSTNAME - Required. User's first name.
  4. LASTNAME - Required. User's last name.
  5. EMAIL - User's email address.
  6. ROW_STATUS - User availability status; values include enabled/disabled.
  7. AVAILABLE_IND - Boolean indicating if the record is available.

Courses​

The following fields must be specified:

  1. EXTERNAL_COURSE_KEY - Required. Unique external course identifier.
  2. COURSE_ID - Required. Course short ID.
  3. COURSE_NAME - Required. Course name.
  4. TEMPLATE_COURSE_KEY - External ID of a course whose contents will be copied into the new course.
  5. AVAILABLE_IND - Boolean indicating if the record is available.
  6. TERM_KEY - External identifier for the associated term.
  7. EXTERNAL_ASSOCIATION_KEY - Identifier of the institutional hierarchy node this course is linked to.
  8. PRIMARY_EXTERNAL_NODE_KEY - Node in the institutional hierarchy from which the course's initial settings are inherited.

Enrollments​

The following fields must be specified:

  1. EXTERNAL_COURSE_KEY - Required. External ID of the course where the student will be enrolled.
  2. EXTERNAL_PERSON_KEY - Required. External ID of the student to be enrolled.
  3. ROLE - Required. Role of the student in the course.
  4. ROW_STATUS - Enrollment availability status; values include enabled/disabled.
  5. AVAILABLE_IND - Boolean indicating if the record is available.

Terms​

The following fields must be specified:

  1. EXTERNAL_TERM_KEY - Required. External term identifier.
  2. NAME - Required. Name of the term.
tip

Help us improve! Have suggestions or improvements for this documentation? Write to us!