Birt使用手册范本

Birt使用手册
1.1简介
BIRT 是一个Eclipse-based 开放源代码报表系统。

它主要是用在基于Java 与J2EE的Web 应用程序上。

BIRT 主要由两部分组成：一个是基于Eclipse 的报表设计和一个可以加到你应用服务的运行期组件。

BIRT 同时也提供一个图形报表制作引擎。

BIRT 拥有和Dreamweaver 一般的操作界面，可以像画table 一样画报表，也可以生成图片、导出Excel、html 分页，样式比script 设置简单，另外BIRT 还有OLAP 导航功能。

1.2基本概念
数据源：数据的来源，或提供者。

如xml 数据源、jdbc 数据源等。

数据集：数据集合，它必须与数据源关联，可以理解为查询的结果。

报表以及报表项，报表可视为是针对一组数据集的表现形式，而报表项这是这个表现形式的某个具体的单元。

它们之间的关系，与窗体和控件的关系非常类似。

报表、数据集、数据源三者间的关系：
数据源 --- 数据集 --- 报表。

报表参数：查询参数的表现形式，使用它可以构建更灵活的报表。

模板和库：主要用于复用报表设计，提高报表开发的效率。

1.3Birt报表设计器的安装与配置
BIRT 的下载地址是：/birt/downloads/ 有两种下载方式：
1) All-in-One 版本（birt-report-designer-all-in-one-2.2.2.zip），
它包含了运行BIRT系统所需的组件，可直接应用。

2) Framework 插件版本（birt-report-framework-2.2.2.zip），安装的必要环境为Java1.4.2/1.5 JDK/JRE; Eclipse SDK 3.2, GEF 3.2 and EMF 3.2。

安装步骤如下：打开eclipse 文件夹，在文件夹中再新建一文件夹（如：birt）,然后打开birt-report-framework-2.2.2.zip 把其中的eclipse 文件夹放入新建的birt文件夹中。

然后在同文件夹的links 文件夹中，新建一个 .link 文件（如：birt.link），且修改其(birt.link)里的路径（如：path=d: \\eclipse\\birt）即已完成。

3)同时应下载中文安装包
(NLpack1-birt-report-designer-all-in-one-2_2_2.zip)将其下plugins 和features文件夹下的文件分别放入至对应的eclipse的plugins和features下即可。

1.4使用Birt报表设计器设计报表
1.4.1创建一个报表项目
选择“文件一>新建一>项目”,出现一新项目对话框。

打开"业务智能和报告工具”（Business Intelligence and Reporting Tools）组，并选择"报表项目" 。

如图1：
图1
点击下一步输入项目名称即可，如输入birtExample作为项目名称，点击”完成”即可。

1.4.2创建一个报表
选择文件->新建->报表。

新建报表（new report ）对话框出现。

在Tree View 中选择我们之前创建的项目birtExample，接下来在文件名字段输入test.rptdesign，如图2
图2
点击下一步”。

“新建报告”提供了一些选项，通过这些选项您可以从空白报告开始或从几个报告模板开始，如图3：
图3
这里我们先选择空白报表，点击完成后将出现如图4所示界面：
图4
此界面主要包括四个区域，左上区域包括Palette、DataExplorer(数据资源管理器)、库资源管理器，其中Palette主要为一些表格、图形等选项区，可通过拖拽放入工作区中；DataExplorer 主要是对数据源、数据集、报表参数的设置；库资源管理器，可以理解为，在使用创建报表的时候有很多的报表资源都会重复的使用，这样为了方便管理，可以将这些部分放在library文件里，这样其它报表只要是引用这些library文件即可。

右上区域为工作区，下边的包含布局、主页、脚本、xml sourc、preview(预览)选项卡；左下区域为工程结构；右下区域为具体元素的属性及参数设定。

1.4.3建立数据源
企业数据经常以不同格式存储在各种系统中，在布局编辑器中开始设计报告之前，构建 BIRT 数据源以将报告连接至数据库或其他类型的数据源。

构建数据源时，要指定驱动程序类、数据源名称和其他连接信息（例如，用户名和密码）。

选择数据源节点，用鼠标右键单击打开弹出菜单，选择新建数据源。

出现新建数据源对话框，如图5：
图5
BIRT 报告使用的最常见的数据源类型是启用 JDBC 的数据库。

