Standard Troubleshooting Checklist - Ginesys Report
Introduction
This article is primarily intended for Helpdesk team. But any team who faces any issue in accessing Ginesys Report may refer this document. In this article we have described the standard checklist to investigate and troubleshoot issues related to Ginesys Report module. Corresponding short easy to understand 'how to' guides are also specified in following table. In majority of cases, it has been observed, the problem gets resolved by going with standard verification.
Guide
Problem Type
Report Home: Home is not loading
What to check / Basic actions | How to check ( Quick Guide ) | Recommended action | |
|---|---|---|---|
| 1 | Run Report SYNC |
| Note the error message appeared if any for tech team investigation. |
| 2 | Verify Report configuration entries in GinApps.config | Ensure the following standard entries are present in Ginapps.config file. Deployment 1: Ginesys and Report on same server
Deployment 2: Ginesys and Report on different server
IMPORTANT: If different URL is mentioned as ReportURI and/or ReportAPI, DO NOT proceed to change the URL immediately. Check accessing those URL for verification first (Check 4 & 5). If applications are accessible then do not change the URLs. | Correct the the URL if inappropriately mentioned. |
| 3 | Check presence of GinesysWebReprts.xml file | Find the file available at following mentioned path
| If missing, forward to technical team. |
| 4 | Verify access to GinesysReportUI application |
*Note: Ensure the server IP is being used while testing the access.
| Note the error message appeared if any for tech team investigation. |
| 5 | Verify access to GinesysReportAPI application
| Access GinesysReportAPI URL directly entering in browser. The format of GinesysReportAPI URL should similar to Ginesys ReportUI URL. Replace application same and page name as mentioned in following format.
*Note: Ensure the server IP is being used while testing the access. | Note the error message appeared if any for tech team investigation. |
| 6 | Test Data Source connection string under Server tab | Go to Ginesys Web > Report > Server > Data (left side menu) > Source (Expand)
| In case of unsuccessful connection, verify Oracle connection string and assembly path mentioned GinesysAssembly connection string |
| 7 | Test Report Path under Server tab | Go to Ginesys Web > Report > Server > General (left side menu) > Main Settings (double click to load) Test the Report Path using the lightning Icon at the end of the Report Path field. | In case of unsuccessful test, verify assembly path mentioned Report Path connection string |
| 8 | Properties of Report web applications: GinesysReportUI, GinesysReportAPI
| Verify Physical path and Application Pool Open inetmgr and expand to the application list. Right click on GinesysReportAPI, select Manage Application > Advance Settings | Select the correct AppPool. Mention correct path for Physical Path if found wrong. |
| 9 | Folder Security of Report directories: \GinesysReport\ReportUI, \GinesysReport\ReportAPI
| Go to directory \GSL\GINESYS12\GinesysReport Following permissions must be present in a healthy configuration.
| Add Full permission for IIS_IUSRS if found missing. |
Problem Type
Report Repository: Report SYNC is not happening
What to check / Basic actions | How to check ( Quick Guide ) | Recommended action | |
|---|---|---|---|
| 1 | Check presence of GinesysWebReprts.xml file | Find the file available at following mentioned path
| If missing, forward to technical team. |
| 2 | Folder Security of Report directories: \GinesysReport\ReportUI, \GinesysReport\ReportAPI
| Go to directory \GSL\GINESYS12\GinesysReport Following permissions must be present in a healthy configuration.
| Add Full permission for IIS_IUSRS if found missing. |
Problem Type
Report Scheduler: Report Scheduler service is not working
What to check / Basic actions | How to check ( Quick Guide ) | Recommended action | |
|---|---|---|---|
| 1 | Check status of service GinesysReportScheduler, should be in running. | Go to Services.msc | If GinesysReportScheduler service is not found in service list, then you need to install it. Please refer Report Scheduler installation section in the Report installation guide. https://ginesys.atlassian.net/wiki/spaces/PUB/pages/53477456 “Error occurred The service failed to start within 30 seconds.” - This message may appear while installing Report Scheduler service using InstallReportSchedulerSerrvice Solution: If service is found in stopped state, try to start the service. Unblock the scheduler executable |
| 2 | Check presence of eWebReportsScheduler.exe file
| Find the file in the following location.
| If missing, copy the file from Report kit. |
| 3 | Check presence of eWebReportsScheduler.xml file
| Find the file in the following location.
| If the XML is not present in the expected name, then
|
| 4 | IMPORTANT All files in GinesysReport folder have to be in UNBLOCK state NOTE: Since the Ginesys Report file set is separately downloaded, Windows Smart Screen Filter marks most of the files as BLOCKED to execute.
|
|
|
| 5 | Test connection of Schedule Remoting Host
| Go to Ginesys Web > Report > Server > General (left side menu) > Scheduler Settings (double click) | If find the field blank, mention following. |
| 6 | Enable Report Scheduling Option is True
| Server > General > Main Settings > Scheduler Settings > Find Enable Report scheduling > It should be set as True. |
|
Problem Type
Report Scheduler: Scheduled mail is not sent. Schedule goes to 'ABENDED' state.
What to check / Basic actions | How to check ( Quick Guide ) | Decision | |
|---|---|---|---|
| 1 | GinesysReportScheduler Service state | RUN > Services.msc > Find the Report scheduler service > Check the service it stopped or not installed. If Service is not installed , see in the description section link. | If GinesysReportScheduler service is not installed then you need to install it. Please follow the below reference for Report Scheduler Service installation. https://ginesys.atlassian.net/wiki/spaces/PUB/pages/53477456 |
| 2 | Test mail credentials in SMTP mailer from Launchpad. | Open Launchpad > SMTP Mailer > Click on Stop Service > Click on Pencil t button for editing > Put your credentials & test the smtp details. ( Do not save any details after checking on this window ) . |
|
| 3 | eWebReportsScheduler.exe file
| Find the file from the below path.
|
|
| 4 | SMTP Mail settings in eWebReportsScheduler.xml file | Find the file from the below path and verify the SMTP details.
|
|
| 5 | SMTP SSL settings in eWebReportsScheduler.xml file. | The common known SMTP ports are used in mail configuration i.e. 587,465,25. SSL ports : 587 , 465 Non SSL ports : 25 If found SSL ports are associated with SMTP server name. then SSL tag should be set as true accordingly. |
|
| 6 | eWebReportsScheduler.exe.config file settings under Runtime tag for mail attachment failure. | Below xml tag needs to be add under <Runtime> tag from the the following path. <loadFromRemoteSources enabled="true"/> path : |
|
| 7 | eWebReportsScheduler.xml , eWebReportsScheduler.exe , eWebReportsScheduler.exe.config – this files along with all DLL files under Ginesys Report folder needs to be unblock. | Open CMD with Admin privilege and run the below command. Type Powershell ( press Enter ) Type below command.
| If Report Server or Report Installation folder location is different then change the mentioned path accordingly in How to check section. |