How to manage Blackbaud integration

Dyknow’s Import Manager feature enables Dyknow Administrators to easily import data from the Blackbaud SIS into Dyknow.

Note:

• Blackbaud has changed the steps and requirements to activate the ON API integration as of June 30, 2021.  For an integration type that does not require regular updates, please contact us about changing your import method type to Blackbaud OneRoster integration.
• In order to import Blackbaud user data into Dyknow, each Teacher user must be assigned to a Class in Blackbaud and each Student user must be assigned to a Class roster in Blackbaud. Blackbaud users aren’t tied to schools.
• Blackbaud has no method for identifying the Primary Teacher of a Class. When multiple Teachers are listed for a class, all will be assigned to the class and displayed in alphabetical order.
  

Prerequisite: Manage Roster Import Settings

This document is a resource for Dyknow Administrators to understand how to:

• Generate Blackbaud OneRoster Integration Credentials
• Enter Blackbaud OneRoster Integration Credentials
• Generate Blackbaud ON Integration Credentials
• Enter Blackbaud ON Integration Credentials
• Generate Blackbaud SKY Integration Credentials
• Authorize Blackbaud SKY Integration Credentials
• Process Blackbaud Data into Dyknow
• Disable Blackbaud Integration

GENERATE BLACKBAUD ONEROSTER INTEGRATION CREDENTIALS

Follow the steps below to generate your Blackbaud OneRoster integration credentials.

1. Login to Blackbaud as an Administrator.

2.Add new OAuth Client credentials for Dyknow in your Blackbaud Core settings (Core > Settings > Integration settings > OneRoster > Add).

3.Create a new provider by selecting the "Other" provider and entering the name "Dyknow."

4. Check the box for Use legacy OAuth 1.0 authentication.

5. Save the Key, Secret, and API Host Name for the Dyknow Client. You will need to enter them into Dyknow. Note: Click the ellipsis (…) to get the Key and Secret. If the host name is not shown, try your myschoolapp.com URL

6. Continue to Enter Blackbaud OneRoster Integration Credentials.

ENTER BLACKBAUD ONEROSTER INTEGRATION CREDENTIALS

Follow the steps below to enter your Blackbaud OneRoster integration in Dyknow Import Manager.

1. Log in to Dyknow.

2. Click the gear icon ; you will be redirected to the Admin Settings.

3. Click theImport Managertab.

4. ClickSetup.

5. Locate the Setup Integration section.

6. Enter your integration URL into the Integration URL field (e.g.https://myschool.myschoolapp.com/ims/oneroster/v1p1/).

7. Enter the Key for the newly-created Dyknow provider into the Integration Key field.

8. Enter the Secret for the newly-created Dyknow provider into the Integration Secret field.

9. Click to Select Types of Student Devicesused at your district in the Student Devicesfield; review options below:

• Only Chromebooks(No Windows and/or Mac devices used)
• No Chromebooks(Only Windows and/or Mac devices used)
• Mix of Chromebooks and Non-Chromebooks

10. Click Load Schools to view all schools to be imported.  All schools will be imported by default.  To select specific schools to import, click Load Schools and deselect any schools you do not wish to import.

11. Click Continue: Process Import.

12. Continue to Process Blackbaud Data into Dyknow.

GENERATE BLACKBAUD ON INTEGRATION CREDENTIALS

Follow the steps below to generate your Blackbaud ON integration credentials.

1. Contact your Blackbaud Account Manager to ensure you have the Blackbaud ON API SDK installed (Note: You will know it's already installed if you are able to perform the remaining steps).

2. Log in to Blackbaud ON as an Administrator.

3. Create a new user.

4. Assign the newly-created user the Web API Services Manager role in the Blackbaud admin portal (Core > Users/Access > Profile > Manage Roles).

5. Generate an API access Key and Shared Secret for the Dyknow user by following Blackbaud's instructions  (Note: This step will need to be repeated regularly to maintain daily imports as Blackbaud expires key/secrets every 90 days).

6. Continue to Enter Blackbaud ON Integration Credentials.

ENTER BLACKBAUD ON INTEGRATION CREDENTIALS

Follow the steps below to enter your Blackbaud ON integration credentials in Dyknow Import Manager.

1. Log in to Dyknow.

2. Click the gear icon ; you will be redirected to the Admin Settings.

3. Click the Import Manager tab.

4. Click Setup.

5. Locate the Setup Integration section.

6. Enter your integration URL into the Integration URL field (e.g.https://myschool.myschoolapp.com/api/).

7. Enter the Key for the newly-created Blackbaud Web Services Manager user into the Integration Key field.

8. Enter the Shared Secret for the newly-created Blackbaud Web Services Manager user into the Integration Secret field.

9. Click to Select Types of Student Devices used at your district in the Student Devices field; review options below:

• Only Chromebooks(No Windows and/or Mac devices used)
• No Chromebooks(Only Windows and/or Mac devices used)
• Mix of Chromebooks and Non-Chromebooks

10. ClickLoad Schools to view all schools to be imported.  All schools will be imported by default.  To select specific schools to import, click Load Schools and deselect any schools you do not wish to import.

11. Click Continue: Process Import.

12. Continue to Process Blackbaud Data into Dyknow.

GENERATE BLACKBAUD SKY INTEGRATION CREDENTIALS

Follow the steps below to authorize your Blackbaud SKY integration credentials.

1. Login to Blackbaud SKY as an Administrator (an Environment Admin).

2. Connect the SKY application by navigating to the Dyknow Import Manager app on the Blackbaud Marketplace and clicking Connect.

3. Confirm that your Blackbaud account has the Platform Manager role, or the Academic Group Manager, Contact Card Manager, and SKY API Data Sync roles.

4. Continue to Authorize Blackbaud SKY Integration Credentials.

AUTHORIZE BLACKBAUD SKY INTEGRATION CREDENTIALS

Follow the steps below to authorize your Blackbaud SKY integration in Dyknow Import Manager.

1. Log in to Dyknow.

2. Click the gear icon ; you will be redirected to the Admin Settings.

3. Click the Import Manager tab.

4. Click Setup.

5. Locate the Setup Integration section.

6. Click Authorize to Connect to Blackbaud SKY (Note: You may still need to log in to Blackbaud using your Blackbaud ID).

7. Click to Select Types of Student Devices used at your district in the Student Devicesfield; review options below:

• Only Chromebooks(No Windows and/or Mac devices used)
• No Chromebooks(Only Windows and/or Mac devices used)
• Mix of Chromebooks and Non-Chromebooks

8. Click Load Schools to view all schools to be imported.  All schools will be imported by default.  To select specific schools to import, click Load Schools and deselect any schools you do not wish to import.

9. Click Continue: Process Import.

10. Continue to Process Blackbaud Data into Dyknow.

PROCESS BLACKBAUD DATA INTO DYKNOW

1. Log in to Dyknow.

2. Click the gear icon ; you will be redirected to the Admin Settings.

3. Click the Import Manager tab.

4. Click Import.

5. Click Process Import.

6. You will receive an Import Results confirmation email once your import has processed.

Note:If your importing data contains errors and/or changes that exceed Import Thresholds, you will receive a Check Your Data email, in addition to the Import Results confirmation email. To review and validate import errors, read the Validate Paused Imports article.

DISABLE BLACKBAUD INTEGRATION

Please contact Dyknow Support to disable your Blackbaud integration.