Integrate with your Student Information System (SIS)
Before you integrate with your Student Information System (SIS), you should review the requirements and features you can use during the integration. See Prepare to integrate Apple School Manager with your Student Information System (SIS).
Integrate with your SIS
You must have a verified domain to integrate with your SIS.
Important: Don’t edit user account information after you integrate your SIS with Apple School Manager. If you do, the account is considered a local account and is no longer associated with your SIS.
In Apple School Manager , sign in with a user that has the role of Administrator, Site Manager, or People Manager.
Do one of the following:
If you’re integrating your SIS for the first time: Select your name at the bottom of the sidebar, select Preferences , select Managed Apple IDs , select Get Started, select “Create new accounts,” then select Continue.
If you’ve already integrated your SIS: Select “Reconfigure sync with [name of SIS].”
If you’ve started the process but didn’t finish: Select Complete.
Choose Connect to Student Information System, then agree to the Claris terms of service.
You need to agree to the Claris terms of service only once.
Choose your SIS.
Some SISs (for example, PowerSchool) require that you download and install a plug-in before you can continue. Follow the instructions provided onscreen, then select Continue.
Enter any required information, then select Continue.
On the Sync Assist page, do one of the following:
To configure Sync Frequency settings, select Continue and go to step 11.
To configure Patch Data and Filter Data options, select Continue and go to the next step.
On the Patch Data page, turn off any of the following:
Prevent duplicate accounts: This prevents additional records from being created if incoming SIS data matches existing data based on first name, last name, and email address.
Patch errors: This removes:
Any Instructor IDs from the classes.csv file if they don’t match any Person ID in the staff.csv file
Records in the rosters.csv file that have Class IDs that don’t match any Class ID in the classes.csv file
Records in the rosters.csv file that have Student IDs that don’t match any Person ID in the students.csv file
Select Continue.
On the Filter Data page, choose what you want to include in the sync:
Schools
Instructors, students, classes, courses, and locations
Select Continue.
On the Sync Frequency page, choose the frequency, time of day, and time zone of the sync, then select Save and Continue.
You can view the progress or you can close the window.
If the sync is successfully completed with no issues, you can close the window and continue to the SIS/SFTP Assistant.
Select Review [name of SIS] data to make sure the data being added is correct, then select Continue.
Select Preview Accounts and Classes to view the accounts and classes being created, then select Create Accounts and Classes.
After the process completes, select Close.
If necessary, do any of the following:
To download a summary of data that was patched during sync, select Patch Summary.
To download the resulting .csv files that were modified during the sync, select Modified CSVs.
Upload OneRoster .csv files
You can use the Secure File Transfer Protocol (SFTP) to upload all the .csv files from your Student Information System (SIS) to Apple School Manager. Before you begin, review the requirements. See Prepare to integrate Apple School Manager with your Student Information System (SIS).
Important: Don’t edit user account information after you integrate your SIS with Apple School Manager. If you do, the account is considered a local account and is no longer associated with your SIS.
In Apple School Manager , sign in with a user that has the role of Administrator, Site Manager, or People Manager.
Do one of the following:
If you’re uploading CSV data for the first time: Select your name at the bottom of the sidebar, select Preferences , select Managed Apple IDs, select Get Started, select “Create new accounts,” then select Continue.
If you’ve previously uploaded CSV data: Select the ellipsis next to CSV, then select Upload CSV to upload new CSV data.
If you’ve started the process but didn’t finish: Select Complete.
Choose Use OneRoster CSV.
Agree to the Claris terms of service.
You need to agree to the Claris terms of service only once.
Using an SFTP client, upload your .csv files using the provided SFTP URL and generated credentials.
If the upload is successfully completed with no issues, select Preview Accounts to continue in the SIS/SFTP Assistant.
To view the data being added, select “Review [name of SIS] data.”
Make sure the data looks correct, then select Continue.
To view the accounts and classes being created, select Preview Accounts and Classes, then select Create Accounts and Classes.
After you’ve finished, select Close to return to the Managed Apple IDs window.
If necessary, do any of the following:
To download a summary of data that was patched during the sync, select Patch Summary.
To download the resulting CSV files that were modified during the sync, select Modified CSVs.
Upload Apple formatted .csv files
You can use the Secure File Transfer Protocol (SFTP) to upload all the .csv files from your Student Information System (SIS) to Apple School Manager. Before you begin, review the requirements. See Prepare to integrate Apple School Manager with your Student Information System (SIS).
Important: Don’t edit user account information after you integrate your SIS with Apple School Manager. If you do, the account is considered a local account and is no longer associated with your SIS.
In Apple School Manager , sign in with a user that has the role of Administrator, Site Manager, or People Manager.
Do one of the following:
If you’re uploading CSV data for the first time: Select your name at the bottom of the sidebar, select Preferences , select Managed Apple IDs, select Get Started, select “Create new accounts,” then select Continue.
If you’ve previously uploaded CSV data: Select the ellipsis next to CSV, then select Upload CSV to upload new CSV data.
If you’ve started the process but didn’t finish: Select Complete.
Choose Use Apple formatted CSV.
Select Add next to Find Students, Instructors, and Classes, then select Set Up SFTP.
Apple School Manager generates a URL, user name, and password to use when uploading files. Use this information to configure your SFTP app.
Select Download Templates to download the template files to your computer, then read the instructions for using templates in the Filling Out Data Files section, which explains in detail the formatting requirements and expected contents of each file.
Open the templates, add your data in the columns, then save the files that have a .csv extension.
When your files are filled out, create a zip archive of all six files (select the files in the Finder, then go to the File menu and choose Compress 6 Items).
Open your SFTP app and create a new SFTP connection. This process will differ for each app.
Enter the URL, user name, and password generated by Apple School Manager.
After the connection is made, locate and open the dropbox folder, then drag in your zipped file.
In Apple School Manager , select Continue and wait for the file to upload.
If your upload contains errors, you can review a log identifying the files and lines that contain errors. Correct any errors in the data files, then upload a new zipped file. You don’t need to remove the previous file from the Apple SFTP server.
After you successfully upload your file, you’ll see what was imported—for example, the number and type of users, the number of classes, and locations. You can also adjust the window to display additional users.
To review the information, select Review SFTP Data.
After you’ve reviewed the SFTP data, then select Continue.
This automatically opens Create Accounts and Classes.
Select Preview Accounts and Classes, preview the SFTP data, then select Create Accounts and Classes.
After the process is complete, select Close to close the SIS/SFTP Assistant.
You can now view the imported accounts and classes in Apple School Manager.
Perform a manual sync
In some cases, you may want to sync manually. For example, you may have had initial sync errors and you want to perform a manual sync to confirm you fixed the errors.
In Apple School Manager , sign in with a user that has the role of Administrator, Site Manager, or People Manager.
Select your name at the bottom of the sidebar, select Preferences , then select Managed Apple IDs .
Select the ellipsis next to your SIS or OneRoster CSV, then select Sync Now.
View and edit SIS information and sync settings
In Apple School Manager , sign in with a user that has the role of Administrator, Site Manager, or People Manager.
Select your name at the bottom of the sidebar, select Preferences , then select Managed Apple IDs .
Select the ellipsis next to your SIS, then do any of the following:
To edit the API Root URL, Client ID, and Client Secret for the SIS you’re integrated with, select Sync Settings.
To edit sync settings like patching, filtering, and sync frequency options, select Continue.
Important: For changes to take effect, you must complete the sync process.
View sync history
In Apple School Manager , sign in with a user that has the role of Administrator, Site Manager, or People Manager.
Select your name at the bottom of the sidebar, select Preferences , then select Managed Apple IDs .
Select the ellipsis next to your SIS or .csv file, then select Sync History.
Edit SFTP sign-in information
You can view all your SFTP connections for your location, view and reset the SFTP password, and disconnect your SFTP connection from Apple School Manager.
In Apple School Manager , sign in with a user that has the role of Administrator, Site Manager, or People Manager.
Select your name at the bottom of the sidebar, select Preferences , then select Managed Apple IDs.
Under Directory sync, select Edit next to your SFTP connection.
If necessary, edit the information used for the SFTP connection, then select Save.