Chat now with support
Chat with Support

Foglight 5.9.3 - Web Component Tutorial

Using the Web Component Tutorial Tutorial 1: Drag and Drop Tutorial 2: Creating a Dashboard Tutorial 3: Adding a Drilldown Page Tutorial 4: Adding Views Tutorial 5: Using a Grid Tutorial 6: Reports Tutorial 7: Creating a Form Tutorial 8: Renderers Tutorial 9: Adding Questions and Answers Tutorial 10: Sending Messages to Other Users

Creating a Basic Report Page

Just to show you how it works, create a report page using the PDF Layout component that uses an existing view for its body page. We leave the creation of a header and footer for later.

To create a simple report page:
1
In the Module List pane, ensure that your tutorial module is selected.
2
In the Module Contents pane, click the drop-down list, select Views, and click Add .
The Add View dialog box appears.
3
In the Add View dialog box, ensure that the Create a Blank View tab is selected.
4
On the Create a Blank View tab, choose Reporting > PDF Layout.
Figure 1. Create a Blank View tab
5
Click OK.
The Definitions pane displays the view editor, which contains all the boxes that can be used to construct a view. The required fields are marked by an exclamation point icon at the right side of the field. In this case, only the Name field is required.
6
In the view editor, on the General tab, in the Name box, type Hosts Summary Report T5.
7
Ensure that the Public and Deprecated check boxes are clear.
8
Leave the Refresh Interval box unchanged.
9
Leave the Priority set to None.
10
On the right of Purpose, click Edit , and in the dwell that appears, select the Report check box, leaving all of the other boxes clear. Click Apply.
11
Leave the Custom Purpose(s), Relevant Role(s) and Allowed Role(s) unchanged.
12
In each of the Comments and Context Help boxes, type A test that displays a simple report page.
Define a value for the context “title”:

This context is useful if you embed the report in a container, such as a Grid Layout, and then choose Show Title in the layout configuration for the report, which in this case must be purposed as a Pagelet as well as a Report.

To set the contexts for the report title and to generate a list of host objects:
1
Open the Context tab.
2
Under Inputs, click Add Input , and set the columns of the newly added row as follows:
•
Key: title
•
Name: unchanged
•
Usage: Optional
•
List: False
•
Data Type: Common:String
3
In the Fallback Value column, click Edit , and choose String from the list that appears.
4
In the Edit - Context Input Entry “title” dialog box that appears, in the String value box, type Utilization Report - Hosts, and then click Set.
To define a context entry for the Host Model query that returns a single host model:
1
Under Additional, click the Add Context Entry , and set the columns of the newly added row as follows:
•
Key: hostmodel
•
Name: unchanged
•
Evaluate Once: Selected
2
In the Value column, click Edit , and choose Set to Binding > Query from the list that appears.
3
In the Edit - Context Entry “hostmodel” dialog box that appears, click the Query box, and choose My Queries > Host Model T5.
4
Select the Return First Object in List check box.
5
Click Set.

You are about to use this context input to the table of hosts that we construct shortly.

To define a context entry “hosts” for a list of hosts contained in the host model:
1
Under Additional, click the Add Context Entry , and set the columns of the newly added row as follows:
•
Key: hosts
•
Name: unchanged
•
Evaluate Once: Cleared
2
In the Value column, click Edit , and choose Set to Binding > Context from the list that appears.
3
In the Edit - Context Entry “hosts” dialog box that appears, click the Input Key box, and choose hostmodel (Host Model) from the list that appears.
4
Click the Path box, and choose Host - List of Hosts from the list that appears.
5
Click Set.
The hosts context key now references the list of hosts in the host model.
6
Optional. There are two other internally-generated contexts associated with the component: Page Number and Current Time, both of which are optionally available for use in header and footer views. To use these, create context input keys in the child views with the following values:
Page Number
•
Key: pageNumber
•
Data Type: Common:Page Number
Current Time
•
Key: currentTime
•
Data Type: Common:Date
 
* 
TIP: The PDF Layout component provides two additional special contexts: pageCount and reportTitle. For more information, see the Web Component Reference.

Define a page orientation and title for the report

To define the page orientation and title:
1
Open the Configuration tab.
2
In the Page Orientation row, in the Value column, click Edit (), and choose Landscape from the list that appears.
3
In the Title row, in the Value column, click Edit (), and choose Set to Binding > Context from the list that appears.
4
In the Edit - Title dialog box that appears, click the Input Key box, and select title (String) from the list that appears.
Because you already set this context key to Utilization Report - Hosts, that is the title that appears if you embed the report in a container and set its Show Title property to true.

Adding a sample view to the report

You create pages for the report later on in this tutorial. For now we just want to test basic report construction. There is an existing table in Foglight® that has the same context as needed later on in this tutorial, so we will use it for now.

Next, we add this table to the report.

To add the table to the report:
1
Open the Views tab.
2
On the menu bar, click Add .
3
In the Select a View to add to the Report dialog box that appears, choose an appropriate view under Hosts > Host. For example, Hosts > Host > Host Summary.
4
Click Save.
5
On the Views tab, in the row containing the newly-added view, ensure the Function column is set to Body.
 
* 
TIP: The other possible choices in this column are Header and Footer. You add a header and a footer to your report later on in this tutorial.
6
Ensure the New Page column is set to None.
 
* 
TIP: The other possible choices in this column are Before, After, or Both. The settings control the placement of page breaks. You can choose to have a page break before, after or both before and after this view. We choose None because this is a single page report. There are no other views.
7
The PDF Layout component is now configured. On the view editor toolbar, click .
8
Test the report.
9
On the view editor toolbar, click .
To see the report, click the Test PDF button () on the toolbar.
10
In the Input Values dialog box that appears, change the values for the time range and title. Choose a range during which you know some activity has occurred and then click the Results button.
If you have Acrobat Reader installed, the report appears in a new Web browser window (or tab) you a page containing a table with entries similar to that shown in the figure. The report shows the view you selected in Step 3.
Even though the report does not include a header or a footer and contains only one view, this exercise helps you become familiar with the basic steps for creating a report.

Creating a More Elaborate Hosts Table

A view like the one you just used serves as a useful introductory item to Foglight® reporting features. This report can be refined to show numerical data supplemented by time plots. This time you build it yourself.

To add a Row-Oriented Table component showing load summaries:
1
In the Module List pane, ensure that your tutorial module is selected.
2
In the Module Contents pane, click the drop-down list, select Views, and click Add .
The Add View dialog box appears.
3
In the Add View dialog box, ensure that the Create a Blank View tab is selected.
4
On the Create a Blank View tab, choose Tables and Trees > Row-Oriented Table.
5
Click OK.
6
Populate the values on the view’s General tab as follows:
Figure 2. Row-Oriented Table settings
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating