Apple School Manager
Apple School Manager is a secure portal for managing school resources such as students, teachers, courses, and locations.
Actions
Action |
Configuration fields |
Data type |
Required? |
---|---|---|---|
Upload ZIP file - Uploads a ZIP archive of CSV files to Apple School Manager |
File to Upload - A ZIP archive containing six CSV files in Apple School Manager format. Input must be step data that references a file path from a previous step. See Using step data in Claris Connect Help. |
String |
|
Validate Apple School Manager ZIP file - Validates a ZIP archive against Apple School Manager formatting rules |
File to validate - A ZIP archive containing six CSV files in Apple School Manager format. Input must be step data that references a file path from a previous step. See Using step data in Claris Connect Help. |
String |
|
Patch Apple School Manager CSV data - Looks for validation errors and modifies Apple School Manager-formatted CSV data to temporarily fix errors. May increase the likelihood that the sync to Apple School Manager succeeds. After the step finishes, a new ZIP file containing the modified CSV data as well as a report listing the modifications made are available to download in the History tab. |
File with CSV data to patch - A ZIP archive containing six CSV files in Apple School Manager format. Input must be step data that references a file path from a previous step. See ‘Using step data’ in Claris Connect Help. |
String |
|
Prevent duplicate Apple School Manager records - If the selected fields of an incoming user record match those of an existing user in Apple Schoole Manager, the incoming user data will update the existing user data instead of creating a new record, even if they have different Person IDs. Matching field options:
|
Choice |
|
|
Patch instructor errors in the Classes table - Remove instructor_id’s from classes.csv if they don’t match any person_id in staff.csv. |
Choice |
|
|
Patch Roster class record errors - Remove records in rosters.csv that have class_id’s that don’t match any class_id in classes.csv. |
Choice |
|
|
Patch Roster student record errors - Remove records in rosters.csv that have student_id’s that don’t match any person_id in students.csv. |
Choice |
|
|
Prevent Empty Files - This will check if files are empty and will add a placeholder record in order to complete the sync. |
Choice |
|
|
Organization Account - Your Apple School Manager Organization ID. This can be found in Apple School Manager by going to Preferences -> Organization Information. |
String |
|
|
Format data as CSV files - Transforms a dataset into CSV files that can be used by Apple School Manager |
Migrate from existing Apple School Manager connection - Applies transformations specific to migrating from existing Student Information System connections in Apple School Manager. Includes recreating unique identifiers for students and teachers records. If enabled during the initial sync, this option should remain enabled for any subsequent syncs. |
Choice |
|
Data to format - Dataset (stored as JSON). Input must be step data that references a file path from a previous step. See Using step data in Claris Connect Help. |
String |
|
|
Organization Account - Your ASM Organization ID. The can be found in your ASM console under Preferences -> Organization Information |
String |
|