Integrating with Apple School Manager

The Apple Education Support settings allow you to integrate the Jamf Software Server (JSS) with Apple School Manager. Integrating with Apple School Manager allows you to do the following:

  • Specify a class naming format. This is applied to all classes imported from Apple School Manager. (For more information, see Class Naming and Description Format.)

  • Specify a class description format. This is applied to all classes imported from Apple School Manager. The description is displayed in Apple's Classroom app. (For more information, see Class Naming and Description Format.)

  • Sync the JSS with Apple School Manager to automatically update user and class information in the JSS at a scheduled time. You can also force the JSS to sync immediately with Apple School Manager. (For more information, see Apple School Manager Sync Time.)

  • Choose user criteria for matching imported users from Apple School Manager with existing users in the JSS. Imported user information is appended to the Roster category of user inventory information for the existing user in the JSS. (For more information, see Matching Criteria for Importing Users from Apple School Manager.)

  • Automatically create new users in the JSS by importing users from Apple School Manager.

  • Automatically create classes in the JSS by importing classes from Apple School Manager.

Integrating the JSS with Apple School Manager creates one instance of Apple School Manager in the JSS. To integrate with Apple School Manager, you need to associate a Device Enrollment Program (DEP) instance with the Apple School Manager instance. You can associate one DEP instance with one Apple School Manager instance.

For more information about Apple School Manager, see Apple's Help documentation:
https://help.apple.com/schoolmanager/

Class Naming and Description Format

When you integrate with Apple School Manager, you choose variables in the JSS that match values for class information in Apple School Manager. The JSS allows you to specify variables that apply to a class name and class description when the class is imported from Apple School Manager to the JSS. You can specify variables for the following settings:

  • Class Naming Format—When a class is imported, the variables are applied to the display name of the class in the order you select. For example, if you select "Course Name" and "Class Source ID", the class is imported to the JSS with a name like "Biology12345".
    The default values for the class naming format are "Course Name" and "Class Source ID".

  • Class Description Format—When a class is imported, the variables are applied to the description of the class in the order you select. For example, if you select "Location" and "Instructor", the class is imported to the JSS with a description like "EauClaireSamanthaJohnson".
    This setting overwrites existing class descriptions the next time the JSS syncs with Apple School Manager for classes that have already been imported.

The following table displays the available variables in the JSS and the values for class information that the variables match in Apple School Manager. The same variables are available for the class naming format and the class description format:

Variable in the JSS

Class Information in Apple School Manager

Notes

Location Name

Role/Location

 

Class ID

Class ID

 

Class Source ID

Course ID

 

Course Name

Course Name

 

Class Name

Class Name

 

Course Number

Course Number

 

Class Room

Room

 

Class Site

N/A

Value is populated based on the site the class is imported to in the JSS.

Instructor Name

N/A

Value is populated based on "Last Name" for the teacher that is imported with the class. If there is no value for "Last Name", this value is populated with the value for "Full Name".

If there are multiple teachers in a class, the "Instructor Name" value is populated with the teacher name that comes first alphabetically by last name.

Instructor Grade

N/A

Value is populated based on "Grade" for the teacher that is imported with the class.

If there are multiple teachers in a class, the "Instructor Grade" value is populated with the teacher name that comes first alphabetically by last name.

Class Number

Class Number

 

Custom

N/A

In addition to variables, you can apply a custom field to the class naming format to separate variables or enter custom text. For example, if you select "Course Name", "Custom Text", and "Class Source ID", and enter a hyphen (-) in the Custom Text field, the class is imported to the JSS with a name like "Biology-12345".

Note: If a value is not available in Apple School Manager for the variable selected in the JSS, a blank value is displayed in the JSS for that selected variable in the class name.

Apple School Manager Sync Time

You can configure how frequently the JSS syncs information from Apple School Manager. Configuring a sync time allows user and class information to be updated automatically if there is updated information available in Apple School Manager. You can choose to sync never, daily, once a week, every other week, or once a month. The default sync time is "Never". In addition, you can force the JSS to sync immediately with Apple School Manager. (For more information, see Forcing an Apple School Manager Sync.)

Information is only synced from Apple School Manager to the JSS, not from the JSS to Apple School Manager.

When the configured sync time is reached or you have forced an Apple School Manager sync, inventory information in the Roster category is updated for the imported users and users associated with an imported class. Class information, such as the display name, is also updated. If you modify the class naming format after a class has been imported, the class name is updated and the class naming format is re-applied to the classes that have been imported.

Important: Any information that is manually entered in the Roster category of user inventory information is replaced with information from Apple School Manager during a sync.

If a student or teacher is added to a class in Apple School Manager after a class has been imported, the user is imported to the JSS and matched with existing users during a sync based on the criteria for matching imported users from Apple School Manager. If there is no match, the imported user is added to the JSS as a new user in the Users tab. (For more information, see Matching Criteria for Importing Users from Apple School Manager .)

If you have not yet imported users or classes from Apple School Manager when the configured sync time is reached, information is synced at the time configured and stored in the JSS database for the class or user until they are imported. (For more information, see Importing Users to the JSS from Apple School Manager and Classes.)

