Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 with its troubleshooting steps for Web Report module , those will help to understand the cause of the problem & its basic understanding to prevent such problem in future.

Check List are described below in a table format.

...

Issue Type / Problem Type

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

Report is not opening / Home is not opening.

Physical Path , AppPool , Standard Folder Security set of ReportAPI folder.

What to check / Basic actions

How to check ( Quick Guide )

Description / Remarks

Recommended action

1

Run Report SYNC

  • Click on Repository tab Go to Ginesys Web > Report > Repository and then run SYNC.

  • Restart IIS (Follow either step)

    • Open CMD ( in Run as admin privilege), type >IISRESET > Press Enter.

    • Open Windows Services (services.msc), restart the service ‘World Wide Web Publishing Service’

Entries in Ginapps.config for Report configurationNote 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.
Path: \GSL\GINESYS12\Shared\Ginapps.config

Deployment 1: Ginesys and Report on same server

<add key="ReportURI" value="/GinesysReportUI/" />
<add key="CustomPort" value="" />

Deployment 2: Ginesys and Report on different server

<add key="ReportURI" value="http://<Report Server host IP>/GinesysReportUI/" />
<add key="ReportAPI" value="http://<Report Server host IP>/GinesysReportAPI/API.asmx" />
<add key="CustomPort" value="" />

IMPORTANT: If different URL is mentioned as ReportUI ReportURI and/or ReportAPI, DO NOT proceed tochange thatthe URL immediately. Check accessing those URL for verification and consult with technical team if required.

Verify ReportAPI application

Access ReportAPI URL directly entering in browser. The format of ReportAPI URL is mentioned, change the server name or IP appropriatelyfirst (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

\GSL\GINESYS12\GinesysReport\ReportUI\Config\GinesysWebReports.xml

If missing, forward to technical team.

4

Verify access to GinesysReportUI application
Test GinesysWebReprts.xml

  • Open the Exago Admin page accessing GinesysReportUI application directly from web browser. The URL of GinesysReportUI is as mentioned in GinApps.Config. If host name or IP is not mentioned in URL then add application server name or IP in following mentioned format.
    Ideally the Exago Admin page should be loaded.

http://<Server name or IP>/GinesysReportAPI/Api.asmx

Verify ReportUI application

Access ReportUI <IP>/GinesysReportUI/Admin.aspx

*Note: Ensure the server IP is being used while testing the access.

  • Once Exago Admin page opens, then verify Ginesys Report configuration XML. In top left corner, under the Exago logo, load the file GinesysWebReports.xml from drop down. All configuration should be loaded.

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 appropriatelyURL should similar to Ginesys ReportUI URL. Replace application same and page name as mentioned in following format.
Ideally a list of supported API operations should be loaded.

http://<Server name or IP>/GinesysReportUI/Admin.aspx<IP>/GinesysReportAPI/Api.asmx

*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) >

  • For Test database connection check, : Double click on GINESYS. Test In right side test Connection String using the lightning Icon at the end of the connection string.To verify Assemblies , Test the connection

  • Test Assemblies: Double click on GinesysAssemby. In right side test Connection String using the lightning Icon .

Report path test connection
  • at the end of the connection string.

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 tab > General (left side menu) > Main Settings > (double click to load)

Test the Report Path using the lightning Icon .

GinesysWebReprts.xml file is present or not

Find the file from the below path.

\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 :

  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)

Physical path & App pool is mentiond in the Advance settings of each Web application ( ReportAPI, ReportUI etc.)

Select any Web Application > At the right side pane we see the Advance settings > Enter into it & check the physical path of folder of that web application along with app pool.

Physical Path , AppPool , Standard Folder Security set of ReportUI folder.

Verify the physical path of ReportUI folder and its AppPool from IIS Manager. See in the description column.

