How to add TXT exporter to scheduler output options - TIBCO JasperReports® Server v6.0.1 and newer

Use case

By default there is no TXT explorer available for Scheduler in TIBCO JasperReports^® Server.

This artcile describes steps to add this exporter in TIBCO JasperReports Server v6.0.1 and newer.

For older versions refer to this article: http://community.jaspersoft.com/wiki/how-enable-plain-text-exporter-reportadhoc-view-or-configure-list-existing-exporters

Solution

1. The general steps to add a new exporter for scheduler are listed in TIBCO JasperReports Server Ultimate Guide in section 'Adding the Export Format to the Scheduler': 

   http://community.jaspersoft.com/documentation/tibco-jasperreports-server-ultimate-guide/v630/adding-custom-export-channels

   However since all the classes for the TXT exporter are already implemented on the server, you can follow the guidelines in this section starting from step 4.

2. In addition you will need to modify a javascript file to have the TXT format displayed on the UI. This file is located under the deployed jasperserver-pro folder in jasperserver-proscriptsbower_componentsjrs-uisrcschedulervieweditoroutputTabView.js 

   The exporter should be added in the following section:

   availableFormats: [{ name: 'csv',        num:  5 },
                      { name: 'html',       num:  2 }, 
                      { name: 'rtf',        num:  4 },
                      { name: 'docx',       num:  8 },
                      { name: 'ods',        num:  9 },
                      { name: 'xlsx.nopag', num: 12 },
                      { name: 'xls',        num:  3 },
                      { name: 'odt',        num:  6 },
                      { name: 'xlsx',       num: 10 },
                      { name: 'xls.nopag',  num: 11 },
                      { name: 'pdf',        num:  1 },
                      { name: 'pptx',       num: 14 }],

   For example:

   availableFormats: [{ name: 'txt',        num:  7 },
                      { name: 'csv',        num:  5 },
                      { name: 'html',       num:  2 },
                      { name: 'rtf',        num:  4 },
                      { name: 'docx',       num:  8 },
                      { name: 'ods',        num:  9 },
                      { name: 'xlsx.nopag', num: 12 },
                      { name: 'xls',        num:  3 },
                      { name: 'odt',        num:  6 },
                      { name: 'xlsx',       num: 10 },
                      { name: 'xls.nopag',  num: 11 },
                      { name: 'pdf',        num:  1 },
                      { name: 'pptx',       num: 14 }],
   

To view these changes you'll also have to disable the optimized scripts in WEB-INF/js.config.properties by setting "javascript.optimize" property to false. Save the file and restart the server.

This should add the exporter to scheduler, but this way TIBCO JasperReports Server will run on a non-optimized scripts. To optimize the scripts you'll have to follow the steps from the following section of TIBCO JasperReports Server Ultimate Guide: 

http://community.jaspersoft.com/documentation/tibco-jasperreports-server-ultimate-guide/v630/customizing-javascript-files

Ref. case #01461059