Creating Password to Protect Files

Applies to: Kyvos Reporting

Kyvos Reporting allows you to password-protect exported report files to ensure secure access to sensitive content. This functionality is available for the following formats:

Microsoft Excel (.xlsx)
Microsoft Word (.docx)
Microsoft PowerPoint (.ppt)
PDF

Note

Password protection is supported for Ad hoc and Studio report types only

Enabling Password Protection

To enable the password protection feature, administrators must configure the following property:

Property	Description

Property	Description
`ENABLE_PASSWORD_PROTECT_DOCUMENT`	Set to `true` to enable password protection. Set to `false` to disable it.

Steps to Enable

Navigate to the following directory:
Kyvos Reporting/Jakarta/Config
Open the ReportClient_Default.properties file.
Copy the ENABLE_PASSWORD_PROTECT_DOCUMENT property to the ReportClient.properties file in the same directory.
Restart the Report Server for the changes to take effect.

Setting Passwords in Ad hoc Reports

To apply password protection to Ad hoc reports:

Go to Navigate > Administration > Configure > Config Files.
Open the relevant IRL template from the Adhoc Template File.
In the OnReportStart() function, add the following script:

OnReportStart()
{
    rpt.Fields("SYS_EXPORT_PSD").value = "(provide a password string or parameter)";
}

Setting Passwords in Studio Reports

To apply password protection to Studio reports:

Go to Navigate > Design > Studio Reports > Script Editor.
From the function drop-down, select OnReportStart.
Add the following script:

{
    rpt.Fields("SYS_EXPORT_PSD").value = "(provide a password string or parameter)";
}

Note

The password can be a static value or dynamically assigned using a report parameter.
Ensure the password is set before exporting or scheduling the report.
The protected file prompts for the password each time it is opened.