Right click on any folder ( ReportAPI , ReportUI etc. ) > Properties > Security tab > Check the below Set of Security.

  • SYSTEM ( Full Permission)

  • Creator Owner (Special Permission)

  • Administrators (Full permission)

  • Users (

    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 GinesysReportUI, select Manage Application > Advance Settings
    Verify the Application Pool. Must be GinesysReportAppPool.
    Verify the path mentioned for Physical Path.

    Right click on GinesysReportAPI, select Manage Application > Advance Settings
    Verify the Application Pool. Must be GinesysReportAppPool.
    Verify the path mentioned for Physical Path.

    Select the correct AppPool.
    Refer Report installation guide if GinesysReportAppPool is not present in list.
    Ginesys Reports Installation Guide

    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
    Verify folder Security entries for both the directories, ReportUI and ReportAPI

    Following permissions must be present in a healthy configuration.

    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)

    Physical path & App pool is mentiond in the Advance settings of each Web application ( ReportAPI, ReportUI etc.)

    Select any Web Application > At the right side pane we see the Advance settings > Enter into it & check the physical path of folder of that web application along with app pool.

    Report SYNC is not happening

    GinesysWebReprts.xml file is present or not.

    Find the file from the below path.

    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

    \GSL\GINESYS12\GinesysReport\ReportUI\Config\GinesysWebReports.xml

    If missing, forward to technical team.

    2

    Folder Security set of ReportUI & ReportAPI.

    Right click on any folder ( ReportAPI , ReportUI etc. ) > Properties > Security tab > Check the below Set of Security.

  • SYSTEM ( Full Permission)

  • Creator Owner (Special Permission)

  • Administrators (Full permission)

  • Users (

    Report directories: \GinesysReport\ReportUI, \GinesysReport\ReportAPI

    Go to directory \GSL\GINESYS12\GinesysReport
    Verify folder Security entries for both the directories, ReportUI and ReportAPI

    Following permissions must be present in a healthy configuration.

    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)

    Add Full permission for IIS_IUSRS if found missing.

    Problem Type

    Report Scheduler: Report Scheduler service is not working

    Enable Report Scheduling Option is True

    GinesysReportScheduler Service state

    What to check / Basic actions

    How to check ( Quick Guide )

    Recommended action

    1

    Check status of service GinesysReportScheduler, should be in running.

    Go to > RUN > Services.msc >
    Find the Report scheduler service > Check is it stopped or not installed. If Service is not installed , see in the description section link.service GinesysReportScheduler service.
    Ensure service is running

    If GinesysReportScheduler service is not installed found in service list, then you need to install it. Please follow the below reference for Report Scheduler Service installationrefer Report Scheduler installation section in the Report installation guide.

    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:
    Unblock the scheduler executable \GinesysReport\ReportScheduler\eWebReportsScheduler.exe. See, check 4 below.


    If service is found in stopped state, try to start the service. Unblock the scheduler executable \GinesysReport\ReportScheduler\eWebReportsScheduler.exe. See, check 4 below. If still service doesn’t start, note the error message appeared for further troubleshooting.

    2

    Check presence of eWebReportsScheduler.exe file is present or not

    Find the file from in the below pathfollowing location.

    \GinesysReport\ReportScheduler\eWebReportsScheduler.exe

    If missing, copy the file from Report kit.

    3

    Check presence of eWebReportsScheduler.xml file

    Find the file from in the below pathfollowing location.

    \GinesysReport\ReportScheduler\eWebReportsScheduler.xml

    Test connection of Schedule Remoting Host

    Server > General > Main Settings > Scheduler Settings > Find Schedule Remoting host > Test the connection.

    Server > General > Main Settings > Scheduler Settings > Find Enable Report scheduling > It should be set as True.

    eWebReportsScheduler.xml , eWebReportsScheduler.exe , eWebReportsScheduler.exe.config – this files along with all DLL files under Ginesys Report folder needs to be unblock

    If the XML is not present in the expected name, then

    • Look for named as eWebReportsScheduler<Kit Version>.xml.

    • Rename the file to eWebReportsScheduler.xml.

    4

    Status
    colourBlue
    titleIMPORTANT
    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.

    • Go to file property of Report Scheduler executable file, GinesysReport\ReportScheduler\eWebReportsScheduler.exe.

    • Observe, in the General tab at lower side, is there a check box or button to UNBLOCK.

    • If the button or check box is found, then that means the files are in blocked state.

    • Open CMD with Admin privilege and run the below command.

    • Type

    Powershell
    • powershell ( press Enter )

    • Type

    below
    • following command. Mention the correct drive letter and verify path of Ginesys Report before execution.

    • dir

    <Drive>
    • <Drive Letter>:\GSL\GINESYS12\GinesysReport\ -Recurse | Unblock -File

    5

    Test connection of Schedule Remoting Host

    Go to Ginesys Web > Report > Server > General (left side menu) > Scheduler Settings (double click)

    If Report Server or Report Installation folder location is different then change the mentioned path accordingly in How to check section.

    Report Scheduler Mail is not happening / Schedule Report goes to Abend State.

    Find Schedule Remoting Host
    Test the connection using the lightning Icon at the end of the URL field.

    If find the field blank, mention following.
    http://<Report Server IP>:2001 or tcp://<Report Server IP>:2001
    Alter the protocol between tcp and http if connection is not successful.

    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.

    Ginesys Reports Installation Guide

    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.

    \GinesysReport\ReportScheduler\eWebReportsScheduler.exe

    4

    SMTP Mail settings in eWebReportsScheduler.xml file

    Find the file from the below path and verify the SMTP details.

    \GinesysReport\ReportScheduler\eWebReportsScheduler.xml

    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 : \GinesysReport\ReportScheduler\eWebReportsScheduler.exe.config

    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.

    dir <Drive>\GSL\GINESYS12\GinesysReport\ -Recurse | Unblock -File

    If Report Server or Report Installation folder location is different then change the mentioned path accordingly in How to check section.