Clear Reports Setup for ABSolution Architecture

Module Projects
I-NET SOFTWARE CLEAR REPORTS ...................................................................................................2
HOW TO INSTALL I-NET SOFTWARE CLEAR REPORTS 2011 ..............................................................3
I-NET CLEAR REPORT DESIGNER ....................................................................................................10
NOW – RUNTIME SETUP..................................................................................................................11
RUNNING UNIX .............................................................................................................................12
HOW TO CONFIGURE CLEAR REPORTS PROPERTIES.........................................................................13
I-NET DESIGNER .............................................................................................................................21
How to configure datasource values .........................................................................................21
User Prompt Fields. ..................................................................................................................22
Translate Label. ........................................................................................................................23

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 1 di 23
I-net Software Clear Reports

I-net software provides you with a powerful reporting solution, including its very
own graphical Designer.
I-net Clear Reports is a full-blown reporting solution completely coded in Java.
I-net Clear Reports 2011 runs on every platform (OS) that supports Java 6 or
higher (Windows, Unix, Solaris, OSX 10.4+). A GUI is not required for the server.
For this reason, your JBoss environment must be configured to use Java 6.
You can install the i-net Designer Edition on as many clients as you want -
absolutely free of charge.
If you don't receive the product, you can download it from I-net Software at
http://www.inetsoftware.de.
We suggest you to use the Multi-platform installation; the downloaded zipped file
contains also the documentation.

DATATEX doesn't provide it! It is not part of NOW/Runtime module and support
is done directly from I-net Software. NOW RUNTIME customers should buy it in
order to use standard distributed reports.

We strongly suggest purchasing also the Update Subscription to be sure to keep up

to date the CC engine.

Starting from NOW 3.1.x / Runtime 6.1.x, Datatex will support only I-net
Clear Report 2011 or greater.

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 2 di 23
How to install I-net Software Clear Reports 2011

Extract all files from the zip file. Execute the setup.bat (or setup.sh if you use a
Linux system). If you downloaded the Windows Installation Package (exe), you can
execute it directly.

We suggest unchecking the “Send anonymous setup data” and using the “Custom”
setup.

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 3 di 23
Don’t install the Repository and remote Designer and also Database drivers (you
will use standard JDBC driver provided by IBM for DB2 or Oracle for Oracle DB).
You can decide if install Documentation and Sample or not.
The most important is to install the i-net Designer and the standalone server (I
strongly suggest to install the Designer also if you don’t need on the server but only
because it is the quick way to check reports).
This is done selecting the “i-net Clear Reports” item.
Push the Next button.

Select your preferred destination folder where install Clear Reports (don’t use the
EAR folder).
Push the Next button.

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 4 di 23
Clear Reports 2011 uses configuration based on O.S. registry.
If you want migrate your old crystalclear.properties file (version 6 and 7), you can
import it or reuse an existing configuration or create a new one. I suggest keeping
the name “Default” (for System). In this way you can skip some configuration
setting under JBoss. Push the Next button.

Request a new Trial License or enter your license (we don’t need the Plus feature).

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 5 di 23
 Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 6 di 23
Don’t activate the remote interface and the Ad-Hoc Reporting

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 7 di 23
 Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 8 di 23
Done!

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 9 di 23
I-net Clear Report Designer

Datatex provides additional report formulas. In order to use them, we need to set
propertly the Designer’s classpath. To do it, create a DatatexDesigner.bat in the
destination folder with following code inside it. It allow to add in the classpath the
ABSCommon.jar, j2ee standard jar, jdc drivers, ABSWeb.jar. For example in a
Jboss environment with db2 as jdbc driver:

ECHO OFF
SET EAR_FOLDER=<ear_folders_name>\deploy\now.ear
SET JBOSS_HOME=<jboss_folders_name>
SET JBOSS_LIB=%JBOSS_HOME%\server\default\lib
SET JDBC_DRIVER=<jdbc_folder_name>
SET CLASSPATH=.;./core/Designer.jar
SET CLASSPATH=%CLASSPATH%;%EAR_FOLDER%\ABSCommon.jar
SET CLASSPATH=%CLASSPATH%;%EAR_FOLDER%\nowui.war\WEB-
INF\lib\ABSWeb.jar
SET CLASSPATH=%CLASSPATH%;%EAR_FOLDER%\nowui.war\WEB-
INF\lib\jackson-core-lgpl.jar
SET CLASSPATH=%CLASSPATH%;%EAR_FOLDER%\nowui.war\WEB-
INF\lib\jackson-mapper-lgpl.jar
REM JBOSS 4.2.3 / 4.3.0
SET CLASSPATH=%CLASSPATH%;%JBOSS_LIB%\jboss-
j2ee.jar;%JBOSS_LIB%\servlet-api.jar