BIRT 报告可以使用 SQL 查询和存储过程访问这些数据源。

我们选择“JDBC数据源”
类型，在数据源名称处输入自定义的名称，我们用testDS作为数据源名称，点击下一步，进入数据源配置选项框，如图6：
图6
点击“管理驱动程序”在弹出框中添加对应的数据库驱动程序，如图7
图7
它显示新的驱动程序类，BIRT 报告设计器将 JAR 文件复制到 Eclipse JDBC 目录，选择“驱动程序”以查看驱动程序。

这里我们选择oracle的ojdbc14.jar作为驱动。

然后测试连接，成功后，确定即可。

1.4.4建立数据集
打开数据资源管理器，选择数据集节点，用鼠标右键单击打开弹出菜单。

选择新建数据集，将出现新建数据集对话框。

“在数据集名称”输入框，输入"dsRes"。

确保数据源下拉框显示的是我们之前创建的 testDS 数据源。

确保数据集类型下拉框选中的是"SQL 查询语句" 。

图8
点击下一步，进入“查询”对话框。

如图9：
图9
在这里可以创建和改变 SQL，可以增加WHERE子句, 调整所选择的字段集，等等。

使用 SQL 编辑器增加计算字段，由数据库引擎负责计算。

使用SQL 别名子句给这样的字段命一个名字。

这里可通过对表和字段的双击和拖拽即可将其复制到sql查询区域。

在界面的“架构处”可以选择相应的数据库用户，“类型”中可以选择将要应用的表或存储过程等，点击“应用筛选器”即可过滤。

编辑一条sql语句，点击完成，弹出一编辑数据集对话框，在“输出列”单元编辑其显示名称,如图10：
图10
选择一个字段，点击右侧的编辑按钮，可对字段进行设置，如图11：
图11
可通过筛选器对结果集进行筛选设置，与sql query中的where条件查询功能一样。

点击筛选器->新建，如图12：
图12
可点击“预览结果”来查看结果集是否正确。

计算列- 计算字段由 BIRT 来实现计算，您能使用 JavaScript 表达式, 及调用业务逻辑。

参数- SQL SELECT 语句能包含输入参数，传递数据到查询语句。

在查询语句中他们被标记为SQL的 "?" 符号。

你可以各参数设置一个名字，设置一个默认值等操作。

参数必须与你的SQL "?" 符号一一对应。

过滤器- 附加的过滤器将应用于您的数据。

过滤器约束传递到报表上的数据。

Where 子句也是过滤器: 由数据库执行。

这个选项卡让您使用BIRT 的 JavaScript 脚本语言定义附加的过滤器。

输出列- 根据查询显示Columns, 并让您定义一个Column别名给报表使用。

注意这个view显示的Columns 将是报表所能看见的。

查询选项卡显示着能能从数据库选择的Columns。

1.4.5报表模板
1.4.5.1创建模板
BIRT 提供了模板机制来重用设计，可以加快报表的开发，定义报表模板有以下两种方式：
1. 文件->新建->模板，输入名称等，可以设计一个模板文件；
2. 对于已经设计好的报表，可以发布为模板。

在设计好的报表文件上点右键，选择发布到模板文件夹，输入名称即可。

1.4.5.2使用模板
报表有大量重复的信息时，可以制作出一个模板，把这些重复的信息放在模板里定义，之后再制作报表时，直接应用该模板，即应用上了这些重复的信息。

1.4.6创建库文件
1.4.6.1理解library(库)
Library(库)可以理解为，在使用创建报表的时候有很多的报表资源都会重复的使用，这样为了方便管理，可以将这些部分放在library文件里，
这样其它报表只要是引用这些library文件即可。

同时也方便了管理。

1.4.6.2创建library
1.选择新建“库”，如图13
图13
2.新建库的数据源和数据集，方法步骤同1.4.3，建后如图：
图14
1.4.6.3使用library
1. 新建一个报表文件，如图15
图15
2. 进行引用，首先确保Data Explorer和Library Explorer同时在界面里显示，之后便是将Library 里的我们要用的数据拖拽到Data Explorer 自己的报表Data Sources中。

便完成了引用数据源。

如果Library中还有其它我们要引用的部分也是同样去操作。

