Integration with JasperServer

To integrate Aspose.Imaging for JasperReports with JasperServer, it is necessary to take several additional steps and update the JasperServer config files. This article explains how.

Add new exporter properties to the %INTALL_DIR%\apache-tomcat\webapps\jasperserver\WEB-INF\flows\viewReportBeans.xml config file.

    <!--JPG-->
    <bean id="reportASJpegExporter" class="com.aspose.imaging.jasperreports.export.jpg.ASReportJpegExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="jpgExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">Batch</value>
        </property>
    </bean>

    <bean id="jpgASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="JPG - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="jpgExportParams"/>
        <property name="exportParameters" ref="jpgExportParameters"/>
        <property name="currentExporter" ref="reportASJpegExporter"/>
    </bean>

    <!--BMP-->
    <bean id="reportASBmpExporter" class="com.aspose.imaging.jasperreports.export.bmp.ASReportBmpExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="bmpExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">Batch</value>
        </property>
    </bean>

    <bean id="bmpASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="BMP - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="bmpExportParams"/>
        <property name="exportParameters" ref="bmpExportParameters"/>
        <property name="currentExporter" ref="reportASBmpExporter"/>
    </bean>

    <!--DCM-->
    <bean id="reportASDcmExporter" class="com.aspose.imaging.jasperreports.export.dcm.ASReportDcmExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="dcmExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">Batch</value>
        </property>
    </bean>

    <bean id="dcmASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="DCM - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="dcmExportParams"/>
        <property name="exportParameters" ref="dcmExportParameters"/>
        <property name="currentExporter" ref="reportASDcmExporter"/>
    </bean>

    <!--EMF-->
    <bean id="reportASEmfExporter" class="com.aspose.imaging.jasperreports.export.emf.ASReportEmfExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="emfExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">Batch</value>
        </property>
    </bean>

    <bean id="emfASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="EMF - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="emfExportParams"/>
        <property name="exportParameters" ref="emfExportParameters"/>
        <property name="currentExporter" ref="reportASEmfExporter"/>
    </bean>

    <!--GIF-->
    <bean id="reportASGifExporter" class="com.aspose.imaging.jasperreports.export.gif.ASReportGifExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="gifExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">Batch</value>
        </property>
    </bean>

    <bean id="gifASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="GIF - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="gifExportParams"/>
        <property name="exportParameters" ref="gifExportParameters"/>
        <property name="currentExporter" ref="reportASGifExporter"/>
    </bean>

    <!--HTML-->
    <bean id="reportASHtmlExporter" class="com.aspose.imaging.jasperreports.export.html.ASReportHtml5CanvasExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="htmlExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">Batch</value>
        </property>
    </bean>

    <bean id="htmlASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="HTML - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="htmlExportParams"/>
        <property name="exportParameters" ref="htmlExportParameters"/>
        <property name="currentExporter" ref="reportASHtmlExporter"/>
    </bean>

    <!--JPG2000-->
    <bean id="reportASJpg2000Exporter" class="com.aspose.imaging.jasperreports.export.jpg2000.ASReportJpeg2000Exporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="jpg2000ExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">Batch</value>
        </property>
    </bean>

    <bean id="jpg2000ASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="JPG2000 - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="jpg2000ExportParams"/>
        <property name="exportParameters" ref="jpg2000ExportParameters"/>
        <property name="currentExporter" ref="reportASJpg2000Exporter"/>
    </bean>

    <!--PDF-->
    <bean id="reportASPdfExporter" class="com.aspose.imaging.jasperreports.export.pdf.ASReportPdfExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="pdfASExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">Multipage</value>
        </property>
    </bean>

    <bean id="pdfASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="PDF - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="pdfExportParams"/>
        <property name="exportParameters" ref="pdfASExportParameters"/>
        <property name="currentExporter" ref="reportASPdfExporter"/>
    </bean>

    <!--PNG-->
    <bean id="reportASPngExporter" class="com.aspose.imaging.jasperreports.export.png.ASReportPngExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="pngExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">Batch</value>
        </property>
    </bean>

    <bean id="pngASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="PNG - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="pngExportParams"/>
        <property name="exportParameters" ref="pngExportParameters"/>
        <property name="currentExporter" ref="reportASPngExporter"/>
    </bean>

    <!--PSD-->
    <bean id="reportASPsdExporter" class="com.aspose.imaging.jasperreports.export.psd.ASReportPsdExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="psdExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">Batch</value>
        </property>
    </bean>

    <bean id="psdASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="PSD - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="psdExportParams"/>
        <property name="exportParameters" ref="psdExportParameters"/>
        <property name="currentExporter" ref="reportASPsdExporter"/>
    </bean>

    <!--SVG-->
    <bean id="reportASSvgExporter" class="com.aspose.imaging.jasperreports.export.svg.ASReportSvgExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="svgExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">SinglePage</value>
        </property>
    </bean>

    <bean id="svgASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="SVG - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="svgExportParams"/>
        <property name="exportParameters" ref="svgExportParameters"/>
        <property name="currentExporter" ref="reportASSvgExporter"/>
    </bean>

    <!--TIFF-->
    <bean id="reportASTiffExporter" class="com.aspose.imaging.jasperreports.export.tiff.ASReportTiffExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="tiffExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">Multipage</value>
        </property>
    </bean>

    <bean id="tiffASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="TIFF - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="tiffExportParams"/>
        <property name="exportParameters" ref="tiffExportParameters"/>
        <property name="currentExporter" ref="reportASTiffExporter"/>
    </bean>

    <!--WEBP-->
    <bean id="reportASWebpExporter" class="com.aspose.imaging.jasperreports.export.webp.ASReportWebpExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="webpExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">Batch</value>
        </property>
    </bean>

    <bean id="webpASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="WEBP - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="webpExportParams"/>
        <property name="exportParameters" ref="webpExportParameters"/>
        <property name="currentExporter" ref="reportASWebpExporter"/>
    </bean>

    <!--WMF-->
    <bean id="reportASWmfExporter" class="com.aspose.imaging.jasperreports.export.wmf.ASReportWmfExporter"
          parent="baseReportExporter">
        <property name="exportParameters" ref="wmfExportParameters"/>
        <property name="exportMode">
            <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">SinglePage</value>
        </property>
    </bean>

    <bean id="wmfASExporterParameters" class="com.jaspersoft.jasperserver.war.action.ExporterConfigurationBean">
        <property name="descriptionKey" value="WMF - Image export from Aspose.Imaging"/>
        <property name="parameterDialogName" value="wmfExportParams"/>
        <property name="exportParameters" ref="wmfExportParameters"/>
        <property name="currentExporter" ref="reportASWmfExporter"/>
    </bean>

