Clever Developer Docs

Custom Sandbox Districts

A sandbox district is a demo district account, populated with demo data, that your team manages for development purposes. Developer accounts are automatically populated with a sandbox dataset upon creation. Clever also allows developers to create custom sandbox school districts to help build and test your integration if necessary.

Each application may create sandboxes adhering to the following guidelines:

  • Maximum of 5 sandbox districts
  • Name districts with the following convention: #DEMO <app name> (e.g. #DEMO ReadingFun Sandbox District)

Creating your own sandbox is a great way to understand the experience districts have setting up Clever and your application. You'll also have the opportunity to control the data Clever sends your application. You'll be juggling multiple accounts to administrate your sandbox.

Creating a sandbox district

Step 0: Grab the application signup URL

You can link the new sandbox district to an application on creation by using your application's signup URL.

Sandbox districts must be connected to at least one application

You can find the signup URL on the Application Settings page of your Clever dashboard and clicking on the Settings link in the left sidebar:

Copy the District Signup URL - that's the URL you'll need to create the district.

Step 1: Create the district

Step 0.5: Log out of your application dashboard first!

Sandbox districts are distinct from application accounts, and so you'll receive an error if you attempt to sign up as a district while logged in to your application's Clever dashboard. Alternatively, you can use an incognito window.

The District Signup URL should lead to the district signup form:

Enter your sandbox name (`#DEMO <Application Name>) and wait for our system to search our records for it. Since this is not a real district, Clever will then provide you with a link to "Add" your district to our records. Click this link to continue!

Add your email address and provide a username and password for the account.

The email address you use must not be associated with any other sandbox district or application account.

Step 2: Set up Instant Login

As part of the signup process, you'll need to set up users' credentials for your sandbox district.

While you can set up Instant Login with any supported identity provider we recommend "Custom Username and Password" as this will allow you to log in as any user without needing to do any custom IDP configuration.

Here are the default credentials for "Custom Username and Password" option:

We recommend the following configuration:

  • Students:
    • Username: Student Number
    • Password: Student Number
    • Uncheck "Require students to reset their passwords on first login
  • Teachers:
    • Username: Teacher Number
    • Password: Teacher Number
    • Uncheck "Require teachers to reset their passwords on first login

Credentials for district admins can be set on this page once setup is complete. Please note: you must be logged in to your sandbox district to access this link.

Step 3: Set up for syncing

You'll need to pick a SIS and sync type before you can continue. If you happen to have a dummy SIS, you can certainly choose it - for ease of syncing, we recommend selecting any SIS and setting Data Export Configuration to "SFTP" - this means you will sync data to Clever by sending CSV files via SFTP.

Step 4: Approve applications

Next you'll be prompted to add applications - your application will already be selected since you used the District Signup URL to create your account.

Please do not add any applications that don't belong to you.

When you're ready hit Next and you'll be asked to authorize each application:

Since you used the District Signup URL, the connection is pre-authorized! When districts add applications via their dashboards instead, an application would need to approve the request.

Uploading data

Now that you have a sandbox district and have added your application, it's time to populate it with data! If you set your district up with the SFTP sync method, you navigate to Settings > Sync Settings to sync data:

You can either connect via a SFTP client or use the 'Upload' link to submit your files - please note that you will need to provide at least the following five files every time you sync data:

  • schools.csv
  • students.csv
  • teachers.csv
  • sections.csv
  • enrollments.csv

admins.csv, which is used to provision school admins, is not required.

Sample data

  • Clever USD (default) - a 249-school data set made up of anonymized real district data. This provides a realistic dataset for a large school district.
  • Certification ISD - a 5-school data set that we built to contain as many edge cases as possible. This allows you to test the worst of the worst district data. For more information, check out Testing Your Sync.

Sharing data

Once your data is synced, the next step is to share data with your application. To start, navigate to your application by clicking your app name/icon from the district's Clever dashboard.

Next, click over to the "Data Sharing" tab:

For testing purposes, you'll usually want to share by district. If you'd like to better understand the sharing options or share a specific subset of data, check out our guide to sharing settings.

Launch the district connection

As the final step, you'll need to launch the district connection from your application dashboard to complete the setup process.

Log back into your application dashboard. On your Home screen, you should now see your new sandbox district marked with an orange "Setting Up" status indicator. Click into the new sandbox, and in the "Overview" tab, you'll see the Launch Date preset as 30 days from the creation date.

Click on the Edit/Pencil icon to modify the launch date, and select "Launch Now". This will launch the connection and allow sandbox data to be accessed by your application.

That's it! You should now see the "Launched" blue status indicator for the new sandbox district.

Linking a sandbox district to multiple applications

To connect an existing sandbox district to additional applications, log in to your sandbox district and go to the application's District Signup URL. You'll then be prompted to authorize the additional application and share data!

Custom Sandbox Districts