blob: ac3db6d5a03ea1dfaede4f7be804c43832843f2d [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Deploying BIRT</title>
<link rel="stylesheet" href="../style/compose.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="head">Integrating BIRT</p>
<p class="subhead">Installing the BIRT Viewer in Tomcat</p>
<h1>Using Tomcat</h1>
<p>This page explains how to deploy the BIRT viewer to a J2EE container.
We'll use <a href="http://jakarta.apache.org/tomcat/">Apache Tomcat</a>, since
it is open source and readily available. The same concepts, perhaps
with different details, apply to other app servers. These instructions assume you'll
install Tomcat on your own machine using the default port number of 8080.</p>
<p>If you don&rsquo;t have Tomcat installed on your system you can download it from <a href="http://jakarta.apache.org/tomcat">http://jakarta.apache.org/tomcat</a>. BIRT works with the 4.1.x and 5.5.x verisons of Tomcat, but 5.5.x requires installation of the Java compatibility package described below.</p>
<h1>Install the Viewer</h1>
<p>Deploy the BIRT Viewer application.
Follow these steps:
<ul>
<li>Download the zip file with the BIRT report engine runtime. The file is named birt-runtime-&lt;version#&gt;.zip.</li>
<li>Unzip the file in a staging area.</li>
<li>Look under the birt-runtime-&lt;version#&gt; directory and locate the &quot;Web Viewer Example&quot; directory.</li>
<li>Copy the Web Viewer Example directory to the webapps directory of your
Tomcat installation. For ease of reference, rename the directory to &quot;birt-viewer&quot;.</li>
<li>Copy additional files to the directory structure as described in the BIRT Runtime <a href=http://www.eclipse.org/birt/index.php?page=build/install.html>Note</a>
<li>Stop, then restart Tomcat.</li>
<li>Display the Tomcat manager application to check that the
viewer is deployed: <a href="http://localhost:8080/manager/html">
http://localhost:8080/manager/html</a>.</li>
<li>Verify that birt-viewer is listed as an application, then click on the birt-viewer link.</li>
<li> A page confirming that the BIRT viewer has been installed should be displayed. Click on the link labeled &quot;View Example&quot; to confirm that your installation is working properly.</li>
<li> Alternately, instead of using the Web Viewer Example, you can also copy the birt.war file to the Tomcat webapps directory. The WAR file is located in birt-runtime-&lt;version#&gt;.zip.</li>
</ul>
<p>If you choose to put the Viewer into some other location, you'll
need to use a context entry within the server.xml file to indicate the
deployment location. See Tomcat documentation for details. </p>
<br>
<h1>Install your JDBC Drivers</h1>
<p>Add the jar files for your JDBC drivers to the Viewer. They go in the following directory:</p>
<p> birt-viewer/plugins/org.eclipse.birt.report.data.oda.jdbc/drivers</p>
<p>(Note: you must install the drivers both into
the Eclipse-based design environment and the deployed viewer environment; these
two environments do not share files.)</p>
<h1>Testing a More Complex Report </h1>
<p>We'll test the viewer further using one of the example reports created for the &quot;Classic Models&quot; database. Note that Classic Models database is included in the birt runtime distribution so no further set-up is required. Follow these steps:
<ul>
<li>Click on the following link to download the example report design,
<a href="../examples/solution/SalesInvoice.rptdesign" target="_blank">SalesInvoice.rptdesign</a> into another browser window. Use the &quot;Save as...&quot; command from the file menu to save the report into the birt-viewer/report directory.</li>
<li>If you've installed everything in its default location, then click on the
following link. If you've changed anything, then copy the following URL into
your browser and make the needed changes.<pre class="code-block"><a href="http://localhost:8080/birt-viewer/frameset?__report=report%5CSalesInvoice.rptdesign" target="_blank">http://localhost:8080/birt-viewer/frameset?__report=report%5CSalesInvoice.rptdesign</a>
</pre></li>
</ul>
<p>The report should run and appear in your browser, along with a parameter form
in which you can enter a different value for the &quot;Order Number &quot; parameter for this
report.
</body></html>