Integration Data Filters

Coursedog Support

Modified on: Thu, Apr 11, 2024 at 11:53 AM

Table of Contents

Overview

Integration filters allow for excluding integration data that your institution does not want displayed in your Coursedog environment.
Coursedog can filter out integration data that should not be displayed in the Coursedog environment by setting up Integration Data Filters in the Admin Console (Admin > Integration Filters).
Initial filtering rules/logic are identified during your Coursedog implementation and set up by your Coursedog team. If you need to make an update post-implementation, we recommend reaching out to your Coursedog Customer Success contact and/or opening a support ticket for assistance.

General examples of integration data an institution might want to filter out include, but are not limited to:

Coursedog has observed schools using the following filters:

Terms - Exclude terms older than a given year (e.g. 2019)
Instructors - Exclude inactive instructors
Rooms - Exclude inactive rooms, and rooms of type “Dormitory” or else only include a set of rooms using a list of explicit room IDs
Buildings - Exclude or include buildings by their building code/ID
Departments - Exclude or include departments by department ID

Courses - We do not often need to filter courses; however, there are instances when we exclude inactive courses or courses that belong to departments we don’t want in Coursedog.
Sections - We never include filters for sections.

Step 1: Navigate to the Admin Panel > Integration Filters.

Step 2:

Select the appropriate entity.
You can create filters for each object type: courses, relationships, sections, courses (curriculum), professors, rooms, departments, terms, programs, buildings.

Step 3: Click “Add Filter”.

Step 4:

Select the type of filter.
There are five different types of filters:
Value Filter: This filter is used to filter out documents with fields equal to specific values. Below there are three inputs: Key, Values, Anti-Values. The key input specifies which field is being filtered on. If the Values input is populated, then if the data field equals at least one of the items in the values list, the document will be removed. If the Anti-Values input is populated, then if the data field does not equal one of the items in the Anti-Values list, the document will be removed. In other words, if the value is included in the Anti-Values list, the document will be kept
Sub Value Filter: This works the same as the Value filter, except it will search for sub-values within fields that are of type string or array. For example, if you want to filter on the Course Code field, and you provide a value of "ECON", then all courses with a code that includes "ECON" will be filtered out.
Empty Value Filter: This filter is used to filter out documents with keys that contain a value of null, undefined, NaN, or an empty string.
Empty Array Filter: This filter is used to filter out documents with keys that contain an empty array.
Starts With Filter: This filter is used to filter out documents with keys that contain values that start with the filter value.

Step 5:

Complete the remaining information, which will vary depending on the selected filter type.
Filter Values are used to remove records from integration. In other words: options selected here will be filtered out.
Filter Anti Values means the integration will keep these records. In other words: these values will not be filtered out.

Step 6: Click the "SAVE" button.

Step 7:

Once you’ve saved your filter, you can test it by clicking the "TEST FILTER" button.
This function that will pull the integration data, apply the filter, and display the results (a dialogue box listing the result count before the filter was applied and after the filter was applied to show how many results were filtered out).
Note the "TEST FILTER" function does not work on all entities – e.g. large data sets like Courses, Sections, and Courses (Curriculum) – due to timeout in the web UI before the API completes.

Step 8:

Execute a manual merge, or wait for the nightly merge to run, for the entity to which integration filters have been added to see the resultant remaining integration data in Coursedog.
The integration filters will not be applied until a merge on the entity has been executed.
There is a default protection enabled for nightly merges that prevents changes to more than 100 entities. If you need to merge changes to more than 100 entities, you can bypass this protection with a manual merge at Admin > Execute Merge. Learn more here.