How to register an emitter

ATreus1981 · May 20, 2015

Hi,
 
I try to get my own Excel emitter running with the Birt runtime 4.4.2. It is an Eclipse plugin and has everything necessary defined and implemented and is visible in the classpath.
 
But when I set the Emitter with EngineConfig.setDefaultEmitter("xlsx", CLASS_NAME) I always get an OutputFormatNotSupprted exception. Looking a bit around in the API has revealed the ExtensionManager class which loads Emitter infromations from schema/emitters.exsd.
 
So my question is, have I to build my own Birt distribution to Register my own Emitter or is there a way to use the Birt API for this purpose? Is there a tutorial dealing with the Problem (Google could not help

)
 
Kind Regards
Andreas

JFreeman · May 20, 2015

Take a look at this article on creating a custom emitter: <a data-ipb='nomediaparse' href='http://www.ibm.com/developerworks/library/ba-birt-emitter/'>http://www.ibm.com/developerworks/library/ba-birt-emitter/</a>
 
It should help in walking you through the process.

ATreus1981 · May 20, 2015

Hi,
 
that's what I have done. But creating an IRenderTask and running it leads to the exception described above.
 
The method setupRenderOption() in class EngineTask does not recognise my emitter. Its line 2156 (extManager.getSupportedFormat()) if the format is set or line 2133 (extManager.isValidEmitterId()) if the emitterID is set....
 
Regards,
Andreas

JFreeman · May 20, 2015

Can you attach the emitter so I can test it out in my environment?

ATreus1981 · May 20, 2015

Find attached the emitter project. Thank you for the support...
 
Regards,
Andreas

JFreeman · May 20, 2015

On initial inspection, it looks to me like this may have to do with a conflict in the format name you have specified. When launching an eclipse instance from your project, the emitters you have defined do not show up in the list of available emitters. Which I believe is due to specifying the formats as "xls" and "xlsx" which are already in use by the out of the box emitters.
 
As a quick test I renamed the format on these to "cust_xls" and "cust_xlsx" and then launched a new eclipse instance from the project. With this change in place, the two emitters now show up as available export formats named "cust_xls" and "cust_xlsx" as I have named them.
 
I would start by renaming the format of the emitters.

ATreus1981 · May 22, 2015

Unfortunately the Problem is not resolved: After executing the line:
<pre class="_prettyXprint">
config.setDefaultEmitter("xlsx_gnwi", "de.gnwi.birt.emitters.excel.XlsxEmitter");
</pre>
And Setting the output format following exception is thrown:
<pre class="_prettyXprint _lang-xml">
org.eclipse.birt.report.engine.api.UnsupportedFormatException: The output format xlsx_gnwi is not supported.
at org.eclipse.birt.report.engine.api.impl.EngineTask.setupRenderOption(EngineTask.java:2162)
at org.eclipse.birt.report.engine.api.impl.RenderTask$PageRangeRender.render(RenderTask.java:570)
at org.eclipse.birt.report.engine.api.impl.RenderTask.render(RenderTask.java:321)
at de.gnwi.birt.engine.BirtReportEngine.generateReport(BirtReportEngine.java:99)
at de.gnwi.birt.engine.AbstractReportServiceImpl$1.call(AbstractReportServiceImpl.java:35)
at de.gnwi.birt.engine.AbstractReportServiceImpl$1.call(AbstractReportServiceImpl.java:1)
at java.util.concurrent.FutureTask.run(FutureTask.java:266)
at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)
at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)
at java.lang.Thread.run(Thread.java:745)

</pre>
Regards,
Andreas

JFreeman · May 22, 2015

That particular error could have quiet a few causes but it typically is going to indicate that the report engine cannot access the emitter.
 
Can you attach the full code you are using when you get the error?
 
Have you built your JAR and deployed it to the designers plugins directory?
Or are launching a new version of eclipse from within the emitter project and coding there?

ATreus1981 · May 27, 2015

