SpagoBI Worksheet Engine. Alessandra Toninelli 2013/11/13 11:58

Size: px

Start display at page:

Download "SpagoBI Worksheet Engine. Alessandra Toninelli 2013/11/13 11:58"

Victor Williamson
5 years ago
Views:

1 SpagoBI Worksheet Engine Alessandra Toninelli 2013/11/13 11:58

2 Table of Contents 1 Worksheet overview Engine configuration Worksheet design Starting the designer Defining a sheet Worksheet preview Saving a new Worksheet document Worksheet Editing Charts' engines configuration Page 2 - last modified by Alessandra Toninelli on 2013/11/13 11:58

3 1 Worksheet overview 2 Engine configuration 3 Worksheet design 3.1 Starting the designer Tools Sheet designer 3.2 Defining a sheet Defining Header Filters Defining sheet content Pie Chart Line Chart Bar Chart Table Pivot Table Defining Footer 3.3 Worksheet preview Pie Chart preview Line Chart preview Bar Chart preview Table preview Pivot Table preview 4 Saving a new Worksheet document 5 Worksheet Editing 6 Charts' engines configuration 1 Worksheet overview SpagoBIWorksheetEngine is an external engine available for SpagoBI 3.0 or newer releases. Worksheet is an extension of Qbe: it provides the user a simple way to visualize data by means of charts and tables that can be created by the end user himself. In other words, the end user builds a base query using Qbe web interface and then designs a set of sheets with charts and tables through an easy tu use interface. 2 Engine configuration This is the configuration of the engine: the SpagoBIWorksheetEngine is physically the same web application of SpagoBIQbeEngine (but it is logically a separated engine) and therefore the main url is exaclty the same: url: http<or https>://<your server name>:<your server port>/spagobiqbeengine/servlet/adapterhttp driver: it.eng.spagobi.engines.drivers.worksheet.worksheetdriver use data set: no use data source: yes exporters: PDF, XLS 3 Worksheet design You can enter into the designer from two points: the smart filter or the Qbe.. If you are in the execution of a SmartFilter Document you should see in the top toolbar a button with the label "Show worsheet" Page 3 - last modified by Alessandra Toninelli on 2013/11/13 11:58

1 Starting the designer Now let take a look at the structure

4 If you are in the execution of a Qbe Document you should see a tab with the label "Worksheet designer" 3.1 Starting the designer Now let take a look at the structure of the designer: Page 4 - last modified by Alessandra Toninelli on 2013/11/13 11:58

The designer is composed by two sections: The tools on the left The designer of the sheet on the right 3.1.1 Tools We have 3 type of tools: Selected fields: Contains a list of the query fields.

5 The designer is composed by two sections: The tools on the left The designer of the sheet on the right Tools We have 3 type of tools: Selected fields: Contains a list of the query fields.. This fields are necessary to build the worksheet objects (charts, tables,...). To get or refresh the fields you should click the button on the top (see the previous image). Palette: The objects a sheet can contain. Layout: The available layouts: Header, content, footer Header, content Content, footer Only content Note: you can change the size of the tool panels Sheet designer If you select the layout with all the components, the designer region should be composed by four panels: First: In the first one you could design the header. You can specify a title and a image.. Second: With this panel the user can add some filters. Third: The third panel contains the significant part of the sheet, id est the data.. The user should drag from the palette panel an object (for example a chart) and this panel will be repaint with the selected object designer (for example a chart designer). Last: In the first one you could design the footer. To add a new tab you should click the last icon in the sheet tab list (the list on the bottom of this sheet designer panel).. There is another faster way to add a new sheet. Suppose you have finished to build a sheet.. If you drag a new object from the palette panel into the designer area, a new sheet will be added with the dragged designer Defining a sheet Page 5 - last modified by Alessandra Toninelli on 2013/11/13 11:58

Now it's time to build a sheet.. 3.2.1 Defining Header If you want to add a Header to your sheet you can Define a Header Text and/or a Header Image. The text can be edited through an Html Editor.

6 Now it's time to build a sheet Defining Header If you want to add a Header to your sheet you can Define a Header Text and/or a Header Image. The text can be edited through an Html Editor. The image can be uploaded through the interface in the resources folder, and be placed in a specific position of the Header Filters It s possible to define some filter for the data of the content. To add a filter you should drag a field from the "Selected fields" in the panel with title "Filters".. Clicking the button on the top right of the panel you can move the filters on the left of the content (see the next image) Defining sheet content Once you have defined the Layout of your Sheet you can Drag and Drop in the designer one element from the Palette. After you have Dragged and Dropped your element you can Drag And Drop in it the various available fields. Page 6 - last modified by Alessandra Toninelli on 2013/11/13 11:58