如图16
图16
这样当修改数据源的时候，只要修改包含数据源的library文件就可以了，而不必去一个个修改其它的报表文件。

这些库可包含任何报表元素，比如样式、数据源、报表条目、脚本等等。

1.4.7对报表进行布局
在开始对报告进行布局之前，应在“数据资源管理器”中验证数据集是否返回了您想要在报告中使用的数据。

在许多情况下，报告的布局由数据驱动。

在“布局管理器”上列出了各种报表元素，可以拖拽相应的元素至工作区中。

其中最常用的就是“表”和“图表”下面将介绍各种元素的用法：1.4.7.1文本
报表通常会以文本格式显示大多数信息。

实际上，我们可以安全地假设所有报表都包含文本。

即使报表主要由图表或图片组成，它仍然会使用文本来标注图表、显示标题、描述图表或图片等等。

文本包含静态文本和动态文本两类。

1）静态文本：即在报告中输入的文本。

可在报告标题或列标题中使用静态文本，也可以使用静态文本来编写有关报告的摘要。

2）动态文本：通过计算得到的信息或来自数据集的信息。

1.4.7.1.1创建动态文本
1)确保想要在其中插入动态文本元素的表或列表绑定至包含 CLOB 数
据的数据集。

要验证或创建数据集绑定：
1.选择表或列表。

2.选择“属性编辑器”上的“绑定”。

3.在“绑定”页的“数据集”中，选择数据集。

2)创建一个列绑定，它引用包含 CLOB 数据的数据集字段：
1.在表的“绑定”页上，选择“添加”。

2.在表达式构建器中，选择“可用的数据集”，然后选择数据集
并双击 CLOB 字段。

选择“确定”以保存表达式。

新的列绑定
将出现在“数据绑定”中，并且突出显示了列名。

3.将名称“新的绑定”替换为您选择的名称，然后选择“确定”。

3)将布局管理器中的动态文本元素拖放到表或列表中。

4)在表达式构建器中，选择“可用的列绑定”，选择“子类别”中的
表，然后双击创建的列绑定。

选择“确定”以保存表达式。

5)在布局编辑器中，选择动态文本元素。

“属性编辑器”将显示该动
态文本元素的属性。

6)选择“常规属性”，然后对“内容类型”选择下列其中一个值：
o自动
如果不知道字段内容的格式，则选择此值。

如果内容包含 HTML
标记，则 BIRT 报告设计器会将其解释为 HTML 并正确显示内
容。

如果内容为纯文本，则 BIRT 报告设计器也会正确显示内
容。

o HTML
如果知道所有字段内容都是 HTML 格式，则选择此值。

o纯文本
选择此值将会完全按照数据源中的显示样式显示字段内容。

如
果内容包含 HTML 标记，则 BIRT 报告设计器会显示 HTML 标
记。

1.4.7.2网格
网格可以组织报表项，将报表项放入网格的单元格中，网格类似excel 中的表格操作，可以进行单元格的合并等操作。

将布局管理器中的图像元素拖放到页面上的期望位置。

将出现“插入网格”如图17：
图17
点击确定后就会出现网格布局如图18：
图18
通过右键单击想要添加行或列的位置旁的指导单元格，从上下文菜单中选择下列其中一项以在期望的位置添加行或列。

1.4.7.3图像
将布局管理器中的图像元素拖放到页面上的期望位置。

将出现“新建图像项”如图19：
图19
其中有四个选项，
RUI：链接至存储在资源文件夹中的图像； Image file in shared resources 为连接至存储在任何其他位置的图像；Embedded image为嵌入式图像；Dynamic image动态图像。

1.4.7.4表
1.4.7.4.1表格边框设置
选中整个表格（选中一个单元格、再shift选中整个表格），填充设置为0，然后选在边框，既可以为整个表格设置边框。

1.4.7.4.2建表
用鼠标拖动“表”项，移到编辑区，即可弹出“插入表”对话框，如图20
图20
修改相应的属性，“数据集”要选上已有的数据集，点击确定后出现如图21
图21
此表包含了页眉（表头），明细数据行（数据），页脚行。

若要编辑或删除表只要右键点击左下角的脚手架“表”即可选择相应的操作。

同时可对表进行列大小的调整，如图22
图22
将鼠标放置列与列间的间隔线即可拖动调整大小，与操作excel类似。