The Birt engine and the emitter are two independend projects. The engine project references the emitter project. 
I have attached the two eclipse projects as a minimal working example. 
Regards, 
Andreas

cmalnoe · July 6, 2015

Hi,
 
 
I kinda have similar issue.
I can't use my home mad plugin.
 
While using it in my project by definig the emitterId :
final IRenderOption xmlOptions = new RenderOption(options); 
 xmlOptions.setOutputFormat("xml"); 
 xmlOptions.setOutputStream(response); 
 runAndRenderTask.setRenderOption(xmlOptions); 
 runAndRenderTask.setEmitterID("org.eclipse.birt.report.engine.emitter.xml.XMLReportEmitter");
 
I got this error :
juil. 06, 2015 1:39:47 PM org.eclipse.birt.report.engine.api.impl.EngineTask createContentEmitter 
GRAVE: Report engine can not create emitter org.eclipse.birt.report.engine.emitter.xml.XMLReportEmitter. 
juil. 06, 2015 1:39:47 PM org.eclipse.birt.report.engine.api.impl.EngineTask handleFatalExceptions 
GRAVE: An error happened while running the report. Cause: 
org.eclipse.birt.report.engine.api.EngineException: Report engine fails to initialize org.eclipse.birt.report.engine.emitter.xml.XMLReportEmitter emitter, please make sure required libraries for this emitter are installed. 
 at org.eclipse.birt.report.engine.api.impl.EngineTask.createContentEmitter(EngineTask.java:1763) 
 at org.eclipse.birt.report.engine.api.impl.RunAndRenderTask.doRun(RunAndRenderTask.java:106) 
 at org.eclipse.birt.report.engine.api.impl.RunAndRenderTask.run(RunAndRenderTask.java:77) 
 at fr.inra.means.birt.report.BirtView.runReportEngine(BirtView.java:232) 
 at fr.inra.means.birt.report.BirtView.renderMergedOutputModel(BirtView.java:123) 
 at org.springframework.web.servlet.view.AbstractView.render(AbstractView.java:262) 
 at org.springframework.web.servlet.DispatcherServlet.render(DispatcherServlet.java:1180) 
 at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:950) 
 at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:852) 
 at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:882) 
 at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:778) 
 at javax.servlet.http.HttpServlet.service(HttpServlet.java:668) 
 at javax.servlet.http.HttpServlet.service(HttpServlet.java:770) 
 at org.apache.catalina.core.StandardWrapper.service(StandardWrapper.java:1550) 
 at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:343) 
 at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:217) 
 at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:330) 
 at org.springframework.security.web.access.intercept.FilterSecurityInterceptor.invoke(FilterSecurityInterceptor.java:118) 
 at org.springframework.security.web.access.intercept.FilterSecurityInterceptor.doFilter(FilterSecurityInterceptor.java:84) 
 at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:342) 
 at org.springframework.security.web.access.ExceptionTranslationFilter.doFilter(ExceptionTranslationFilter.java:113) 
 at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:342) 
 at org.springframework.security.web.session.SessionManagementFilter.doFilter(SessionManagementFilter.java:103) 
 at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:342) 
 at org.springframework.security.web.authentication.AnonymousAuthenticationFilter.doFilter(AnonymousAuthenticationFilter.java:113) 
 at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:342) 
 at org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter.doFilter(SecurityContextHolderAwareRequestFilter.java:54) 
 at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:342) 
 at org.springframework.security.web.savedrequest.RequestCacheAwareFilter.doFilter(RequestCacheAwareFilter.java:45) 
 at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:342) 
 at org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter.doFilter(AbstractAuthenticationProcessingFilter.java:183) 
 at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:342) 
 at org.springframework.security.web.authentication.logout.LogoutFilter.doFilter(LogoutFilter.java:105) 
 at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:342) 
 at org.springframework.security.web.context.SecurityContextPersistenceFilter.doFilter(SecurityContextPersistenceFilter.java:87) 
 at org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:342) 
 at org.springframework.security.web.FilterChainProxy.doFilterInternal(FilterChainProxy.java:192) 
 at org.springframework.security.web.FilterChainProxy.doFilter(FilterChainProxy.java:160) 
 at org.springframework.web.filter.DelegatingFilterProxy.invokeDelegate(DelegatingFilterProxy.java:346) 
 at org.springframework.web.filter.DelegatingFilterProxy.doFilter(DelegatingFilterProxy.java:259) 
 at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:256) 
 at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:217) 
 at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:88) 
 at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:76) 
 at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:256) 
 at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:217) 
 at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:279) 
 at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:175) 
 at org.apache.catalina.core.StandardPipeline.doInvoke(StandardPipeline.java:655) 
 at org.apache.catalina.core.StandardPipeline.invoke(StandardPipeline.java:595) 
 at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:161) 
 at org.apache.catalina.connector.CoyoteAdapter.doService(CoyoteAdapter.java:331) 
 at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:231) 
 at com.sun.enterprise.v3.services.impl.ContainerMapper$AdapterCallable.call(ContainerMapper.java:317) 
 at com.sun.enterprise.v3.services.impl.ContainerMapper.service(ContainerMapper.java:195) 
 at com.sun.grizzly.http.ProcessorTask.invokeAdapter(ProcessorTask.java:860) 
 at com.sun.grizzly.http.ProcessorTask.doProcess(ProcessorTask.java:757) 
 at com.sun.grizzly.http.ProcessorTask.process(ProcessorTask.java:1056) 
 at com.sun.grizzly.http.DefaultProtocolFilter.execute(DefaultProtocolFilter.java:229) 
 at com.sun.grizzly.DefaultProtocolChain.executeProtocolFilter(DefaultProtocolChain.java:137) 
 at com.sun.grizzly.DefaultProtocolChain.execute(DefaultProtocolChain.java:104) 
 at com.sun.grizzly.DefaultProtocolChain.execute(DefaultProtocolChain.java:90) 
 at com.sun.grizzly.http.HttpProtocolChain.execute(HttpProtocolChain.java:79) 
 at com.sun.grizzly.ProtocolChainContextTask.doCall(ProtocolChainContextTask.java:54) 
 at com.sun.grizzly.SelectionKeyContextTask.call(SelectionKeyContextTask.java:59) 
 at com.sun.grizzly.ContextTask.run(ContextTask.java:71) 
 at com.sun.grizzly.util.AbstractThreadPool$Worker.doWork(AbstractThreadPool.java:532) 
 at com.sun.grizzly.util.AbstractThreadPool$Worker.run(AbstractThreadPool.java:513) 
 at java.lang.Thread.run(Thread.java:745) 