3.2.3.1 Pie Chart If you design a Pie Chart you can define 1 Serie and 1 Category.

7 Pie Chart If you design a Pie Chart you can define 1 Serie and 1 Category. By clicking on the line of your Series you can define the aggregation function, the precision of the value and an eventual suffix. By clicking next to the Category title you can define the colors of the different Sections of your Pie. More over you can define some specific Pie Chart Layout properties: If showing or not the Pie section Values If showing or not the legend If showing or not the Pie section Values in percentage form Line Chart If you design a Line Chart you can define 1 or more Series and 1 Category. By clicking on the line of your Series you can define the color of the Serie, the aggregation function, the precision of the value and an eventual suffix. More over you can define some specific Line Chart Layout properties: If showing or not the Values If showing or not the legend If coloring or not the area beneath the Lines Page 7 - last modified by Alessandra Toninelli on 2013/11/13 11:58

8 Bar Chart If you design a Bar Chart you can define 1 or more Series and 1 Category. By clicking on the line of your Series you can define the color of the Serie, the aggregation function, the precision of the value and an eventual suffix. More over you can define some specific Bar Chart Layout properties: If showing or not the Values If showing or not the legend If using a vertical or horizontal orientation What type of Bar Chart you want to use Table If you design a Simple Table you can define which fields you want to show in the table. Page 8 - last modified by Alessandra Toninelli on 2013/11/13 11:58

9 Pivot Table If you design a Pivot Table you can define which fields you want to place in the Rows, which in the columns and which in the measures Defining Footer If you want to add a Footer to your sheet you can Define a Footer Text and/or a Footer Image. The text can be edited through an Html Editor. The image can be uploaded through the interface in the resources folder, and be placed in a specific position of the Footer. 3.3 Worksheet preview By clicking on the tab Worksheet Preview it is possible to see a preview of what you have designed. Page 9 - last modified by Alessandra Toninelli on 2013/11/13 11:58

3.3.1 Pie Chart preview 3.3.2 Line Chart preview Page 10

10 3.3.1 Pie Chart preview Line Chart preview Page 10 - last modified by Alessandra Toninelli on 2013/11/13 11:58

11 3.3.3 Bar Chart preview Page 11 - last modified by Alessandra Toninelli on 2013/11/13 11:58

12 3.3.4 Table preview Page 12 - last modified by Alessandra Toninelli on 2013/11/13 11:58

13 3.3.5 Pivot Table preview Page 13 - last modified by Alessandra Toninelli on 2013/11/13 11:58

A window like the following one will appear: Here you need to fill in Label, Name and Description fields and you have to select in

14 4 Saving a new Worksheet document Once you are done creating your worksheet, you can save it as a Worksheet Document in your tree folder structure. You can do this just by clicking on the save button on the toolbar. A window like the following one will appear: Here you need to fill in Label, Name and Description fields and you have to select in which folders you want to place you Worksheet document. Click save and your new Worksheet document is created. Page 14 - last modified by Alessandra Toninelli on 2013/11/13 11:58

. As you can see the toolbar is changed.

15 5 Worksheet Editing After executing a worksheet document you can also change it.. To do that you should click the edit button in the SpagoBI toolbar After you ve clicked the button the designer will be displayed.. As you can see the toolbar is changed. Now you have 3 buttons: one for save the changes one for save the changes in a new document one for go back to the document execution page.. 6 Charts' engines configuration The Worksheet engine is able to produce charts using 2 different JavaScript libraries: ExtJS (the default since SpagoBI 3.4) Highcharts JS Page 15 - last modified by Alessandra Toninelli on 2013/11/13 11:58

16 The configuration of the library you want to use is in file SpagoBIQbeEngine/js/spagobi/commons/Settings.js, 'chartlib' property that can assume 'ext3' or 'highchart' values. Clean browser cache when modifying this property. You have to choose the library to be used according your project's nature: you can use the Highchart JS for free for personal or non-profit projects; if you want to use the Highcharts JS for commercial purposes you need to by a Highcharts JS license. Page 16 - last modified by Alessandra Toninelli on 2013/11/13 11:58

Analysis and Report Utility

Analysis and Report Utility Microsoft Excel SAP Crystal Reports Revised: July 12, 2012 Analysis and report utility This utility allows you to access data in your OGC-Plus software so that you can organize