REM JBOSS 5.1.0

REM SET CLASSPATH=%CLASSPATH%;%JBOSS_HOME%\lib\jboss-
javaee.jar;%JBOSS_HOME%\common\lib\servlet-api.jar

SET CLASSPATH=%CLASSPATH%;%JDBC_DRIVER%\db2jcc_license_cisuz.jar
SET CLASSPATH=%CLASSPATH%;%JDBC_DRIVER%\db2jcc_license_cu.jar
SET CLASSPATH=%CLASSPATH%;%JDBC_DRIVER%\db2jcc.jar
ECHO ON
java -Xmx768m -classpath %CLASSPATH% com.inet.designer.Main

Warning: substitute “<xxx_folders_name>” your folder names and check all other
folders.
E.g.:
ear_folder_name = C:\jbossnow
jboss_folder_name = C:\jboss
jdbc_folder_name = C:\SQLLIB\java

If you are not using IBM Db2 you must replace db2jcc jars with yours.
Warning: adjust the script according your JBoss version.

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 10 di 23
Now – Runtime Setup

If you are using NOW please check in the WEB-INF/CustomABSUISetup.xml that

you have

<ReportsEngineImpl>com.dat.now.bas.action.NOWReportsCrystalClear8</ReportsEngineImpl>

If you haven’t the NOW application, but you have only RUNTIME please check in
the WEB-INF/CustomABSUISetup.xml that you have

<ReportsEngineImpl>com.one.tec.gpl.ReportsCrystalClear8</ReportsEngineImpl>

If you don’t have it, add it.

You can have some trouble getting printouts in Thai based on report font used in the
report definition.
For example: Verdana is a variation of a San Sarif font, but it is not a UCI type,
hence doesn't support Thai.
In this case you should use another font type; for example MS Sans Serif.
To avoid replace standard report distributed with our package you can apply this
improvement that allows you to replace fonts at runtime.

You can use "com.dat.now.bas.action.NOWReportsCrystalClearReplacingFonts" or

"com.one.tec.gpl.ReportsCrystalClearReplacingFonts” as Reports Engine
Implementation.

To define font to be replaced and new font to be used, in the

CustomABSUISetup.xml you can add 1 or more keyword starting with
"CCFontToReplace-" + the name *lowercase* of the font name declared in the RPT
(removing white spaces).

Example for "Verdana" replacing it to Microsoft Sans Serif

<CCFontToReplace-verdana>Microsoft Sans Serif</CCFontToReplace-verdana>

Warning to the new Font Name: it must be exactly the font name (with capital
letter if necessary and spaces).

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 11 di 23
Running UNIX

If you are using an UNIX machine, you have to start the java virtual machine with
the option -Djava.awt.headless=true

For a more complete documentation you can visit this web page :

http://www.inetsoftware.de/documentation/clear-reports/online-
help/support/faq/guidelines?s[]=unix&s[]=faq&s[]=documentation&s[]=clear&s[]=
reports&s[]=online&s[]=help&s[]=support#how-do-i-deploy-i-net-clear-reports-
into-a-servlet-engine-running-unix

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 12 di 23
How to configure Clear Reports properties

Go to the installation folder.

Execute the ConfigurationManager.exe (you can also use the shortcut in the start /
program menu).

Warning: screens can be different between versions.

Select the Default (or your configuration name) configuration and push the Edit
button.
Add your license key provided by i-net Software.
Please feel all information like the following:

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 13 di 23
Under the Performance tab (see next image), enable the “MetaDataCache”.
The MetaData cache stores runtime information about database objects. Usually i-
net Clear Reports will try to identify the database objects of a report when it is
executed. That's why some JDBC meta data queries will be used. In fact if you
request many reports with the same database objects or if you request a report many
times then for each report meta data queries would be needed. If you enable the
MetaData cache the information about the database objects will be cached so that a
second execution of a report would not need a JDBC meta data query anymore.
Enabling the cache will enhance the speed of the report server.

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 14 di 23
 Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 15 di 23