Caused by: java.lang.NoClassDefFoundError: org/eclipse/birt/report/engine/emitter/ContentEmitterAdapter 
 at java.lang.ClassLoader.defineClass1(Native Method) 
 at java.lang.ClassLoader.defineClass(ClassLoader.java:800) 
 at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:142) 
 at java.net.URLClassLoader.defineClass(URLClassLoader.java:449) 
 at java.net.URLClassLoader.access$100(URLClassLoader.java:71) 
 at java.net.URLClassLoader$1.run(URLClassLoader.java:361) 
 at java.net.URLClassLoader$1.run(URLClassLoader.java:355) 
 at java.security.AccessController.doPrivileged(Native Method) 
 at java.net.URLClassLoader.findClass(URLClassLoader.java:354) 
 at java.lang.ClassLoader.loadClass(ClassLoader.java:425) 
 at java.lang.ClassLoader.loadClass(ClassLoader.java:412) 
 at java.lang.ClassLoader.loadClass(ClassLoader.java:358) 
 at org.glassfish.web.loader.WebappClassLoader.loadClass(WebappClassLoader.java:1456) 
 at org.glassfish.web.loader.WebappClassLoader.loadClass(WebappClassLoader.java:1359) 
 at java.lang.Class.forName0(Native Method) 
 at java.lang.Class.forName(Class.java:191) 
 at org.eclipse.birt.core.framework.jar.ConfigurationElement.createExecutableExtension(ConfigurationElement.java:46) 
 at org.eclipse.birt.core.framework.eclipse.EclipseConfigurationElement.createExecutableExtension(EclipseConfigurationElement.java:35) 
 at org.eclipse.birt.report.engine.extension.internal.ExtensionManager.createObject(ExtensionManager.java:482) 
 at org.eclipse.birt.report.engine.extension.internal.ExtensionManager.createEmitter(ExtensionManager.java:312) 
 at org.eclipse.birt.report.engine.api.impl.EngineTask.createContentEmitter(EngineTask.java:1757) 
 ... 68 more 