To change the mode of the export use property with name “exportMode” and put the value according to the desired mode. For example:

    <property name="exportMode">
        <value type="com.aspose.imaging.jasperreports.export.common.ExportMode">SinglePage</value>
    </property>

You can change the value of the property to Batch, SinglePage or Multipage using com.aspose.imaging.jasperreports.export.common.ExportMode enum type.

Locate the <util:map id=“exporterConfigMap”> element in the %INTALL_DIR%\apache-tomcat\webapps\jasperserver\WEB-INF\flows\viewReportBeans.xml file and add the following lines:

    <util:map id="exporterConfigMap">
        <!-- comment/uncomment any of the lines below if you want related exporters 
        	 to be excluded/included in the viewer's exporters list
        	 Note: separate configuration for iPad 'exportersSupportedByiPad'
        	 -->
        	 
        <entry key="pdf" value-ref="pdfExporterConfiguration"/>
        <entry key="xls" value-ref="xlsExporterConfiguration"/>
        <entry key="xlsNoPag" value-ref="xlsNoPaginationExporterConfiguration"/>
        <entry key="csv" value-ref="csvExporterConfiguration"/>
        <entry key="docx" value-ref="docxExporterConfiguration"/>
        <entry key="rtf" value-ref="rtfExporterConfiguration"/>
        <entry key="odt" value-ref="odtExporterConfiguration"/>
        <entry key="ods" value-ref="odsExporterConfiguration"/>
        <entry key="xlsx" value-ref="xlsxExporterConfiguration"/>
        <entry key="xlsxNoPag" value-ref="xlsxNoPaginationExporterConfiguration"/>
        <entry key="pptx" value-ref="pptxExporterConfiguration"/>
        <!-- 
        <entry key="txt" value-ref="txtExporterConfiguration"/>
        -->
		
			<!-- add this entries to exporterConfigMap -->
			<!-- Aspose.Imaging JasperReports START -->
		<entry key="as_jpg" value-ref="jpgASExporterParameters"/>
		<entry key="as_bmp" value-ref="bmpASExporterParameters"/>
		<entry key="as_dcm" value-ref="dcmASExporterParameters"/>
		<entry key="as_emf" value-ref="emfASExporterParameters"/>
		<entry key="as_gif" value-ref="gifASExporterParameters"/>
		<entry key="as_html" value-ref="htmlASExporterParameters"/>
		<entry key="as_jpg2000" value-ref="jpg2000ASExporterParameters"/>
		<entry key="as_pdf" value-ref="pdfASExporterParameters"/>
		<entry key="as_png" value-ref="pngASExporterParameters"/>
		<entry key="as_psd" value-ref="psdASExporterParameters"/>
		<entry key="as_svg" value-ref="svgASExporterParameters"/>
		<entry key="as_tiff" value-ref="tiffASExporterParameters"/>
		<entry key="as_webp" value-ref="webpASExporterParameters"/>
		<entry key="as_wmf" value-ref="wmfASExporterParameters"/>
		<!-- Aspose.Imaging for JasperReports END -->
    </util:map>

