Hitachi Vantara Pentaho Community Wiki
Child pages
  • 10. Configuration
Skip to end of metadata
Go to start of metadata

Description

The following describes the property settings available.

CSV default separator

Defines the default separator, that should be used for the output.

<configuration>
 <property name="org.jfree.report.modules.output.table.csv.Separator">,</property>
</configuration>

CSV write column name into first row

Defines whether to write the column names of the data row into the first row.

<configuration>
 <property name="org.jfree.report.modules.output.csv.WriteDatarowNames">true</property>
</configuration>

Excel output set paper size

Defines the Paper that should be used in the excel print setup. If no paper is defined, a suitable paper will be selected automatically.

<configuration>
 <property name=" org.jfree.report.modules.output.table.xls.Paper">LETTER</property>
</configuration>

Excel output set paper orientation

Defines the Paper that should be used in the excel print setup. If no paper is defined, an suitable paper will be selected automatically. Valid values are "Landscape" or "Portrait"

<configuration>
 <property name="org.jfree.report.modules.output.table.xls.PaperOrientation">LETTER</property>
</configuration>

HTML encoding

Defines the encoding for the HTML.

<configuration>
 <property name="org.jfree.report.modules.output.table.html.Encoding">UTF-8</property>
</configuration>

HTML body fragment only

Defines whether to define a body fragment only. This removes the header and body tags and makes it easy to include the generated content in own pages.

<configuration>
 <property name="org.jfree.report.modules.output.table.html.BodyFragment">false</property>
</configuration>

HTML, XHTML 1.0 or HTML 4.0 format

Defines whether to generate XHTML1.0 or HTML4.0 content.

<configuration>
 <property name="org.jfree.report.modules.output.table.html.GenerateXHTML">false</property>
</configuration>

HTML default title

Defines the default title for generated HTML documents.

<configuration>
 <property name="org.jfree.report.modules.output.table.html.Title">My First Report</property>
</configuration>

HTML set author

Defines a author for generated HTML documents.

<configuration>
 <property name="org.jfree.report.modules.output.table.html.Author">Shakespeare</property>
</configuration>

HTML set empty cells to use CSS

Defines, whether empty cells will be controlled using CSS. If this is set to true, the Table gets the style property "empty-cells: show" assigned and the otherwise required no-break-space entities will no longer be generated.

The Internet Explorer is not able to use correct CSS2 yet. Thus, the default is set to "false".
This is a local configuration setting an can be enabled in the report.

<configuration>
 <property name="org.jfree.report.modules.output.table.html.EmptyCellsUseCSS">false</property>
</configuration>

HTML image size in Points or Pixels

Defines, whether image sizes should be given in device independent Point unit (1/72 inch) or in pixels (which is device dependent and makes it hard to predict the final size in the HTML-Page.

The default is pixels, false.

<configuration>
 <property name="org.jfree.report.modules.output.table.html.UseDeviceIndependentImageSize">false</property>
</configuration>

HTML table carrier a border definition

Defines, whether table rows should carry a border definition (in addition to the cell definitions). This is a workaround for a layout bug in the Mozilla browser family.

<configuration>
 <property name="org.jfree.report.modules.output.table.html.TableRowBorderDefinition">false</property>
</configuration>

HTML Table, use proportional column widths

Enables the use of proportional column widths instead of static ones. The resulting table will have a width of 100% and the columns will have the proportional equivalent of their static widths as width.

<configuration>
 <property name="org.jfree.report.modules.output.table.html.ProportionalColumnWidths">false</property>
</configuration>

PDF set author

The author string of the document.

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.Author">Larry Augustin</property>
</configuration>

PDF set title

The title of the document.

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.Title">Sales Report</property>
</configuration>

PDF encoding

Defines PDF encoding for report.

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.Encoding">Cp1252</property>
</configuration>

PDF embed fonts

Defines whether to embed fonts in the generated PDF. This will result in larger PDF files, but makes sure that all characters are displayed properly.

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.EmbedFonts">Cp1252</property>
</configuration>

PDF version

The PDF Version that should be created. Valid values are "1.2", "1.3","1.4" or "1.5"

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.Version">1.4</property>
</configuration>

PDF Security, Allow Copy

Defines, whether the PDF Security setting allows copying of the document's
contents by default. PDF Security flags are only used with security enabled and a password set.

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.AllowCopy">false</property>
</configuration>

PDF Security, Allow Printing

Defines, whether the PDF Security setting allows printing of the document's
contents by default

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.AllowPrinting">false</property>
</configuration>

PDF Security, Allow Modifying Contents

Defines, whether the PDF Security setting allows modifying of the document by default.

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.AllowModifyContents">false</property>
</configuration>

PDF Security, Allow Modifying Annotations

Defines, whether the PDF Security setting allows document annotations by default.

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.AllowModifyAnnotations">false</property>
</configuration>

PDF Security, Allow Fill-in of Document Forms

Defines, whether the PDF Security setting allows the fill-in of document forms (input fields etc).

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.AllowFillIn">false</property>
</configuration>

PDF Security, Allow access for screenreaders

Defines, whether the PDF Security setting allows access for screen readers by default. Although this could make it easier to grab the contents your PDF document, enabling this property will allow blind people to access your content. It is usually a good idea to always enable this property.

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.AllowScreenReaders">false</property>
</configuration>

PDF Security, Allows reassembly of document

Defines, whether the PDF Security setting allows reassembly of the document by default.

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.AllowAssembly">false</property>
</configuration>

PDF Security, Allow low quality printing

Defines, whether the PDF Security setting allows low quality printing of the document's contents by default.

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.AllowDegradedPrinting">false</property>
</configuration>

PDF Security, Encrypt

Defines whether the PDF file should be encrypted by default. Set this to "none" "40bit" or "128bit". Access restrictions have no effect if the document is not encrypted, and not all security settings are active on 40-Bit encryption.

No encryption

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.Encryption">none</property>
</configuration>

40 bit encryption

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.Encryption">40bit</property>
</configuration>

128 bit encryption

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.Encryption">128bit</property>
</configuration>

Specifying passwords in the property file can introduce a security risk. Do not use these settings on the client side or in unprotected (world-readable) server environments. In these cases use other means of defining the password.

PDF Security, Password

The default user password for the document. Users are able to access the document within the defined security restrictions.

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.UserPassword">password</property>
</configuration>

PDF Security, Owner

The default owner password for the document. The owner has all permissions on the document and will be able to change the security settings.

<configuration>
 <property name="org.jfree.report.modules.output.pageable.pdf.OwnerPassword">password</property>
</configuration>
  • No labels