Sub-Domain and Multi-Domain Setups for Teacher Dashboard Follow

Overview

If your school or district's teacher and student accounts are in separate Google Apps domains, there are a few extra steps to set up Teacher Dashboard.

There are three ways for teachers and students to be in separate domains:

Sub-domains

sub-domain is a Google Apps domain that resides within another domain. All administration is carried out through the parent domain, but email addresses are separate, and some settings can differ between parent and child domains. Student sub-domains are often a "more specific" version of the teacher domain. For example, teachers may be located in the domain myschool.org, while students are in the sub-domain students.myschool.org.

Multi-domains

Teachers and students can be in two completely different Google Apps domains. This includes scenarios in which teachers and students are in different sub-domains but share the same parent domain (e.g., teachers.myschool.org and students.myschool.org, with parent domain myschool.org).

Domain Aliases

When a domain alias is used, students may appear to be in a different domain than teachers even though they are in the same domain. This option allows users receive emails sent to addresses in a different domain, and is usually done to preserve existing email address structures.

For example, a school using the domain myschool.org might add a domain alias named students.myschool.org so that students can receive emails sent to addresses like xyz@students.myschool.org, even though their user accounts are in the domain myschool.org.

With this type of configuration, Teacher Dashboard should be treated as a single domain setup, pointing to the primary domain that contains student accounts, not the alias domain.

How to distinguish sub-domains, multi-domains, and domain aliases

Administrators who only have administrator access to the teacher domain can determine their configuration by navigating to Domain Settings > Domain Names in the Google Apps Admin console, and looking for one of the following:

  • If the student domain is listed as a domain, it is a sub-domain setup.
  • If the student domain is listed as a domain alias, then it is a domain alias setup.
  • If the student domain is not listed, then it is a multi-domain setup. 

Restrictions

Currently, the following Teacher Dashboard features are not supported in a sub-domain or multi-domain setup:

  • Class calendars
  • Email copy function

Pre-requisite Configuration Steps

requires the ability to access a variety of protected Google Apps functions in order to be configured in your domain. In a sub-domain or multi-domain environment these permissions must be explicitly granted in your Google Apps domain. Please take the following steps to do so: 

  1. Check that both domains (teacher and student) have the OAuth key enabled by following the below in each domain:

    Note: If you are using a sub-domain setup, this step is not necessary, as sub-domains inherit this setting from their parent domain. In this case, you only need to check the following in your primary domain's Admin console.
    1. Log into the Google Apps Admin console as a super administrator.
    2. From the main dashboard, navigate to "Security" > "Advanced settings" > "Authentication" and click on "Manage OAuth domain key"
    3. Ensure that both check boxes on this page are enabled (and remember to "Save changes" if changes are made):
      • "Enable this consumer key"
      • "Allow access to all APIs"
  2. Primary and Secondary domains

    Using the guidelines below, identify which domain will be used as the primary domain, and which will therefore be used as the secondary domain. The primary domain is the domain that we will copy the OAuth key and secret from, when setting up Teacher Dashboard. 
    • In sub-domain configurations, the primary domain must be the parent domain. The secondary domain will be the sub-domain.
    • In multi-domain configurations either domain can be used as the primary domain.
  3. Grant your secondary domain access to the primary domain's OAuth key

    1. Log into the primary domain's Google Apps Admin console as a super administrator. From the main dashboard, navigate to "Security" > "Advanced settings" > "Authentication" and click on "Manage OAuth Client access".
    2. Populate the "Client Name" text field with the name of the secondary domain.
    3. Copy and paste the value from the box below into the "API Scopes" text field. Please make sure that this value is copied as a single line, without any breaks.  https://docs.google.com/feeds/,https://docs.googleusercontent.com/,https://spreadsheets.google.com/feeds/,https://www.googleapis.com/auth/calendar,https://mail.google.com/,https://sites.google.com/feeds/,https://www.googleapis.com/auth/tasks,https://www.blogger.com/feeds/,https://picasaweb.google.com/data/,https://www.googleapis.com/auth/drive,https://www.googleapis.com/auth/admin.directory.group,https://www.googleapis.com/auth/admin.directory.orgunit,https://www.googleapis.com/auth/admin.directory.user,https://www.googleapis.com/auth/plus.me

      Updated 27 Jan 2014
    4. Click "Authorize" - IMPORTANT: At this point, you may receive an error message saying "This client name has not been registered with Google yet." Please disregard this message.
    5. On the same page, replace the value in the "Client Name" text field with the name of your primary domain. Please note that your primary domain may appear to have access to these APIs already, however this step is still required. 
    6. Populate the "API Scopes" text field with the same value from the box above (see step iii).
    7. Click "Authorize". 
Have more questions? Submit a request