Installieren des School Data Sync-ToolkitsInstall the School Data Sync Toolkit

Hinweis

Dieses Toolkit wird in Kürze veraltet sein.This toolkit will be deprecated soon. Wir empfehlen Ihnen, Ihre CSV-Dateien mit dem SDS-Flow-Konnektor hochzuladen.We suggest you upload your CSV files using the SDS Flow Connector. Ausführliche Anweisungen finden Sie unter CSV-Datei Synchronisierungs AutomatisierungDetailed instructions can be found at CSV File Sync Automation

Sie können das School Data Sync-Toolkit verwenden, um Ihre CSV-Dateien zu überprüfen und nach Fehlern zu suchen, eine manuelle CSV-Synchronisierung von PowerShell aus durchzuführen und den CSV-Synchronisierungsprozess entsprechend Ihren Anforderungen automatisieren.You can use the School Data Sync Toolkit to validate your CSV files and check for errors, perform a manual CSV sync from PowerShell, and automate the CSV sync process to meet your needs.

Inhalt dieses Themas:In this topic:

Installieren des Microsoft School Data Sync-ToolkitsInstall the Microsoft School Data Sync Toolkit

  1. Laden Sie das Tool aus dem Microsoft School Data Sync Toolkit herunter.Download the tool from Microsoft School Data Sync Toolkit

  2. Doppelklicken Sie auf das Tool, um den Assistenten auszuführen.Double-click the tool to run the wizard.

  3. Klicken Sie auf der Seite Willkommen auf Weiter.On the Welcome page, choose Next.

    Auf der Willkommensseite des Setup für das Microsoft School Data Sync-Toolkit „Weiter“ wählen

  4. Akzeptieren Sie den Lizenzvertrag > klicken Sie auf Weiter, wählen Sie einen Installationspfad aus, und wählen Sie dann Weiter.Accept the license agreement > click Next, choose an installation path, and then choose Next.

    Installationspfad für das Microsoft School Data Sync-Toolkit auswählen

  5. Wählen Sie Installieren > Fertig stellen.Choose Install > Finish.

Funktionen des School Data Sync-ToolkitsCapabilities of the School Data Sync Toolkit

Nachdem Sie das Toolkit installiert haben und Ihr anfängliches Profil im School Data Sync-Portal erstellt wurde, können Sie das folgende Skript verwenden, um zusätzliche CSV-Dateien regelmäßig oder bedarfsbasiert hochzuladen.After you have installed the toolkit and your initial profile has been created in the School Data Sync Portal, you can use the following script to upload additional CSV files on a regular or as-needed basis. Das Installationsprogramm ermöglicht Ihnen, mehrere Cmdlets aus einer PowerShell-Administrator Sitzung auf Ihrem Computer auszuführen, damit Sie die School Data Sync erfolgreich bereitstellen können.The installer allows you to run several cmdlets from an admin PowerShell session on your computer, to help you deploy School Data Sync successfully. In den folgenden Abschnitten finden Sie eine Beschreibung und einen Anwendungsfall für jedes Cmdlet.See the following sections for a description and use case for each cmdlet.

Hinweis

Sie müssen eine bestimmte Version von AzCopy installieren, damit die Dateiuploads funktionsfähig sind.You will need to install a specific version of AzCopy for the file uploads to work. Der Link zum AZCopy-Installationsprogramm ist hier.The link to the AZCopy installer is here.

Verwenden des School Data Sync-Toolkits zum Überprüfen von CSV-Dateidaten (vor der Synchronisierung)Use the School Data Sync Toolkit to validate CSV file data (Pre-sync)

Um mit dem Toolkit CSV-Dateien zu überprüfen, bevor Sie sie für die Synchronisierung hochladen, öffnen Sie PowerShell als Administrator, und verwenden Sie das Cmdlet Start-CsvFilesValidation entsprechend der folgenden Syntax und den Beispielen.To use the toolkit to validate CSV files before you upload the files for synchronization, open PowerShell as an Administrator and use the Start-CsvFilesValidation cmdlet as described by the following syntax and examples.

Syntax von Start-CsvFilesValidationStart-CsvFilesValidation syntax

Verwenden Sie das Cmdlet Start-CsvFilesValidation zum Überprüfen von CSV-Dateien für ein gegebenes Synchronisierungsprofil.Use the Start-CsvFilesValidation cmdlet to validate CSV files for a given sync profile.


