To configure the web portal, click Navigate > Administration > Configure > Web Portal.

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 click the Client tab.

Report Server IP

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

Default: 127.0.0.1

Example: REPORT_ENGINE_IP=127.0.0.1

Report Server Port

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

Default: 45450

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 the user.

Default: 600

Example: SERVER_TIME_OUT=600

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.

Default: 30

Example: HTML_VIEWER_TIMEOUT=30

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.

Default: 600

Example: SERVER_TIME_OUT_CHUNK=600

Logs

Enable Logging

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

Default: Selected

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:

INTERA HOME

This is fully qualified path to “root” folder in 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 value is blank.

Example: INTERA_HOME=JakartawebappsKyvos Reportingclientlogs

Output Mode

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

filemode: shared folder mode: files are created in REPORT_PATH folder by Report Engine.

streammode: Stream Mode: Files are created by Report Engine Interface into REPORT_PATH folder after reading report files from Report Engine through socket.

Default: streammode

Example: OUTPUT_MODE=streammode

Report Path

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

Default: reports

Example: REPORT_PATH=reports

Temp Path

Report Client uses this temp folder for its temporary operations.

Default: temp

Example: TEMP_PATH=temp

Relative Path

This is the relative path for Application integration purposes.

Default: “”

Example: RELATIVE_PATH= “”

Mapping Business Parameters to User Info

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

Default: “”

Example: PARAMS_TO_USERINFO_MAP= “”

User Credentials

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

Default values are:

USER_NAME=Admin

USER_PASSWORD=Admin

USER_ORG=Kyvos Reporting

Example:

USER_NAME=Admin

ENCR_PASSWORD=Y80ucY+JdRY=

USER_ORG=Kyvos Reporting

Task Scheduler Report Clean up Time

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

Default: 4*60*60*1000 (4 hrs)

Example: REPORT_CLEAN_UP_INTERVAL=14400000

Task Scheduler Report Clean up Interval

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

Default: 60*60*1000 (1 hr)

Example: REPORT_CLEAN_UP_TIME=3600000

Load Balancer Registry Status

This flag specifies usage of Load Balancer Registry.

Default: FALSE

Example: REGISTRY_ENABLED=FALSE

List of Load Balancing Registries

Default: 127.0.0.1:60000

Example: REGISTRIES=127.0.0.1:60000

HTML Folder Capacity

This is the folder capacity for HTML reports.

Default: 5000

Example: HTML_FOLDER_CAPACITY=5000

Applying Custom Login Page

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

Default: LOGIN_PAGE_URL=blank

Example: LOGIN_PAGE_URL= http://192.168.33.11:5000/kyvosreporting/

Escaping XSS characters

List of all javascript characters which need to be escaped.

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

First value after assignment is ASCII value of that javascript char.

[JAVASCRIPT_ESCAPE_CHAR]

DOUBLE_QUOTES=34,”

BACKSLASH=92,

SINGLE_FORWARDSLASH=47,/

TAB=9,t

NEW_LINE=10,n

CARRIAGE_RETURN=13,r

FORM_FEED=12,f

SINGLE_QUOTE=39,’

Escaping XML characters

List of all html characters which need to be escaped.

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

First value after assignment is ASCII value of that html char.

[HTML_ESCAPE_CHAR]

GREATER_THAN=62,&gt;

LESSER_THAN=60,&lt;

QUOTE_BACKSLASH=34,&quot;

AMPERSAND=38,&amp;

SINGLE_QUOTE=39,’

Actions

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

To download log files

1. Select the required files. To download all the log file, 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 the required files. To purge all the log files, check the checkbox available in the header row.

2. Click Purge Log Files.

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