To enable sharing rules, click on your integration in your Edlink dashboard.

You will see your Integration Summary page.

Next, select the Sharing Rules tab.

Note: If you are a developer (learning platform), you can access your team’s developer sharing rules, not the districts. Vice versa if you are a district administrator.

You will see filtered roster data if a district administrator has set District Rules.

Click on the blue Create a Rule button.

This will prompt a menu of three sharing rule options. You can share by Class, School, or People.

Once you select a type, choose which data you want to share with your app. Use the categories listed at the top of the page. For example, below are the categories for sharing by class.

Check out this article to see all the categories you can set rules by.

Create a rule based on a condition. In the example below, I will share classes where the class title contains any of "Spanish.”

Tips:

  • The Set Start Date, Set End Date, and Products are optional.
  • Note that the filter is case-sensitive. For example, if classes in the LMS are titled "Spanish,” do not use “spanish.”
  • When you add more than one condition (i.e., class, teacher, session), they will narrow more and more on the roster data since between each additional condition is an “and” statement.
  • If you can't find a class that you think should appear, please reach out to your client success manager at Edlink.
  • You will need to hit enter on your keyboard after typing in a class name, email, student name, etc. If you do not hit enter, the condition will not be entered. Clicking outside of the text box will not enter the condition.

You can check the results of your conditions by clicking the Preview button.

In my example above, I selected Classes to preview the classes I want to share.

Note: When you select an entity (in this case, a class), you will now see our new “Peak” tab:

You will have the option to view the entities “JSON” and “Passed Rules.”

Passed rules is where you can check as to why that specific entity (i.e., class) was shared:

In the example above, the Spanish 3 - Canvas (Section 1) class was shared because it passed the “Licensed by Class Title” rule.

Now that we’re done with our rule, select the blue Save Changes button.

You'll then see the rule block that you saved.

Important step: Toggle the Enable Developer (or District) Sharing Rules if you want to apply the rule block that you created earlier.

A window will appear. Select Switch to Share By Rules.

Note: It can take several minutes for the updated info to show in the dashboard.

You can check the progress of your changes in the Materialization tab.

Once the materialization is completed, you can see the filtered roster data.

Once the process is complete, you'll only be able to view the shared users from the Edlink dashboard.