Synchronisation rules - Revision history

Admin at 11:31, 24 May 2018

2018-05-24T11:31:27Z

Admin at 08:30, 14 April 2016

2016-04-14T08:30:59Z

Admin: /* Creating and Editing rules */

2016-04-05T14:34:17Z

Creating and Editing rules

Admin: /* Example */

2016-04-05T14:28:31Z

Example

Admin: /* How the Rules Work */

2016-04-05T14:18:08Z

How the Rules Work

Admin: /* How the Rules Work */

2016-04-05T14:17:53Z

How the Rules Work

Admin at 14:01, 5 April 2016

2016-04-05T14:01:22Z

Admin at 14:00, 5 April 2016

2016-04-05T14:00:57Z

Admin: /* How the Rules Work */

2016-04-05T14:00:28Z

How the Rules Work

Admin: 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..."

2016-04-05T13:36:54Z

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..."

New page

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. 

<div>[[Image:sync_rules.jpg]]</div> 

==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|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).

@@ Line 1: / Line 1: @@
 __FORCETOC__
-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. <br> <br>
+=Students=
-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. <br> <br>
+In order for students to log in to Insight, you must have purchased the '''[[AD links|AD Links]]''' additional module for Insight. This allows students to log in using their Active Directory details. <br> <br>
-==The Synchronisation Rules page==
+You can create multiple Synchronisation Rules if required. This allows you to assign different roles to students, depending on which year group they are in. If you want all students to use the same Role then you only need one Synchronisation Rule, otherwise you need one Synchronisation Rule per Role you want to use. <br> <br>
-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. <br> <br>
+Select a Synchronisation Rule then click the '''Edit''' button to edit that rule, or click '''Add''' to create a new rule. This will take you to a new page. Select the year groups that this rule should apply to, then at the bottom of the page select the Role to be given to the students. Click '''Save''' once done. <br> <br>
-<div>[[Image:sync_rules.jpg]]</div> <br> <br>
+=Parents=
-==How the Rules Work==
+[[Image:parental_sync_rules_list.png|thumb|A list of Synchronisation Rules for parental accounts]]
-Each parent/contact in the SIMS database could be linked to one or more pupils e.g. a Dad has a son and a daughter at school. This represents two contact-pupil links; Dad-Son and Dad-Daughter. Each contact will have a maximum of one account which can be linked to multiple pupils. <br> <br>
+Parents may need to be given different roles depending on the year group that their child is in e.g. a parent of a Year 13 student may need to see more options (such as exam data) in Insight than a parent of a Year 7 student. <br> <br>
-The process Insight uses to create users is called a Sync. The Sync will check each contact-pupil link to see what role (if any) should be applied. A role is a set of permissions that 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. <br> <br>
+Parents may also need to be given different Roles because of their relationship to students. For example, a contact who has Parental Responsibility but also has a Court Order against them may need a limited access Role. <br> <br>
-Each of the Synchronisation rules has criteria and a Role. If a contact-pupil link meets the criteria for the rule, then the Role is applied to the contact-pupil link. <br> <br>
+Click the '''Edit''' button or '''Add''' button to edit or create a rule. <br> <br>
-===Example===
+If a parent has more than one child at school then more than rule may apply to them, one rule per child. This means that a parent may have a different Role for each of their children. See the '''[[#Example|example]]''' below for more information. <br> <br>
-The Ordinal value of the rule is shown in red, the criteria in green and the role in blue. <br> <br>
+For the following three options you can choose '''Yes''' (parents must have this attribute), '''No''' (parents must not have this attribute) or '''na''' (it does not matter whether parents have this attribute): <br>
-<div>[[Image:sync_example.jpg]]</div> <br> <br>
+===Example===
 Imagine a parent has two children at school with the following details in SIMS:
@@ Line 31: / Line 39: @@
 |Daughter||1||Yes||No||Yes
 |-
-|Son||2||Yes||No||No
+|Son||9||Yes||Yes||No
 |} <br>
