Kyvos Reporting stores several application configurations as files on the report server and web portal.

Configuration changes, such as server properties and Ad hoc Wizard customizations can be made through corresponding portal pages. For changes in other files like mail messages and templates, you need to navigate to Config Files page where you can select a file, make changes and save it.

You can edit text-based files using the text editor provided on the page. Files requiring specialized software can be downloaded, edited, and uploaded to the server.

To open the Config Files page, click Navigate > Administration > Configure > Config Files.

You can select one or multiple files from this screen and download them to a local machine or upload file(s) back to the server.
To work with the files at the Report Server, make sure the Report Server is selected. To work with the files at Web Portal, click Web Portal from the Component drop-down menu.
Options in File Type will display file types available at selected location (Report Server or Web Portal). If you see a file node grayed, it means that the file does not exist at the location and so, can’t be downloaded.
To select a folder or a file, you need to expand the parent folder and navigate in its hierarchy by clicking the down arrow sign on the left side of the folder. The filename will be displayed as a leaf node. To collapse the folder hierarchy, click the up-arrow sign on the left side of the folder name.
When you select a file type from the dropdown, a checkbox displays the folder where the files are located. A description of the selected file type is displayed on the right of the dropdown.

Default and Customized Report Template files

Kyvos Reporting ships default template files with every download/ upgrade. Users can customize template files based on their requirements. Kyvos Reporting provides separate folders to place these files so that others overwrite no files. Default files are present under the Default folder. Customized files can also be retained on an upgrade.

During execution, customized files are given priority. However, if no custom files are available, Kyvos Reporting will execute templates from default files.

Note

If suppose the user is upgrading to a newer version and wants to use template files of an older version in Kyvos Reporting. In that case, the user will need to create a backup of the folder present inside the template folder of the report engine (for eg.:-Kyvos ReportingReportEnginetemplatesadhoc) and will have to copy those backup folders manually in adjacent of newly created DEFAULT folder under-report engine template. (for eg.:- Kyvos ReportingReportEnginetemplates)

Edit

Minor changes are easy to be made on the application UI itself.

Click the name of the file you want to edit.
The file name will be highlighted, and the Edit button will be enabled when hovering the mouse.
Click the Edit button to open the selected file in the editor.
Editor has functionalities like Cut, Copy, Paste, Undo, Redo, Search etc., which you can access from the toolbar. You can also maximize or minimize the editor.
Click the Save button to save the changes. This allows you to switch between template files from the same folder without closing the editor.
Click the Save & Close to save the file and close the editor.

Note

The Report Server and Web Client restart is not required to reflect the changes when you edit and manage these files from UI.
After editing any file in default folder, a separate folder will get create for customized files. For e.g. if you make changes in adhoc template files like “Beach.irl” , then a folder with name “adhoc” will get created automatically having customized “Beach.irl” file.

Download

You can download one file or multiple files at a time.

When you download one file, you can download it in its original format. When you download multiple files, they will only be downloaded as a zip file.

To start the download process, click Download. When you download-

Single file in its original format, it will download as it is.
Multiple files, they are downloaded in zipped format only. Name of file will be <File type name>_<yyyy_MM_dd_HH_mm_ss>.zip

Note:

yyyy_MM_dd_HH_mm_ss is the date and time format when the download has started.

Upload

Use the upload functionality on mouse-hover to upload one or multiple files to the Report Server or Web Portal.

Click the Browse button to navigate to the folder where the file is placed and select the file. If the file(s) being uploaded already exist at the location, they will not be overwritten. To overwrite existing files, select the Overwrite checkbox.

To start the upload process, click Upload. After the upload is successful, a success message will be displayed at the top of the screen.

Using Script files as script function libraries

Designers can now re-use the Java scripts created by them. If the designers have some standard JavaScript methods they plan to reuse in other queries, this version will allow them to do so. The designer needs to keep the entire Java script code (Methods) in a file with the extension ‘.js’ and then upload that file into Kyvos Reporting as shown in the figure below:

The code in the .js file can look something like this:

function TestParam(value)
{
    if (value=="abc")
        {
            if (params("ParamTest") != null)
                {
                    return "where JOB in (<%ParamTest%>)";
                }
            else
                {
                    return "where JOB not in (<%ParamTest%>)";
                }
        }
    else
        {
            return "where JOB in (<%ParamTest%>)";
        }
}

After uploading the ‘.js’ file, if the designer wants to use that script in the query object designer, they need to write code like the one shown below to use the methods.

select   empno,empname from Employee
<@%
#include TestParam.js;
%@>

<@%
return TestParam("abc");
%@>

Refresh Cache

If a folder for which the system caches the template is selected, the Refresh Cache button is enabled. When you click the Refresh Cache button, the selected folder’s cache is refreshed. You can also choose to refresh the full template cache.

Kyvos 2025.1