Installing an Actuate BIRT Java Component

Installing an Actuate BIRT Java Component
Information in this document is subject to change without notice. Examples provided are fictitious. No part of this document
may be reproduced or transmitted in any form, or by any means, electronic or mechanical, for any purpose, in whole or in part,
without the express written permission of Actuate Corporation.
© 1995 - 2015 by Actuate Corporation. All rights reserved. Printed in the United States of America.
Contains information proprietary to:
Actuate Corporation, 951 Mariners Island Boulevard, San Mateo, CA 94404
www.actuate.com
The software described in this manual is provided by Actuate Corporation under an Actuate License agreement. The software
may be used only in accordance with the terms of the agreement. Actuate software products are protected by U.S. and
International patents and patents pending. For a current list of patents, please see http://www.actuate.com/patents.
Actuate Corporation trademarks and registered trademarks include:
Actuate, ActuateOne, the Actuate logo, Archived Data Analytics, BIRT, BIRT 360, BIRT Analytics, The BIRT Company, BIRT
Content Services, BIRT Data Analyzer, BIRT for Statements, BIRT iHub, BIRT Metrics Management, BIRT Performance
Analytics, Collaborative Reporting Architecture, e.Analysis, e.Report, e.Reporting, e.Spreadsheet, Encyclopedia, Interactive
Viewing, OnPerformance, The people behind BIRT, Performancesoft, Performancesoft Track, Performancesoft Views,
Report Encyclopedia, Reportlet, X2BIRT, and XML reports.
Actuate products may contain third-party products or technologies. Third-party trademarks or registered trademarks of their
respective owners, companies, or organizations include:
Mark Adler and Jean-loup Gailly (www.zlib.net): zLib. Adobe Systems Incorporated: Flash Player, Source Sans Pro font.
Amazon Web Services, Incorporated: Amazon Web Services SDK. Apache Software Foundation (www.apache.org): Ant, Axis,
Axis2, Batik, Batik SVG library, Commons Command Line Interface (CLI), Commons Codec, Commons Lang, Commons Math,
Crimson, Derby, Hive driver for Hadoop, Kafka, log4j, Pluto, POI ooxml and ooxml-schema, Portlet, Shindig, Struts, Thrift,
Tomcat, Velocity, Xalan, Xerces, Xerces2 Java Parser, Xerces-C++ XML Parser, and XML Beans. Daniel Bruce (www.entypo.com):
Entypo Pictogram Suite. Castor (www.castor.org), ExoLab Project (www.exolab.org), and Intalio, Inc. (www.intalio.org): Castor.
Alessandro Colantonio: CONCISE. Day Management AG: Content Repository for Java. Eclipse Foundation, Inc.
(www.eclipse.org): Babel, Data Tools Platform (DTP) ODA, Eclipse SDK, Graphics Editor Framework (GEF), Eclipse Modeling
Framework (EMF), Jetty, and Eclipse Web Tools Platform (WTP). Dave Gandy: Font Awesome. Gargoyle Software Inc.:
HtmlUnit. GNU Project: GNU Regular Expression. Groovy project (groovy.codehaus.org): Groovy. Guava Libraries: Google
Guava. HighSlide: HighCharts. headjs.com: head.js. Hector Project: Cassandra Thrift, Hector. Jason Hsueth and Kenton Varda
(code.google.com): Protocole Buffer. H2 Database: H2 database. Groovy project (groovy.codehaus.org): Groovy.
IDAutomation.com, Inc.: IDAutomation. IDRsolutions Ltd.: JBIG2. InfoSoft Global (P) Ltd.: FusionCharts, FusionMaps,
FusionWidgets, PowerCharts. Matt Inger (sourceforge.net): Ant-Contrib. Matt Ingenthron, Eric D. Lambert, and Dustin Sallings
(code.google.com): Spymemcached. International Components for Unicode (ICU): ICU library. JCraft, Inc.: JSch. jQuery: jQuery.
Yuri Kanivets (code.google.com): Android Wheel gadget. LEAD Technologies, Inc.: LEADTOOLS. The Legion of the Bouncy
Castle: Bouncy Castle Crypto APIs. Bruno Lowagie and Paulo Soares: iText. MetaStuff: dom4j. Microsoft Corporation (Microsoft
Developer Network): CompoundDocument Library. Mozilla: Mozilla XML Parser. MySQL Americas, Inc.: MySQL Connector.
Netscape Communications Corporation, Inc.: Rhino. nullsoft project: Nullsoft Scriptable Install System. OOPS Consultancy:
XMLTask. OpenSSL Project: OpenSSL. Oracle Corporation: Berkeley DB, Java Advanced Imaging, JAXB, JDK, Jstl, Oracle JDBC
driver. PostgreSQL Global Development Group: pgAdmin, PostgreSQL, PostgreSQL JDBC driver. Progress Software
Corporation: DataDirect Connect XE for JDBC Salesforce, DataDirect JDBC, DataDirect ODBC. Quality Open Software: Simple
Logging Facade for Java (SLF4J), SLF4J API and NOP. Rogue Wave Software, Inc.: Rogue Wave Library SourcePro Core,
tools.h++. Sam Stephenson (prototype.conio.net): prototype.js. Sencha Inc.: Ext JS, Sencha Touch. Shibboleth Consortium:
OpenSAML, Shibboleth Identity Provider. Matteo Spinelli: iscroll. StAX Project (stax.codehaus.org): Streaming API for XML
(StAX). SWFObject Project (code.google.com): SWFObject. ThimbleWare, Inc.: JMemcached. Twittr: Twitter Bootstrap. VMWare:
Hyperic SIGAR. Woodstox Project (woodstox.codehaus.org): Woodstox Fast XML processor (wstx-asl). World Wide Web
Consortium (W3C) (MIT, ERCIM, Keio): Flute, JTidy, Simple API for CSS. XFree86 Project, Inc.: (www.xfree86.org): xvfb. ZXing
Project (code.google.com): ZXing.
All other brand or product names are trademarks or registered trademarks of their respective owners, companies, or
organizations.
Document No. 141215-2-781510 October 15, 2014
Contents
About Installing an Actuate BIRT Java Component . . . . . . . . . . . . . . . . . .iii
Accessing Actuate BIRT Java Components information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Obtaining documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Obtaining late-breaking information and documentation updates . . . . . . . . . . . . . . . . . . . . . . v
Obtaining technical support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Supported and obsolete products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Chapter 1
Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
About Actuate Java Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About deployment formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Checking installation prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About the license key file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2
2
3
3
Chapter 2
Deploying a Java Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Setting web application parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Configuring locale parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Configuring parameters for Deployment Kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Configuring parameters for BIRT Viewer and BIRT Interactive Viewer . . . . . . . . . . . . . . . . . . 9
Configuring parameters for Report Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Compressing files and renaming the WAR file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Deploying the WAR file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Deploying the WAR file on Apache Tomcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Deploying Actuate Java Components EARs to JBoss 6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Chapter 3
Using a Java Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Testing the installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Java Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using BIRT Viewer and BIRT Interactive Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Report Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the Deployment Kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Licensing a Java Component in a WAR file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting JVM properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14
14
14
15
15
17
18
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
i
ii
About Installing an Actuate
BIRT Java Component
Installing an Actuate BIRT Java Component includes the following chapters:
■
■
■
■
About Installing an Actuate BIRT Java Component. Provides an overview of this
guide and a summary of Actuate Java Components documentation.
Chapter 1. Before you begin. Explains Java Components capabilities, installation
prerequisites, and licensing.
Chapter 2. Deploying a Java Component. Covers editing parameters for using
Java Components and deploying the Java Components war file.
Chapter 3. Using a Java Component. Describes testing, using, and licensing a Java
Component.
Accessing Actuate BIRT Java Components information
The online documentation includes the materials described in Table I-1. You can
obtain HTML and PDF files from the Actuate web site. These documentation files
are updated in response to customer requirements.
About Installing an Actuate BIRT Java Component
iii
Table I-1
Product documentation
For information about this topic
See the following
resource
Installing and configuring Actuate BIRT Java
Components
Installing an
Actuate BIRT
Java
Component
Overview of Report Studio concepts
Designing, editing, and formatting reports
Organizing and filtering data, presenting data in a chart;
inserting calculated data; functions and operators
reference
Creating and publishing report templates; configuring
and customizing Report Studio pages
Introduction to the Deployment Kit and Viewers,
including concepts and online reporting
Accessing files and folders; running reports
Introduction to report viewers
Navigating, printing and exporting to other formats
Organizing and formatting a cross tab
BIRT Interactive Viewer:
Formatting reports, organizing data, working with
charts, and hiding and filtering data
Overview of Java Component concepts and the web
applications
Using, customizing, and configuring Java Components
Using the code components for JSPs, URL parameters,
JavaScript files, Java servlets, Java Beans, and security
facilities
Overview of concepts for programming with Actuate
JavaScript
Creating custom pages using Actuate JavaScript
Reference of Actuate JavaScript classes and methods
iv
Installing an Actuate BIRT Java Component
Using Report
Studio - Java
Component
Edition
Using an
Actuate BIRT
Java
Component
Developing
Developing
Actuate
ActuateBasic
Basic
Actuate
Java
Reports
Reports
using
using
Components
Actuate
Actuate
Developer
e.Report
e.Report
Guide
Designer
Designer
Professional
Professional
Obtaining documentation
Actuate provides technical documentation in PDF and HTML formats. You can
download PDF or view HTML versions of the documentation from
developer.actuate.com/resources/documentation/ihub/ihub3/.
Obtaining late-breaking information and
documentation updates
The release notes contain late-breaking news about Actuate products and
features. The release notes are available on the Actuate Support site at the
following URL:
http://support.actuate.com/documentation/releasenotes
If you are a new user, you must first register on the site and log in to view the
release notes. actuate.com also provides product update information.
Obtaining technical support
You can contact Customer Support by e-mail or telephone. For contact
information, go to the following URL:
http://www.actuate.com/services/support/contact-support.asp
Supported and obsolete products
The Actuate Support Lifecycle Policy and Supported Products Matrix are
available on the Actuate Support web site at the following URL:
http://support.actuate.com/documentation/spm
About Installing an Actuate BIRT Java Component
v
vi
Installing an Actuate BIRT Java Component
1
Chapter
Before you begin
Chapter 1
This chapter discusses the following topics:
■
About deployment formats
■
Checking installation prerequisites
■
About the license key file
Chapter 1, Before you begin
1
About Actuate Java Components
Actuate Java Components provide a complete reporting technology consisting of
a report designer, report distribution in files and folders, and viewing or
interactive viewing of reports. The following list describes each component:
■
BIRT Deployment Kit
A file and folder browser that optimizes performance and viewing of BIRT
reports
■
BIRT Interactive Viewer
A viewer that you can use to customize and personalize a BIRT report to
answer ad hoc business questions
■
BIRT Viewer
A viewer for BIRT reports that extends the capabilities of BIRT to deliver rich
dynamic content and display aggregate data in cross tabs
■
Report Studio
A web-based BIRT report designer for creating reports that can include charts
and graphs
About deployment formats
You can install Java Components on Windows or Linux. Actuate provides Java
Components in WAR and EAR formats. These formats are suitable for
deployment on application servers shown in Table 1-1.
Table 1-1
Java Component deployment formats
File
Application server
WL_TOMCAT_
ActuateBIRTJavaComponent.war
Apache Tomcat
BEA WebLogic
JBOSS_ActuateBIRTJavaComponent.ear
JBoss
WAS_ActuateBIRTJavaComponent.ear
IBM WebSphere
Apache Tomcat web server does not support EAR deployment. Only the JBoss
and WebSphere application servers support EAR deployment. The specific
versions of each server that Actuate supports are listed in the Supported Product
Matrix (SPM) available on the Actuate Support website:
http://support.actuate.com/documentation/spm
2
Installing an Actuate BIRT Java Component
Checking installation prerequisites
Before you deploy a Java Component, ensure that your system meets the
following requirements:
■
Java Development Kit 7 (JDK)
You need to use the JAR utility included in the JDK to decompress and
compress the Java Components archive. Java Components also require the
Java Runtime Environment (JRE) 7 included in the JDK. The Deployment Kits
require the use of the local JVM and cannot differentiate multiple JVMs on the
same machine. Therefore, you must install Deployment Kit with only one
JVM.
■
An application server
Java Components run as a web application in the application server, such as
Apache Tomcat or JBoss.
■
Administrators group privileges on Windows, or root privileges on Linux
■
Permission to start and stop the application server
■
A Java Virtual Machine and Web Server configured for the same application
platform, either 32-bit or 64-bit
About the license key file
You can download Actuate BIRT Java Components from an electronic download
site. Included in the download is an evaluation license for using each of the
components for a limited time.
If you install products using the evaluation license, you do not need to reinstall
before you activate the permanent license. To arrange for a permanent license key
file, contact Actuate Customer Care at customercare@actuate.com. If you are an
international customer, your request routes to a team in international distribution.
If you are not a direct Actuate customer, the partner or distributor who provides
the product arranges for your license key file. The name for an Actuate Java
Component license key file uses the following format:
Actuate_AJC_key_<ID>.xml
<ID> is a unique number generated by Actuate Licensing when it creates the
license key file. You receive an e-mail that contains the permanent license key file
information when Actuate processes your order.
If the license file does not exist, is invalid, or has expired, an error appears in the
reportService log file, described later. When the license is invalid or expired, Java
Components load, but any attempt to access an Actuate application, including the
Chapter 1, Before you begin
3
login page, results in an error. If you have a problem with a license key file,
contact Actuate Customer Care at customercare@actuate.com.
4
Installing an Actuate BIRT Java Component
2
Chapter
Chapter 2
Deploying a Java
Component
This chapter discusses the following topics:
■
Setting web application parameters
■
Compressing files and renaming the WAR file
■
Deploying the WAR file
Chapter 2, Deploying a Java Component
5
Setting web application parameters
The first step in deploying the Java Component WAR file is editing the web.xml
file. Extract web.xml from the WAR file, then edit web.xml to set configuration
parameters for one or more components that you purchased or are evaluating.
The tables in this section describe these parameters and actions you take. Perform
these actions as you edit web.xml.
How to edit web.xml
To access web.xml for editing, first decompress the WAR file that contains
web.xml. Next, configure parameters for the Java Components that you want to
use.
1 Create a directory named /temp. Java Components writes temporary files to
this directory after deployment.
2 Decompress the ActuateJavaComponent.war file in a subdirectory of /temp.
Type the following command:
jar -xf ActuateJavaComponent.war
Use this command on Windows or Linux. The BIRT Java Component files
appear in the subdirectory of /temp.
Figure 2-1 shows these files on Linux.
Figure 2-1
Files extracted from ActuateJavaComponent.war
Keep all downloaded files together in their original relative locations.
3 Using a text editor that accepts UTF-8 encoding, edit web.xml in /WEB-INF to
configure the parameters for the BIRT Java Components you purchased or are
evaluating.
4 Save and close web.xml.
5 Perform this step only if you are deploying BIRT Java Component using one of
the following WAR files:
■
6
WAS_ActuateBIRTJavaComponent.war
Installing an Actuate BIRT Java Component
For deploying Information Console to the IBM WebSphere application
server. WAS_ActuateBIRTJavaComponent.ear contains
WAS_ActuateBIRTJavaComponent.war.
■
WL_ActuateBIRTJavaComponent.war
For deploying Information Console to the Oracle WebLogic application
server.
Remove the WEB-INF/lib/el-api.jar file from the WAR file if the /lib directory
for your application server also contains el-api.jar. The presence of el-api.jar in
both the Information Console WEB-INF/lib directory and the application
server /lib directory may cause errors.
Configuring locale parameters
The locale parameters, described in Table 2-1, are applicable to all Java
Components.
Table 2-1
Locale parameters
Parameter name
Description
Action
DEFAULT_LOCALE
The value of this parameter
determines the default
locale. The default locale is
en_US. Users can select a
locale when they log in.
Use the default
locale or a value
from Localemap.xml
in the WEB-INF
directory.
DEFAULT_TIMEZONE
The value of this parameter
determines the default time
zone. The default time
zone is Pacific Standard
Time (PST).
Use the default time
zone or a value from
Timezonemap.xml
in the WEB-INF
directory.
For example, changing the DEFAULT_LOCALE parameter value to es_ES
changes the locale to Spain, and the interface changes to Spanish, as shown in
Figure 2-3.
Chapter 2, Deploying a Java Component
7
Figure 2-2
Using the Actuate Java Components interface localized to Spain
Configuring parameters for Deployment Kit
The components for BIRT Deployment Kit have additional core configuration
parameters in web.xml. Table 2-2 describes these parameters. Update these
parameters before deployment.
For BIRT Deployment Kit, also review the parameters described in Table 2-3.
Table 2-2
8
Deployment Kit parameters
Parameter name
Description
Action
LOG_FILE_LOCATION
The location of the files that
log Deployment Kit
activities.
You must create this
physical location on
the file system. The
default value is
/logs.
TEMP_FOLDER_
LOCATION
The location where
Deployment Kit creates
temporary files.
You must create this
physical location on
the file system. There
is no default value.
TRANSIENT_STORE_
PATH
Another location where
Deployment Kit creates
temporary files.
You must create this
physical location on
the file system. The
default value is
/temp.
Installing an Actuate BIRT Java Component
Configuring parameters for BIRT Viewer and BIRT
Interactive Viewer
The BIRT Viewer and BIRT Interactive Viewer components also have core
configuration parameters in web.xml. Table 2-3 describes these configuration
parameters. Consider changing these parameters to optimize performance.
Table 2-3
BIRT Viewer parameters
Parameter name
Description
Action
BIRT_ARCHIVE_
MEMORY_TOTALSIZE
Total memory available for BIRT
report document files in
kilobytes. The default value is
50 MB.
None required
REPOSITORY_CACHE_
TIMEOUT_SEC
Specifies, in seconds, how long to
retain temporary files that BIRT
Viewer creates when a user
modifies the appearance of a
report. The default value is 900,
which is 15 minutes.
None required
Configuring parameters for Report Studio
Report Studio component has one configuration parameter, shown in Table 2-4.
Edit the parameter to change the path to BIRT resources. BIRT resources include
libraries and templates for Actuate BIRT report designs and Actuate Report
Studio.
Table 2-4
Report Studio parameter
Parameter name
Description
Action
BIRT_RESOURCE_PATH
Path to Actuate BIRT shared
resources. The default value is the
following directory:
None required
<Tomcat install directory>
/webapps/newJavaComponent
/resources
Compressing files and renaming the WAR file
After editing the web.xml file, compress and rename the archive. For example,
rename the archive newJavaComponent.war. Compress the files into a WAR file
of a different name to preserve your original WAR file.
Chapter 2, Deploying a Java Component
9
How to compress files and rename the WAR file
1 After editing web.xml in the WEB-INF directory, move up one directory.
2 Check that files shown in Figure 2-1 are present in your current directory.
3 Compress the files and specify a new name for the WAR file. Type the
following command:
jar -cf newJavaComponent.war *
Use this command on Windows or Linux. The WAR file containing the
modified configuration values in web.xml appears.
Deploying the WAR file
This section discusses deploying a BIRT Java Component WAR file. For example
purposes, deployment on Tomcat 6 is shown.
To deploy the WAR file on an application server other than Tomcat 6, use your
application server’s deployment tools. If your application server does not have
deployment tools, add the Java Components context root to your application
server. Typically, you modify the application server's configuration file.
Deploying the WAR file on Apache Tomcat
Perform the steps in the following procedure to deploy the WAR file by putting it
in the /webapps directory.
How to deploy the WAR file on Apache Tomcat
1 Stop the Apache Tomcat service.
2 Copy the renamed BIRT Java Component WAR file from the working
directory to the /webapps directory of your Tomcat installation files, as shown
in Figure 2-3.
Figure 2-3
Copying the WAR file to /webapps on Linux
3 Start Tomcat.
10
Installing an Actuate BIRT Java Component
The Tomcat log confirms the deployment of the WAR file and the location of
the /temp directory that you created earlier.
Figure 2-4 shows an example of a Tomcat log file on Linux.
Default Linux
path to log
Deployment
confirmation
Your temp
directory
Figure 2-4
Tomcat log file confirms deployment
Deploying Actuate Java Components EARs to
JBoss 6
To deploy Actuate BIRT Java Component EARs to JBoss 6, you must remove the
commons-logging.jar library from the EAR file before deploying it. Leaving this
file in the EAR causes JBoss 6 to throw an exception during deployment.
The commons-logging.jar file is still necessary for deployments to JBoss 5 and
JBoss 7.
To deploy Java Components to JBoss 6, perform the following steps:
1 In a separate directory, extract the contents of
JBOSS_ActuateBIRTJavaComponent.ear by typing the following command
into a command prompt:
jar -xf JBOSS_ActuateBIRTJavaComponent.ear
Keep all extracted files together in their original relative locations.
2 Copy JBOSS_ActuateBIRTJavaComponent.war into a separate directory and
extract the contents of JBOSS_ActuateBIRTJavaComponent.war by typing the
following command into a command prompt:
jar -xf JBOSS_ActuateBIRTJavaComponent.war
3 Delete <warFile>/WEB-INF/lib/commons-logging.jar.
4 Compress the all files in the directory into a war file by typing the following
command:
jar -cf JBOSS_ActuateBIRTJavaComponent.war *
Chapter 2, Deploying a Java Component
11
5 Copy JBOSS_ActuateBIRTJavaComponent.war into the separate directory
containing the extracted files from JBOSS_ActuateBIRTJavaComponent.ear.
Compress these files into a ear file by typing the following command:
jar -cf JBOSS_ActuateBIRTJavaComponent.ear *
6 Deploy JBOSS_ActuateBIRTJavaComponent.ear to the JBoss 6 server.
12
Installing an Actuate BIRT Java Component
3
Chapter
Chapter 3
Using a Java Component
This chapter discusses the following topics:
■
Testing the installation
■
Using Java Components
■
Licensing a Java Component in a WAR file
■
Setting JVM properties
Chapter 3, Using a Java Component
13
Testing the installation
To test the BIRT Java Component install, open the Java Components landing
page. Go to the following URL to access the landing page shown in Figure 3-1:
http://host:8080/newJavaComponent/
Figure 3-1
Actuate Java Components landing page
Using Java Components
If you are evaluating Java Components, use all products for the evaluation
period. If you purchased particular Java Components, you can use only those
products.
Using BIRT Viewer and BIRT Interactive Viewer
BIRT Viewer is the default viewer that BIRT uses when you open a report. To use
BIRT Interactive Viewer, open a report, and choose Enable Interactivity.
Figure 3-2 shows Enable Interactivity.
14
Installing an Actuate BIRT Java Component
Figure 3-2
Choosing Enable Interactivity
Using Report Studio
Launch Report Studio by going to the following URL:
http://host:8080/newJavaComponent/wr?&iportal
Figure 3-3 shows the Report Studio opening page.
Figure 3-3
Launching the Report Studio Component
Using the Deployment Kit
Launch BIRT Deployment Kit from the Actuate Java Components landing page.
Chapter 3, Using a Java Component
15
How to launch BIRT Deployment Kit
1 On the landing page, choose Actuate BIRT Deployment Kit, as shown in
Figure 3-4.
Choose
Figure 3-4
Actuate Java Components landing page
The Actuate BIRT Deployment Kit appears, as shown in Figure 3-5.
Choose
Figure 3-5
Launching the Actuate BIRT Deployment
2 Launch the Actuate BIRT Deployment Kit. Figure 3-6 shows the folders of
report documents that you can browse.
16
Installing an Actuate BIRT Java Component
Figure 3-6
Accessing folders of report documents
Licensing a Java Component in a WAR file
The installation files include an evaluation license for using each of the
components for a limited time. After installation, check the evaluation license
expiration date by opening the reportService log in the following directory:
<Tomcat install directory>/webapps/newJavaComponent/logs
Figure 3-7 shows the reportService log on Windows.
Supported options
Figure 3-7
License expiration
Checking the license expiration date and supported options
When you complete the evaluation, replace the evaluation license with a
permanent license. After obtaining a new license key file, as explained earlier,
perform the steps in the following procedure:
How to license a BIRT Java Component
1 Rename the BIRT Java Component license file that Actuate sent you to
ajclicense.xml.
2 Decompress the BIRT Java Component WAR file.
jar -xf ActuateJavaComponent.war
Chapter 3, Using a Java Component
17
The BIRT Java Component files appear.
3 Copy the ajclicense.xml file into the extracted <context root>\WEB-INF
directory. For example, assuming you named the file newJavaComponent.war,
the path to access the WEB-INF directory is:
<Tomcat install directory>/webapps/newJavaComponent/WEB-INF
4 Assuming WEB-INF is your current directory, move up one directory and type
the following command on Windows or Linux:
jar -cf MyJavaComponent.war *
This command creates MyJavaComponent.war. This WAR file contains the
license. The WAR file now has the context root MyJavaComponent.
5 Deploy MyJavaComponent.war to the application server or servlet engine as
an application, as described earlier.
6 Restart the application server or servlet engine.
Setting JVM properties
Deploying Actuate Java Components within some application server
environments requires Java configuration to avoid Java Virtual Machine (JVM)
errors. Set the following JVM properties:
■
Initial heap size
Include -Xms512m as a Java option.
■
Maximum heap size
Include -Xmx1536m as a Java option.
■
Maximum size for the permanent generation heap
Include -XX:MaxPermSize=256m as an option.
How to configure JVM properties for Tomcat 6.x and 7.x on Windows
1 From the Windows Start menu, choose All Programs➛Apache Tomcat
6.x➛Configure Tomcat.
2 On Apache Tomcat 6.x Properties, choose Java.
3 Change the value of the Initial memory pool to 512.
4 Change the value of the Maximum memory pool to 1536.
5 Add -XX:MaxPermSize=256m to Java Options on separate lines, as shown in
Figure 3-8.
18
Installing an Actuate BIRT Java Component
Figure 3-8
Apache Tomcat 6 Java configuration
6 Choose OK.
7 Restart Tomcat.
How to configure JVM properties for JBoss on Windows
1 Navigate to the following directory:
<JBoss install directory>\bin
2 Open run.bat.
3 Add -Xms512m -Xmx1536m and -XX:MaxPermSize=256m to the JAVA_OPTS
variable specification.
4 Save and close run.bat.
5 Restart Tomcat.
How to configure JVM properties for Tomcat on Linux
1 Navigate to the following directory:
/etc/tomcat#
where # is the Tomcat release number, either 6 or 7
2 Open tomcat#.conf.
3 Add -Xms512m -XMx1536m and -XX:MaxPermSize=256m to the JAVA_OPTS
variable specification.
4 Save and close tomcat#.conf.
5 Restart Tomcat.
Chapter 3, Using a Java Component
19
20
Installing an Actuate BIRT Java Component
Index
A
accessing
documentation v
activity logs 8
Actuate Customer Support v
Actuate product information v
ajclicense.xml file 18
Apache Tomcat Configuration 18
application servers. See servers
B
BIRT Data Analyzer 2
BIRT Interactive Viewer 2, 9
BIRT reports 9
BIRT Viewer 2, 9
BIRT_ARCHIVE_ MEMORY_TOTALSIZE
parameter 9
BIRT_RESOURCE_PATH parameter 9
C
cache 9
changing
default locales 7
licensing options 3
time zones 7
configuration parameters 8, 9
configuring
application servers 18
Java Components 7–9
context root 18
context roots 10
Customer Care 4
Customer Support v
customizing WAR files 10
D
decompressing WAR files 17
DEFAULT_LOCALE parameter 7
DEFAULT_TIMEZONE parameter 7
deploying Java Components 2, 3, 10
Deployment Kit for BIRT Reports 2, 8
deployment tools 10
designs 9
document files 9
documentation
administering iHub System and iii
downloading v
updating iii
downloading
documentation files v
E
editors 6
expired license keys 3
F
features v
file names 18
files 17
accessing help v
downloading documentation v
H
help files v
HTML documentation iii, v
HTML documentation. See documentation
I
installation guide iii
installing Java Components 14
international licensing requests 3
invalid license keys 3
J
jar utility 18
Java Components
configuring 7–9, ??–18
deploying 2, 3
installing 14
obtaining licenses for 3
Java Virtual Machine Configuration 18
JBoss Configuration 19
Index
21
JBOSS_ActuateBIRTJavaComponent.ear 2
S
L
servers
configuring 18
deploying Java Components to 10
setting context root for 18
servlet engines 18
Support Lifecycle Policy v
Supported Products Matrix v
libraries 9
license key files 3
license keys 3
Localemap.xml 7
locales 7
log files 8
LOG_FILE_LOCATION parameter 8
M
manuals. See documentation
memory 9
N
naming WAR files 18
O
obsolete product information v
online documentation
administering iHub System and iii
downloading v
updating iii
online documentation. See documentation
P
parameters. See configuration parameters
PDF documentation iii, v
See also documentation
product information v
product updates v
R
release notes v
report designs 9
report document files 9
Report Studio 2, 9
reporting applications. See applications
reports 9
REPOSITORY_CACHE_TIMEOUT_SEC
parameter 9
rich internet applications
See also applications
22
T
technical support v
TEMP_FOLDER_LOCATION parameter 8
templates 9
temporary files 8, 9
testing Java Components installations 14
text editors 6
time zones 7
Timezonemap.xml 7
TRANSIENT_STORE_PATH parameter 8
U
updates (documentation) iii
updates (product) v
URLs 15, 18
Actuate product information v
Actuate technical support v
release notes v
W
WAR files 10
WAS_ActuateBIRTJavaComponent.war 2
web applications. See applications
web archive files. See WAR files
web servers. See servers
web.xml 6
WL_TOMCAT_ActuateBIRTJavaComponent.
war 2
Installing an Actuate BIRT Java Component
Download PDF