Caused by: java.lang.ClassNotFoundException: org.eclipse.birt.report.engine.emitter.ContentEmitterAdapter 
 at java.net.URLClassLoader$1.run(URLClassLoader.java:366) 
 at java.net.URLClassLoader$1.run(URLClassLoader.java:355) 
 at java.security.AccessController.doPrivileged(Native Method) 
 at java.net.URLClassLoader.findClass(URLClassLoader.java:354) 
 at java.lang.ClassLoader.loadClass(ClassLoader.java:425) 
 at java.lang.ClassLoader.loadClass(ClassLoader.java:358)
 
It seems that the emitter can't be initialized.
 
I'm using <groupId>org.eclipse.birt.runtime</groupId> 
 <artifactId>org.eclipse.birt.runtime</artifactId> 
 <version>4.3.1</version>
 
Any ideas?
 
Thanks
 
Caroline

asheeshSeekingHelp · January 17, 2017

<div>Hi I am facing same kind of issue.</div>
<div> </div>
<div>Current Scenario:</div>
<div>In my project we are creating reports using BIRT reporting tool using its 4.5 versioned jar.HTMLReportEmiiter is the main class which generates the html code, which is rendered on browser finally.</div>
<div>Now it is a requirement for our software to meet 508 Accessibility Compliance. </div>
<div> </div>
<div>Requirement:</div>
<div>As a part of this change,we need to append "lang = 'en' " attribute to html tag like below:</div>
<div><html lang="en"> to existing generating html source code.</div>
<div> </div>
<div>What I tried:</div>
<div>I created my custom class which extends HTMLReportEmitter class and I override the method "openRootTag" where I can add this "lang" attribute while create html start tag.</div>
<div> </div>
<div>Issue I am facing:</div>
<div>Now issue is how can I register my custom emitter class, so that in actual existing code flow, instead of actual HTMLReportEmitter class object, my custom emitter class object can be in flow and it calls existing code methods and its own single overridden method.</div>
<div>I saw in BIRT jar,there is plugin.xml file in which this emitter registeration code is given,now how can I achieve the same thing in my existing project.</div>
<div>Please give some pointers..</div>

Clement Wong · February 16, 2017

For your 508 compliance, is the appending of LANG='en' to the <HTML> tag the only change?
 
If yes, then why not just change the value of TAG_HTML in HTMLTags?
 
The method openRootTag() contains the line:
...
writer.openTag( HTMLTags.TAG_HTML );
...
 
Here is the source on GitHub:
<a data-ipb='nomediaparse' href='https://github.com/eclipse/birt/blob/master/engine/org.eclipse.birt.report.engine/src/org/eclipse/birt/report/engine/emitter/HTMLTags.java'>https://github.com/eclipse/birt/blob/master/engine/org.eclipse.birt.report.engine/src/org/eclipse/birt/report/engine/emitter/HTMLTags.java</a>
 
 
After making the change, compile it so that you can replace the existing HTMLTags in org.eclipse.birt.report.engine_x.y.z.vYYYYMMDDhhmm.jar

How to register an emitter

Comments

Categories