To configure the web portal, click Click Navigate > Administration > Configure > Web Portal to configure the Web Portal.
...
If the security configuration for Kyvos Reporting is running with security = set to false, then specify following URL in the browser’s address bar to get this page.enter the http://<localhost>/Kyvos Reporting/pattern/conf and URL to access the Web Portal configuration page. Once this page is displayed, click the Client tab.
You can configure the following properties on this page.
Report Server IP
...
: This is the report server to which the client can connect. The default IP is 127.0.0.1
...
only 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
| Tip |
|---|
Tip After providing values for Report Server IP and Report Server Port, click Test button to check if Kyvos Reporting Report Server is up and running at specified IP and Port. When you click Test button, portal responds with respective message. |
Report Server Time Out (seconds)
...
: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.
...
`Default: 600
Example: SERVER_TIME_OUT=600
HTML Viewer Time Out (seconds)
...
:This is the time in seconds
...
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
...
to
...
another 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
...
it takes the client to receive
...
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.
...
The default value is blank.
Example: INTERA_HOME=
...
Jakarta\webapps\kyvosreporting\client\logs
Output Mode
...
:This value should be the same as Report Engine’s REPORT_OUTPUT value. Output mode decides
...
where to read the report files to display and
...
save reports.
...
File mode: shared folder mode: Report Engine creates files
...
in the REPORT_PATH folder
...
.
...
Stream
...
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
Example: OUTPUT_MODE=streammode
Report Path
...
:This is the folder where Report Engine puts the generated report files and from
...
which Report Engine Interface reads
...
them.
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
...
maps the business parameters
...
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 the web client
...
cannot communicate with the Report Server. Kyvos Reporting stores user
...
passwords in encrypted form only
...
; the USER_PASSWORD property will be replaced with ENCR_USER_PASSWORD with the encrypted value
...
. If the Administrator wants to change the password manually,
...
they would be required to add the USER_PASSWORD property and set a 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
...
exceeded its clean-up time.
Default: 60*60*1000 (1 hr)
Example: REPORT_CLEAN_UP_TIME=3600000
Load Balancer Registry Status
...
:This flag specifies the usage of the 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 the user wants to use
...
a different 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 the assignment) contains a key , and value pair.
First value after assignment is ASCII value of that javascript char.
After the assignment, the first value is the javascript char's ASCII value.
| Code Block |
|---|
[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 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.
| Code Block |
|---|
[HTML_ESCAPE_CHAR] |
...
GREATER_THAN=62,> |
...
LESSER_THAN=60,< |
...
QUOTE_BACKSLASH=34," |
...
AMPERSAND=38,& |
...
SINGLE_QUOTE=39,’ |
Actions
Change property values as required for the Web Portal. Click Then, click the Save button on atthetop-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
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.
Click Download Log Logs . Logs will be archived as a zip file and downloaded to the specified location.
...
Select the required files. To purge all the log files, check select the checkbox available in the header row.
Click Purge Log Files.
As you go on selecting select the files from the list, the file count gets is displayed.