Frequently Asked Questions (FAQs)
This article covers frequently asked questions for our Extract module and will be updated as needed.
I can't see the "Data Extracts" page or the option "Advanced > Make Custom Extract" in the Custom Report menu.
If you have trouble locating either of these two features, please verify the account has the permission, "Data Extracts Access".
How do I run an extract job manually?
Go to Admin Cog > Data Extracts and locate the job you want to run manually. On the second column from the right is a "Run" link. Click this link and it will run a job manually.
If the last runtime does not update or if the file does not appear in the SFTP server, there was an error when attempting to run the file.
What does "absolute path" mean in the extract job?
Absolute path allows you to switch between "Absolute Path" or "Relative Path" when pushing out the file into the vendor's server. By default, it uses Relative Path.
For example, let's say you wanted to place it on your own computer in your downloads folder. In your Downloads folder you created a folder called "Nutrition." Here is how the pathing is considered.
Absolute Path: `/c/users/john_smith/Downloads/Nutrition`
Relative to "Downloads" folder: `./Nutrition`
Relative to your "john_smith" folder: `./Downloads/Nutrition`
When running a job manually, the extract job hangs and the run button stays a black clock icon. How do I fix this?
This is a known issue tied to running an extract manually while the job is not enabled. Edit the affected job and enable the job. This should resolve the problem.
My vendor needs to whitelist your IP Address. Where can I find this information?
Please forward the vendor our Whitelist documentation here. Specifically, ask them to look at the different IP ranges provided on this page.
How do I rollover my extracts during the summer? I want to prepare my vendor's services/systems for the upcoming academic school year?
There are two answers to this question depending on the extract. Custom Reports created by the user and Forced SQL Custom Reports provided by Illuminate Education will have different approaches.
- If you built your own extract using a Custom Report, update the filters on your report. Make sure the report will filter for the upcoming school year and when the extract job runs, it will pull this data automatically. You can refer to this help document if you need help with your filters.
- Forced SQL Reports provided by Illuminate will require you to go to Admin Cog > Data Extracts. Locate the report you want to edit and click the Edit link. There will be a header titled "Input Controls", between the "File" and "Run" section of the scheduled extract page. The filters of the report will be determined by the Input Controls. Below is a sample screen shot of this feature.
Do you have a template or custom report for {insert vendor name here}?
The complete list of our extracts is still under construction. Please contact our help desk at (949)-242-0343 or email us at [email protected]. When all extracts are available as articles in this manual, we will update this question.