Skip to main content
pdf?stylesheet=default
Blackboard Help

Create and Edit SIS Integrations

Overview

You can create and edit Student Information System (SIS) integrations to bring information into Blackboard Learn from other data sources, including other Learning Management Systems (LMS).

How to Create Student Information System Integrations

Follow these steps to create and configure the basic information for an SIS integration.

  1. On the Administrator Panel, under Building Blocks, click Data Integration.
  2. Click Student Information System Integrations.
  3. Point to Create Integration in the Action Bar to access the drop-down list.
  4. Select the integration type.
    • IMS Enterprise 1.1 adds an integration type compatible with IMS standards.
    • IMS Enterprise 1.1 - Vista adds an integration type compatible with Vista systems.
    • IMS Learning Information Services adds an integration type compatible with LIS standards.
  5. Snapshot Flat File adds an integration type compatible with the Blackboard Learn Snapshot Command Line Tool.
  6. Snapshot XML adds an integration type compatible with the Blackboard Learn  Snapshot Command Line Tool.
  7. In the Integration Properties section, set options for the integration described in Student Information System Integration Configuration.
  8. In the Data Support section, set options for the Data Support described in Student Information System Integration Configuration.
  9. In the Advanced Configuration section, set options for the Advanced Configuration described in Student Information System Integration Configuration.
  10. Click Submit.

How to Edit Student Information System Integrations

Follow these steps to edit the basic configuration and information for an existing SIS integration.

  1. On the Administrator Panel, under Building Blocks, click Data Integration.
  2. Click Student Information System Integrations.
  3. Click the integration's contextual menu for the integration and select Edit.
  4. In the Integration Properties section, edit the integration settings.
  5. In the Data Support section, edit the data support settings.
  6. In the Advanced Configuration section, edit the advanced configuration settings.
  7. Click Submit.

Student Information System Integration Configuration

The following table describes the properties you set when creating a new SIS integration.

SIS Integration Properties
Option Description
Integration Properties
Integration Name Required. Type a unique name for your integration.
Description Type a description for your integration.
Shared Username Required. The Shared Username is generated automatically from the SIS system and populated to this text box.
Shared Password Required. Type the password for this integration when using Integration Endpoints. It is used with Shared Username.
Feed File Delimiter This option is available only for Snapshot Flat File integrations. Select the delimiter type that is used in the current Feed File. The delimiter is the character used to separate fields in the data file. Delimiter options:
  • Comma
  • Colon
  • Pipe
  • Tab
  • Other
SIS Learning Information Services Batch Web Service URL This option is available only for IMS Learning Information Services integrations. Type the endpoint URL for the Learning Information Services Batch Web Service on your Student Information System. The URL is used to coordinate bulk data transfer between Blackboard Learn and the SIS. If the URL is not specified, bulk data transfers may not work correctly.
Batch Service Username This option is available only for IMS Learning Information Services integrations. If your SIS requires a separate username and password for the Batch Web Service, provide the username. If the username is not supplied in this text box, the Shared Username will be used.
Batch Service Password This option is available only for IMS Learning Information Services integrations. If your SIS requires a separate username and password for the Batch Web Service, provide the password. If the password is not supplied in this text box, the Shared Password will be used.
Batch Download Username This option is available only for IMS Learning Information Services integrations. If your SIS requires a separate username and password for downloading Batch files, provide the username. If the username is not supplied in this text box, the Shared Username will be used.
Batch Download Password This option is available only for IMS Learning Information Services integrations. If your SIS requires a separate username and password for downloading Batch files, provide the password. If the password is not supplied in this text box, the Shared Password will be used.
Integration Status Required. Integration Status options:
  • Inactive: The system will not process requests or update data in the database.
  • Active: The system will process requests, update data in the database, and be visible to the users.
  • Testing: Data is not integrated into the live system.

Blackboard recommends that integrations begin in Testing. Selecting this status will allow you to test the integration and fix any issues which may arise before committing to the integration. After testing is complete, the status should be set to Inactive or Active.

Log Verbosity Required. The Log Verbosity option determines what is visible in the SIS Logs screen for this integration.
  • Errors Only: Any fatal issues, any issues preventing create, update, disable, or purge operations.
  • Errors and Warnings: Any non-fatal issues, any issue with an individual record, or any successful operation which required a change to the record.
  • All Diagnostic Messages: Any successful activity, including record types and counts, timing, and data.
  • All Diagnostic and Debug Messages: All individual records, and data transformation attempts.

