Creating Report Books

Creating a report book involves the following steps:

•   Creating Categories

•   Adding Contents to Categories

•   Using the Page List

•   Selecting Parameter Values for Parameterized Reports

•   Adding Report Book Banners

These steps are discussed in detail in the following sections.

Creating Categories

The first step of creating a report book is creating categories. Categories make your report book more organizable. For example, you can create a category that will be used to host reports for the eastern sales region, or a category that contains employee data.

To create a category, either select the menu option EditΖCategories, or click the Categories button. The Edit Categories window is displayed, as shown below:

 

   Figure 326: Edit Categories Window

This window allows you to add, edit, remove, and arrange the order of categories. The list box displays all categories that have been created.

Adding New Categories

To add a new category, click Add and the Explorer User Prompt dialog is displayed, as shown below:

 

   Figure 327: Entering Name for Category

Enter a name for the category (no file extension required) and click OK, and the newly created category is displayed in the Categories list on the Edit Categories window. When naming categories, do not include a file extension, any spaces, or any special characters (@,#,$,%, and so on) in the name.

Note that categories can not be nested, this is to say you are not allowed to create categories within an already created category.

Managing Categories Using the Edit Categories Window

The Edit Categories window, as shown in Figure 326, provides a listing of all the categories that have been created in the report book. You may want to edit, delete, or rearrange the categories. Follow the sections below for relevant operations.

•   Editing Existing Categories

To edit an existing category, select it in the Categories list and click Edit. The dialog, shown in Figure 327, appears allowing you to enter a new name. Enter a new name and click OK to confirm the change.

•   Deleting Categories

To delete an unwanted category, select it in the list and click Remove. When asked whether to remove the selected category, click OK to confirm or Cancel to cancel the operation.

•   Rearranging Categories

If you wish to change the sequence of the created categories, select the desired category in the list and click the up or down arrow button to move it up or down in the list. This also changes the sequence of the categories in the Page List when it is shown.

Adding Contents to Categories

Once categories are created, you can add contents into them. The Report Book Designer supports the following list of report styles:

•   Reports, charts, crosstabs, LCharts and cubes created using Report Designer or Easy Reporter with default styles.

•   Parameterized reports, charts, crosstabs, LCharts, and cubes created using Report Designer or Easy Reporter with appropriately supported styles.

•   Freeform template files created using Freeform Report Designer.

•   HTML pages and images (GIF, JPG, PNG, BMP) (report snapshots)

 

   Note:


    Contents can only be added into categories, therefore, always create categories first, then add contents into categories.


Adding Contents

To add content, click the Add Content button or select the menu option EditΖAdd Content, the Add Content window appears, as shown below:

 

   Figure 328: Add Content Window

Follow along the procedure below to add content:

1.   Select from the Content Type drop-down list the desired file type to display.

2.   Select either My Channels or My Folders button, and navigate to the channel or folder that stores the desired report to add.

Double-clicking an item or using the Expand button can take you to the next-level channel or folder.

3.   Select the desired report, and its name is displayed in the Content Name field.

4.   With a report selected in the list, select from the Categories drop-down list which category you wish to add the selected report into.

5.   Click Add to add the report into the selected category.

Other Content Management Capabilities

Besides adding new contents to your categories, you can also delete unwanted contents and reorder the already added contents.

Deleting Contents

To delete a specific content, click the Remove Content button or select the menu option EditΖDelete Content, the Delete Content window appears, as shown below:

 

   Figure 329: Delete Content Window

Select a category from the Category drop-down list, and all the contents already added in that category are listed in the Content list. Select the desired content and click Remove. The content is removed here and in the Page List. Note that the changes are not really saved into the report book until you click the Save Reportbook button in the toolbar.

Reordering Contents

To rearrange the sequence of the contents, click the Reorder Content button or select the menu option EditΖReorder Content, the Reorder Pages window appears, as shown below:

 

   Figure 330: Reorder Page Window

The Reorder Page window provides lists of all the available categories and contents added in them.

To change the sequence of the contents, select the desired content in the list and click the up or down arrow buttons on the right of the list, until the content is placed into the desired position. Note that contents can be moved among different categories.

When done, click Reorder to instruct Report Book Designer to display the contents in the specified order. The updated order is immediately reflected in the Page List.

Using the Page List

Once categories are created and reports added into categories, the Page List, when shown (by selecting the menu option ViewΖPage List, will be displayed as follows:

 

   Figure 331: Page List

To see contents added into a category, expand the list by clicking the plus sign to the left of a category name; the plus sign changes to a minus sign, which can then be used to collapse a category list.

Viewing Reports

When you place your cursor over any report in the Page List, the cursor changes to a hand shape. Click a report and details of the report are displayed on the right pane of the interface. This pane provides report information such as the name, description, the file type, the owner, the modification time, and so on. The name of the report is displayed as a clickable link. Once it is clicked, the report is started in the application in which it is created (such as Report Designer).

Selecting Parameter Values for Parameterized Reports

When a parameterized report or chart is clicked in the Page List, the information shown on the right pane includes an additional section: Parameter Details, as shown below:

 

   Figure 332: File Details

The Parameter Details table shows details of the parameter(s) utilized in the report, and you can use it to select parameter values for parameterized reports. The table options are described below:

Table 105: Parameter Details

Options

Description

Parameter Name

Displays the name(s) of the parameter(s) currently used in the report.

Item Count

Displays the number of values selected for the parameter. These values were selected during the time the parameter was created.

Source

There are four radio buttons to choose:

•   Tree - A list box appears in the Available Value(s) field, listing all the values available in the column on which the parameter is based.

•   Report Bar - A list box appears in the Available Value(s) field, listing all the parameter values. This option displays parameter values in the report title.

•   Preset - A list box appears in the Preset Value(s) field, showing the values selected in the parameter.

•   Manual Entry - An editing box appears in the Preset Value(s) field, which allows you to enter new values for the parameter.

Available Value(s)

Displays the values available in the table column on which the parameter is based, in the form of list box. Either select desired values by Shift/Ctrl-clicking values, or check Load from Database to instruct report book designer to load parameter values live from the database.

Preset Value(s)

Either displays the values selected in the parameter in the form of a list box, or displays an editing box allowing manual entry of parameter values.

When parameter values are selected, you must click Save Parameter Settings to validate the changes.

Adding Report Book Banners

You can add a banner to your report book. This is useful to give all your report books a common look and feel. For example, you can add your company’s logo in an HTML file, then use that HTML file as the banner.

A qualified report book banner is an HTML file, which must be uploaded into Netcool Reporter before it can be used as a banner. The following procedures describe how to add an HTML file as the banner:

1.   Create the HTML file to be used as a banner. This HTML may include text and pictures.

2.   Upload that HTML file into the Netcool Reporter using the Upload Content utility, as described in Uploading Data to a Folder on page 38. Make sure the picture(s) referenced by the HTML file are also uploaded.

3.   For the uploaded pictures, you need to manually copy them into the $INFOHOME/reportbook directory of your Reporter 2.1 server in order to make them available to the Report Book Designer.

4.   With your report book opened in the Report Book Designer, select the menu option EditΖAdd ReportBook Banner.

5.   The Add ReportBook Banner window is opened. Select the desired HTML file and click Add.

This window is similar to the Open ReportBook window, as shown in Figure 335. Select the banner file to add in the same manner as selecting a report book to open.

6.   The HTML file is displayed on top of the report book as the banner.

You can remove an existing banner by selecting the menu option EditΖRemove ReportBook Banner.