Copy aspose-imaging-jasperreports-20.9.jar to %INTALL_DIR%\apache-tomcat\webapps\jasperserver\WEB-INF\lib.

To use exporting features, update %INTALL_DIR%\apache-tomcat\webapps\jasperserver\WEB-INF\applicationContext.xml as below.

    <bean id="jpgExportParameters" class="com.aspose.imaging.jasperreports.export.jpg.ASJpegExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
	</bean>

	<bean id="bmpExportParameters" class="com.aspose.imaging.jasperreports.export.bmp.ASBmpExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
	</bean>

	<bean id="dcmExportParameters" class="com.aspose.imaging.jasperreports.export.dcm.ASDcmExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
	</bean>

	<bean id="emfExportParameters" class="com.aspose.imaging.jasperreports.export.emf.ASEmfExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
	</bean>

	<bean id="gifExportParameters" class="com.aspose.imaging.jasperreports.export.gif.ASGifExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
	</bean>

	<bean id="htmlExportParameters" class="com.aspose.imaging.jasperreports.export.html.ASHtml5CanvasExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
	</bean>

	<bean id="jpg2000ExportParameters" class="com.aspose.imaging.jasperreports.export.jpg2000.ASJpeg2000ExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
	</bean>

	<bean id="pdfASExportParameters" class="com.aspose.imaging.jasperreports.export.pdf.ASPdfExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
	</bean>

	<bean id="pngExportParameters" class="com.aspose.imaging.jasperreports.export.png.ASPngExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
	</bean>

	<bean id="psdExportParameters" class="com.aspose.imaging.jasperreports.export.psd.ASPsdExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
	</bean>

	<bean id="svgExportParameters" class="com.aspose.imaging.jasperreports.export.svg.ASSvgExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
    </bean>

	<bean id="tiffExportParameters" class="com.aspose.imaging.jasperreports.export.tiff.ASTiffExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
	</bean>

	<bean id="webpExportParameters" class="com.aspose.imaging.jasperreports.export.webp.ASWebpExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
	</bean>

	<bean id="wmfExportParameters" class="com.aspose.imaging.jasperreports.export.wmf.ASWmfExportParametersBean">
	<!--        Uncomment and modify to apply a license. Check the license path.
	<property name="license" value="C:/Aspose.Imaging.JasperReports.lic"/>
	-->
    </bean>

Restart JasperReports Server and open any report to view. If the previous steps were performed properly, you will see additional choices in the list of export formats.

todo:image_alt_text

If you do not see additional formats (icons or choices), please check log files in \apache-tomcat\logs directory.

Introduction Demos Setup