Sync Configuration Tab Follow

The Sync Method supports the pulling of student and/or class information from the Clever integration tool, the PowerSchool Student Information System (SIS), or the RIC One API, and automatically loading the information into Hapara daily. The configuration specified in the "Sync Configuration" page determines how the Sync Load Method works. It also impacts the format of the data that you will need to load.

If Sync is turned on, then the Sync Configuration tab is not editable. You must turn Sync off before you can edit the page.

 

Academic Year Suffix

The Academic Year Suffix is used by the Data Loader to simplify data management, and maintain a yearly class structure.

To minimise errors, and simplify the data loading process, Hapara has moved away from custom configuration of the Academic Year Suffix. The Academic Year Suffix will now be incremented automatically after archiving:

  • For Southern Hemisphere customers from "-2017" to "-2018" for example
  • For Northern Hemisphere customers from "-1617" to "-1718".

 

SIS Provider

This section specifies whether you load data from the Clever integration tool, the PowerSchool SIS, or the RIC One API. These are the only three sources currently supported by this method.

 

If you specified Source Type as Clever then you must enter:

  • Clever District/School Id

This Id is generated by Clever for your district/school and should have been provided to you.

 

If you specified Source Type as PowerSchool then you must enter:

  • HostURL
  • AuthID
  • SecretKey

These details are generated by PowerSchool for your district/school and should have been provided to you.

The section also contains a “Test” button allowing the access to PowerSchool to be tested.

 

Types of Data to Load

This section specifies whether you load Student data, Class data or both. You must select at least one of the options.

During initial testing you may decide to only synchronize Classes. But in day to day operation, almost all customers synchronize Students daily (because Student data changes often).  

 

Class Name

NB:  For RIC One integration, this section is hidden.  The first option below is applied - the class email is used for the class name.

This section specifies how the Class Name will be calculated from the data loaded. The Class Name options are:

  1. ClassEmail
  2. CourseName
  3. CourseName-Period
  4. CourseName-Section
  5. CourseName-SISId
  6. CourseName-Period-SISId
  7. CourseName-Section-SISId

 

Note:

  • The Class Names generated here must be unique across the school. If your CourseNames are not unique, choosing an option with the suffix SISId will ensure the Class Names calculated here are unique.
  • If some of the fields, in the option you choose above, are not provided by Clever/PowerSchool then the Class will not be uploaded. For example, if you choose the option "CourseName-Period-SISId" and Clever/PowerSchool provides a blank "Period" value, then the associated class will not be imported.
  • Teachers can assign a “nickname” to each of their classes in Hapara via the Manage Classes page.

 

Subject Folders

Student folders are Google Drive folders that can be created for each student in a class. The folders are shared to the student and the teacher, so the work here is not visible to other students unless explicitly shared.

The Hapara Dashboard product supports students having zero to many Subject Folders per Student per Class. This setting states how folders will be used with Classes loaded via the Sync Method.

You must select one of these options:

  1. Secondary school: Each student has one folder matching ClassEmail
  2. Secondary school: Each student has one folder matching ClassName
  3. Secondary school: Each student has one folder matching CourseName
  4. Secondary school: Each student has one folder matching CourseNumber
  5. Elementary school: Each student has the same set of subject folder(s)
  6. No student folders are created

Notes on the above options:

  • Options 1 to 4 are commonly used in secondary schools where a Class represents a combination of a subject (e.g. English) and a student cohort (e.g. Grade8B).
  • Option 5 is commonly used in primary schools where a Class represents a student cohort (e.g. Grade2c) and the teacher teaches multiple subjects to that class. You specify the folder names that will be used for all classes (e.g. English,Math,Art,Other) in this section.
  • Option 6 is not recommended for customers who are using the Hapara Dashboard product.
  • Option 6 is recommended for customers who are only using Workspace and Highlights.         
  • Also refer to the Naming Subject Folders - Recommendations article.

 

You can also specify a suffix that will be added to the end of all student subject folder names - both in each Teacher's Google Drive and each Student's Google Drive. Suffixes help make the folder names unique across all students. This suffix doesn’t help students (as they only see their own folders). This suffix helps teachers who see student subject folders in Google Drive (as the folder names they see will all be different).

You must select one of these folder suffix options:

  1. No Suffix
  2. - FirstName LastName
  3. - LastName, FirstName
  4. - StudentEmail

Notes on the folder suffix options:

  • Option 2 is the most commonly used.
  • If you select Option 4 the portion of the student email address before the “@” symbol will be used as the suffix.

Warning: Once the suffix is added to the folder names, the suffix cannot be removed or changed. So it is important to get this setting right.

Note: If you have purchased an “unprovisioned” Hapara product (such as Reseller Highlights) then this section will be hidden.

 

Student Sites

The Hapara Dashboard product supports teachers viewing student’s posts and comments on Google sites. This setting states how Student Sites will be used with Classes loaded via the Sync Method.

You must select one of these options:

  1. Do not show Site content
  2. Show content from all Sites where student is a co-author

Notes on the above options:

  • Option 2 is the most commonly used.

 

Student Blogs

The Hapara Dashboard product supports teachers viewing student’s Google blogs. This setting state how Student Blogs will be used with Classes loaded via the Sync Method.

You must select one of these options:

  1. Do not show Blogger content
  2. Show content from all blogs where student is a co-author

Notes on the above options:

Note: Hapara does not create (or provision) Blogs. Instead the Hapara Dashboard shows existing Blogs that match the option chosen above.

 

Class Calendar

Hapara can create a Google Class Calendar for each class. This setting states how Calendars will be used with Classes loaded via the Sync Method.

You must select one of these options:

  1. Class Calendars are not created
  2. Create a class calendar named ClassName_YearSuffix

Notes on the above options:

  • Option 2 is the most commonly used. This means the Calendar is given the same name as the Class.
  • Option 2 will create a Google Calendar for the Class (if the Calendar does not already exist).

Note: If you have purchased an “unprovisioned” Hapara product (such as Reseller Highlights) then this section will be hidden.

 

Student Gmails

You can control who can view Gmails associated with classes. This setting states who can see Gmails associated with Classes loaded via the Sync Method

You must specify whether Gmails are viewable by:

  1. Admins and teachers who can view the class.
  2. The teachers of the class.

Notes on the above options:

Note: If the Gmail Viewer has been disabled, then this section will be hidden. The Gmail Viewer is enabled / disabled via the Hapara Admin Console > Modules > Gmail Viewer page.



Email Notifications

You can specify people who will be emailed after a (successful or unsuccessful) automated daily Sync has occurred. Multiple people can be specified e.g. “person1@myschool.org,person2@myschool.org”.

We recommend that this field be filled in. Irrespective of whether this field filled in, the results of every Sync can be viewed on the Status page.

Each person listed here will receive two emails per automated daily Sync - that is two emails per day. The first email shows the results of the extraction of data from your SIS. The second email shows the results of the completed load.

 

Have more questions? Submit a request