About configuration files

After July 1, 2022, we no longer support School Directory Sync (SDS). Instead, use the Student Information System (SIS) roster report. Learn more

In Configuration Manager, you can create, save, or load configuration files to store Google School Directory Sync (SDS) settings. All configuration files are in XML format.

Note: Store your configuration files securely. Unprotected configuration files are a security risk.

Work with configuration files

Open Configuration Manager

1. Choose an option:
   • On Windows, click the Start menu All Programs Google School Directory Sync Configuration Manager.
   • In the directory where you installed SDS, open a command line and enter config-manager-sds.
2. In the panel on the left, click a topic to access settings.

   Required settings are in red.

Open a configuration file

• Click File Open and select the configuration file.

  Configuration Manager displays the settings for that configuration file.

• Click File Open Recent to easily find a file you recently worked on.

Create, save, or copy a configuration file

Create a new configuration file

• From the top menu, click File New.

  Configuration Manager loads a new file with no configuration rules specified.

Save a configuration file with a new name

• Click File Save As and specify the directory and file name.

Save a configuration file with an existing name

• Click File Save and specify the directory and file name.

If you overwrite an existing file, Configuration Manager saves the existing file as a copy with a timestamp in the file name that indicates when the file was overwritten.

Copy a configuration file

If you copy a configuration file to another server, use Configuration Manager on the new server to open the file and re-enter sensitive data, such as passwords or an OAuth 2.0 reauthorization.

Using files from different machines or users (Windows)

If you open an XML file that was saved on a different machine or by a different user on the same machine, SDS won't be able to access the secrets in the XML file. You must re-enter them in Configuration Manager.

To run SDS files from different machines or users:

1. Click the Start menu  All Programs and search for SDS.
2. When you see SDS, hold down Shift and right-click Google School Directory Sync.
3. Click Run as different user.

   Note: If you're running the sync-cmd task as the Windows SYSTEM user, NetworkService, or another system account, you may not be able to use Run as different user to run the Configuration Manager as that user. Try using PsExec from Microsoft to run Configuration Manager as a system user.

4. Enter the administrator username and password.
5. Click OK.
6. Update the passwords and reauthorize OAuth as needed.
7. Save the XML file.
8. Run a simulation to ensure that your settings are correct.
9. Manually run a synchronization and review the logs to ensure that the XML file was saved correctly.