The Freeform Report Designer is a convenient application development tool for combining multiple existing Reporter 2.1 reports together for output to HTML or PDF format. The layout properties for a presentation are stored in a Freeform Report Template file which can then be saved, edited or distributed to other Netcool Reporter users for reuse. The Freeform Report Designer allows you to combine a number of components into a presentation to enhance the output.
In general, the Freeform Report Designer features:
• A GUI based, application development design editor
• Multiple pre-defined templates
• Output presentation to PDF or HTML
• The ability to create, re-use and share Freeform Report Templates
• The ability to combine Netcool Reporter reports, charts, text, graphics, and other types of components within a presentation
• The ability to present a report via a Form or Table style
• Support for parameterized reports within the presentation
• The ability to support Netcool Reporter XML and CSV output as the presentation component
Freeform Report Templates are XML files that are used to combine Netcool Reporter charts, reports, and various components into a single presentation. These presentation components are summarized in the list below:
• Netcool Reporter Reports
• Netcool Reporter Charts
• Text
• Images
• Page numbers
• Dates
• Header and Footers
• Table of Contents
• Page Areas
• Definable Print Areas
The combination of these components on a layout page is saved to a Freeform Report Template file. Template files are standard Netcool Reporter files that can be reused or distributed to other users. When Netcool Reporter users run a template file, they will be presented with the appropriate presentation, in PDF or HTML format.
There are a number of sample freeform templates supplied with Netcool Reporter 2.1. To access those templates, click the My Folders link to open the My Folders page; click the Reporter 2.1 folder and select the Sample Freeform Reports folder.
One of the sample templates is shown in the following figure:
|
|
Figure 252: Sample Freeform Template |
Web browsers automatically store recent versions of web pages and Java applets. However, this cache capability may prevent the Freeform Report Designer from displaying correct report output for you. To solve this, it is important that your web browser be configured to disable its cache capability such that it always reads the latest version of a report and does not use an older version in the web browser cache.
The following examples describe how to configure your web browser to refresh its cache. You may see different names on your web browser interface. For correct information on changing the cache settings specific to your web browser, see your web browser documentation.
Internet Explorer
1. On the Tools menu select Internet Options.
2. Select the General tab in the Internet Options dialog box.
3. Select Settings in the Temporary Internet Files section.
4. Select Every visit to the page in the Settings dialog box.
Netscape Communicator
1. Select Preferences from the Edit menu.
2. Click the plus box beside Advanced.
3. Click Cache.
4. Click the Every Time radio button
To start Freeform Report Designer, click the Freeform Report Designer link in the Report Designers page; the Freeform Report Designer window opens, as shown below:
|
|
Figure 253: Freeform Report Designer Window |
The functional buttons and most of the menu commands are grayed out until you create a new template or open an existing template to edit. Create a new freeform template file or open an existing template using the File menu.
You can create, open, preview, save, delete and publish freeform report templates.
To create a new freeform report template, select the menu option FileÆNew. The New Report window is displayed, prompting you to select a predefined report template to start with. This window is described in Quickly Using Predefined Freeform Templates on page 419.
When you click New, and make changes to the formatting, the changes are not saved until you select the menu options FileÆSave or FileÆSave As.
Once a freeform report template has been created, you can modify it at any time.
To edit an existing freeform report template:
1. Select the menu option FileÆOpen. The Open window is displayed, as shown below:
|
|
Figure 254: Open Window |
2. Navigate to the desired folder and then select the freeform report template to open.
3. Click Open to view and begin editing. The Freeform Report Designer window is displayed. This window is described in Page Layout on page 474.
4. You can preview the file in either HTML or PDF format, as described in Previewing Templates on page 413.
When creating or editing a freeform report template, you can preview the template in the following formats:
• HTML
To preview a freeform report template, select the menu option FileÆPreview, or click the Preview button. The report is displayed in a new browser window.
To change between the output types, select FileÆOutput Type. The Output Properties window is displayed, as shown below:
|
|
Figure 255: Output Properties Window |
Select the required output radio button and click OK.
Note:
Although Freeform Report Designer supports both HTML and PDF as output types, some elements and features are not supported in both formats. See Element Restrictions for Output Types on page 417 for detail information.
To save a new freeform report template or to save an existing freeform report template under a new name, select FileÆSave As. If you are saving an existing template under a new name, the old template still exists in the state it was in when you last saved it. Any changes since that last save are only stored under the new name.
When you save under a new name, the Save As... window is displayed, as shown below:
|
|
Figure 256: Save As Window |
To save an item using this window:
1. Enter a name for the item in the File Name field.
2. Enter a description for the property file.
3. Make sure freeform report templates is selected in the File Type drop-down list.
4. From the Look In drop-down list, select the name of the folder into which you wish to save the item.
5. Click Save to save the item.
If you wish to save changes to an existing freeform report template, without specifying a new name, select the menu option FileÆSave.
If you want to save a fixed image of the Freeform template, select FileÆSave Snapshot. The Save Snapshot window appears prompting you to select a location to save the snapshot file and enter the file name. Enter a name and click Save to continue.
You can save the freeform snapshot in the following formats:
• HTML
For information on changing between the two formats, see Previewing Templates on page 413.
Existing freeform report templates can be deleted only through the Manage Folder Content page, as described in Managing Folder Content on page 33.
Once a Freeform report template is created, you can publish it to other users in the same manner as other Netcool Reporter reports and files, as described in Publishing Files on page 42.
As with most tools, there are a set of terms that are unique to or defined by the Freeform Report Designer. Understanding this vocabulary is important when using this tool.
These terms are:
• Page Area - A Page Area is a rectangular area drawn on a page that can be used to accommodate elements that are supported by the Freeform Report Designer. Once page areas are added to a template, their positions and sizes can be modified as desired. A page area has two modes: Container for elements and Non-container. For detailed information on Page Area, see Working with Page Areas on page 469.
• Element - An Element is a piece of content displayed in the template, for example, a chart, a table, a graph, a newline, HTML, text, and so on. Elements can be placed on a page as well as in a page area added on the page. See Inserting Elements on page 434 for more information.
• View - A View is a way of displaying the template for editing. A view can provide access to elements or to areas. See Changing Views on page 474 for relevant information.
While Freeform Report Designer supports both HTML and PDF as output types, some elements are not supported in both formats. The table below lists a number of features and describes whether they are supported in HTML and/or PDF output. If an element is not listed here, it is supported in both formats. Note that a check mark means support for that particular feature.
|
Element |
|
HTML |
|
Areas (Area Breaks, Area Order) |
Ö |
|
|
Scroll option in container-mode area |
|
Ö |
|
Some special fonts such as Default, Georgia, Lucida Bright, Microsoft Sans Serif (For information on configuring fonts for Freeform (for example, Truetype fonts), see Appendix E in Netcool Reporter Administration Guide.) |
Supported but not well enough |
Ö |
|
Container mode area |
Ö |
Ö |
|
Non-container mode area |
Ö |
|
|
Font underline/strikethrough dash; fixed length underline; effect like shadow; line styles other than solid in text font and tab styles (for example, dotted line style) |
Ö |
|
|
Anchors (images, charts) |
Ö |
|
|
Some tags in Header/Footer, such as current page number {P} and total page numbers {N} |
Ö |
|
|
Some table styles, especially 3D styles and other styles with double/dash border |
Ö |
|
|
Page Layout (Page Orientation, Margin, From Edge) |
Ö |
|
|
Pagination (for images and charts) |
Ö |
|
|
Line Styles other than a single line (Tab Fill, Separator, Text Underline, Form Field Underline, Area Border Line) |
Ö |
|
|
Table of Contents/Headings as clickable links |
|
Ö |
|
Table Style Designer: Body: Row Border |
Ö |
|
|
Table Style Designer: Body: Row Border Color |
Ö |
|
|
Table Style Designer: Body: Column Border |
Ö |
|
|
Table Style Designer: Body: Column Border Color |
Ö |
|
|
Table Style Designer: Border: Border Style |
Ö |
|
|
Table Style Designer: Border: Border Color |
|
Ö |
|
Text Alignment (vertical) |
|
Ö |
|
Text Wrapping |
|
Ö |