Selecting a verbose log level will also select the less-verbose log level or levels that precede the selected log level. For example, if you select the Messages log level, errors, warnings, and messages will be logged.

Data Support
Learn Data Source

Required. Determine the data source used during the integration with Blackboard Learn.

  • Use the Learn Data Source defined in the inbound data
  • Use the same Learn Data Source for all new inbound data. Select New Data Source from the drop-down list, and type the new data source key in the text box.
  • Use the same Learn Data Source for all new inbound data. Select an existing data source key from the drop-down list.
Batch UID Prefix Avoid ID conflicts by prefixing identifiers for objects created during the integration. Blackboard recommends that you do not change this setting after data has been created for the integration.
Parent Hierarchy Node Required. This option is available only for IMS Enterprise 1.1, IMS Enterprise 1.1 - Vista, and Snapshot Flat File integrations.
  • Create hierarchy under the top level
  • Create hierarchy under the specified node. Click Find Node if there are nodes available to be chosen.
Hierarchy Levels This option is available only for IMS Enterprise 1.1 - Vista integrations.
  • Integrate nodes at the Division Level
  • Integrate nodes at the Group Level
  • Integrate nodes at the Course Offering Level. Integrating nodes at the Course Offering level can create many thousands of nodes.
Implied Section Association This option is available only for IMS Enterprise 1.1 - Vista integrations. Optionally create an association for each incoming section based on the selected Hierarchy Level.
Advanced Configuration
Users The Learn Object Type named Users is associated to SIS Object Type as follows:
  • IMS Enterprise 1.1: Person
  • IMS Enterprise 1.1 - Vista: Person
  • IMS Learning Information Services: Person
  • Snapshot Flat File: Person
  • Snapshot XML: Person

Select the method of handling conflicting items from the Inserts and Updates drop-down list:

  • Do Not Insert or Update: Do not update any data from the feed file.
  • Inserts Only: Only add new data from the feed file (data not already in the system). Do not update any existing data.
  • Updates Only: Only update existing data. Do not add any new data in the feed file.
  • Smart Inserts or Updates: Add new data and update existing data from the feed file.

Select the method of handling conflicting items from the Deletes drop-down list:

  • Do Not Disable or Purge: Do not delete or mark for deletion any data in the system based on the feed file.
  • Disable: Mark for deletion, but do not actually delete any data in the system based on the feed file.
  • Purge: Delete data from the system based on the feed file.
Courses The Learn Object Type named Courses is associated to the SIS Object Type named as follows:
  • IMS Enterprise 1.1: Course Sections
  • IMS Enterprise 1.1 - Vista: Course Sections
  • IMS Learning Information Services: Course Section
  • Snapshot Flat File: Course
  • Snapshot XML: Course

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Organizations This option is available only for Snapshot Flat File and Snapshot XML integrations. The Learn Object Type named Organizations is associated to the SIS Object Type named as follows:
  • Snapshot Flat File: Organization
  • Snapshot XML: Organization

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Enrollments The Learn Object Type named Enrollments is associated to the SIS Object Type named as follows:
  • IMS Enterprise 1.1: Membership
  • IMS Enterprise 1.1 - Vista: Membership
  • IMS Learning Information Services: Membership
  • Snapshot Flat File: Course Membership
  • Snapshot XML: Membership

Select the method of handling conflicting items from the  Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Organization Enrollments This option is available only for Snapshot Flat File integrations. The Learn Object Type named Organization Enrollments is associated to the SIS Object Type named as follows:
  • Snapshot Flat File: Organization Membership

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Observer Association This option is available only for Snapshot Flat File and Snapshot XML integrations. The Learn Object Type named Observer Association is associated to the SIS Object Type as follows:
  • Snapshot Flat File: Observer Association
  • Snapshot XML: Observer Membership

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Course Categories This option is available only for Snapshot Flat File and Snapshot XML integrations. The Learn Object Type named Course Categories is associated to the SIS Object Type as follows:
  • Snapshot Flat File: Course Category
  • Snapshot XML: Course Category

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Course Category Membership This option is available only for Snapshot Flat File and Snapshot XML integrations. The Learn Object Type named Course Category Membership is associated to the SIS Object Type as follows:
  • Snapshot Flat File: Course Category Membership
  • Snapshot XML: Course Category Membership

