InetSoft Reporting Software: Report Structure

A report consists of a sequence of report elements. The elements are processed sequentially during formatting and printing in the order they are added to the report. There are three types of elements in the report: inline elements, float elements, and block elements. Each type of element is laid out differently. The elements in each category are listed in the chart below.

Table 1. Element Category and Element Type

Category

Element TYpes

Inline Elements

Text, Tab, Space

Float Elements

Chart, TextBox, Image, Painter

Block Elements

Table, Section, Form, Separator, Newline, Page Break, Area

structured report sample

Inline Elements

Inline elements are laid out from left to right on each line and adjusted for their horizontal alignment. Each line is defined as an area on a report that occupies the entire width of a report, while the height of the area is the maximum height of the elements on the line. A sequence of inline elements is printed from left to right. The printing advances to the next line after one of the following conditions occurs:

  • The contents of the line overflow the current line. The printing advances to the next line starting with any unfinished elements from the previous line.
  • A block element is encountered, which always forces a new line.

Float Elements

Float elements are a special class of inline elements. A float element always takes up a rectangular area on the report. Float elements are printed in the same flow as inline elements, but they may alter the flow depending on their anchor and wrapping settings. Because all float elements are implemented internally as painters, the term “painter” is sometimes used interchangeably with float elements in this document. Painter properties are shared by all float elements. They share the following characteristics:

  • Float elements can have a fixed size specified by a program. • Float elements can be anchored horizontally and/or vertically. If a float element is anchored, it changes the flow of the inline elements by creating sub-areas between the float elements. Inline elements flow horizontally and vertically inside these sub-areas.
  • Float elements can have a margin around the rectangular area.
  • Float elements share the rules of the layout, regarding whether the elements can be broken up in pieces when they do not fit on the remaining space of a page.
  • Float elements use wrapping rules to control how other inline elements can be positioned next to the float elements.
structured report graph
structured report template

Block Elements

Block elements always force the printing to advance to a new line and never share horizontal space with any other elements. Some of the block elements are invisible elements, meaning they do not take up any space but simply alter the flow of printing.

More Articles About Reporting

Create Parameter Inputs - To manage report initialization and creation parameters, follow the steps below: 1Press the 'Settings' button at the top of Enterprise Manager. 2Select the Content page in the left panel, and select the Repository tab. 3Click to select the desired report in the tree. 4Select the Parameter tab. Note: Values that you assign to parameters here will also be used for report preview in Style Studio (for reports saved as "repository reports"). 5Press the 'Add' button below the table on the Parameter tab. This opens the 'Add Parameter' panel. 6Select 'Initialization Parameter' or 'Creation Parameter'. Creation parameters are parameters for template-based (.srt) reports. Use these to set default parameter values and bypass the default parameter prompting mechanism (not custom Parameter Sheets). Initialization parameters are used to set global properties at initialization for a manually coded Replet class. Some of these are generic and can be used for all report types. (Report creation parameters can also be set from the Scheduler tab; see Scheduler Actions...

How to Create an Executable Report - Replets are organized in a hierarchical structure in the repository. There can be any number of levels in the tree. The leaf nodes of the tree are replets and non-leaf nodes are folders. A non-leaf node can be empty, in which case it is simply an empty folder (with no reports in it). The tree position of a replet is encoded in the replet name. A replet name is a full path from the root of the tree to the replet leaf node. Each node is separated by a slash '/'. For example, the replet 'Replet2' in a top-level folder, 'Sales', would have the name 'Sales/Replet2'. Whenever a replet is referenced in a Java program or as a URL, the full name must be used. Because the entire tree structure is encoded in the replet full name, changing the name of a replet could have the effect of moving it among the branches of the tree...

Monitoring Report Execution - The 'Reports' page under the 'Monitoring' node provides key information about reports that are currently executing on the server, as well as reports that are awaiting execution, and those that have already been executed. A pending report is a report that the user has requested, but that has not yet been assigned an execution thread (due to natural or designed processing limitations). As soon as the required processing resources become available, the pending report will be generated and immediately displayed to the user. Note that a pending report is different that a queued report...

Summary of the Use of Report Templates - This chapter described the API that influences report templates created by the visual Designer. Report templates can be imported into a Java Program as ReportSheet objects. We also discussed template processing, which concerns binding data to an element on a template; and template execution, which executes scripts and queries bound to elements. Adding table styles, and all other formatting operations, should be performed at the template level using the Report Designer...

What Actions Can Be Executed from InetSoft's Report Scheduler? - InetSoft's Report Scheduler is a feature-rich tool designed to automate various reporting-related tasks, allowing organizations to schedule and manage report generation, distribution, and other actions. While the specific capabilities may vary based on the version and configuration of the software, here are common actions that can typically be executed from InetSoft's Report Scheduler: Report Generation: The primary function of the Report Scheduler is to automatically generate reports based on predefined schedules. Users can configure the scheduler to execute specific reports at regular intervals (e.g., daily, weekly, monthly) or on specific dates and times. Email Delivery: InetSoft's Report Scheduler enables automated email delivery of generated reports to predefined recipients. Users can specify email...

Previous: Reporting API Conventions