Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Reports and other objects (like Query and Parameters) are stored in categories.  Categories  Categories are stored in the repository as a hierarchical structure. 

On the Manage Categories and Reports page, you can create a category, modify category details, change a category name, and delete a category.

Standard reports are designed using Desktop studio.  On this page, you can deploy standard reports, delete a deployed report as well as download an already deployed report (to modify it).  You can also copy or move a report to one or more categories.

When you update a report that is copied in multiple categories, you have to make sure you re-deploy the updated report in all those categories.  As a solution, you may deploy a report in a category and then copy it as “link” to multiple categories.

Categories

...

Categories

Kyvos Reporting supports a multi-level (hierarchical) category structure.  For better management, user You can group desired reports and other objects in into one category for better management.

  • Every category has a Category Menu Name

...

  • that uniquely identifies the category at that level in the hierarchy. 

...

  • The name will be displayed in all

...

  • dialogs and pages where the category name is displayed. 

  • The Category ID should be unique across all

...

  • categories.

...

  • By default,

...

  • Kyvos Reporting auto-

...

  • generates it. To specify the Category ID manually,

...

  • clear the System Generated checkbox.

  • A Public category

...

  • (and the objects in that category

...

  • ) is available to all

...

  • users. 

  • A Private category is available only to the owner.  So, objects stored in a private category will be available only to the owner.

  • To create a Public category, you need to

...

  • log in using a Super Administrator ID, Administrator ID, or

...

  • the ID that has Category Setup rights.

...

  • Select the Hidden checkbox

...

  • if you do not want to display this category in any of the dialogs and pages (except the Manage Folders and Reports page).  This will stop users from directly accessing the objects and reports stored in it.  For example, reports

...

  • are used as sub-reports and executed

...

  • within a report.

To create a category

  1. After navigating to the desired folder, click the Add Folder button.

  2. Provide the required details and click the Save button.

...

To change a category information

  • Once set, Category ID and scope (Public / Private options) cannot be changed.

...

  • The application allows you to change the Category Menu Name and Hidden property of the selected category.  To

...

  • make changes in category information, you need to be the owner of

...

  • an empty category. have Category Setup rights, or be a Super Administrator or Administrator.

To delete a category

  1. You can delete

...

  1. an empty category. To delete a category

...

  1. and its contents,

...

  1. select the Delete Cascade checkbox.

...

  1. Click the Remove button to delete the selected category.

...

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

When you delete a Category that is not empty, and the Delete Cascade check box is clear, a message “Failed to delete the category” will appear

...

at the top left of the page.

Reports

Use this page to carryout carry out the following report-related operations:

  • Deploy a report

  • Copy, Move, or Copy-link a report.

  • Change details of the deployed report

  • Delete a report or a linked report

Click the object selector, navigate to the desired folder, and select a report. When you navigate to a folder and click a report listed there, the name and other properties of the selected report will be displayed.

  • You can browse a Report File to select an existing IRL file to create a report.

  • A report has a Report Name (unique across the category) and a Report ID (unique across the repository).  The Report Name is visible in all the dialogs and pages where the report is listed.  When you deploy the report, the application, by default, generates a unique Report ID.  To specify it manually,

...

  •  clear the System Generated checkbox.

  • Content provided in the Description is displayed at all the places where the report name is listed.

  • A Public report is available to all the users. 

  • A Private report is available only to the owner.  To deploy a report as Public, you need to login into the application using Super Administrator ID, Administrator ID or using the ID that has Category Setup rights.

...

  • Select the Hidden checkbox when you don’t want users to access it directly.

...

  •  A hidden report is not listed in any

...

  • dialogs and pages (except the Manage Folders and Reports page).  Mark a report as hidden when you don’t want users to access it directly.  For example, a report

...

  • is used as a sub-report and executed from within a report.

  • Text in Design Mode indicates if the report was designed using

...

  • Web

...

  • Studio

...

  • or Ad hoc Report Wizard.

Defaults

These are the default values for Database connection, Report Output and Printer Setting for the selected reportthe selected report's database connection, report output, and printer settings.  If, at the time of report generation, the user does not specify these, then

  • Report The report will run on the Database Connection selected on this page,

  • in the Output Format selected on this page and

  • if chosen to If you choose Print Direct, you will use the Printer Setting selected here.

If you are a Super Administrator, you can set the following for a report:

  • Deployment Type: A report deployed as Read Only can not cannot be modified and uploaded with same name.  A report deployed as Custom can be modified and uploaded with the same name.  For end-user, Deployment Type is pre-set as Custom.

  • Approval Process: Select an approval process to be followed while publishing a report.  As a part of it, report needs to be approved before it can be published.  To publish report without undergoing approval process, select Direct.

  • Assign Users: To assign users with the workflow process associated with all the reports deployed in this folder.

Administrators can also set advanced properties for the report.  To know about Advanced Properties, click the Advanced button.

To deploy a report

Use this page to locate a report from local or network machine and deploy it in the repository.

After navigating to the desired folder, click Browse button to locate and select the report to be deployed.  Provide required details and click Save button.

Approval Process details

Assign Users button

When you click this button a dialog box opens.  Users / Roles are selected as Approver / commenter on this dialog.

...

When you are taking this report out of the approval process, it may have report outputs which are pending for approvals.  On Action on pending report outputs dialog box, select Approve to approve and publish all the pending outputs, select Reject to reject all the pending outputs and click OK.  Approved outputs will be published and made available to users.

To Copy – Paste a report

Select the report and click the Copy button. 

Navigate to the category where you want to paste the report and click the  buttonthe Paste button.  Click Save button.

...

Click the Save button.

To Cut – Paste a report

Select the report and click the Cut button. Open the category where you want to paste the report and click  button.  Click Save button.

...

click the Paste button.Click the Save button.

To Copy link a report

You can copy link of a report to the same category or another category.  When you copy a link, only reference of the report is copied.   So  So, if original report is updated, it will be accessible from all the links pointing to that report.

Select the report and click the Link button.   Open the category where you want to paste the report and click  button.  Click Save button.

...

click the Paste Link button.Click the Save button.

Select the report / report link and click the Delete button.   A confirm delete dialog appears.  Click OK to proceed with the confirmation.

...

When you delete a report, it will not be available for execution.  It will be removed from all of the open dialog boxes where reports are listed.  Schedules having the deleted report will fail to execute.  Reports that have the deleted report as sub-report, will fail to execute.

When you delete a link, it will be removed from all of the pages and dialogs where reports are listed.

To Download a report

You may need to download a report to make changes in it and upload it back to the server with a different name.

Select the report and click the Download button.

...

To de-link a linked report

  1. Select the linked report and click  buttonclick the Unlink button.

  2. In Delink Confirmation dialog, select the desired option and click Set.

  3. Click Save button to save the changes.

...

Options on Delink Confirmation dialog

  • Copy Layout from Source Report: To make the selected report, exact copy of the original (linked) report.

  • Keep Original Layout: If this report is an independent report (configured internally as a linked report), click this option to just mark it as delinked.