Select the method of handling conflicting items from the  Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Organization Categories This option is available only during the creation of a Snapshot Flat File Integration, or Snapshot XML Integration. The Learn Object Type named Organization Categories is associated to the SIS Object Type as follows:
  • Snapshot Flat File: Organization Category
  • Snapshot XML: Organization Category

Select the method of handling conflicting items from the  Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Organization Category Membership This option is available only for Snapshot Flat File and Snapshot XML integrations. The Learn Object Type named Organization Category Membership is associated to the SIS Object Type as follows:
  • Snapshot File: Organization Category Membership
  • Snapshot XML: Organization Category Membership

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes rop-down list. See Users for definitions of all available selections.

Secondary Institution Role Associations This option is available only for Snapshot Flat File and Snapshot XML integrations. The Learn Object Type named Secondary Institution Role Associations is associated to the SIS Object Type as follows:
  • Snapshot Flat File: User Secondary Institution Role
  • Snapshot XML: Portal Role Membership

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Goals Associations This option is available only for Snapshot Flat File integrations. The Learn Object Type name Goals Associations is associated to the SIS Object Type as follows:
  • Snapshot Flat File: Course Goal Association

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Terms This option is available only for IMS Enterprise 1.1, IMS Enterprise 1.1 - Vista, IMS LIS, or Snapshot Flat File integrations. This Object, if used, will assign Terms to Courses. The Learn Object Type named Terms is associated to the SIS Object Type as follows:
  • IMS Enterprise 1.1: Term
  • IMS Enterprise 1.1 - Vista: Term
  • IMS Learning Information Services: Term Group
  • Snapshot Flat File: Term

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Cross List This option is available only during the creation of an IMS Enterprise 1.1 and IMS Enterprise 1.1 - Vista integrations. This object, if used, provides the ability to have multiple course IDs that are cross listed courses, which can be merged into one course. The Learn Object Type named Cross List is associated to the SIS Object Type as follows:
  • IMS Enterprise 1.1: Cross List Association
  • IMS Enterprise 1.1 - Vista: Cross List Association

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Hierarchy Nodes This option is available only during the creation of an IMS Enterprise 1.1 integration, or a Flat File integration. The Learn Object Type named Hierarchy Nodes is associated to the SIS Object Type as follows:
  • IMS Enterprise 1.1: Group
  • Snapshot Flat File: Hierarchy Node

Select the method of handling conflicting items from the Inserts and Updates drop-down list, and the Deletes drop-down list. See Users for definitions of all available selections.

Hierarchy Nodes (Division) This option is available only for IMS Enterprise 1.1 - Vista integrations. The Learn Object Type named Hierarchy Nodes (Division) is associated to the SIS Object Type as follows:
  • IMS Enterprise 1.1 - Vista: Divisions

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Hierarchy Nodes (Group) This option is available only for IMS Enterprise 1.1 - Vista integrations. The Learn Object Type named Hierarchy Nodes (Group) is associated to the SIS Object Type as follows:
  • IMS Enterprise 1.1 - Vista: Groups

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Hierarchy Nodes (Course Offering) This option is available only for IMS Enterprise 1.1 - Vista integrations. The Learn Object Type named Hierarchy Nodes (Course Offering) is associated to the SIS Object Type as follows:
  • IMS Enterprise 1.1 - Vista: Course Offerings

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

User Associations This option is available only during the creation of an IMS Enterprise 1.1 and Snapshot Flat File integrations. The Learn Object Type named User Associations is associated to the SIS Object Type as follows:
  • IMS Enterprise 1.1: User Association
  • Snapshot Flat File: User Association

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Course Associations This option is available only for Snapshot Flat File integrations. The Learn Object Type named Course Associations is associated to the SIS Object Type as follows:
  • Snapshot Flat File: Course Association

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.

Organization Associations This option is available only for Snapshot Flat File integrations. The Learn Object Type named Organization Associations is associated to the SIS Object Type as follows:
  • Snapshot Flat File: Organization Association

Select the method of handling conflicting items from the Inserts and Updates drop-down list and the Deletes drop-down list. See Users for definitions of all available selections.