Sharing rules are the primary way that data is filtered between a school's data source and a company's application. Want a quick overview? Check out this video where we explain what sharing rules are.
Both companies and schools can create sharing rules, but they are applied in order of priority. School rules are applied first, followed by company rules, so that companies cannot access more data than the school has allowed. Both groups can view each other's rules, but only the creator can edit them.
- Developer sharing rules are set up by the developer.
- District sharing rules are set up by a district administrator.
District sharing rules are applied prior to developer sharing rules so developers cannot access more data than the district has allowed.
Examples of Rules
- Share classes for a specific grade level.
- Share all data about a specific school (e.g. people, classes, enrollments).
Create a Sharing Rule
Developer Guide
Click to Read
Types of Sharing Rules
There are currently 3 types of sharing rules that you can create in the Edlink dashboard:
- Share by Person
- Person rules allow you to include specific people by one or more attributes (e.g. email address, grade level).
- Optionally, you can also include all class enrollments associated with each person.
- Share by Class
- This is the most common type of sharing rule used.
- Class rules allow you to include a set of classes based on their attributes (e.g. class name, teacher email).
- When sharing classes, all related data is automatically shared (e.g. teachers and students).
- Share by School
- This allows you to include or exclude an entire school, along with its classes and people.
Additional Notes
- Sharing rules can be created programmatically, if needed.
- Rules can contain a start and end date.
- Filtering data via rules will result in the creation of event deltas for developers.