Start-CsvFilesValidation -CsvFolderPath <String> -ProfileName <String> -UserName <String>
ParameterParameter BeschreibungDescription
CsvFolderPathCsvFolderPath
Pfad zu dem Ordner, der die CSV-Dateien enthält.Path to the folder containing the CSV files.
ProfileNameProfileName
Name des Profils, das Sie in School Data Sync für die CSVs erstellt haben, die Sie überprüfen möchten.Name of the profile you've created in School Data Sync for the CSVs you want to validate.
UserNameUserName
Benutzername des Administratorkontos mit globalen Administratorrechten für den Office 365-Mandanten.User name of the admin account with Global admin rights for the Office 365 tenant.

Im folgenden Beispiel wird eine clientseitige Prüfung der CSV-Dateien im Verzeichnis „c:\temp“ des lokalen Computers für ein Profil namens „School 1“ unter Verwendung des globalen Administratorkontos admin@contoso.com ausgeführt.The following example performs client-side validation of CSV files located in the c:\temp directory of the local computer, for a profile called "School 1", using the global admin account of admin@contoso.com.

Start-CsvFilesValidation -CsvFolderPath "c:\\temp" -ProfileName "School 1" -UserName admin@contoso.com

Verwenden des School Data Sync-Toolkits zum Synchronisieren von CSV-DateienUse the School Data Sync Toolkit to sync CSV files

Zum Hochladen und Synchronisieren von CSV-Dateien mit School Data Sync öffnen Sie PowerShell als Administrator, und verwenden Sie das Cmdlet Send-CsvFiles, wie in der folgenden Syntax und dem Beispiel beschrieben.To upload and sync CSV files with School Data Sync, open PowerShell as an Administrator and use the Send-CsvFiles cmdlet as described by the following syntax and example.

Syntax von Send-CsvFilesSend-CsvFiles syntax

Verwenden Sie das Cmdlet Send-CsvFiles zum Hochladen und Synchronisieren von CSV-Dateien für ein gegebenes Synchronisierungsprofil.Use the Send-CsvFiles cmdlet to upload and sync CSV files for a given sync profile.


Send-CsvFiles -CsvFolderPath <String> -ProfileName <String> -UserName <String>
ParameterParameter BeschreibungDescription
CsvFolderPathCsvFolderPath
Pfad zu dem Ordner, der die CSV-Dateien enthält.Path to the folder containing the CSV files.
ProfileNameProfileName
Name des Profils, das Sie in School Data Sync für die CSVs erstellt haben, die Sie überprüfen möchten.Name of the profile you've created in School Data Sync for the CSVs you want to validate.
UserNameUserName
Benutzername des Administratorkontos mit globalen Administratorrechten für den Office 365-Mandanten.User name of the admin account with Global admin rights for the Office 365 tenant.

Im folgenden Beispiel wird ein Satz von CSV-Dateien, der sich im Verzeichnis „c:\temp“ des lokalen Computers befindet, für ein Profil namens „School 1“ unter Verwendung des globalen Administratorkontos admin@contoso.com hochgeladen und synchronisiert.The following example uploads and syncs a set of CSV files located in the c:\temp directory of the local computer, for a profile called "School 1", using the global admin account of "admin@contoso.com.


Send-CsvFiles -CsvFolderPath "c:\\temp" -ProfileName "School 1" -UserName "admin@contoso.com"

Verwenden des School Data Sync-Toolkits zum Konfigurieren einer automatisierten CSV-SynchronisierungUse the School Data Sync Toolkit to configure automated CSV sync

Sie können unbeaufsichtigte automatisierte Synchronisierungen zwischen lokal gespeicherten CSV-Dateien und dem SDS-Synchronisierungsprofil in Office 365 planen. Öffnen Sie hierzu PowerShell als Administrator, und verwenden Sie das Cmdlet Add-CsvFileSyncTask, wie in der folgenden Syntax und dem Beispiel beschrieben. Nach Abschluss der geplanten Aufgabe können Sie den Fortschritt und den Verlauf dieser automatisierten Synchronisierungen überwachen, indem Sie die neu erstellte Aufgabe in der Aufgabenplanung überprüfen. Die geplante Aufgabe wird täglich um Mitternacht ausgeführt, es sei denn, Sie ändern die Startzeit mithilfe des unten aufgeführten Parameters.You can schedule unattended automated syncs between your CSV files stored locally and your SDS Sync Profile in Office 365. To do this, open PowerShell as an Administrator and use the Add-CsvFileSyncTask cmdlet as described by the following syntax and examples. After the scheduled task is complete, you can monitor the progress and history of these automated syncs by reviewing the newly created scheduled task in Task Scheduler. This scheduled task will run daily at midnight, unless you modify the start time using the parameter below.

