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 will describe the basic understanding and trouble shooting steps for Web Report module , those will help to understand the cause of the problem & its basic understanding to prevent such problem in future. Also it will help to avoid the unnecessary delay of tickets forwarding.
...
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 | Remarks | Report is Not opening( 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 ReportUI ReportURI and/or ReportAPI, DONOT change thatDO NOT proceed tochange the URL immediately. Check accessing those URL to verify and consult technical team. Verify ReportAPI application | Access ReportAPI URL directly entering in browser. The format of ReportAPI URL is mentioned, change the server name or IP appropriately http://<Server name or IP>/GinesysReportAPI/Api.asmx | Verify ReportUI application | Access ReportUI 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 is mentioned, change the server name or IP appropriatelyshould similar to Ginesys ReportUI URL. Replace application same and page name as mentioned in following format. | Report path test connection under Server tab. | Server tab > General > Main Settings > We can find the Report Path line > Test the Report path. | GinesysWebReprts.xml file is present or not | C:\GSL\GINESYS12\GinesysReport\ReportUI\Config\GinesysWebReports.xml | Verify the physical path of ReportAPI folder and its AppPool from IIS Manager. Verify the folder Security of ReportAPI folder. Standard set of security should be like :
| Physical Path , AppPool , Standard Folder Security permission of ReportUI folder. Verify the physical path of ReportUI folder and its AppPool from IIS Manager. Verify the folder Security of ReportUI folder. Standard set of security should be like : SYSTEM ( Full Permission) Creator Owner (Special Permission) Administrators (Full permission)
| Test Admin Configuration: Data Sources |
|
*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 is present or not.C: file | Find the file available at following mentioned path
| If missing, forward to technical team. |
| 2 | Folder Security permission of ReportUI & ReportAPI. Verify the standard Folder security permission. SYSTEM ( Full Permission) Creator Owner (Special Permission) Administrators (Full permission) 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 | GinesysReportScheduler Service state. | RUN > Check status of service GinesysReportScheduler, should be in running. | Go to Services.msc > | If GinesysReportScheduler service is not installed found in service list, then you need to install it. Please follow the below reference for Service installation.
Ginesys Reports Installation Guide “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 below file is present or not from in the following pathlocation. <Ginesys Installation_drive>\GSL\GINESYS12 | If missing, copy the file from Report kit. | |||||||
| 3 | Check presence of eWebReportsScheduler.xml file | Find the below file is present or not from the following path.<Ginesys Installation_drive>file in the following location.
| If the XML is not present in the expected name, then
| |||||||
| 4 |
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 test connection ? | Go to Ginesys Web > Report > Server > General > Main Settings > Scheduler Settings > Find Schedule Remoting host > test the connection.(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 is 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. |
| 2 | Test mail credentials in SMTP mailer from Launchpad. | Open Launchpad > SMTP Mailer > Click on Stop Service > Click Edit on Pencil t button for editing > Put your credentials & test the smtp details. ( Do not save anything any details after checking on this window ) . | |
| 3 | eWebReportsScheduler.exe file | Find the below file is present or not from the following below path. <Ginesys Installation_drive> | |
| 4 | Check mail SMTP Mail settings in eWebReportsScheduler.xml file | Find the below file & check the settings from the following below path and verify the SMTP details. <Ginesys Installation_drive>\GSL\GINESYS12 | |
| 5 | Check 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 or falseaccordingly. | |
| 6 | eWebReportsScheduler.exe.config file settings under Runtime tag for mail attachment failure. | Following Below xml tag needs to be add under Runtime <Runtime> tag . from the the following path. <loadFromRemoteSources enabled="true"/> <Ginesys Installation_drive>\GSL\GINESYS12path : |
This Article is applicable for all those cases where No Web report is running or Web Report module is not opening or Some specific report menu is not running.
Area of Troubleshooting :
Ginesys Report server or Ginesys Report Folder path identify or Location identify.
Ginapps config file checking.
Standard folder permission checking.
Report applications checking using IIS Manager.
Log searching for Advance troubleshooting.
- Basic Task
Basic steps to be performed at preliminary stage when any issue occurs ,
1.Run SYNC first from Repository tab.
2.Then reset IIS server in Ginesys HO server / Report Server system using IISRESET option in Command Prompt or CMD.
- Basic Troubleshooting steps
1.Check the Server tab settings of Ginesys Report Module :
a. Test the connection of Data source (Ginesys).
b. Check report path in Main Setting under Server tab.
c. Check the Remoting scheduler host path setting. ( protocol : http or tcp , server hostname or IP , Port : 2001 ).
d. Check the Report Scheduler service is running or not.
e. Check Ginapps.config file from <\GSL\GINESYS12\Shared> location and find the below rows.
<add key="ReportURI" value="/GinesysReportUI/" />
<add key="CustomPort" value="" />
2.Check the basic configuration from IIS manager :
a.Check standard Permission is enabled or not in each report application ( Report UI , Report API ):
1.SYSTEM ( Full Permission)
2.Creator Owner (Special Permission)
3.Administrators (Full permission)
4.Users (Read& Execute , List of Folders , Read , Special Permission)
5.IIS_IUSRS (Full Permission)
b. Check the Report Applications ( Report UI , Report API ) path :
Example: Physical path of Report UI folder and Path of GinesysReportUI set in IIS server is same or not.
Ex : C : \ GSL\GINESYS12\GinesysReport\ReportUI = below picture.
...
c. Check the Application Pool:
a.Check Report Applications GinesysReportUI, GinesysReportAPI , which must be run from GinesysReportAppPool.
d. Check the Application Pool identity :
a. Click on Application Pool at Left hand side , there must be a list view of AppPool at Right hand side , check GinesysReportAppPool is set to Application Pool Identity or not.
e. Check the Binding settings of default Web Site :
a. Click on Default Web Site , at the right hand side there is an option Binding. Click on that observe the binding details if any.
3. Procedure of advance Error findings :
In such cases after performing if the above basic checks fails and still problem exists, then you have to find out actual error from various logs.
1.log path for General Web Report related error : C : \ GSL\GINESYS12\WebUI\logs\log.txt
2.For Report scheduling related error : C : \ GSL\GINESYS12\GinesysReport\Report Scheduler\eWebReportScheduler.txt ( as per latest date & time)
| Tip |
|---|
In this section we will briefly describe that how to use IIS Manager to check various web report related parameters : |
First to Open IIS Manager :
Go to RUN and type inetmgr or Go to Start Button type IIS server Manager. Find & enter into it.
At the Left side you will find IIS server name , below that you will see the Application Pool , just a little below you will find the Default Web Site along with its web applications or web sites. Like as below.
Star Page
Server Name (Domain\username)
Application Pools
Sites
Default Web Site
GINESYSReportUI
GINESYSReportAPI
- To check Application Pool & its Identity
Just click on Application Pool , at the middle of the window you will see all Application Pool & its identity. For Web report Application Pool is GinesysReportAppPool and its Identity is ApplicationPoolIdentity .
- To check Default Web Site along with its Binding
Click on Default Web Site , at left hand side , you will see the Binding Option , click on that one small window will open and you can see all binding & Certificate details if any exists.
- To check Basic settings of any Web Report Application ( Ex. GinesysReportUI , GinesysReportAPI )
Click on any application , at left hand side you will find the Basic Settings option & click on it. Post that you can see the Alias Name , Application pool , Physical Path of that application.
- To check Permission of any Application ( Ex. GinesysReportUI , GinesysReportAPI ) ,
Click on the application and at the left hand side you will see Edit Permission option. Then click on it and you can find the Security tab. On that tab you can check & verify the Standard permission settings which is mentioned below section.
Check standard Permission is enabled or not in each report application ( Report UI , Report API ):
SYSTEM ( Full Permission)
Creator Owner (Special Permission)
Administrators (Full permission)
Users (Read& Execute , List of Folders , Read , Special Permission)
IIS_IUSRS (Full Permission)
For more details regarding Web Report Installation including its configuration you can go through the below link : Ginesys Reports Installation Guide
...
| 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. |