StyleReport入门指导手册.doc

1 Style Report 的帮助文档为了你全面掌握软件的全部完整特性，我们提供了以下的文档作为指导。所有文档的英文版本会随产品安装到本地，从“开始”菜单中可以直接打开。部分核心文档的中文版本保存在产品介质中，如需单独获得，请向英网公司北京代表处获取。I 参考手册Style Report管理员手册 这个文档主要描述了报表服务器的管理。II 索引和指南最初使用指南（Getting Started Guide）是报表设计的大纲，使用Style Report的一个基本介绍，包括了基本的报表设计（使用可视化设计器和编程方式）以及报表服务器的概况。可视化设计器指南（Report Design Guide）本文档详细讲解了报表设计器的使用，主要包括了使用Style Report来设立报表模扳，还包括了Query Builder，它是一个定义数据源和查询语句的设计界面，介绍了报表元素如table，section，chart等如何进行数据绑定的，同时介绍了如何在报表模板中嵌入javascript来动态设计报表，而更多的关于脚本设计的部分我们有专门的script指南来介绍。Script指南（Report Scripting Guide）本文档详细介绍了在可视化设计器中如何使用javascript，包括了详细的语法描述，以及嵌入到Style Report中一些对象的用法。编程指南（Programming Guide）本文档包含了Style Report所有的特性描述，如果用户使用到java API的方式，或者需要理解报表的特性就需要阅读着这个文档。Data Model数据模型指南（Data Modeler Guide）Style Report包含的分析模块（用户可选择购买），可以进行高级的数据分析，本文档详细介绍了开发者如何来建立和增加这些功能模块。Data Worksheet指南（Data Worksheet Guide）Style Report包含的分析模块（用户可选择购买），本文档描述了如何使用Data Worksheet的简化方式来完成复杂的数据分析功能。用户指南（User Guide）Style Report企业版中有许多可供用户对报表进行操作和数据处理的功能，本文档详细描述了最终用户如何使用这些功能在Web界面上。III 白皮书Style Report白皮书本文档是Style Report的高度特性概括，包括了同其他报表解决方案的比较。IV API文档API参考文档API文档是java语言类的一个集合。包括了所有定义的类和方法。2 可选择组件Style Report企业版可以加入一些分析的功能组件，用户可以在企业版的基础上自选购买，包括ad-hoc（即席报表），预警功能，OLAP分析，和Jetspeed Portal集成接口等。可选组件描述即席报表在Web界面上最终用户可以用拖拽方式来新建报表，用户可以控制报表元素增加，数据绑定，格式以及样式风格，在有设定权限准许的情况下，用户还可以修改已经存在的报表。在线预警用户可以给设定一些条件，可以在确定的时间间隔告警，并通过设定的格式以e-mail发送用户来达到监控数据或绝对级的目的。OLAP 分析Style Report可模拟分析服务器来进行数据的向上钻取和向下钻取的功能，可以达到OLAP服务器的标准筛选有用数据。他也可以直接访问OLAP服务器，来完成所有OLAP服务器所能完成的功能。与Jetspeed Portal集成用户可以集成到Apache Jetspeed Portal服务器中，这样最终用户可以将多个报表在一个页面中显示，也就是常说的仪表盘。Data Worksheet 通过这个功能模块可以使用户很便利的对生成复杂的数据分析和汲取重要信息，用户在没有数据库和查询语句的知识条件下可以建立复杂的查询语句。3关于帮助文档3.1先决条件在正确安装好 Style Report 软件后可以查看本帮助文档。3.2文档规定一些关键字体都是以斜体形式来表现的。 一些重要的概念和或者例子都是以下列固定的方式和字体显示的 还会有备注重要的信息，如： 一些例子会有详细的步骤来说明，和图片显示。1. 建立新的报表，点Blank Tabular Report，然后点OK.源代码和操作系统命令用以下固定的 格式出现，比如：java inetsoft.report.design.Designer完整代码例子会以列表标题的方式展现，并以如下固定的字体宽度被打印。Listing 1. Report Templateconfigure”内的CLASSPATH来定义）4.3.2 定义一个查询数据源定义好后，我们接下来可以在这个刚建好的Order数据源下面建立一个新的query来提取特殊产品销售情况的数据了。注：Style Report提供了一个有逻辑的数据库提取模型叫Data Models（类似于一个实体关系的模型），使用Data Models可以增强用户的数据处理能力，如即席报表的建立以及和用户的安全权限想结合，更多的可以参看Data Modeler指南。举例：1打开Query Builder2点击New Query Wizard后选择Order数据源，接着选择New Query。3. 输入query名称为product sales，选择Order，点击OK。4. 拖动categories, products, order_details, 和 orders这几张表至界面右侧。5. 选择Fields，拖动categories.category_name, products. product_name, 和orders.order_date这几个域。6. 选择Add Expression（增加表达式），输入公式“(1-orders.discount)* products.price*order_details.quantity”，点OK.7. 我们可以为每一个选择的域输入别名，分别修改为以下的别名“Category”, “Product”, “Order Date”, and “Sale Total”。8.点击完成。4.4 团队开发Style Report支持团队报表开发，如果是多个用户需要访问和修改一公共的data source (xml), query(xml), and library (srl)。我们会提供一个远程的注册对话框，或者使用TeamServlet.，更多的信息在设计器指南中有详细的描述。4.5报表布局在新建一个报表之前，必须要选择一个布局类型，软件提供了有流式的布局，网格式的布局，如果要生成的一系列报表中，他们中都有共同的报表元素存在，可以首先制作元模板（meta-template），否则使用一个空白的模板来生成一个报表。下面将列举一个例子。4.5.1选择报表类型备注：传统的报表工具使用带状的报表布局格式，Style Report提供了很多应付复杂报表的报表布局流式布局是类似于word的生成器，所以报表元素生成的顺序是由左至右，由上至下，流式布局也可以通过放置一系列元素至自动分页，也可以通过一系列的换行符元素顺序的填满本页面，接着自动沿到下一个页面网格式布局布局是划分一个页面成多个格状，报表元素可以加入到不同的格状的区域中，而每一个格状区域又是具有流式布局的特性，因此用这种格状的区域来适应报表页面，网格式布局适合于很明显的带有区域状的报表。每一个区域有不同的报表元素。4.5.2报表样例备注：Style Report预先设定的meta-templates（元模板）模板有Mailing Label, Simple，Report,和 Standard tRepor许多报表都需要这样预先做好的报表模板再加工。我们将做一个使用网格式布局的销售报表，主要包括了几个步骤，选择布局，增加报表元素，绑定数据，增加报表样式。.注：有些报表是有类似报表布局和元素，使用元模板制作同一类型的报表，可以节约时间和修改方便。一个meta-template是一个包含了布局和元素的一个有规则的报表，但是meta-template不适合单独作为报表使用，它是包括了一个基本的布局和一系列报表元素，而这些固定的布局和元素可以作为一个新的报表模板来使用。1点击新建报表按纽。2选择Create From Wizard3选择Blank Tabular Report，点击OK。4模板生成后，点File Page Setup.，选择Landscape（水平）方向4.5.3建立布局设计器提供了design view 和 layout view，在design view，可以随意加入报表元素，在layout view不允许加入元素，layout view只是设计报表布局，没有其他功能，因此，在layout view中的左边有自己的工具栏。在本例中，我们选的是Tabular，我们可以添加格状区域到模板中，初始化的时候是一个格子，我们可以增加行和列来划分区域，新生成的区域有可以再加入行和列来再细划分区域，也可以合并和删除生成的格状区域。1选择layout view 2鼠标右键，选择Split Cell.3增加2列，点OK。4再点鼠标右键选择Insert Row，就会在页面上多出一行。5左右拖动鼠标来选择下面两格。6右键选择Merge Cells合并选中的单元格。备注：行和列的一些大小也可以修改，鼠标右键选择properties，也可以对行和列的边界或者背景等编辑。7. 用鼠标拖动行往下拉，适当调整页面布局。8选中最底下一行，鼠标右键然后再选择Insert Row4.6 Report Elements报表元素报表元素是报表内容的一个可视化的展现，Text元素是加入文本内容到报表中，spacing（间隔符）元素是加入一间隔符，Chart, table和 section用作各种数据的展现，它们在初始化的时候是空的。备注：有四种页眉页脚的类型确定是否显示： default,，first page, even page和odd page.元素可以被加入到页面主体上，也可以加入到页眉和页脚中，通过直接使用菜单或者直接从右边的工具栏拖动。4.6.1增加文本框和文本内容1再次点击“layout view”，回到设计界面2点击“Header”按钮右下角的黑色三角，然后选择First Page。3选择Text按纽，表头会出现一个待编辑的灰色的编辑框，输入“Product Sales Report”然后点击完成。4. 选中这个text元素，使用工具栏改变字体是Verdana 24，粗体，选择位置居中。备注：自动放置表头和表尾的tag，页数是P，页总和是N，T表示时间5. 同样的方式，加入text元素到默认的页脚，输入内容为“D”，当报表生成的时候会自动显示当前的时间，增加时写成 “D, MM-dd-yy”可以显示对应的格式。6. 单击左边的单元格区域，增加一个文本元素，输入内容为“Sales By State”，同样的方法在右边的加入文本框，内容为“Employee Sales”，中部区域是“Order Details”7.修改这三个文本内容，右键属性中定义字体和方位居中。8. 选择中部的单元格加一个分隔符4.6.2 加入数据元素在报表中，我们会遇到char，table和section元素，table和section元素都用来展现表格样式的数据，但是展现的方式很不同，table元素根据绑定的数据来自动创建行和列，对表格的展现有很多控制，对表格的布局却没有多少控制。相反对于section，绑定数据后，每个字段会被分成了一个个独立的元素（是text元素），这些元素可以做任意的修改，移动，删除，section可以被绑定数据，每个字段也会自动生成独立的text元素。10点击左边的单元框，选择，增加图形，从下拉列表中选择样式为3D Bar。11. 在右边单元插入框中插入table元素，随意选择一些行和列，这个不太重要，因为绑定数据的时候会重新适应行和列。12. 选择Section Element，加入section元素。4.7 数据绑定Data binding 是报表元素绑定query的，在数据绑定的时候，我们可以修改query，包括隐藏某些域，增加条件，分组等等。多个元素可以绑定同一个query，一种元素也可以绑定不同的query。在下面的例子中，在报表模板中向数据元素中进行数据绑定，可以使用数据绑定工具，我们也可以通过javascript和编程的方式来完成数据绑定。1选择Chart，在设计器的底部会显示元素ID是(Chart1)，用鼠标适当控制图形大小。2. 右键点击图形，选择Data Binding，会弹出数据绑定的对话框，选择Orders sales by state query 3.来到Chart Data中，设定State为lable（X轴），设定Sales为data（Y轴）4. 同样的给元素table也绑定Orders All Salesquery，选择Grouping & Summary页面，选择按照Employee分组，按照Total取求和。5. 转到Options页面，在Grouping Options控制范围下，选择Show Summary Only，点击保存。6. 同样的类似的过程给section绑定数据Orders Order details query，不用设定分组，直接保存。4.7.1数据格式和外观虽然这个时候已经可以显示数据了，但是数据的格式和样式还需要改进，特别是价格price和销售总额Total都需要显示金额，表格还需要有合适的样式，而这些设置通过对话框的形式都可以配置，每一个元素都有属性的功能，右键点击每个元素，选择Properties就会看到每个元素的属性。1打开图形的属性对话框。2选择Y Axis，点Edit按纽，修改Y轴格式，输入“$#,#”，点OK。3点击OK保存设置。4在section中，右键点击text元素，选择Format.5选择Percent，点OK.6同样的过程对Price和Total的格式定义为Currency格式。7定义Sale Total的格式为Currency格式。8鼠标右键点table元素选择Highlight。9选择New，输入“top performers”为加亮的名称。10选择Foreground为红色。11点击Edit Condition来设定加亮的条件，从下拉框中选择字段Sale Total。12设定条件Total is greater than 4000000（总额大于4000000），点Append加入条件，可以继续增加条件。13.选中table，右键选择table的Properties.14. Confirm.选择Select Style按纽，会弹出一个对话框来选择报表样式，我们选择Grid Grid8然后点击Confirm确定。备注：Style Report的table style也可以新建，点New可以定义新的报表样式类型。15在属性对话框中，点OK保存，选中的报表样式就被加入到表中。4.8 报表脚本注：Style Report可以嵌入Javascript语言，可以更灵活的进行报表设计，支持标准的Javascript语言，并且可以嵌入java API，更多的介绍在Scripting指南。设计器专门提供一个窗口向报表中加入JavaScript（与web浏览器的script的概念不同，但有相同的语法），他可以在报表执行的时候改变元素属性，数据绑定等等。可以为单独的元素加入脚本，也可以为整个报表加入脚本，为单独的元素加入脚本，右键点击某个报表元素选择Script.，为整个报表加入脚本，不要选择元素，在报表空白的地方右键点击选择Script.，使用脚本是多样化的，在本文档中提供一个简单的例子，更详细的内容在报表Scripting指南中。我们将加一个文本元素在页脚，当section的数据填满一页至下一页后，页脚的内容在满页的时候会显示，而在当没有满页的时候为了使页脚不显示，我们要加入脚本，在onPageBreak界面下写入脚本，来控制当section里的数据填充满页后显示页脚的文本元素，不满页的时候页脚不显示，虽然下面的例子中section是报表最后的一个元素，做这么严格的控制没有必要，但是对多元素的报表来说很有必要的。1.采用默认的页脚。2.往页脚中加入一文本元素，输入内容“continued on next page.”3.选择文本的属性。4.改变元素的ID为“continueLabel”。这个没有严格要求，但是在script中需要通过元素的ID来分辨每个元素。5.（本例子延续上一节），修改section中最后一个text元素的ID为“lastText”。6.为整个报表加入脚本，鼠标右键选择Script.7.在onPageBreak下写入以下的脚本：if(event.elementID = lastText & event.lastPage = false)continueLabel.visible = true;else continueLabel.visible = false;8.点击Save and close 按钮.9.报表模板就完成了，点击保存，如果是用Style Report默认的目录安装目录TomcatwebappssreeWEB-INFtemplates输入保存名字为SalesReport1.srt，当然也可以保存在别的目录中，在File Configure.下可以新建目录，包括了相关的注册信息。4.9 预览并发布报表报表制作完成后，我们可以在设计器中直接看到做好的报表，设计器有一个预览界面，主要用于报表设计的时候预览效果的，在Style Report中预览的效果和在服务器中看到的效果一样，你只要选择设计器中的Tools Preferences.然后选择Misc，接着将Preview server features选中就可以了。Figure 4. Preview Server Features in Preferences Dialog预览的时候就可以执行数据绑定和脚本，而且还可以输出多种格式，例如PDF.1选择预览界面，在设计器中会出现一个新的视窗，展现一个完整的报表。2. 这个界面可以输出PDF，选择File Export PDF.即可。4.9.1 PDF ServiceStyle Repor包括可以发布报表到web浏览器的servlet，将报表以PDF, Excel, 或者 HTML 格式输出的servlet，举一个输出格式为PDF的例子，使用Tomcat服务器，配置一个嵌入到Tomcat的具体的细节为。1在Tomcat的webapps目录下新建一个目录“reports”.2在“reports”目录下在建立一个WEB-INF目录，在WEB-INF下新建一个目录lib。3将Style Report的jar文件加入到lib中。4.在WEB-INF目录下新建一个web.xml文件，内容如下：PDF Servletinetsoft.report.web.PDFServicetmpDira directory to place temporaryfilestemplateDirthe directory containing ourexample templatesree.homeregistry directorylicense.keylicense keyPDF Servlet/PDF5. 启动Tomcat服务器。6. 打开浏览器，输入以下的URL地址（默认的端口号是8080）：http:/localhost:8080/reports/PDF?templateFile=SalesReport1.srt&type=pdf.4.10在设计器中发布报表在设计器中可以直接将报表发布到设计器中，可以不需要额外的程序直接将所做好的模板加入到报表库中，一旦报表注册成功，报表就可以在web浏览界面上看到了。（在初始化的时候，设置的可视化设计器不能直接发布报表，需要我们在Enterprise Manager中进行选择是否允许发布报表）1. 如果是windows系统，打开开始 程序 Style Report 企业版 Enterprise Manager.对于unix系统，运行一个二进制文件em.bin，它是在Style Report的安装目录下的一个bin目录，使用本地的浏览器就可以打开Enterprise Manager.界面，http:/localhost:8080/sree/EnterpriseManager)。2默认的用户名和密码都是“admin”.3在左边的树状选项中选择Deployment（发布）。4选中Enable live report deployment。点Edit。5选中选择框，点击保存。6. 回到设计器中，点击Deploy。7. 会弹出一个对话框，输入服务器的URL为http:/localhost:8080/sree/Examples，用户名和密码都是“admin”，报表的名字定义为“SalesReport”，最后 点击Deploy发布。4.11管理界面发布报表备注：Style Report 中所有的配置文件都是xml格式的或者是纯文本Java属性格式。因而可以用文本编辑器手工编辑perties和 repository.xml文件，而不需使用Enterprise Manager，虽然我们不建议通过手工来编辑这些文件。我们也可以在Enterprise Manager界面中发布报表，操作在浏览界面中完成。首先要确定的是Style Report安装成功，包括两个sevlet（Enterprise Manager管理界面和最终用户界面）配置在Tomcat界面。The Enterprise Manager通过Enterprise Manager不仅可以管理报表库的逻辑结构，也可以控制报表库的各种属性。 Enterprise Manager提供的管理界面主要用来管理两个文件，即perties 和 repository.xml，它们存放在由sree.home的属性所指定的路径中。Style Report/企业版服务器端报表环境的配置可以描述为：- sree.home目录下存放了与一个报表库有关的所有的配置文件- 报表库的逻辑结构记录在repository.xml文件中- 文件perties中包含了一个报表库的所有的属性配置报表库报表库servlet可以在任何WEB浏览器中显示基于WEB的报表。报表库不仅作为servlet来实现，Style Report/企业版还提供RMI和CORBA的报表库调用。如果我们没有使用报表库servlet，在报表库中的报表只能通过Java Viewer来观看，而不能在WEB浏览器中看到。4.11.1报表展现设置完成后，报表服务器正常运行后，我们可以用浏览器通过URL或则通过点击Enterprise Manager 中replet repository的连接。1打开浏览界面，输入URL: “http:/localhost:8080/sree/Examples”.2. 我们会看到InetSoft的web界面，点击左边的树形栏，选择SalesReport。4.11.2报表参数和超链接(Drilldown)注：有关更详细的描述，包括报表中的用户交互性的指导在可视化设计器指南中。在Style Report中，报表可以接收参数，参数可以通过用户输入（通过参数对话框），或者通过另一张报表使用超链接。这个功能对实现逐层细化（drilldowns）非常有用，我们可以链接一张新的表，而这张表显示的是比原来更明细的数据。我们可以给图形加一个超链接 比如点击图形的一柱体，就会链接到另外一张表，显示所选择柱体的明细项。为了举例说明报表的参数和超链接，我们修改一下上面例子所做过的表，我们需要再新建一张链接到图形的报表，叫“Drilldo