Wenn Sie diesen Befehl ausführen, werden Sie aufgefordert, sich zu authentifizieren. Die erste Eingabeaufforderung zur Authentifizierung setzt die Anmeldeberechtigungen Ihres globalen Administrators voraus und enthält bereits den Benutzernamen, den Sie im unten aufgeführten Befehl im Parameter „username“ angeben. Nachdem Sie Ihr Kennwort eingegeben und die EINGABETASTE gedrückt haben, erhalten Sie eine zweite Eingabeaufforderung zur Standardauthentifizierung. Hier sollten Sie den Benutzernamen und das Kennwort des lokalen Administrators eingeben. Dies sind die Anmeldeinformationen, die bei jedem täglichen Start der geplanten Aufgabe verwendet werden. Wenn Sie den Parameter StoreCredentials einschließen, werden Kontoanmeldeinformationen des lokalen Administrators in der Anmeldeinformationsverwaltung gespeichert und funktionieren, solange das Kennwort nicht geändert wird. Wenn Sie den Parameter StoreCredentials nicht angeben, erhalten Sie ein Authentifizierungstoken mit einer maximalen Lebensdauer von 90 Tagen. Dies setzt voraus, dass Sie den Befehl nach Ablauf des Authentifizierungstokens erneut ausführen, da Sie sonst nicht mehr in der Lage sind, sich zu authentifizieren, während die geplante Aufgabe ausgeführt wird.When you run this command, you will be prompted to authenticate. The first authentication prompt will require your Global Admin credentials and will already contain the username you specify in the command below, under the username parameter. After you enter your password and click Enter, you will then receive a second, basic authentication prompt. Here you should enter the local administrator username and password, which will be the credentials used to run the scheduled task, each time it starts daily. If you include the StoreCredentials parameter, the local administrator account credentials will be stored in Credential Manager, and continue to work as long as the password remains unchanged. If you do not specify the StoreCredentials parameter, you will be granted an auth token, which has a maximum lifetime of 90 days. This will require that you run the command again after the auth token expires and is no longer able to authenticate while running the scheduled task.

Syntax von Add-CsvFileSyncTaskAdd-CsvFileSyncTask syntax

Verwenden Sie das Cmdlet Add-CsvFileSyncTask zum Hochladen und Synchronisieren von CSV-Dateien für ein gegebenes Synchronisierungsprofil.Use the Add-CsvFileSyncTask cmdlet to upload and sync CSV files for a given sync profile.


Add-CsvFileSyncTask -CSVFolderPath <path to csv file location> -ProfileName <name of sync profile in SDS> -LogPath <path to store logs> -UserName <global admin account> -Validate -RedirectOutput
ParameterParameter BeschreibungDescription
CSVFolderPathCSVFolderPath
Pfad zu dem Ordner mit den CSV-Dateien, die regelmäßig synchronisiert werden sollen.Path to the folder containing the CSV files that will be regularly synced.
ProfileNameProfileName
Name des SDS-Synchronisierungsprofils, mit dem die CSV-Dateien synchronisiert werden.Name of the SDS Sync Profile you are syncing the CSV Files against.
UserNameUserName
UserPrincipalName des globalen Administratorkontos, das mit SDS verwendet werden soll.UserPrincipalName of the Global Admin Account to be used with SDS.
LogPathLogPath
Pfad zu dem Verzeichnis, in dem die Protokolldateien der Prüfung gespeichert werden sollen.Path to the directory where you would like to store your validation log files.
RedirectOutputRedirectOutput
Ermöglicht die Ausgabe der Prüfungsparameter in das angegebene Verzeichnis. Dies ist erforderlich, wenn Sie die Ergebnisse der Prüfungsparameter überprüfen möchten.Will allow the output of the validate parameter to be written out to the specified directory. This is required if you want to review the results of the validate parameter.
ValidierenValidate
Führt die Prüfungsaufgabe vor jeder Synchronisierung aus. Erstellt eine Datei im Verzeichnis Logpath, wenn der Parameter RedirectOutput ebenfalls eingeschlossen wird.Run the validation task prior to each sync. Creates a file in the Logpath directory if the RedirectOutput parameter is also included.
TaskUserNameTaskUserName
Benutzername des lokalen Administrators auf dem System.Username of the local administrator on the system.
TaskStartTimeTaskStartTime
Tageszeit, zu der die geplante Aufgabe beginnt.Time of day the scheduled task will begin.
StoreCredentialsStoreCredentials
Erstellt einen Eintrag in der Anmeldeinformationsverwaltung, um die geplante Aufgabe auszuführen. Die Anmeldeinformationen bleiben gültig und funktionieren weiterhin, bis das dem Konto zugehörige Kennwort abläuft.Creates an entry in Credential Manager to run the scheduled task. The credential remains valid and continues to work, unless the password associated with this account expires.

