Simple Excel Plug-in¶
This plug-in expects a flat xml stream as input and returns an xml document as an OutputStream. The resulting document can be opened using excel and contains all available data in the report as a flat structure. No formatting is applied.
Note: We recommend this plug-in only for reports with lots of data as it works on streams and is reasonably quick and uses less memory. For more elaborate layout designs the excel-plug-in should be used instead.
Report Plug-in Layout¶
Layout properties¶
Required layout properties for the Excel plug-in:
| Name | Value |
|---|---|
| plugin-type | S-EXCEL |
| plugin-class | ifs.application.reportingservices.impl.extendedformatter.excelplugin.SimpleExcelPlugin |
| output-extension | xml |
| flattened-xml:enabled | TRUE |
| flattened-xml:strongtyping | TRUE |
| flattened-xml | TRUE |
Plug-in properties¶
The plug-in properties are not case sensitive and can be in any order, if they are not included in the rpl file the default values will be used.
| Name | Type | Default value | Description |
|---|---|---|---|
| use-display-names | YES/NO | YES | Whether or not to use display names as column names for the first row. |
| include-columns | LIST (,) | <empty> | A list of column names. Only columns in this list will be added to the Excel sheet. |
| exclude-columns | LIST (,) | <empty> | A list of column names. None of the columns in this list will be added to the Excel sheet. Can not be used in combination with include-columns. |
Plug-in data¶
This plug-in does not use the data tag of the report plug-in layout.
Plug-in variables¶
This plug-in does not use the variable tag of the report plug-in layout.
Example¶
The following example can be installed on any report. Make sure to update the <report-id> and <report-title> to match your needs.
<?xml version="1.0" encoding="UTF-8"?> <report-layout> <properties> <version>8.0</version> <layout-type>S-EXCEL</layout-type> <!--SCRIPT,XSL,XML,EXCEL,S-EXCEL--> <plugin-class>ifs.application.reportingservices.impl.extendedformatter.excelplugin.SimpleExcelPlugin</plugin-class> <output-method>E-MAIL</output-method> <!-- BINARY,FILE,E-MAIL this can be more that one value separated by ; --> <output-name></output-name> <!-- This will default to "ReportId"_"ResultKey" if left empty. <output-extension>xml</output-extension> <!-- The file name and attachment name will be a concatenation of <output-name> and <output-extension>. <default-output-reference> <e-mail></e-mail> <!-- if left empty, it will use the email adress in the print dialog or if not defined it will use the sender address instead (send to yourself). Make sure each user has his own email adress set correctly. --> <e-mail-sender></e-mail-sender> <e-mail-cc></e-mail-cc> <e-mail-subject>Excel report [#ReportTitle] is ready.</e-mail-subject> <e-mail-body><![CDATA[Printjob: [#PrintJobId] has finished executing. Excel report attached.]]></e-mail-body> <file></file> <!-- Deprecaded! Used only for FILE output method. It sets the file name for the output file. --> <file-sender></file-sender> <!-- File Sender name configured in solution manager --> <binary></binary> </default-output-reference> <full-xml>TRUE</full-xml> <flattened-xml> <enabled>TRUE</enabled> <strongtyping>TRUE</strongtyping> <full-xsd-column-set>OFF</full-xsd-column-set> </flattened-xml> <report-id>ORDER_QUOTATION_REP,CUSTOMER_AGE_REP</report-id> <!-- For which reports should IFS installer register this layout. --> <report-title>Operational Excel Report</report-title> <!-- Title used when installed via IFS Installer --> </properties> <plugin> <properties> <use-display-names>ON</use-display-names> <include-columns></include-columns> <exclude-columns></exclude-columns> </properties> <data> <!-- not used by this plugin --> </data> <variables> <!-- not used by this plugin --> </variables> </plugin> </report-layout>