Apple School Manager import
The ASM Import Configuration enables Relution to create new users based on data from the Apple School Manager (ASM) or to synchronize existing users with the Managed Apple Accounts (Managed Apple ID in the portal) from the ASM. In addition, the classes from ASM can be imported.
The opposite direction, creating Managed Apple Accounts in ASM from the data in Relution, is described under SFTP Upload →.
Prerequisites
- A valid ADE token (Automated Device Enrollment, DEP token in the portal) within the organization where the configuration is to be created.
- Managed Apple Accounts that have been grouped into at least one class in the ASM (minimum of one student and one teacher).
Configuration
Navigate to Settings:
Settings→Education→Apple School Manager Import ConfigurationAdd a New Configuration: A new configuration is created via Add.
Enter the Provider Name: A unique name is entered under Provider name. The name cannot be changed after saving, because Relution uses it to match previously synchronized objects.
Select the DEP Account: Under DEP account, Select is used to choose the DEP account through which Apple School Manager is accessed. Without a DEP account, Check connection, Locations and Preview are not available, and the configuration cannot be saved.
Test the Connection: Check connection verifies whether a connection to Apple School Manager is possible with the DEP account.
Select Locations: Under Locations, one or more ASM locations are chosen for the import via Select. Only the classes of these locations are imported, together with the teachers and students who are members of one of these classes.
Preview Available Classes: Under Preview, Show displays the classes that will ultimately be imported.
In the global organization and in meta organizations, the Locations option does not exist. There, the configuration is first saved with the DEP account. Afterwards, the Map locations to organizations section in the Map objects to organizations area defines which ASM locations are imported into which organization. Without mapped locations, no synchronization takes place.
Synchronization Settings
The Synchronization settings area defines which objects Relution creates from ASM and what happens to objects that are no longer delivered by ASM.
Create New Relution Users
- Enabled by default.
- Relution creates a new user for every ASM user for whom no matching Relution user is found. The search uses the link from previous synchronizations, the Managed Apple Account and the matching rules enabled under Advanced.
- Matching users without a source system (e.g. created manually) or from the same ASM configuration are linked and taken over instead. They get the ASM configuration as their source system.
- Users of other source systems (e.g. LDAP) are not linked. If they have the same email address or the same username as the user to be created, creating the user fails (sync error Duplicate e-mail or Duplicate username).
- If the option is disabled, only existing users are linked. ASM users without a matching Relution user are not imported.
Update Managed Apple ID for Matching Relution User of Any Source System
- Disabled by default.
- Overwrites the Managed Apple ID field of a user from another source system (e.g. LDAP) if the ASM user can be matched to this user via one of the matching rules enabled under Advanced. The user’s other data and source system remain unchanged.
- The option only applies to ASM users that were neither linked nor newly created, in practice only when Create new Relution users is disabled.
Synchronize Classes
- Enabled by default.
- Imports the classes of the selected locations from ASM and creates or updates them in Relution.
- Classes for which no synchronized teacher or no synchronized student exists in Relution are skipped (sync error Class members are missing).
- Recommended only in cases where:
- No class data exists in Relution.
- Manual class configuration in Relution is not planned.
- No LDAP system is in use.
- Important: If classes are already synchronized via LDAP, this option should not be enabled.
Action When a User Is Removed in ASM
- Defines what happens to users of this configuration that are no longer delivered during a synchronization:
- None (default): The users remain unchanged.
- Deactivate: The users are deactivated in Relution.
- Delete: The users are deleted in Relution.
- This applies to all users that have the ASM configuration as their source system, i.e. newly created users as well as linked users that previously had no source system (e.g. created manually).
- Users of other source systems (e.g. LDAP) whose Managed Apple Account was only updated remain unchanged. Their Managed Apple Account is not removed.
- If a synchronization does not deliver a single user, for example because of a connection problem or a misconfiguration, no users are deactivated or deleted.
Action When a Class Is Removed in ASM
- Specifies whether classes in Relution are deleted when they are removed from ASM: None (default) or Delete.
- If no classes are synchronized, this option has no effect.
Automatic Synchronization via Cron Expression
- Defines the frequency at which Relution automatically imports information from ASM.
- By default, the synchronization runs daily at 6 a.m. and 9 p.m. (
0 0 6,21 * * ?).
Advanced
The Advanced area defines how ASM users are matched to existing Relution users and which ASM value is used as the username.
ASM User to Relution User Matching
- Defines the rules by which an ASM user is matched to an existing Relution user. Several rules can be active at the same time.
- Before these rules are applied, the synchronization always first looks for a Relution user that is already linked to the ASM user or has the same Managed Apple Account.
- The enabled rules are then checked in this order. The first matching rule applies:
- Match the ASM user’s Managed Apple ID to the Relution user’s email (default: enabled)
- Match the ASM user’s email to the Relution user’s email (default: disabled)
- Match the ASM user’s name to the Relution user’s username (default: disabled)
- Match the ASM user’s first and last name to the Relution user’s first and last name (default: disabled)
- Only Relution users of the same organization that have no source system or come from this ASM configuration are considered. Users of other source systems (e.g. LDAP) are not taken over. If Update Managed Apple ID for matching Relution user of any source system is enabled, the same rules (without the preceding check) determine for which user of another source system only the Managed Apple Account is updated.
- Note: If Create new Relution users is not enabled and none of the rules allows a match, no linkage will occur between the systems.
ASM User to Relution User Mapping
- ASM user field to use as Relution user name specifies which value from ASM is used as the username in Relution. The options are Name (default), Managed Apple ID and E-mail.
- Note: With every synchronization, the username as well as the first and last name are taken over from ASM for matched users. The email address in Relution is replaced by the Managed Apple Account, and the user is activated.
Synchronization
The synchronization runs automatically according to the configured schedule. It is started manually in the list of configurations via Sync in the context menu, or in the detail view of a configuration via the Sync icon.
Synchronized teachers and students are added to the respective default group Teacher or Student of their organization. For more on these groups, see Education function →.
The detail view shows the synchronization results separately for Users and Courses, including Next planned synchronization, Last completed and Success. The Sync Errors column shows the individual errors, e.g. Duplicate e-mail, Duplicate username, Class members are missing or Roster object synchronization failed.