How to deploy a custom emitter to iServer

This example assumes that the iServer is installed in the Actuate<Release> folder on Windows.

1	Copy org.eclipse.birt.report.engine.emitter.csv.jar to:

Actuate<Release>\iServer\MyClasses\eclipse\plugins

2	Register the emitter with iServer.

1	Open the following file:

Actuate<Release>\iServer\etc\jfctsrvrconfig.xml

JREM uses this configuration file at startup to load the registered emitters.

2	Navigate to the end of the file to find the following entry:

<node name="BIRTReportRenderOption">

The entry contains a list of emitter descriptions separated by a semicolon. The emitter description must have the format type and the emitter id separated by a colon. For example, the PDF emitter is described as:

pdf:org.eclipse.birt.report.engine.emitter.pdf;

3	Add your emitter description to the beginning of the <entry name="RenderFormatEmitterIdMapping"> tag:

MyCSV:org.eclipse.birt.report.engine.emitter.mycsv;

The whole tag would look like this:

<node name="BIRTReportRenderOption">

<!-- The value is "render_format:emitter_ID" separated by ";", for example, pdf:org.eclipse.birt.report.engine.emitter.pdf;
xml:org.eclipse.birt.report.engine.emitter.xml -->      

<entry name="RenderFormatEmitterIdMapping">

  MyCSV:org.eclipse.birt.report.engine.emitter.csv;
html:org.eclipse.birt.report.engine.emitter.html;
xhtml:com.actuate.birt.report.engine.emitter.xhtml;
pdf:org.eclipse.birt.report.engine.emitter.pdf;
postscript:org.eclipse.birt.report.engine.emitter.postscript;
xls:com.actuate.birt.report.engine.emitter.xls;
ppt:org.eclipse.birt.report.engine.emitter.ppt;
pptx:com.actuate.birt.report.engine.emitter.pptx;
doc:org.eclipse.birt.report.engine.emitter.word;
docx:com.actuate.birt.report.engine.emitter.docx

</entry>

</node>

3	Restart the iServer to make it load the new plug-in in its classpath:

Restart Actuate iServer <Release> from Start→Settings→Control Panel→Administrative Tools→Services, as shown in Figure 30-2.

If you use a separately deployed Information Console, you must also restart Apache Tomcat for Actuate Information Console <Release>.

Figure 30-2

Services

The following procedures show how to export a BIRT report to a custom format in different products. The procedures use an example format, MyCSV.

Copyright Actuate Corporation 2012