Working with Reports. Dell Vizioncore

Add to My manuals
235 Pages

advertisement

Working with Reports. Dell Vizioncore | Manualzz

192 vFoglight

User Guide

Working with Reports

This section describes the functions that are available to work with reports such as run a report, schedule a report, test a report template, and add a new schedule to the default report schedules list. The tasks of running a report and scheduling a report are available in both the Reports dashboard and Report Manager dashboard. The Test and New

Schedule buttons are only accessible in the Report Manager dashboard.

Running a Report

The Run Report option on the Reports Manager dashboard or the Reports dashboard enables you to choose a report from the report template list and run the report so you can view the PDF output of the report immediately without having to schedule the report.

The resulting report appears in the Generated Reports table.

When you run a report you do not attach a schedule to it. To schedule the report to run

on a particular date and time, see “ Scheduling a Report ” on page 194.

When choosing a template in the Run Report option you can specify values for the report inputs or leave the report values without attaching any values to it.

To run a report:

1 In the navigation panel, under Dashboards, click Reports > Report Manager . If you do not have access to the Report Manager dashboard, click Reports >

Reports .

2 Click Run Report to open the Run Report dialog box.

3 Complete the entries in the Run Report dialog box:

Working with Reports

Working with Reports

193 a Report Template —click Please click here to select template and drill-down to the report template on which to base your report. To help you focus on the source of the report, when choosing a report you can select by module, role or all.

• Click the report template you want to use.

The dialog box populates with the data for the template you selected.

• You can leave the report inputs as is or tailor the report by specifying report input values according to your business requirements. To specify an input value to this report, click the Edit icon in the Value column of the

Report Inputs table to open an edit dialog. The contents of this dialog vary depending on the type value you are editing. For example, an input can be a time range that determines the range of data to display. For information on report inputs, see the Report input section for the appropriate report template in “Supplied Report Templates” on page 138. If a Report Input is marked as required under the Usage column, a value must be set to create the scheduled report. If you enter a new value click Set .

c

For more information on the Web Component Framework and context inputs, see the Web Component Guide and Web Component Tutorial.

b Name —type a unique name for the report. This is a required field.

Note If you are using a template in which the host name is required, you must enter the host name in the text field exactly as it appears at the top of the reports.

View Now —select the check box to view the PDF output of the report immediately.

d Report Format —select PDF to create the report in PDF format. e

Note The CSV option does not appear for pre-defined reports (with the exception of the vFMS Database View diagnostic report) since most pre-defined reports are not capable of generating meaningful CSV data. To generate a CSV report, the component type of the report must support CSV output. For details, see

“ Creating a CSV Report ” on page 215.

Email Recipients —type the recipient’s email address in the text box to send an email notification about this report. For multiple email recipients, you can

194 vFoglight

User Guide

4 enter a list of comma-separated email addresses however, you must restart the vFoglight Management Server.

Note To send reports to email recipients from the Report Manager, you must configure the e-mail server by enabling the “Email Reports Sample” rule. By default, this rule is disabled. When enabling the rule you may also have to edit the “Fire” condition to filter the reports before sending them to email recipients. For more information, see the vFoglight Administration and Configuration Guide under

“Working with vFoglight Rules and Registry > Working with Rules > Defining

Conditions, Alarms, and Actions > Defining actions > vFoglight actions > Viewing email settings and configuring email actions”.

Click Run to generate the report immediately in PDF format.

Scheduling a Report

Select the Schedule Report option on the Reports Manager dashboard or the Reports dashboard to create a report using the report template list and then scheduling the report to run at a particular time. You have the option to leave the report input values as is or tailor the report by specifying input values according to your business requirements.

Note

You can also schedule a report that has generated. See “ Scheduling a Generated Report ” on page 208.

If you want to define a new schedule other than the out-of-box schedules provided with

vFoglight, see “ Adding a New Schedule ” on page 198.

To schedule a report:

1 In the navigation panel, under Dashboards, click Reports > Report Manager . If you do not have access to the Report Manager dashboard, click Reports >

Reports .

2 Click Schedule Report to open the Scheduled Report dialog box. You can schedule a report by either:

• Choosing a template from the Reports list in the Reports Manager dashboard:

Working with Reports

Working with Reports

195

If you chose this option, when clicking Schedule Report, the Create Scheduled

Report populates automatically with data for the selected template.

• Choosing Schedule Report from the top pane of the Reports dashboard or

Reports Manager dashboard.

If you chose this option you will need to click Please select report template .

196 vFoglight

User Guide

Drill-down to the report template on which to base your report. Select a template on which to base your report from the Report Template column. To help you focus on the source of the report, choose a report based on their classification: By

Module, By Role, or All.

3

If you choose this option, the dialog automatically populates with the data for the template you selected.

Complete the remaining entries in the Create Scheduled Report dialog box:

• Report Inputs —if you want to specify a value of an input to this report, click the Edit icon in the Value column of the Report Inputs table to open an edit dialog. The contents of this dialog vary depending on the type value you are editing. For example, an input can be a time range that determines the range of data to display. For information on report inputs, see the Report input section

for the appropriate report template in “ Supplied Report Templates ” on page 164.

If a Report Input is marked as required under the Usage column, a value must be set to create the scheduled report.

If you enter a new value click Set .

For more information on the Web Component Framework and context inputs, see the Web Component Guide and Web Component Tutorial .

