Publishing Rules to Web Portal

---

Contents:

Overview

Typically, each group of delegated administrators requires different reports tailored to their specific scope of managed objects with customized settings. Starting from Cayosoft Administrator version 9.3.0, Global Administrators can create a reporting rule, configure it, and publish it to the Web Portal. Once published, delegated administrators can run this rule as needed and access the generated output file from the Web Portal. These reports will only include objects visible to the respective delegated administrator.

 

Configuring rule publishing

1. In the Cayosoft Administrator console, create a reporting rule.
   Learn more here:
   
   • A video tutorial explaining how to create basic rules: Video tutorial: Create and configure basic rules and reports;
   • Rules and runbooks.
2. In Actions, click Publish to Web Portal.  
   
3. Specify the following settings:
   

   Setting Name	Description
   Publish to Virtual Admin Unit(s)	Select the Virtual Admin Units and Web Queries to publish the rule. Delegated administrators with access to these Virtual Admin Units and Web Queries can run the rule and view the generated reports and outputs.
   Rule scope	When a delegated administrator runs the rule, you can restrict the rule's scope to the specific Virtual Admin Unit and Web Query selected by the Web Administrator, or you can use the scope defined in the rule's settings.
   Allow to change these Query settings	Enable delegated administrators to modify selected Query settings when running the rule.

4. Click Publish to publish the rule.
5. When the rule is published there is a Published link on the rule form. If you click this link Publish to Web Portal form will be opened for editing. 
   
6. Click Unpublish to unpublish the rule.

Reports dashboard

To run published reporting rules and generate reports, use the Reports dashboard in the Cayosoft Web Portal. All generated reports are stored as files. Delegated administrators can only see the reports generated for the Virtual Admin Units and Web Queries they have access to.

Learn more in: Reports Dashboard.

 

Creating reports 

The Create Report , accessible from the Reports dashboard, allows delegated administrators to select the reporting rules published for them, define the rule's scope, enter parameters, and execute the rule.

1. In Web Portal navigate to Dashboards > Reports.
2. Click Create Report.
3. Select the report template: choose one of the rules published for this Virtual Admin Unit.
4. Select the rule scope: specify the Virtual Admin Unit and Web Query for which the rule is published.
5. Click Next.
6. Specify the report name.
7. Update query settings if the rule customization is allowed.
8. Click Create.

Managing reports

Once the report has been created, you can open the report content in a new tab, download the generated report, or remove unnecessary ones. 

 

 

Execution History dashboard

To view the execution history details of published rules, use the Execution History dashboard in the Web Portal. This dashboard helps you understand why a rule may have failed to execute. Delegated administrators will only see the execution history and reports for the Virtual Admin Units and Web Queries they have access to. Learn more in: Execution History dashboard.

Select the execution history record and click Details to see the rule execution report. 

For viewing or downloading reports, use the Reports dashboard.

 

Configuring Cleanup Reports and Output Files rule

To clean up generated reports and output files from the database and disk you should configure Cleanup Reports and Output Files rule.

 

Replication of published rules

If a scheduler is set for a published rule, it will be executed only on the Publisher according to the schedule.

When a published rule is unpublished, it will be deleted from all subscribers.