Note: The JSS performs one sync at a time.

Matching Criteria for Importing Users from Apple School Manager

When you integrate the JSS with Apple School Manager, you choose JSS user criteria to match with Apple School Manager user criteria. Users that are imported to the JSS are matched to existing users in the JSS based on the selected user criteria.

The following table displays the criteria you can use to match imported users from Apple School Manager to existing users in the JSS:

JSS User Criteria

Apple School Manager User Criteria

Email (JSS)

Managed Apple ID

Username (JSS)

Source System Identifier

User Extension Attributes*

 

*It is recommended that you match "Source System Identifier" from Apple School Manager with the student ID number in the JSS. One way to do this is to create a user extension attribute that collects the student ID number in the JSS. (For more information on how to create a user extension attribute, see User Extension Attributes.)

The default criteria matches "Email (JSS)" with "Managed Apple ID" from Apple School Manager and an operator of "equals".

Note: Imported users from Apple School Manager cannot be matched to users with manually entered information in the Roster category of user inventory information. This results in duplicate users.

Requirements

To integrate with Apple School Manager, you need to integrate the JSS with DEP. (For more information, see Integrating with the Device Enrollment Program.)

Configuring an Instance of Apple School Manager

  1. Log in to the JSS with a web browser.

  2. In the top-right corner of the page, click Settings images/download/thumbnails/16428442/Settings_icon.png .

  3. Click Mobile Device Management.

  4. Click Apple Education Support images/download/thumbnails/12980243/_thumb_25890.png .

  5. Click Edit.

  6. Click the Apple School Manager tab.

  7. Select the Enable Apple School Manager Integration checkbox.

  8. Click Add.
    If you have not integrated the JSS with DEP, click the Device Enrollment Program settings link.
    For instructions on how to integrate with DEP, see Integrating with the Device Enrollment Program.

  9. Enter a display name for the Apple School Manager instance.

  10. Choose a DEP instance from the Device Enrollment Program Instance pop-up menu.

  11. Use the Class Naming Format options to select a variable to apply to the name of a class when importing the class from Apple School Manager. To add more variables, click Add and select "Variable" or "Custom Text".
    To remove a variable, click the "X" next to the variable field.

    images/download/attachments/14452925/Class_Naming_Format.png

  12. (Optional) Use the Class Description Format options to select a variable to apply to the description of a class when importing the class from Apple School Manager. To add more variables, click Add and select "Variable" or "Custom Text".
    To remove a variable, click the "X" next to the variable field.

  13. (Optional) To select a time that the JSS should sync with Apple School Manager, choose a time interval from the Apple School Manager Sync Time pop-up menu, and then configure the days and time to sync.
    The time zone that is displayed is the time zone that is configured in System Preferences.
    Note: It is recommended that you choose to sync with Apple School Manager at a time other than when you choose to flush logs or back up your database.

  14. Choose criteria to use for matching imported users from Apple School Manager with existing users in the JSS using the Matching Criteria for Importing Users options:

    1. Select JSS or Apple School Manager user criteria from the User Criteria pop-up menu on the left.

    2. Choose an operator from the Operator pop-up menu.

    3. Select JSS or Apple School Manager user criteria from the User Criteria pop-up menu on the right.

      images/download/attachments/16428442/ASM_Match.png
  15. Click Save.

When you import users or classes, the variables selected for the Class Naming Format are applied to the class display name, and the user information from Apple School Manager is matched to existing user information in the JSS based on the selected criteria.

The JSS updates user and class information from Apple School Manager at the time configured.

Forcing an Apple School Manager Sync

You can force the JSS to sync immediately with Apple School Manager. This allows you to update user and class information in the JSS when needed. (For more information about syncing the JSS with Apple School Manager, see Apple School Manager Sync Time.)

Note: Forcing the JSS to sync with Apple School Manager can add significant network traffic in the JSS. It is recommended that you force sync at a time other than when you choose to flush logs or back up your database.

  1. Log in to the JSS with a web browser.

  2. In the top-right corner of the page, click Settings images/download/thumbnails/12985462/Settings_icon.png .

  3. Click Mobile Device Management.

  4. Click Apple Education Support images/download/thumbnails/12976637/EduFeatureSettings.png .
    A list of Apple School Manager instances is displayed.

  5. Click the Force Sync button next to the Apple School Manager instance that you want to manually sync the JSS with.

The JSS immediately syncs information from Apple School Manager.

If you force the JSS to sync with more than one instance of Apple School Manager, the JSS performs one sync at a time.

Further Considerations

Deleting an Apple School Manager instance removes the information in the Roster category of user inventory information that is imported from Apple School Manager. This disables Shared iPad for users.
Note: Deleting an Apple School Manager instance does not remove the users or classes that have been imported from Apple School Manager.

Related Information

For related information, see the following sections in this guide:

For related information, see the following technical papers:

Integrating with Apple School Manager to Support Apple's Education Features Using the Casper Suite
Get step-by-step instructions on how to integrate with Apple School Manager to support Apple's education features with the Casper Suite.

Copyright | Privacy | Terms of Use | Security
© copyright 2002-2017 Jamf. All rights reserved.