Table of Contents
Overview
Examples, Filters & Standards
How to Add Integration Filters
Example of Integration Data Filters Screen in the User Interface
Related Articles
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 Integrations Hub (Integrations Hub > Field Settings > Entity > 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.
Examples, Filters & Standards
General Examples | Typical Filters | General Standards
General Examples
General examples of integration data an institution might want to filter out include, but are not limited to:
Rooms - Rooms of type “office”
Buildings - Buildings of type “Residence Hall”
Instructors - Instructors who do not have a school-based email address
Departments - Departments that are defunct
Typical Filters
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
General Standards
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.
How to Add Integration Filters
Step 1: Navigate to Integrations Hub > Field Settings.
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 “Filters”.
Step 4: Click “Add Filter Group”.
Step 5:
Select the type of filter.
Choose whether to add conditions that will Keep or Remove data when the specified criteria are met.
Select the field to evaluate from the list:
Choose whether to search for an exact match (Equals), a phrase that is included (Contains), or text that starts with (Starts With) the specified value.
Add as many values as needed.
Step 6:
Complete the remaining information, which will vary depending on the selected filter type.
Step 7: Click the "SAVE" button.
Step 8:
Once you’ve saved your filter, you can test it by clicking the "TEST FILTER" button.
This function 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).
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 9:
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.
