This article describes the installation of ZuckerReports 2.x.
Before starting installation, choose your deployment model. You either need a server-side Java Developers Kit
Installation, or you will have to apply for a ZuckerReports On-Demand account. Please see the “ZuckerReports2 Hosting Fact Sheet” for details on how to choose the right deployment model for you.
Install ZuckerReports_2.0_module.zip with the SugarCRM Module Loader. This package contains the ZuckerReports main modules.
Install JDK and JasperReports libraries (optional)
If you choose the “Local JDK” deployment option, additionally install a JDK and the ZuckerReports_Jasper-4.0.0_module.zip module. It contains the JasperReports libraries and is pretty large in size. In case you have troubles uploading the package to the SugarCRM Module Loader, increase the “post_max_size” and “upload_max_filesize” in your php.ini, and starting from SugarCRM 6.4, you will have to increase the “upload_max_size” parameter in your config.php. The instructions for ZuckerReports 1.x contain more information on these steps.
You don’t have to do this step if you have a ZuckerReports On-Demand account!
Have a look at the ZuckerReports configuration screen in the Admin section of SugarCRM.
Make your adaptions or accept the defaults. If you have a ZuckerReports On-Demand account, enter the received details here. The configuration parameters are documented right on the screen. See below for details.
Install Demo Reports
Install the ZuckerReports2_DemoPack.zip module for a set of basic reports to test functionality of ZuckerReports.
ZuckerReports Configuration Settings
The Admin section of SugarCRM contains a “ZuckerReports Configuration” screen. After adapting the settings, don’t forget to press the “Save” button!
ZuckerReports Start Page
Select which View is shown when entering the ZuckerReports module
PHP Script Enabled
set this to yes/no, if you want to enable/disable php scripting for report parameters
Debug Mode Enabled
set this to yes/no, if you want to enable/disable debug output when running a report – this is the first step in troubleshooting
enter your encoding here (f.e. “UTF-8″), if different from sugar default. see here for supported encodings
Deployment Mode (JDK)
If you have a JDK installed locally, choose “Local JDK”. Otherwise you will have to run a ZuckerReports On-Demand Server.
Local JDK Path
Enter the path to your java executable here, if autodetection doesn’t work.
- Windows Environment Default: “javaw %ARGS% 2>&1″
- For Java Web Start installations: “javaws %ARGS% 2>&1″
- Unix Environment Default: “java -Djava.awt.headless=true %ARGS% 2>&1″
You may try to enter the full absolute path here, but avoid pathes with spaces (f.e. “C:/Program Files/…” won’t work).
Make sure that you also include the “%ARGS ….” extension in the path given here. You can test you settings by using the “Test Java” button.
PHP Exec mode
There are several possibilities to run an external command (as Java) in PHP. The default option is “exec”, but as behaviour is inconsistent between PHP and OS versions, it may be worth a try to swicht to “shell_exec” – especially if ZuckerReports doesn’t show detailed error messages on Report Exception or Report compilation.
JDBC URL Extension
if you get the error
“Value ’0000-00-00′ can not be represented as java.sql.Date”
then enter “?zeroDateTimeBehavior=convertToNull” here and it may work (only for “Local JDK” mode)
On-Demand Service Url
The Url of your ZuckerReports On-Demand Server instance (end with “/”)
This Url is provided to you by ZuckerFriends when activating a Demo account or a Live account for ZuckerReports On-Demand.
On-Demand App Secret
The App Secret of your ZuckerReports On-Demand Server instance
This App Secret is provided to you by ZuckerFriends when activating a Demo account or a Live account for ZuckerReports On-Demand.
ZuckerReports Webservice Url
The Url of your ZuckerReports Webservice as seen from your ZuckerReports On-Demand Server instance (if empty, it will point to “<your sugar instance url>/custom/ZuckerReports2/service/v4/rest.php”).
If your Sugar server is accessible from the “outside world” with another IP/Host than used internally, you will have to adapt this value. Your Sugar server has to be accessible from the Amazon EWS cloud. You have to enter the full path to the ZuckerReports Webservice here, for example:
Note: You can use either HTTP or HTTPS here. There is no certificate validation enabled.
This user will be used by ZuckerReports On-Demand to access your ZuckerReports Webservice