Fill Formula Expander Class(es) with
com.dat.abs.web.report.ABSReportUDF

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 16 di 23
Reload On New Request = false
Clear Cache On Next Request = false

It’s recommended to change this value from false to true if you’re working in a
developing environment. Else, if you’re into a producing environment, it’s better to
leave this value to false to have better performance.

Unchecking these flags will make server faster but a server reboot will be
necessary if a report will be modified and overwrited, in other case system will
use old report version.

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 17 di 23
This is very important when you print reports that use non-latin character like
hebrew, turkish, and so on. If characters in your report are not properly displayed
into PDFs, check this property.
So it will appear like this:
FontPath=C:/WINDOWS/Fonts

Please fill field with your correct font path (for example Linux doesn't have a
Windows fonts folder)

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 18 di 23
Please disable Logging
If you have Logging active your performance will be very bad!
Usually never Log Database Data.

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 19 di 23
In order to have a full functionality of Clear Reports with NOW/Runtime, please
copy in the
<your_ear_folder>\nowui.war\WEB-INF\lib folder these jars (taken from the I-net
Clear Reports installation folder):

• BarcodePDF417Bean.jar → from “lib/beans” folder of Clear Report

installation folder
• CCLib.jar → from “core” folder of Clear Report installation folder
• ClearReports.jar → from “core” folder of Clear Report installation folder
• commons-logging.jar → from “core” folder of Clear Report installation
folder
• JbarcodeBean.jar → from “lib/beans” folder of Clear Report installation
folder
• jcommon.jar → from “core” folder of Clear Report installation folder
• jeuclid.jar → from “lib/beans” folder of Clear Report installation folder
• jfreechartCC.jar → from “core” folder of Clear Report installation folder
• JgaugeBean.jar → from “lib/beans” folder of Clear Report installation folder
• JWebEngine.jar → from “core” folder of Clear Report installation folder
• ReportViewer.jar → from “core” folder of Clear Report installation folder
• svgSalamander-tiny.jar → from “lib/beans” folder of Clear Report
installation folder

In order to use the right Clear Reports configuration, add the

-Dclearreports.config=USER/myconfig to the server java options where

USER/myconfig is the Scope/Name of your configuration.

If you are using standard name (SYSTEM/Default) as we suggest, you can

avoid it!

In our example will be:

-Dclearreports.config=SYSTEM/Default

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 20 di 23
I-net Designer

The following information are useful only if you plan to use the designer.

How to configure datasource values

Run DatatexDesigner.bat and open Data Source Manager

Click on Add and create a new datasource. Insert name, JDBC Driver and all other
values. You can set password if you want and save it

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 21 di 23
User Prompt Fields.

Prompt fields (that's to say those fields that must be requested to user before
executing an interactive report) have to begin with "ABSUSERPROMPT_".

WARNING: Prompt fields that begin with "ABSUSERPROMPT_" will be

requested even if they hadn't been placed on report but only declared.

Residual prompt "standard" fields if existent will be valued.

Value Description
_Language Language identifier (as set in browser options)
_Country Country identifier (as set in browser options)
_Variant Variant identifier (as set in browser options)
_User User Id (that of login)
_UserFullName User Full Name (that of login)
_Company Company Id (that of login)
_CompanyDescriptio
Company Description (that of login)
n
The root request url of the web container (e.g.:
_ClientRequestURL
http://localhost:8080/abs)

Every additional login data instance of java.lang.String class will be set as prompt
field using the prefix “_” to the additional login data field name.
For example if you have a additional login field named “Division”, the prompt field
will be “_Division”.

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 22 di 23
Translate Label.

For every label (TEXT OBJECT according to Clear Reports) a translation of a

possible report associated resource file will be tried.
Text Object value will be used as key.
In Clear Reports this kind of object are instance of com.inet.report.TextPart.
Every Prompt Field that begin with "ABSUSERPROMPT_" is translatable:
"Prompting text" value is used as key.
Other kind of translatable fields are all Prompt Field where name begin with
“TRANSLATABLE_”.
For example you can use this tips to receive some translated label and reuse it in
your report formula.
The resource bundle use is the one declared in the Report Definition in the
ABSolution framework

Datatex s.r.l.
Viale Lunigiana, 46
20125 Milano - Italia
Phone +39 02 6797441
Fax +39 02 679744281
P.IVA 02192280960
www.datatex.com
Pag. 23 di 23