Filter Rules

Discover how to filter out your data so the data doesn't appear in the application.

Suggest Edits

The Filter Rules are used to manage data sharing. These rules allow you to configure what data will be made available to applications, and to define what data will be imported in School Passport. To simplify the filtering process, use ready-made filters that contain additional attributes for more accurate filtering.

πŸ‘

Tip

If you are setting up Filter Rules for the first time, feel free to contact [email protected] for assistance.

Overview

Filter Rules enable effective data sharing management by limiting access to specific data. For example, when integrating an Export application with your district, it is often unnecessary for them to have access to the entire dataset, and limited data access is sufficient. Also in some cases, filtering data instead of importing the entire dataset can improve the speed of importing into School Passport.

Filter Rules allow permissive access. This means that all data that meet the specified conditions will be imported into School Passport. For example, if you create a filter for students and set the condition that all grades must be non-empty, only grades that match that condition will be imported. Students with blank grades will be skipped.

πŸ“˜

Note

You cannot configure filters to exclude data.

Filtering conditions

There are the following conditions are available in School Passport.

ConditionDescription
contains textSelects values that are equal to the specified text.
does not contain textSelects values that do not equal the specified text.
is emptySelects values that are empty.
is not emptySelects values that do not be empty.
afterSelects dates that occur after the specified reference date.
beforeSelects dates that occur before the specified reference date.
equalsSelects dates that match the specified reference date exactly.
is futureSelects dates that are in the future in regard to the specified date.
is pastSelects dates that are in the past in regard to the specified date.
is trueSelects values that are true.
is falseSelects values that are false.

Create a filter rule for Import application

  1. From the Home page, select an Import app you want to apply filtering.

  2. Go to the Filter Rules and click Add Filter Rule. Alternatively, click Settings > Filter Rule > Add Filter Rule.

  3. Select an entity you want to apply the filter rule.

Choose an entity for filtering

Choose an entity for filtering

  1. Choose a predefined filter or create a custom one.
  2. Choose an attribute and its condition, and then enter a value for the attribute.
Enter filter values

Enter filter values

  1. (If ready-made filter chosen) From the Include Linked, select entities that will be filtered along with the entity for which the filtering rule is configured. For ready-made filters, this field is preconfigured.
  2. (Optional) Click Add Filter to set multiple conditions for a filter. These conditions are AND conditions.
  3. Click Done.
  4. (Optional) Click Add Filter Rule to set multiple filter rules. These conditions are OR conditions.
  5. Click Save.

Create a filter rule for Export (Vendor) application

To apply filtering with the Export app, you can send a [data-sharing request](Send a Data Sharing Request for your Application) with the required filter rules. Alternatively, you can configure filters directly on the application dashboard as follows:

  1. From the Home page, select an Export app you want to apply filtering.

  2. Go to the Filter Rules and click Add Filter Rule. Alternatively, click Settings > Add Filter Rule.

  3. Select an entity you want to apply the filter rule.

  4. Choose an attribute and its condition, and then enter a value for the attribute.

  5. (If ready-made filter chosen) From the Include Linked, select entities that will be filtered along with the entity for which the filtering rule is configured. For ready-made filters, this field is preconfigured.

  6. (Optional) Click Add Filter to set multiple conditions for a filter. These conditions are AND conditions.

  7. Click Done.

  8. (Optional) Click Add Filter Rule to set multiple filter rules. These conditions are OR conditions.

  9. Click Save.

Format or delete filter rules

  1. From the app dashboard, go to the Filter Rules and click Edit Filter Rules.

  2. Click Edit Filter and make changes.

  3. Click Delete Filter for the filter rule you want to remove.

  4. Once finished, click Save.

Updated 5 months ago