Versions Compared

Key

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

...

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

...

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

...

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

Default: 600

Example: SERVER_TIME_OUT_CHUNK=600

Logs

Enable Logging

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

Default: Selected

...

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

...

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

INTERA HOME

This is the fully qualified path to the “root” folder in the Report Application.
This path signifies the folder in which application logs are to be created.
This path is used while initializing the application in the integration scenario.
Default The default value is blank.

Example: INTERA_HOME=JakartawebappsKyvos Reportingclientlogs

Output Mode

This value should be the same as Report Engine’s REPORT_OUTPUT value. Output mode decides from where to read the report files to display and to save reports.

filemodeFile mode: shared folder mode: Report Engine creates files are created in the REPORT_PATH folder by Report Engine.

streammode: Stream Mode: Files are created by mode: The Report Engine Interface creates files and enters them into the REPORT_PATH folder after reading report files from the Report Engine through the socket.

Default: streammode

...

This is the folder where Report Engine puts the generated report files and from where which Report Engine Interface reads the report filesthem.

Default: reports

Example: REPORT_PATH=reports

...

Mapping Business Parameters to User Info

This property is used to map maps the business parameters that are used to filter data to User Info attributes like security descriptor, customer idID, location, etc.

Default: “”

Example: PARAMS_TO_USERINFO_MAP= “”

...

These user credentials will be used while accessing the Report Client Configuration Page when the web client is unable to cannot communicate with the Report Server. Kyvos Reporting stores user password passwords in encrypted form only, ; the USER_PASSWORD property will be replaced with ENCR_USER_PASSWORD with the encrypted value set into it. If the Administrator wants to change the password manually, he/she would require they would be required to add the USER_PASSWORD property and set a plain text password in this property.

...

Task Scheduler Report Clean-up Time

Specifies the time interval (in milliseconds) a report would be deleted from REPORT_PATH

...

Task Scheduler Report Clean-up Interval

Specifies the time interval (in milliseconds) for a ‘Report Cleaner’ to check if any report has crossed exceeded its clean-up time.

Default: 60*60*1000 (1 hr)

...

Load Balancer Registry Status

This flag specifies the usage of the Load Balancer Registry.

Default: FALSE

...

This is the login page URL, which can be specified if the user wants to use some other a different page as a login page.

Default: LOGIN_PAGE_URL=blank

...

Every property (left side of the assignment) contains a key , and value pair.

First value after assignment is ASCII value of that javascript charAfter the assignment, the first value is the javascript char's ASCII value.

[JAVASCRIPT_ESCAPE_CHAR]

...

Escaping XML characters

List of all html HTML characters which need to be escaped.

Every property (left side of the assignment) contains a key , and value pair.

First The first value after the assignment is the ASCII value of that html HTML char.

[HTML_ESCAPE_CHAR]

GREATER_THAN=62,>

...

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

Action Buttons

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

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

  • Purge Log Files (under Logs): Deletes This function deletes all old log files. It , but it does not delete the current log file.

  • Save : Saves changes made in the client configuration.

  • Discard: Abandons the changes.

Log Files

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

This page lists all the log files that the client has created but has not yet purged.  Latest The client uses the latest log file, ReportClientLogs.log is used by client.

To download log files

  1. Select the required files. To download all the log file, select the Select the checkbox available in the header row to download all the log files.

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

...

  1. Select the required files. To purge all the log files, check select the checkbox available in the header row.

  2. Click Purge Log Files.

As you go on selecting select the files from the list, the file count gets is displayed.