Using DeepSee Visual Reporting
Editing the Report Layout
[Back] [Next]
   
Server:docs2
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

Introduction
The Line Item Report Builder provides a graphical editor that lets you modify the default report format to improve the report output. The following section provides a brief introductory tutorial. The subsequent section describes the main elements of the Report Builder user interface.
Tutorial
In the following exercise, you create and modify the report layout for the data structure you defined in MyApp.MyReportDC.
  1. Click New. The system displays a dialog box where you can enter the following values:
    1. Package Name — MyApp
    2. Class Name — MyReport
  2. Click OK.
  3. At the top of the Fields column, click Set source. The system displays a dialog box. Select the Data Collector you created previously, by clicking MyApp, then MyReportDC. At the top of the Fields column, click Auto-fill to create a default report.
  4. Click Preview to view the default report.
  5. In this step, you modify the report by removing the sysID data field.
    1. In the Report Body section, select either the sysID data field, or field label.
    2. Click Edit to open the editing toolbar, and click Cut.
    3. The sysID data field disappears from the report. If you want to add a data field to the report, drag it from the Fields column.
  6. Edit table properties.
    Select a component in the Report Body section. A collection of tools for formatting tables in reports appears in the Properties column.
    1. In the section labeled Borders and Dividers, select Toggle table border. It is the first selection in this section, and draws a border around the table.
    2. In the section labeled Borders and Dividers, select Toggle zebra striping in body. It is the last selection in this section, and applies zebra stripe coloration to rows in the table.
  7. Add an element to the report layout.
    Drag $pageNum from the Fields column and drop it in the Page Footer section. You can position this element by dragging it, or by editing values in the Size and Position section of the Properties column.
  8. Click Save.
  9. Click Preview to see the effect of your modifications.
Line Item Report Builder UI
The Line Item Report Builder provides a single view, which shows the report layout. It provides the following buttons:
The Page Set-up Dialog lets you set the following parameters of the physical page the report is printed on:
When a report is open in the editor, the page is organized into the following columns:
The next sections discuss the content and function of these columns.
Fields Column
The fields column is empty until you select a data collector for the report with the Set source button. Once you have selected a data source, the Fields column lists the data fields you defined when you created the data collector, along with the additional fields runTime, RunBy, and $pageNum. You can drag and drop fields from the Fields column into the report layout column. When you begin to drag a field, report sections where you cannot drop it turn gray.
The Auto-fill button populates the layout section with a default report layout based on the selected data source.
Layout Column
The layout column is where much of the report layout editing takes place. The Auto-fill button in the Fields column, creates a default report layout in the layout column, which you can use as a starting point. The layout column is divided into a number of sections, and provides a variety of tools and controls.
Toolbar Buttons
Buttons at the top of the column provide access to graphical editing tools. Click on the button to open a toolbar, click again to close it. Once the toolbar is open, you can drag it to another part of the page. The following image shows the edit toolbar open and docked with the Edit button:
This image shows the edit toolbar after it has been dragged away from the Edit button:
The toolbars invoked by the editing buttons, and the tools they contain, are as follows:
Configuring Charts, Barcodes and Images
When you add a chart, barcode, or image, the editor puts a placeholder object into the report. Right-click on the placeholder to open a dialog box that enables you to supply additional information about the object. The following sections describe how to configure these objects:
Chart
This image shows the chart configuration dialog.
This image shows the dialog with the X-Axis tab active.
Barcode
This image shows the barcode configuration dialog.
It is divided into the following sections:
Image
This image shows the image configuration dialog. You can specify an image by typing the URL into the text field, or by browsing for a local file.
Report Sections
The main area of the Layout column is divided into areas that correspond to the sections that make up a report. These sections are as follows:
Each report section has a gray bar across the top of the section that contains a variety of controls. Not all sections contain all available controls. The following list describes these controls:
Properties Column
The properties column lets you specify the style attributes of objects in the layout column. The possible options are grouped according to the relevant style properties for various types of objects. The selection you make in the layout column determines what options are available in the properties column. The available options are as follows: