Troubleshooting Report Module
This topic provides information about Report Module log files and some common problems.
Logging
Error reporting for the Report Module is communicated via log files. These files are found in the local folder of the process that is running the report:
- If a report is run manually through CygNet Studio the log file(s) will be in CygNet\Clients\CStudio
- If a report is scheduled the log file(s) will be in CygNet\Services\HSS
There are numerous log files generated by the Report Module. To diagnose why a report failed to run you'll need to check all files.
| Log File | Description |
|---|---|
|
CygNet.AE.JobScheduler001.log |
Reports errors related to scheduling reports. |
|
CygNet.AE.JobSchedulerUI001.log |
Reports errors related to the user interface for creating and editing and report schedules. |
|
CygNet.AE.Reporter001.log |
Reports errors related to report generation. |
|
CygNet.AE.ReporterU00I001.log |
Reports errors related to the user interface for creating and editing report definitions. |
|
CygNet.AE.SharedAPI001.log |
Reports errors related to the shared API. |
Common Problems
The following tips might be helpful in solving issues that arise when using Report Module.
I can create a report as CVS and XML, but not Excel or PDF
- This is likely a problem with the template.xlsx file
- Check the template file
- Confirm the template path is configured correctly in the Report Module configuration.
I have no report definitions in my list on the Define Reports screen
- Check the path to the screen
- Check for .rdf screens
- Confirm the path to the Default report location is correct in the Report Module configuration.
I ran my report but no file was published
- Check the storage location defined in the report definition
- If the report was configured to output to Excel or PDF, try using CSV or XML to determine if the problem is related to the template file
- Check the log files for error messages
- Remember that some historical reports can take a while to run to completion depending on local network and amount of data calculating.
I configuring a report but some of the columns are missing
- Check the template.xlsx file
- Do you have more columns in your report than appear in the template.xlsx file
- Add more columns to the template.xlsx file as necessary
- Having too many columns can have an impact on performance, so be careful not to add more columns than are needed.