还可
可对表应用样式如图23,
图23
下边的属性编辑器可对表的属性进行详细设置，如图24:
图24
拖动左边数据集“dsRes”下的列到表的相应明细数据行，如图25：
图25
可对页眉行的标题进行重命名，拖完后点击“预览”，在编辑区就可以看到报表数据，如图26：
图26
1.4.7.4.3典型应用
1.4.7.4.3.1给表添加行号
1.选中表的第一列，点右键，插入/在左侧插入行，如图27:
图27
2.在第一列第一个单元格插入一个“文本”项，在弹出的编辑框中输入“序号”，如图28：
图28
3. 在第一列第二个单元格中插入一个“数据”项，在弹出框中会让建立一个数据绑定如图29：
图29
填写相应的绑定字段名、显示名、在Data Type(数据类型)中选择‘整型’，Expression（表达式）中输入’row[0]+1’即可实现添加行号。

效果如图30：
图30
1.4.7.4.3.2隔行高亮显示
选中数据显示行，这里是第二行,如图31：
图31
在属性编辑器-行中点突出显示选项卡，如图32
图32
点添加按钮，在“新建突出显示”中添加相应的项。

如图33：
图33 预览效果如图34:
图34
这样一个简单的报表就做好了。

1.4.7.4.3.3设置预警阀值
可以利用“突出显示”设置预警阀值，当表格中的数值大于某个值、并且小于某个值时，数值可以自动变色。

也可以在映射中设置。

1.4.7.5图表
图表是报表中重要的应用，通过图表可以各直观的显示数据信息。

1.4.7.5.1创建图表
在开始设计图表之前，必须创建要显示图表的报告设计文件，然后设置图表使用的数据源和数据集。

1.从"Palette"面板拖入"图表"项到报表中，此时会弹出"新建图表"窗口，选择图表类型；如图35：
图35
首先会选择要建立的图表的类型，其中包括了各种常用的图表，如条形图、折线图、面积图、仪表图、饼图等，这里我们选择条形图作为例子,在属性“维”中可以选择要显示图形的维数，“输出格式”是输出的图形的格式，
“多个y轴”是显示的图形的y轴数，这里例子使用默认选项即可。

2.在"选择数据"页，使用数据集chart(新建的作为统计用)，同时选中name 列，将其拖入"类别（x）系列"。

对于统计列，将“zongfen”同样将其拖入"类别y 系列"。

拖入后相应的列颜色会改变，这里还可以做数据筛选等操作；如图36：
图36
在右下角有筛选器、参数、数据绑定操作，可对数据集进行操作，与数据集、参数操作一样，点击下一步，进入图表样式设置页面，如图37:
图37
在这里可对图形的具体样式进行设置，选择“值Y系列”,选择“显示系列标签”，这里是在柱状图上显示数值，点击左侧图表区域，如图38：
图38
可设置图表背景色、添加图表样式、图表边框和属性等；点击左侧坐标轴，可对坐标轴的可见性、类型、样色进行设置；如图39：
图39
可设置具体的X轴、Y轴、Title、图形、图例进行设置。

在布局操作区可用鼠标对图的大小进行调整，效果预览如图40：
图40
1.4.8报表样式
BIRT 使用CSS 为报表项目定义样式。

BIRT 允许您在样式表定义属性, 然后将样式应用与报表项, 就好像HTML一样。

结果是, 您只要创造样式一次就可以多次的使用它们。

如果您需要改变报表的风格, 您只要在一个地方修改就可以将效果应用于许多不同的报表项。

如果您曾经在创造HTML页时定义过自己的样式表, 您将很容易理解BIRT的样式系统。

样式可以被放置入BIRT lib中(使用Themes)，并且被报表共享。

1.4.8.1创建样式
1.在布局编辑器中，选择想要对其应用样式的报表元素。

如果想要创建样式但不对任何元素应用它，则单击报表页上的空白区域
2.选择“元素”->“新建样式”。

将出现“新建样式”，如图41 所示。

属性类别显示在左边。

所选类别的属性显示在右边。

图41
3.指定下列其中一个设置:
(1) 要对特定类型的报告元素应用样式属性，请选择“预定义样式”并从下拉列表中选择一种样式。

