Adding Tasks
Applies to: Kyvos Reporting
To define a new task for scheduled report execution, follow these steps:
Steps to Add a Task
Open the Task List page and click Add Task.
In the Name field, enter a unique name for the task.
This name will be used to reference the task in jobs.Select a report for the task:
Click the object selector to browse and choose the report.
Once selected, the Operational Parameters and Report Parameters sections will be populated automatically.
Specify report format under Report Format and configure the required Delivery Options (e.g., email, FTP, folder).
(Optional) To run the task in a specific user context, select the Organization and User under Run As.
Note
The Run As option is available only to users with Administrator or Super Administrator roles. It is not available to users with only Scheduler privileges.Provide values for the following:
Operational Parameters: Internal settings that control execution behavior.
Report Parameters: Input values needed by the report for data filtering and rendering.
If the report requires multiple sets of parameter combinations, define MultiSet details accordingly.
Click Save to create the task.
The new task will be added to the Tasks list.To discard changes, click Cancel.
(Optional) Click Preview to view the report output in the selected format before scheduling.
Note
Preview may not work if the report includes hidden parameters or shadow (display) parameters. However, the scheduled task will still execute correctly.
Selecting Delivery Operations (Operational Parameters)
Setting Report Delivery Options in a Task
When you select a report format in the Report Format dropdown, the Delivery Options area appears below it, displaying properties relevant to the selected format.
Sending Reports by Email
To deliver the report via email:
Select the Email checkbox.
Choose the desired Report Format.
Under Send Report As, choose from:
Attachment: Send the report as an attachment.
Link: Save the report on the server and send a link.
Embedded: Embed the report within the email body.
If using Link, also specify:
File Name and Save In location (select from the folder structure).
User’s Working Folder checkbox if required.
Suffix Timestamp Format to append date/time to the file name.
Provide recipient details:
To, Cc, and Bcc (separate multiple emails using commas or semicolons).
Specify the Subject and optionally enable Suffix Timestamp Format.
Enter the email body in the Message field. You can include report or system parameters in the format
<%ParameterName%>.If the report is a High Speed View report being emailed as a PDF, an option appears to embed report snapshots in the email.
Example: Sales Report for <%ReportDate%> — the parameter is replaced with actual value at runtime.
Using Parameters in Free-Form Fields
You can include parameter values in the following fields:
File Name
To, Cc, Bcc
Subject
Message
Syntax: Enclose the parameter name in <% and %>.
Example: Sales_<%Region%>.pdf
Printing Reports
To print a report:
Select the Print checkbox.
Choose the Report Format.
In Copies, specify the number of copies.
In Page Range, select:
All to print all pages.
Page Range to specify custom pages.
In Printer Name, select from the list of configured printers.
Note
Printers must be configured in Administration > Configure > Printer Settings.
Only users with configuration privileges can set up printers.
iHTML, Smart, and Raw Text formats are not supported for printing.
If the print setting is marked as “forced” for the report, it cannot be changed.
Uploading Reports
You can upload reports to an FTP server or a shared folder.
FTP Upload
Select Upload.
In Connection, select a preconfigured FTP connection or choose Custom.
Choose the Report Format and configure Delivery Options.
In Upload Type, select FTP.
Provide the following details:
Property | Description |
|---|---|
Secure | Select to use SFTP (port 22). Disables passive mode. |
Use PASV mode | Enable passive mode if not using secure FTP. |
Server Name | FTP server address. |
Port | Port number for FTP. |
User Name / Password | FTP login credentials. |
Folder Name | Folder path (use |
File Name | Output file name. |
Suffix Timestamp Format | Optional timestamp in file name. |
Shared Folder Upload
Select Upload.
In Connection, select a preconfigured Shared Folder connection or choose Custom.
Choose the Report Format and configure Delivery Options.
In Upload Type, select Shared Folder.
Provide the following details:
Property | Description |
|---|---|
Folder Name | UNC path (e.g., |
File Name | Output file name. |
Suffix Timestamp Format | Optional timestamp in file name. |
Publishing Reports
To publish the report:
Select the Publish checkbox.
Choose the Report Format.
Configure Delivery Options.
In Save In, click the folder icon to select a destination using the object selector.
To use the user’s working folder, select the User’s Working Folder checkbox.
Optionally specify a unique File Name and apply Suffix Timestamp Format.
Select access level:
Private: Only you can view.
Public: All users can view.
To generate a permanent link:
Select the Permalink for last saved instance checkbox.
Specify:
View Output In: Output format.
Access Code (optional): Protects access to the link.
Click Generate to create the link.
Note
Permalink is a license-controlled feature.
Setting Validity Options for Published Reports
You can configure when the published report should expire:
Option | Description |
|---|---|
For | Duration after generation (e.g., 3 weeks, 2 months). |
Until the End of this | Valid until the end of current day/week/month/year. |
To Date | Valid until a specific date (e.g., July 30, 2025). |
Recommendation
Always specify an expiry date to manage server space efficiently. Expired reports are removed and cannot be retrieved.
Entity Parameters
You can define ad hoc filters while setting up a schedule. These filters apply at report runtime and are supported for:
Ad hoc
Smart
Studio reports
Note
Not applicable for High Speed View reports.
Using MultiSet Parameters
MultiSet enables report bursting with different parameter sets and delivery options. You can dynamically:
Assign custom parameter values
Deliver reports via email, upload, or publish link
Personalize content for each recipient
To Configure MultiSet:
Click MultiSet to open the MultiSet Parameters pane.
Select Static or SQL as the source of parameter values.
Static Parameters
Select Static.
Use checkboxes to choose operational or report parameters.
Click Add to create new rows.
Enter values for each parameter.
Click Save.
SQL-Based Parameters
Select SQL.
Choose a database connection.
Enter the SQL query.
Click Verify SQL to validate the query.
Scheduling Query Objects
Kyvos Reporting allows scheduling of query objects, which is helpful when:
Fetching from multiple data sources
Running queries across similar table structures
Reducing manual execution effort
Use MultiSet with query objects to automate background execution and improve report generation time.