Working with Reports

Working with Reports

197

4

• Name —type a unique name for the report. This is a required value.

Note If you are using a template in which the host name is required, you must enter the host name in the text field exactly as it appears at the top of the reports.

• Schedule —choose when to run the report. For example, choose “End of day” to run the report on an end-of-day schedule.

To create a schedule that is not in the list, see “ Adding a New Schedule ” on page 198.

• Retained Results— choose a value to indicate how many instances of a report to keep. This is a required field. For example, if the value is 3, then when a fourth report is generated, the oldest report will be deleted.

• Enabled —the checkbox to set report generation is selected by default.

• Report Format —select PDF to create the report in PDF format.

Note The CSV option does not appear for pre-defined reports (with the exception of the vFMS Database View diagnostic report) since most pre-defined reports are not capable of generating meaningful CSV data. To generate a CSV report, the

component type of the report must support CSV output. For details, see “ Creating a

CSV Report ” on page 215.

• Email Recipients —type the recipient’s email address in the box to send an email notification about this report. For multiple email recipients, you can enter a list of comma-separated email addresses however, you must restart the vFoglight Management Server.

Note To send reports to email recipients from the Report Manager, you must configure the e-mail server by enabling the “Email Reports Sample” rule. By default, this rule is disabled. When enabling the rule you may also have to edit the “Fire” condition to filter the reports before sending them to email recipients. For more information, see the vFoglight Administration and Configuration Guide under “Working with vFoglight

Rules and Registry > Working with Rules > Defining Conditions, Alarms, and Actions

> Defining actions > vFoglight actions > Viewing email settings and configuring email actions”.

Click Create to create and schedule the report. The report appears in the

Scheduled Reports View. See “ Managing Scheduled Reports ” on page 200.

When the report is generated, it will appear in the Generated Reports view. See

“ Viewing a Generated Report ” on page 204.

Testing a Report Template

If you have the appropriate permissions, you can use the Test button on the Report

Manager dashboard as a quick and easy way to preview a report template without having to create a scheduled report nor generate the report.

198 vFoglight

User Guide

To test a selected report template:

1

2

In the navigation panel under Dashboards , click Reports > Report Manager .

Create a report based on a pre-defined or custom template. For a pre-defined

report template, see “ Supplied Report Templates ” on page 164. For custom report

templates, see “ Creating a Custom Report Template ” on page 213.

3 Click .

A test dialog box with the context inputs for the selected report appears.

4 You can optionally enter context input values for the report. If a Report Input is marked as required under the Usage column, a value must be set to preview the

5 report. To change the value of a context input value click . By entering values for the context input you can set your own specialized parameters using the Web Component Framework which is used to build all the views in the vFoglight user interface. If you specify a context input value, make sure you click

Set . For information on report inputs, see the Report input section for the

appropriate report template in “ Supplied Report Templates ” on page 164. For

more information on the Web Component Framework and context inputs, see the

Web Component Guide and Web Component Tutorial .

Click Test to view a PDF output of the report template.

Adding a New Schedule

If the schedule options available in the Report Manager do not meet your needs, you can define a new schedule to fit your requirements. For more information about schedules, see the Administration and Configuration Guide .

To add a new schedule:

2

3

1 In the Report Manager dashboard, click New Schedule .

Type a unique name for the schedule in the Schedule Name field.

Add an optional description about the schedule in the Description/Comments field.

Working with Reports

Working with Reports

199

4

5

Click Next to go to the Details of Schedule page.

Set the Start Date using the fields and drop-down menu, or click the browse button ( ) to open a calendar where you can select the start date.

6

7

8

Enter a Start Time and End Time , or select the Whole Day check box if you want the schedule to cover the whole day. The Whole Day check box may or may not be available depending on the Recurrence Pattern you select. For example, it does not appear for the Recurrence Pattern "Once" (which is the default option.)

Note The End Time must be later than the Start Time.

Choose an option under Recurrence Pattern:

• Once—to specify the schedule to execute only one time during the specified start and end time.

• Periodical—specify the hour and minute that the report will run. For example, type 06:00 to run the report every 6 hours.

• Daily—specify the number of days the report will run. For example, type 2 to run the report every 2 days.

• Weekly—specify the number of weeks and the days that the report will run.

For example, to run the report to schedule every 2 weeks on Friday, type 2 and select Friday.

• Monthly—select to run the report by date or by week.

For example, to run the report by date you can run the report every 6th day each month. Type 6 in the Day box and type 1 in the month field.

If you select to run the report by week, select the week (First, Second, Third,

Fourth, or Last), the weekday and monthly frequency. For example, you can schedule the report to run on the last week of every Tuesday every 2 months.

• Yearly—select the report to run by date or by week.

For example, to run the report by date you can run the report on a particular day on the selected month such as every December 31.

If you select to run the report by week, select the week (First, Second, Third,

Fourth, or Last), the weekday and the month. For example, you can choose to specify the report to run on the last week on Friday every December.

Choose an option under Range of Occurrence (the period during which the schedule will recur).

If you selected an option other than Once as the recurrence pattern, you can select the No End option button to cause the schedule to recur indefinitely, or set an

End By Date using the fields and drop-down menu or by clicking the browse button ( ) to open a calendar from which you can select the end date.

advertisement

Related manuals

Download PDF

advertisement

Table of contents