Im folgenden Beispiel wird eine geplante Aufgabe für eine automatisierte Synchronisierung für CSV-Dateien im Verzeichnis „C:\temp“ mit einem Synchronisierungsprofil namens SDSSync erstellt. Darüber hinaus werden Protokolldateien für die Prüfung im Ordner „C:\temp\logs“ erstellt, und das Verzeichnis „C:\temp\SDS\Logs“ wird als Speicherort für alle generierten Protokolldateien festgelegt. Mit diesem Befehl wird zudem der Prüfungsprozess für die CSVs vor Beginn der Synchronisierung ausgeführt und die Ausgabe der Validierung in demselben Verzeichnis "C:\temp\logs" gespeichert.The following example creates an automated sync scheduled task for CSV files located in the C:\temp folder, on a sync profile called SDSSync, creates validation log files in the C:\temp\logs folder, and sets the C:\temp\SDS\Logs directory as the location for all log files generated. This command also runs the validation process for the CSVs before the sync begins and saves the validation output in the same c:\temp\logs directory.

Add-CsvFileSyncTask -CSVFolderPath "C:\\temp" -ProfileName "SDSSync" -LogPath "C:\\temp\\logs" -UserName admin@contoso.com -Validate -RedirectOutput

Verwenden des School Data Sync-Toolkits zum Konvertieren von OneRoster-CSV-DateienUse the School Data Sync Toolkit to convert OneRoster CSV files

Mit dem Toolkit können Sie OneRoster-CSV-Dateien konvertieren und mit School Data Sync synchronisieren. Öffnen Sie dazu PowerShell als Administrator, und verwenden Sie das Convert-OneRosterToMicrosoftSDS-Cmdlet, wie in der folgenden Syntax und im Beispiel beschrieben.You can use the Toolkit to convert OneRoster CSV Files and sync them with School Data Sync. To do this, open PowerShell as an Administrator and use the Convert-OneRosterToMicrosoftSDS cmdlet as described by the following syntax and example. Nachdem die Konvertierung abgeschlossen ist, können Sie diese CSV-Dateien über SDS nach unserer standardmäßigen CSV-Synchronisierungs Anleitung synchronisieren.After the conversion is complete, you can then sync those CSV files through SDS, following our standard CSV sync guidance.

Convert-OneRosterToMicrosoftSDS-SyntaxConvert-OneRosterToMicrosoftSDS syntax

Verwenden Sie das Convert-OneRosterToMicrosoftSDS-Cmdlet, um CSV-Dateien für ein bestimmtes Synchronisierungsprofil hochzuladen und zu synchronisieren.Use the Convert-OneRosterToMicrosoftSDS cmdlet to upload and sync CSV files for a given sync profile.

Convert-OneRosterToMicrosoftSDS -OneRosterFolderPath <String> -SDSFolderPath <String> -LogPath <String>
ParameterParameter BeschreibungDescription
OneRosterFolderPathOneRosterFolderPath
Pfad zu dem Ordner, der die aus OneRoster exportierten CSV-Dateien enthält.Path to the folder containing the CSV files exported from OneRoster.
SDSFolderPathSDSFolderPath
Pfad zu dem Ordner, in dem die konvertierten CSV-Dateien erstellt werden.Path to the folder where the converted CSV files will be created.
LogPathLogPath
Pfad zu dem Ordner, in dem die bei diesen Aktionen erzeugten Protokolle gespeichert werden sollen.Path to the folder where you want logging stored on these actions.

Im folgenden Beispiel wird ein Satz OneRoster-CSV-Dateien konvertiert, die sich im Ordner „C:\temp\OneRoster“ befinden, es wird ein neuer Satz von CSV-Dateien im Verzeichnis „C:\temp\SDS“ des lokalen Computers erstellt, und das Verzeichnis „C:\temp\SDS\Logs wird als Speicherort für alle generierten Protokolldateien festgelegt.The following example converts a set of OneRoster CSV files located in the C:\temp\OneRoster folder, creates a new set of CSV files located in the C:\temp\SDS directory of the local computer, and sets the C:\temp\SDS\Logs directory as the location for all log files generated.

Convert-OneRosterToMicrosoftSDS -OneRosterFolderPath "C:\\temp\\OneRoster" -SDSFolderPath "C:\\temp\\SDS" -LogPath "C:\\temp\\SDS\\logs"