-The parent's relationship with the daughter meets all the criteria of the first rule; the parent is the Priority 1 contact, has Parental Responsibility and does not have a Court Order. Therefore the parent will have the "Main School Parents - Full Access" role when viewing the daughter. <br> <br>
+And you have the following rules configured in Insight: <br>
+[[Image:parental_sync_rule_example.png]] <br> <br>
-Existing rules can be reordered by selecting them and clicking the Up or Down buttons at the top right of the page. Rules are created and edited using the Add and Edit buttons at the top left of the page which opens a new page where the criteria and Role for a rule can be set. <br> <br>
+The parent's relationship with the daughter meets all the criteria of the first rule; the parent is the Priority 1 contact and does not have a Court Order. Therefore the parent will have the "Full Access" role when viewing the daughter. <br> <br>
-<div>[[Image:syncrules_detail.jpg]]</div> <br> <br>
+The parent's relationship with the son does not meet the criteria for the first rule. The parent does not have the sufficient Priority level and also has a Court Order. The parent's relationship with the son does meet the criteria for the second rule though, so the parent will have the "Limited Access" role when viewing the son. <br> <br>
-[[Category:Management]]
+The rules at the top of the list take priority over those lower down, so if a parent meets the criteria for multiple rules for one of their children, they will always be given a role by the highest rule on the list that applies to them. <br> <br>

← Older revision		Revision as of 08:30, 14 April 2016
Line 46:		Line 46:
	<div>[[Image:syncrules_detail.jpg]]</div> <br> <br>		<div>[[Image:syncrules_detail.jpg]]</div> <br> <br>

−	[[Category:~~Configuration~~]]	+	[[Category:Management]]

← Older revision		Revision as of 14:34, 5 April 2016
Line 41:		Line 41:

	==Creating and Editing rules==		==Creating and Editing rules==
		+
		+	Existing rules can be reordered by selecting them and clicking the Up or Down buttons at the top right of the page. Rules are created and edited using the Add and Edit buttons at the top left of the page which opens a new page where the criteria and Role for a rule can be set. <br> <br>
		+
		+	<div>[[Image:syncrules_detail.jpg]]</div> <br> <br>

	[[Category:Configuration]]		[[Category:Configuration]]

@@ Line 25: / Line 25: @@
 <div>[[Image:sync_example.jpg]]</div> <br> <br>
-Dad's relationship with children
+Imagine a parent has two children at school with the following details in SIMS:
 {| class="wikitable"
 !Relationship!!Priority!!Parental Responsibility!!Court Order!!Cohabiting
@@ Line 34: / Line 34: @@
 |} <br>
-Each contact's relationship with a pupil will be checked against the rules when a Sync is run. If there is a parent at school
+The parent's relationship with the daughter meets all the criteria of the first rule; the parent is the Priority 1 contact, has Parental Responsibility and does not have a Court Order. Therefore the parent will have the "Main School Parents - Full Access" role when viewing the daughter. <br> <br>
 ==Creating and Editing rules==
 [[Category:Configuration]]

@@ Line 26: / Line 26: @@
 Dad's relationship with children
-{|
+{| class="wikitable"
 !Relationship!!Priority!!Parental Responsibility!!Court Order!!Cohabiting
 |-

← Older revision		Revision as of 14:01, 5 April 2016
Line 18:		Line 18:

	Each of the Synchronisation rules has criteria and a Role. If a contact-pupil link meets the criteria for the rule, then the Role is applied to the contact-pupil link. <br> <br>		Each of the Synchronisation rules has criteria and a Role. If a contact-pupil link meets the criteria for the rule, then the Role is applied to the contact-pupil link. <br> <br>
		+
		+	==Creating and Editing rules==
		+
		+	[[Category:Configuration]]

← Older revision		Revision as of 14:00, 5 April 2016
Line 1:		Line 1:
		+	__FORCETOC__
		+
	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. <br> <br>		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. <br> <br>