Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
office@go-mobile.at
http://www.go-mobile.at/
ZuckerReports
Professional 1.2
Manual
Page 1 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Table of Contents
Introduction....................................................................................................................3
ZuckerReports Module ..................................................................................................3
Installation of Requirements ..........................................................................................4
Sugar Suite > 3.0........................................................................................................4
Java Development Kit >= 1.4.2 .................................................................................4
iReport (recommended) .............................................................................................4
.net Framework 1.1 and Microsoft Office (on your desktop) ....................................4
Java Runtime Environment >= 1.4.2 and OpenOffice (on your desktop) .................4
Installation Steps for ZuckerReports .............................................................................5
Add ZuckerReports module to your Sugar installation .............................................5
Prepare and configure ZuckerReports database.........................................................8
Installation of additional libraries ..............................................................................8
Connector/J 3.1 ......................................................................................................8
iReport 0.5.0...........................................................................................................8
Modify “Home” to include published reports................................................................9
Modify your modules to allow “Module Binding”......................................................11
ZuckerReports Administration.....................................................................................12
Parametrization of your reports ...............................................................................12
Defining a Parameter ...............................................................................................12
Category Management .............................................................................................15
Upload and Configuration of report designs............................................................16
Bind and unbind parameters to report designs.........................................................17
Definition of query templates ..................................................................................18
Bind and unbind parameters to queries....................................................................19
Binding Reports or Queries to a Module .................................................................20
Upload and Configuration of Microsoft Office/OpenOffice files ...........................21
Contact .........................................................................................................................22
Page 2 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Introduction
ZuckerReports is an extension module for Sugar Suite, the well-known Open Source
Customer Relationship Management software. In short, it provides the following
functions:
Management of report definitions and query templates
Management of Microsoft Office templates with binding to Sugar data
(mailmerge with Word, Excel reports)
Management of OpenOffice/StarOffice templates with binding to Sugar data
(mailmerge with StarWriter)
Management of parameter selection lists
Parametrization and execution of report definitions and query templates
Categorization of executed reports and query results for later use
Export of executed reports and query results in various formats
Behind the scenes the excellent Open Source reporting library “JasperReports”
(http://jasperreports.sourceforge.net/) is used for providing its outstanding, visually
appealing and feature-rich reporting capabilities.
ZuckerReports Module
The user and administration frontend is embedded as
own module in Sugar Suite. It can be enabled/disabled
for each user just as with all the other modules coming
with Sugar Suite.
Page 3 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Installation of Requirements
Please be sure to meet the following requirements before installation of
ZuckerReports.
iReport (recommended)
Page 4 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Login to Sugar with your “admin” account and click on “Admin” (right on the top) to
open the “Admin”-module.
Click on “Module Loader”
Note: if you receive the error “Please specify a file and try again!”, then open
your php.ini with your favourite text editor, increase the maximum filesize for
upload to 10M and restart apache afterwards:
upload_max_filesize = 10M
You can now see ZuckerReports in the list of available modules. Click on the
“Install” button to install the module.
Page 5 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
If everything works, you will see a screen telling that installation is completed.
Note: you may receive more detailed information when clicking on “Display Log”
Page 6 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Click on the “Back to Module Loader” button to return to the module list. You can
now see ZuckerReports in the list of installed modules.
Back in the „Admin“-module, click on „Configure Tabs”. You will see a line
“ZuckerReports” in the “Hide Tabs” box.
Select „ZuckerReports“ in the „Hide Tabs“ box and click on the arrow pointing to the
left. Click on the “Save”-button.
Page 7 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Due to legal restrictions you have to obtain the following software including
appropriate licenses from the given sources separately.
Connector/J 3.1
Please point your browser to http://dev.mysql.com/downloads/connector/j/3.1.html
and get the current version of the “Connector/J” for MySQL. Copy the file “mysql-
connector-java-<version>-bin.jar” to the “<Sugar-
Root>/modules/ZuckerReports/jasper” folder.
iReport 0.5.0
If you want to use the charts capabilities of iReport, get the package from
http://ireport.sourceforge.net/ and copy the files “lib/jfreechart-0.9.21.jar” and
“lib/iReport.jar” to the “<Sugar-Root>/modules/ZuckerReports/jasper” folder.
Page 8 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Home.html
…
<!-- BEGIN: main -->
<table cellspacing="0" cellpadding="0" border="0"
valign="top" width="100%">
<tr> <td valign="top" width="100%">
…
<slot>{MYREPORTS}</slot>
<slot>{MYOPPORTUNITIES}</slot>
<slot>{MYCASES}</slot>
…
</td>
</tr>
</table>
<!-- END: main -->
…
index.php
…
if(array_key_exists('ZuckerReports', $modListHeader))
$panels['MYREPORTS'] =
"modules/ZuckerReports/ReportHomeView.php";
if(array_key_exists('Bugs', $modListHeader))
$panels['MYBUGS'] = "modules/Bugs/MyBugs.php";
…
Page 9 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Afterwards, you will find a the “Reports” panel showing the published reports on your
“Home” view.
Page 10 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Note: please do a backup of DetailView.php before making the changes. You have to
be something familiar with PHP coding.
Page 11 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
ZuckerReports Administration
This chapter describes common administration tasks necessary to use ZuckerReports.
Defining a Parameter
Page 12 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
“Friendly Name” – Enter the name of the parameter as shown to the user. It should be
a short, descriptive text telling the purpose of the parameter, for example “Account
Selection”
“Default Name” – Enter the name of the parameter as defined in the report (see
chapters on report and query definitions), for example “ACCOUNT_ID”
“Default Value” (optional) – This value is the default value which is presented to the
user at report and query execution
“Description” (optional) – A descriptive text for the parameter, which contains clear
information on how to use this parameter
“Selection” – you can choose between “Direct Input”, “User-Defined Query” and
“User-Defined List”.
Page 13 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
When executing a
report or query, a
selection box is
presented to the user for
mouse selection.
Page 14 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Category Management
For easy retrieval of your report and query result, you can assign it to a category,
which essentially is the same concept as a “Folder” in common Operating Systems.
You can create and delete subcategories in the “Report Archive”.
Page 15 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
ZuckerReports can handle reports designed for JasperReports, which are held in files
ending in “.jrxml”. The ZuckerReports frontend supports the administrator in upload
and configuration of these report design files, as well as attaching and detaching
parameters.
Resource Upload
In case your report uses external
resources such as “.class”-files or
pictures, upload them as well by using the
“Browse”-button in the “Other
Resources”-section
Subreport Upload
In case your report is built on subreports,
upload the “.jrxml”-files by using the
“Browse”-button in the “Reports”-section
Note: please consult the report design manual for correct usage of resources and
subreports
Page 16 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Bind and unbind parameters to report designs
For your report designs you first have to define your parameters in the “.jrxml”-file
when designing the report. Please be sure to use exactly the same value for the
parameter name in ZuckerReports, as otherwise parameter handling won’t work.
Binding a parameter
Select the parameter to bind in the
“Parameter Selection” section on the
bottom
Enter the “Parameter Name” as used
in the report design or accept the
suggestion
Optionally enter a “Default Value”
to suggest to the user when executing
the report
Click on the “Bind Parameter”-
button.
The attached parameter now is
shown in the “Parameter Bindings”
list.
Unbinding a parameter
Simply click on the “Unbind Parameter” button in the “Parameter Bindings” list to
detach the parameter from the report.
Page 17 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
“Query Name” - The name for the template as shown to the user
“Query” – enter your SQL query including placeholders for your parameters (see
below)
“Description” (optional) - A descriptive text which contains clear information on how
to use this query
Page 18 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
For filling your queries with parameters, you have to use placeholders when entering
the query (see above). Use the parameter name prepended with a “$”, and the
parameter value is filled in when executing the query – for example, if you have a
parameter named “ACCOUNT_ID”, use the placeholder “$ACCOUNT_ID” in your
query.
Binding a parameter
Select the parameter to attach in the
“Parameter Selection” section on the
bottom
Enter the “Parameter Name” as used
as placeholder in the query or
accept the suggestion
Optionally enter a “Default Value”
to suggest to the user when
executing the report
Click on the “Bind Parameter”-
button.
The attached parameter now is
shown in the “Parameter Bindings”
list.
Unbinding a parameter
Simply click on the “Unbind Parameter”
button in the “Parameter Bindings” list to
detach the parameter from the query.
Page 19 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
ZuckerReports allows the user to bind reports and queries to modules, which is very
useful if you have reports or queries requiring the database identifier for a sugar
object (contact, account, project, …) as parameter. You can simply bind the report or
query to this module, defining the parameter to set on execution, and the report or
query can be called directly from the detail view of the other module (see chapter
Modify your modules to allow “Module Binding”).
Binding to a module
Select the module to bind to in the
“Module Selection” section on the bottom
Select the parameter to link the database
identifier for the module item to
Click on the “Bind to Module”-button.
The bound module now is shown in the
“Module Bindings” list.
Page 20 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Page 21 of 22
go-mobile
office@go-mobile.at
http://www.go-mobile.at/
Contact
For licensing questions please contact us at mailto:sales@go-mobile.at
For support questions please contact us at mailto:support@go-mobile.at
For general questions please contact us at mailto:office@go-mobile.at
Page 22 of 22