(2) 要创建用户命名的样式，请对“定制样式”指定唯一描述性名称。

确保该名称不会与任何预定义样式名称相同。

如果指定的名称与预定义样式名称相同，则定制样式优先，并且您无法再使用该预定义样式来应用级联表。

4. 通过选择在左边选择属性类别并指定属性值来设置期望的样式属性。

5. 设置完样式属性时，请选择“确定”以保存样式。

如果在创建样式之前选择了元素，则 BIRT 报告设计器会对该元素应用此样式。

1.4.8.2导入样式
1.选择布局编辑器，选择“元素”->“导入 CSS 样式”，如图42:
图42
2.在“导入 CSS 样式”上的“文件名”中，指定想要导入其样式的 CSS 文
件的名称。

可选择“浏览”来查找该文件。

“导入 CSS 样式”将显示在 CSS 文件中定义的所有样式, 选择想要导入的样式。

要导入所有样式，请选择“全部选中”。

3.完成选择之后，请选择“完成”。

BIRT 报告设计器会将这些样式复制到
报告中。

如图43
图43
1.4.8.3级联样式
BIRT 使用CSS为报表项定义样式，BIRT 同样遵循 CSS的"级联" : 一旦为报表或容器设置了属性, 则这些属性值会级联应用于这个容器所包含的内容。

在BIRT中,网格、列表和表都是容器: 他们能够包含其他的报表项。

报表本身是所有报表项最终的容器。

1.4.8.4应用样式
1.右键单击想要对其应用样式的报告元素。

2.从上下文菜单中选择“样式”->“应用样式”，然后选择列表中的一种样
式。

列表显示创建和导入的所有样式。

选择“无”以除去当前对报告元素应用的样式。

报告元素的外观将根据选择的样式变化。

1.5报表参数的使用
参数是 birt 提供的一种很重要的机制，在 birt 中，参数具有变量的作用，它为 birt 报表的生成提供了一种灵活强大的机制。

在开发Bird参数的时候，首先要区分 Bird的参数类型：报表参数（Report Parameters）和数据集参数( Data Set Parameters)。

报表参数是定义于整个报表（Report）中，而数据集参数是定义于某个数据集（Data Set）中。

数据集参数使用的时候通常需要链接某个报表参数或者利用绑定表（binding tab）和一个嵌套表中的某个数据元素绑定，也就是说它一般不单独成为一个可以实际应用的参数（但是它可以设置一个默认参数）。

1.5.1标量参数
标量参数是Birt报表中最简单也是最基本的一类参数，标量参数可以分为静态标量参数和动态标量参数两种。

静态参数是从用户界面获得用户手工输入的数据值，报表根据该参数生成相应内容；动态参数主要指的是在人机交互的界面中，使用人从指定数据集中选择条件，同时在报表中展示的数据是根据使用人所传递的参数所查询出来的内容。

这样能够为使用人提供一个可选范围，方便的选择。

两种参数分别适应不同的情况，下面分别介绍这两种参数。

1.5.1.1静态标量参数
1.在数据资源管理器中的报表参数上点右键，弹出新建报表参数对话框，如图44：
图44
输入相应的值，在值列表项中默认为静态的，若选择其下的组合框、列表框时会变为可选的。

默认值可以输入也可不输。

2.然后定义数据集， Where条件中的ID字段通过”?”代表的参数传入参数值，如图45：
图45
点击”参数”，弹出在数据集中定义参数的对话框。

数据集中的参数需要链接至某一个报表参数。

在本例中将数据集参数链接至前面定义的报表参数ID。

点击OK，我们就完成了数据集中参数的定义。

当报表运行时，Birt 会使用由报表参数ID传入的值填充where条件，生成结果数据集。

如图46：
图46
其中参数名称可以随意，选好字段对应的数据类型，方向一般为输入，默认值即为where条件后“？”代表的默认值。

若选择链接到报表参数下拉框中的报表参数，择输入的默认值失效。

当展现预览报表时会弹出报表参数输入框，如图47：
图47
输入参数点击确定即可展现对应的报表。

1.5.1.2动态标量参数
动态参数可以提供一个数据值的列表供用户选择，这种功能能够极大增强报表设计用户界面的交互性。

在此，我们首先定义一个数据集，这个数据集不使用参数，它从表中查询出所有的ID号，为报表参数提供一个数据值的列表。

