As a part of report client configuration, communication details and logging preferences are stored.

This process is carried on portal configuration page.  Click To configure the web portal, click Navigate > Administration > Configure > Web Portal.

Figure 1: Client Configuration using Web Interface

...

If Kyvos Reporting is running with security = false, then specify following URL in the browser’s address bar to get this page.

http://<localhost>/Kyvos Reporting/pattern/conf and then click Client tab.

Report Server IP:

This is the report server for client to connect.  The default IP is 127.0.0.1 (if report server and web portal are on the same machine).

...

Example: REPORT_ENGINE_IP=127.0.0.1

Report Server Port:

This is the port number at which report server listens to client (portal).  This should be the same as the one configured in report server.

...

Example: REPORT_ENGINE_PORT=45450

...

Report Server Time Out (seconds) :

This is the maximum time in seconds for the server to respond.  If the server does not respond within specified time, client (portal) will display error message Server not responding to user.

...

HTML Viewer Time Out (seconds):

This is the time in seconds for which client will wait before closing the communication thread between report server and client (portal) while running HTML reports. This generally happens when user switches over to some other page leaving the current process before completion.

...

Report Server Chunk Time Out (seconds):

This is the time in seconds for which client will wait to receive 1st chunk of report output from report server.

...

Example: SERVER_TIME_OUT_CHUNK=600

Logs

Enable Logging:

To log activities performed by client (portal), check select this check box.  Uncheck  Clear it to disable logging.

Default: CheckedSelected

Log Level:

This property sets the level of criticality to be considered for logging.  Options available in the drop down list are: Debug (with descriptive information on logging), Info (with general information to log), Warn (with warning only), Error (error without details) and Fatal (with severe error events).

Default: Error

Example: LOG_LEVEL=Error

Additional Properties Manual Configurations

Additional properties that can be manually configured under ReportClient.properties file are:

...

Default: LOGIN_PAGE_URL=blank

Example: LOGIN_PAGE_URL= http://192.168.33.11:5000/Kyvos Reportingkyvosreporting/

Escaping XSS characters

List of all javascript characters which need to be escaped.

...

Change property values as required for Web Portal.  Click Save button on top-left corner to save the changes.

Action Buttons

• Test: To check if Kyvos Reporting Report Server is up and running at specified IP and Port.

• Download Log (under Logs): Downloads and opens the current log.

• Purge Log Files (under Logs): Deletes all old log files. It does not delete current log file.

• Save: Saves changes made in client configuration.

• Discard: Abandons the changes.

Log Files

Actions taken by client are logged in log files.  Actions  Actions that are logged will depend on value set in Log Level property on Web Portal page.  When the log file size reaches 10 MB, client automatically renames the log file and opens another one.

This page lists all the log files that the client has created but not yet purged.  Latest log file, ReportClientLogs.log is used by client.Figure 2: Client Log Files dialog

...

To download log files

1. Select files by checking respective check-boxesthe required files. To download all the log filesfile, check select the checkbox available in the header row.

2. Click Download Log Logs will be archived as a zip file and downloaded to the specified location.

To purge one or more log files

1. Select files by checking respective check-boxesthe required files. To purge all the log files, check the checkbox available in the header row.

2. Click Purge Log Files.

...