Synchronisation rules

From InsightWiki
Revision as of 13:36, 5 April 2016 by Admin (talk | contribs) (Created page with "Synchronisation rules are used by Insight to determine which role a parent/student should be placed in. Students may require different roles because of the year group they are...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Synchronisation rules are used by Insight to determine which role a parent/student should be placed in. Students may require different roles because of the year group they are in. Parents may require different roles because of their Priority level, whether or not they have Parental Responsibility, whether or not there is a Court Order against them, etc.

The Synchronisation Rules page is used to configure the rules that tell Insight which role(s) should be applied to each user. The roles themselves are configured via the Roles page.

The Synchronisation Rules page

The page is split across two tabs, one for parents and another for students. The rules for parents are more complex than those for students.

Sync rules.jpg



How the Rules Work

Each parent/contact in the SIMS database could be linked to one or more pupils. Each of these links will be referred to as a contact-pupil link e.g. Contact1-PupilA, Contact1-PupilB. Each contact will have a maximum of one account which can be linked to multiple pupils.

The process Insight uses to create users is called a Sync. When a Sync is performed each contact-pupil link will be checked by the Synchronisation Rules. If the contact-pupil link matches the criteria of the rules then a role options will be applied to that contact-pupil link. The role determines what information/menu items the contact can see when viewing that particular pupil.

This means a contact's account could have multiple roles applied to it i.e. Dad is given a Full Access role when he is viewing his daughter and a Limited Access role when viewing his son.


When the Sync is performed each of the rules will be performed one at a time. The lower the Ordinal value, the earlier during the process the rule will be considered so the rule with Ordinal 1 will be performed first, followed by Ordinal 2 and so on.

A rule will be used if a contact-pupil link meets the conditions of that rule. In the example above, the rule with Ordinal 1 will trigger for a contact if:

  • The contact has a Priority level between 1 and 1 (e.g. they must be the Priority 1 contact)
  • The contact has Parental Responsibility
  • The contact does not have a Court Order against them

If these conditions are met then the contact-pupil link will be given the role shown on the right of the page ("Main School Parents - Full Access", in the example above).