\nHow can you extract your data and present it to your users? Actually Twproject has several pages with dynamic filtering capabilities that extract meaningful data, but a customizable reporting systems was missing until version 5.5.
\nIn this release we have integrated Jasper Reports<\/a>, one of the most powerful reporting engine. Jasper reports adds the capability to create your own reports in minutes using an intuitive graphical editor.
\nReports are integrated with the flexible Twproject security structure in an easy and practical way, without forcing users to write complex query and rules.<\/p>\n
Reports can be easily designed with the friendly, powerful, free and open-source iReport Designer<\/a> or with Jaspersoft Studio<\/a>.<\/p>\n Jasper Studio is the main product and it’s based on Eclipse. iReport is simpler to configure, but unfortunately will be discontinued soon. If you already know Eclipse interface, use Jasper Studio, otherwise use iReport. Actually the configuration steps are very similar.<\/p>\n For our purposes iReport works perfectly.<\/p>\n Once iReport \u00a0is installed the first step is to add database library to the editor.<\/p>\n 1)\u00a0 Click on tools->options and then on \u201cclasspath\u201d tab.<\/p>\n Database drivers are included on Twproject distribution, you can find them here:<\/span><\/p>\n Click on \u201cAdd jar\u201d button and select the driver for the database you are using.<\/p>\n Then you should also add Twproject classes, in case we need to use some formatting functions.<\/p>\n Click \u201cAdd Folder\u201d and select [twproject root]\\WEB-INF\\lib\\classes folder<\/p>\n Once done we are ready to connect to Twproject database<\/p>\n 1) click on \u201cStep 1: Create database connection\u201d<\/p>\n 3) choose Database JDBC Connection<\/p>\n 4) write the name of this connection, \u201cTW5 test\u201d for instance<\/p>\n 5) select the right database driver:<\/p>\n insert your server connection data, database name, user and password:<\/p>\n 6) test the connection<\/p>\n If the connection is fine, we can proceed writing our first report.<\/p>\n Click on \u201cStep 2 : create a new report\u201c<\/p>\n The report wizard will pop-up. There are many templates:<\/p>\n Select the one you like the most and \u201cLaunch Report Wizard\u201d.<\/p>\n Insert the report name and location carefully: report name and report location are crucial information for integrating Twproject and iReport. Read the dedicated section below<\/a>.<\/p>\n Click \u201cnext\u201d<\/p>\n select your just created data source \u201cTW5 test\u201d; it\u2019s now time to think about the query.<\/p>\n In this example we would like to report time spent by each resource on their projects.<\/p>\n In order to write a query, the knowledge of Twproject data structure is mandatory. Even if table names are quite immediate I suggest to have a look to this section:<\/p>\n https:\/\/twproject.com\/support\/twproject-advanced-usage\/connections\/database-structure\/<\/a><\/p>\n If you are a SQL wizard you can write your query directly, but if you prefer something more \u201cvisual\u201d click on \u201cDesign query\u201d button:<\/p>\n Drag the tables you need for your query.<\/p>\n In our case work hours are on twk_worklog table. Worklog records are always linked to an assignment. Assignments create relations between resources and project weighted with a role. So we need to add \u201ctwk_assignment\u201d, \u201ctsk_task\u201d, \u201ctwk_resource\u201d and \u201colpl_role\u201d. The query editor tool will use sql foreign keys for create joins.<\/p>\n Save the query and click \u201cnext\u201d.<\/p>\n You can select fields you want to see on your report. In our case we will add them manually. Click \u201cnext\u201d<\/p>\n Here you will define some groups, but this is not mandatory, you can eventually add groups after.<\/p>\n Click \u201cnext\u201d and then \u201cfinish\u201d.<\/p>\n Your report \u201cskeleton\u201d is almost ready:<\/p>\n Notice that a report has many sections like \u201cTitle\u201d, \u201cpage header,\u201d two group header, details, and then the footer part.<\/p>\n If you click on \u201cpreview\u201d you will see something ugly like this:<\/p>\n Go back on the designer and let ‘s do some changes:<\/p>\n Change title, use project and resource name instead of ids<\/p>\n Drag\u00a0 worklog insertion date, action, and time spent from \u201cfields\u201d area to our report on \u201cdetails\u201d section:<\/p>\n With these simple change it will look like:<\/p>\n A little bit better, but:<\/p>\n Here we are:<\/p>\n Now you may want to have partial sums on group header\/footers. This can be done introducing variables.<\/p>\n In this case we will need a variable for summing worklog on a project group say \u201dsumGroup1\u201d:<\/p>\n Drag the just created variable on \u201cgroup footer 1\u201d and format the result using \u201cgetMillisInHoursMinutes\u201d function as above:<\/p>\n You can play with the designer to optimize your report. When you are ready save it!<\/p>\n Once you have your report you can run it inside iReport, directly to the database, but if you want to integrate it in Twproject in the right way (e.g.: respecting security) you have to know some additional detail.<\/p>\n The report we have just created is already available in your Twproject (if you created it in the right place with an unique name To see installed reports go to Admin \u2013> Customizations \u2013> Forms, plugins and reports.<\/p>\n In the \u201cAdditional iReports\u201d section your report should be listed. If not click on \u201creload plugins\u201d button (if \u201cnot\u201d again there is a problem on the report, see logs).<\/p>\n You should already have a special widget (\u201cReport list\u201d on wp_genericReports.jsp file) installed on your Twproject. Add it to your dashboard if you want to access you reports directly from Twproject. The widget is already filled with your reports just because you are administrator otherwise it will be empty until you assign the correct permission as described below.<\/p>\n But who can run these reports? How reports are secured in Twproject?<\/span><\/p>\n Report names are used for generating a permission you must select\u00a0to grant access to a report, this is why they must have unique meaningful names.<\/p>\n Every report extends the standard Twproject role based implementation adding a special permission, one for each report. These permissions can be assigned to a role exactly like the standard ones, both at global level or at project level.<\/p>\n Here the role editor extended with report permissions:<\/p>\n For a deep discussion on Twproject security see: https:\/\/twproject.com\/support\/introduction-security\/<\/a><\/p>\n Once you added a report permission to a role, that report will be visible to the users with that role.<\/p>\n That said, in order to integrate JasperReports with Twproject we have to take care of security and data visibility.<\/p>\n Accessing the database directly from the report engine can be acceptable for some \u201chigh level\u201d reports, but as you know, Twproject security model is very flexible, allowing to see only an allowed set of data for each user. How can be possible to create a report that respect Twproject security model without writing complex queries?<\/p>\n We worked hard to solve this problem and we found an easy and practical solution.<\/p>\n First of all we divide reports in \u201cglobal\u201d and \u201centity related\u201d.<\/p>\n Global reports are the most flexible and easy to build (like the one just created); they can use any kind of data from Twproject: project, worklog, resources or ToDo, without restriction.<\/p>\n Global reports will test security at global role level only: in the worst case who can access the report can read its data (e.g project and costs), even if she\/he doesn\u2019t have access to \u201cprojects\u201d the data comes from. As you (should Entity related reports, instead, are related to a main Twproject entity such as project, resource, ToDo and the access is tested object by object, singularly.<\/p>\n Twproject cannot inspect the report and \u201cguess\u201d if it is \u201cglobal\u201d, related to projects, to ToDos and so on; you have to instruct Twproject about report contents by putting it on a folder structured as follows:<\/p>\n
\nJasperReports<\/a> is a reporting tool by JasperSoft<\/a> (recently acquired by Tibco) widely used by the enterprise oriented Java community.<\/p>\nDrivers and classpath<\/h3>\n
![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb.png\" "\\"image\\"")
<\/a><\/p>\n\n
![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb1.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb2.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb3.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb4.png\" "\\"image\\"")
<\/a><\/p>\nCreate your first report<\/h3>\n
![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb5.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb6.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb12.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb10.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb11.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb13.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb14.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb15.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb16.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb17.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb18.png\" "\\"image\\"")
<\/a><\/p>\n\n
\norg.jblooming.utilities.DateUtilities.getMillisInHoursMinutes($F{twk_worklog_duration}). This function will transform milliseconds in a Hours:Minutes<\/li>\n<\/ol>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb19.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb20.png\" "\\"image\\"")
<\/a><\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb21.png\" "\\"image\\"")
<\/a><\/p>\ni<\/a>Report and Twproject integration<\/h3>\n
![\"Smile\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/wlEmoticon-smile.png\")
).<\/p>\n![\"screen977\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/screen977.jpg\")
<\/p>\n
\nSee https:\/\/twproject.com\/support\/twproject-advanced-usage\/customizations\/dashboard-customization\/<\/a>\u00a0for create a new portlet\/widget<\/p>\n![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb23.png\" "\\"image\\"")
<\/a><\/p>\n![\"screen978\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/screen978.jpg\")
<\/p>\nReport location and security<\/h3>\n
\nIf your reports show sensible data, grant access to them wisely.<\/p>\n ) know, Twproject security uses at top level the concept of \u201csecurity area\u201d (see here for details: https:\/\/twproject.com\/support\/areas\/<\/a>). Having the permission to see \u201creport x\u201d on \u201carea 1\u201d doesn\u2019t mean you can see the same report on \u201carea 2\u201d. To solve this problem, Twproject passes to the report the list of areas where you have that permission. You should use that list to filter report data showing, for instance, only project\/resources\/ToDos\/worklog from \u201carea 1\u201d and not from \u201carea 2\u201d. We will explain how to use that parameter in the following.<\/p>\n
![\"image\"](\"https:\/\/twproject.com\/support\/wp-content\/uploads\/2014\/06\/image_thumb9.png\" "\\"image\\"")
<\/a><\/p>\n