Verwenden des School Data Sync-Toolkits zum Überprüfen von CSV-Dateidaten (nach der Synchronisierung)Use the School Data Sync Toolkit to validate CSV file data (Post-sync)

Um mit dem Toolkit CSV-Dateien zu überprüfen, nachdem Sie einen Satz von CSV-Dateien hochgeladen und synchronisiert haben, öffnen Sie PowerShell als Administrator, und verwenden Sie das Cmdlet Compare-DirectoryToCSVFiles entsprechend der folgenden Syntax und den Beispielen.To use the toolkit to validate CSV files after you upload and sync a set of CSV files, open PowerShell as an Administrator and use the Compare-DirectoryToCSVFiles cmdlet as described by the following syntax and examples.

Syntax von Compare-DirectoryToCSVFilesCompare-DirectoryToCSVFiles syntax

Verwenden Sie das Cmdlet Compare-DirectoryToCSVFiles zum Überprüfen von CSV-Dateien für ein gegebenes Synchronisierungsprofil.Use the Compare-DirectoryToCSVFiles cmdlet to validate CSV files for a given sync profile.


Compare-DirectoryToCSVFiles -CsvFolderPath <String> -ProfileName <String> -UserName <String>
ParameterParameter BeschreibungDescription
CsvFolderPathCsvFolderPath
Pfad zu dem Ordner, der die CSV-Dateien enthält.Path to the folder containing the CSV files.
ProfileNameProfileName
Name des Profils, das Sie in School Data Sync für die CSVs erstellt haben, die Sie überprüfen möchten.Name of the profile you've created in School Data Sync for the CSVs you want to validate.
UserNameUserName
Benutzername des Administratorkontos mit globalen Administratorrechten für den Office 365-Mandanten.User name of the admin account with Global admin rights for the Office 365 tenant.

Im folgenden Beispiel wird eine clientseitige Prüfung der CSV-Dateien im Verzeichnis „c:\temp“ des lokalen Computers für ein Profil namens „School 1“ unter Verwendung des globalen Administratorkontos „admin@contoso.com“ ausgeführt.The following example performs client side validation of CSV files located in the c:\temp directory of the local computer, for a profile called "School 1", using the global admin account of "admin@contoso.com".


Compare-DirectoryToCsvFiles -CsvFolderPath "c:\\temp" -ProfileName "School 1" -UserName "admin@contoso.com"

Problembehandlung: die automatisierte Synchronisierung im School Data Sync-Toolkit kann nicht ausgeführt werden.Troubleshooting: Unable to run the Automated Sync within the School Data Sync Toolkit

Schritt 1.Step 1. Löschen Sie die Aufgabe im Aufgabenplaner.Delete the task in task scheduler.

Schritt 2.Step 2. Öffnen Sie PowerShell als Administrator, und führen Sie Folgendes aus:Open Powershell as an administrator and run:


Add-CsvFileSyncTask -CSVFolderPath “path to csv file location” -ProfileName “name of sync profile in SDS” -LogPath “path to store logs” -UserName “global admin account” -RedirectOutput  

Schritt 3.Step 3. Wenn Fehler auftreten, laden Sie bitte das neueste AZCopy von hier herunter.If errors occur, please download the newest AZCopy from here.

Schritt 4:Step 4. Versuchen Sie erneut, den obigen Befehl auszuführen.Attempt to run the above command again.

Schritt 5:Step 5. Nachdem der Befehl ausgeführt wurde, wechseln Sie zum Aufgabenplaner, und öffnen Sie die Aufgabe, und überprüfen Sie Sie in den Protokollen.After the command runs, go to the Task Scheduler and open the task and verify within the logs.

Übersicht über School Data SyncOverview of School Data Sync

CSV-Dateien für School Data SyncCSV files for School Data Sync

Bereitstellen von School Data Sync mithilfe von CSV-DateienHow to deploy School Data Sync by using CSV files

Bereitstellen von School Data Sync mithilfe von PowerSchool SyncHow to deploy School Data Sync by using PowerSchool Sync

Vorgehensweise Bereitstellen von School Data Sync mithilfe von CSV-Dateien im clever-FormatHow to deploy School Data Sync by using CSV files in the Clever format

Bereitstellen von School Data Sync mithilfe von CSV-Dateien im OneRoster-FormatHow to deploy School Data Sync by using OneRoster CSV files

SDS-FehlerSDS Errors

SDS-ProblembehandlungSDS Troubleshooting