在新建参数中的显示类型中选择“组合框”，值列表中选择“动态”选择对应的数据集和值列。

如图48
图48
将本数据集的参数ID链接至ID，就完成藉由一个报表参数为中介将一个数据集的字段值链接到另一个数据集的参数的功能。

预览如图49：
图49
1.5.2级联参数
除了使用动态报表参数提供数据值的选择列表，报表开发过程中用户经常需要用到互相关联的参数。

比如要选择某个客户的某个订单号标识的所有订单的内容，用户并不愿意列出所有可能的订单号，比较理想的情况是给出一个客户编号的选择列表，根据这个列表的内容再给出每个客户的所有订单号的列表，这样用户就可以选择相应的客户对应的某个订单号，从而查询出此客户的这个订单号标识的所有订单的详细内容。

级联参数一方面增强了报表逻辑的功能；另一方面，通过将一部分应用逻辑转移到界面操作上，进一步降低了报表内部逻辑和SQL查询语句的复杂性。

首先定义一个customer数据集，这个数据集包含cus_id和cus_name 两个字段，如图50：
图50
接着定义一个名为oraders的数据集，如图51
图51
在“Orders”数据集中使用一个数据集参数，这个数据集参数将要引用接下来将要定义的层叠参数中customer参数。

定义了以上数据集之后，就可以来定义级联参数了。

右键点击数据资源管理器面板中的报表参数选项，在弹出的上下文菜单中点击“新建级联参数”，弹出以下对话框，在级联参数名称称域输入参数的名字，本例中使用的参数名字为“custorder”，数据集模型选择为多个数据集。

在紧接着的参数表中定义一个名为customer的参数，并将其关联至customer这个数据集，其取值为customer数据集中的cus_id字段，这样customer这个级联参数的取值就是一个cus_id的列表。

Customer此
时也成为一个动态参数。

1.5.3参数组
关于这个参数组，主要是bird考虑到在创建报表的时候需要提供大量的参数，为了在界面上更加有效地对这些参数进行组织，便提供了参数组的功能。

用户可以使用参数组将相关的参数组织在一起，就是说将功能相关的参数放在一个组里面，便于查找，修改等管理操作。

对于其具体操作方法：
1.创建一个参数值。

在数据管理器视图中用鼠标右键点击报表参数
->新建参数组，如图52:
图52
2.创建完参数组后便可以为其创建参数。

3.设置与操作参数组(parameter group)，主要有两个方法：一种方
式是用鼠标右键点击参数组标签并选择new parameter创建新的
parameter；另一种方式是将已有的参数添加入参数组，只需要使
用鼠标将所需要的参数拖拽入参数组中。

1.6展示设计好的报表
首先需要下载BIRT 报表的运行环境包，birt-runtime-2.2.2，如果需要输出PDF 格式，需要下载itext-1.3.jar 支持包，
/itext/itext-1.3.jar；
如果输出PDF 要显示亚洲语言，需要下载iTextAsian.jar 支持包，
/itext/iTextAsian.jar。

1.6.1Web容器生成方式
1.6.1.1用birt-runtime
2.2.2中的webviewerExample
1. 将其复制到%TOMCAT%\webapps 目录下，并将其更改名称为birtServer；
2. 如需生成PDF 格式，在
birtServer\WEB-INF\platform\plugins\com.lowagie.itext
目录下新建文件夹lib,并将itext-1.3.jar 和iTextAsian.jar 拷入其中；
3. 把所使用的数据库的JDBC 驱动jar 包复制到
birtServer\WEB-INF\platform\plugins\org.eclipse.birt.report.data .oda.jdbc（后跟版本号）\drivers 目录下；
4. 将设计好的报表，比如test.rptdesign 放到BirtServer 的根目录下，然后启动TOMCAT，即可通过
http://localhost:8080/birtServer/frameset?__report=test.rptdesig n (相对路径)或者
http://localhost:8080/birtServer/frameset?__report=C:/test.rptde sign (绝对路径)
来访问。

如果要生成pdf 文件，如下：
http://localhost:8080/birtServer/frameset?__report=test.rptdesig n&__format=pdf
如果报表有输入参数，只需在上述url 后拼接参数及值即可，如下：。