Table of Contents
Overview
Requirements for Reports
Report Settings
Running a Single Data Checkup/Scan
Reviewing Results
Possible Error Types
Automatic Reporting
Note on Running Reports in a Staging Environment
Related Articles
Overview
For Catalog customers whose catalog is integrated with Curriculum Management, Coursedog provides an automated data health check-up to ensure your public catalog is as clear and robust as possible.
Requirements for Reports
Catalog must be associated with a URL.
Catalog must be integrated with Curriculum Management for full functionality.
Note: The report can be run by clients whose catalogs are not integrated with Curriculum, but the only scannable error type is Custom Page 404.
For integrated catalogs, program and course templates must be assigned in the catalog.
Users most have the necessary permissions:
“View Reports” to see the "Reports" option in your UI.
“Run Reports” in order to run a report.
“Edit Reports” in order to configure report settings.
Report Settings
Overview
There are two settings that those with “Edit Reports” permission can figure for Reports: Error Types and Catalog Instances.
“Error Types” allows you to configure which error types the scan looks for during every scan.
“Catalog Instances” allows you to determine whether or not each catalog will be automatically scanned on a weekly basis.
How to Edit Report Settings
Step 1: Navigate to Catalog > Settings > Reports
Step 2: Select “Edit Settings” and ensure you’re on the default “Error Types” toggle.
Step 3:
Toggle anything you don’t wish to scan for to the left.
Toggle anything you’d like to scan for to the right.
In the below screenshot, scans will check for everything EXCEPT for “Invalid Internal Link”.
Step 4: Click “Catalog Instances” to determine which catalog(s) your weekly scan includes.
Step 5:
For each catalog, select “Weekly” if you want this catalog to be automatically scanned each week.
Or select “Pause Scans” if you don’t want this catalog to be automatically scanned.
Step 6: Click “Save” before closing out of the modal.
Running a Single Data Checkup/Scan
Step 1: Navigate to Catalog > Reports > Catalog Data Check-Up
Step 2:
Check the “Catalog” dropdown.
Ensure the catalog you wish to scan is the one that’s displayed.
Step 3:
Click “new scan”.
It can take up to one hour to run a scan, and you can continue to navigate through the app while it processes in the background.
Reviewing Results
Overview | Error Type | External Catalog Location | Curriculum Source | Options
Overview
Once the report has loaded, four main columns will appear with data, if errors are found: Error Type, External Catalog Location, Curriculum Source, and Options.
You can filter results using the “Error Type” and “Catalog” (if all were scanned) dropdowns at the top of the page.
Error Type
The type of error surfaced.
For more information on the errors captured in the report, see below.
External Catalog Location
The link in the public, published catalog where the error was identified.
Curriculum Source
If applicable, a link to the curriculum course/program record within the Coursedog System.
Note that a user must have permission to view the record in Curriculum to access the link.
Options
If applicable, a direct link to our Knowledge Base will populate so you can learn more about the error surfaced
Possible Error Types
The list of possible errors that this scan checks for is captured in the below table.
Automatic Reporting
Overview
Weekly automatic scans can be a great way to monitor your catalog in real-time.
How It Works
Settings are configured as outlined above under “How to Edit Report Settings”:
At Catalog > Settings > Report > Edit Settings > Error Types, determine which error types you wish to scan for.
At Catalog > Settings > Report > Edit Settings > Catalog Instances, determine which catalogs you would like to be included in the automated weekly scans.
The scan will happen automatically every Friday at 8 p.m. EST.
Return to Catalog > Reports to see the results.
Note on Running Reports in a Staging Environment
The report has the ability to identify and diagnose high-frequency errors in the public catalog.
Many of these errors relate to data which is not stored in the SIS, such as requirements.
Because of this, it is expected that the staging environment reports will be extensive compared to the production environment reports.
Staging environments do not have the same scope of data as production environments.
With concerns or questions, please reach out to your Coursedog representative or submit a note via Freshdesk.