Skip to end of metadata
  • Created by Former user, last modified by Former user on Oct 30, 2010
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

ReportContentGenerator Parameter Reference

The following parameter names are used by the Mantle-Plugin and should not be used in a report for user-data (unless you know exactly what you are doing)

  • solution: The name of the current solution in the solution repository
  • path: The path within the solution repository
  • name: The name of the prpt within the repository
  • renderMode: one of
    • report: renders the report
    • xml: returns the parameter description document for the UI
    • subscribe: for managing subscriptions
    • download: Downloads the prpt file, if the user has the correct permissions
  • autoSubmit: Boolean -> true = autosubmit, false = manual submit, null: show checkbox
  • autoSubmitUI: boolean: the default value for the autosubmit checkbox (DEPRECATED: use a suitable report attribute instead or configure the global default in the configuration files)
  • ::TabActive defaults to FALSE. When set to TRUE, this opens the target report within a Pentaho User Console's report tab. 
  • ::TabName allows the user to assign a name to the report tab either using static text, data field, parameter or a function.
  • subscribe: Boolean
  • subscription-id
  • subscription-name
  • destination: used for subscription reports
  • output-target: Allows more fine-grained control over the output by specifying the output-target directly. One of:
    • table/html;page-mode=stream
    • table/html;page-mode=page
    • table/excel;page-mode=flow
    • table/csv;page-mode=stream
    • table/rtf;page-mode=flow
    • pageable/pdf
    • pageable/text
    • mime-message/text/html
  • dashboard-mode: Boolean
    if "true": If the export generates HTML, the report will generate a body-fragment (content without the HTML, HEAD and BODY tags and all styles inlined into "style" attributes), which is easy to include in dashboards or other HTML pages.
    This is the same result as if the report configuration property "org.pentaho.reporting.engine.classic.core.modules.output.table.html.BodyFragment" has been set to true.
  • accepted-page: Int, the name of the page that should be shown when in paginated-html-mode
  • print: Boolean
  • printer-name: The (optional) name of the printer
  • showParameters: boolean, disables the parameter ui completely
  • report-definition: InputStream, only usable in XActions
  • useContentRepository: Boolean, only usable in XActions
  • workbook: InputStream, only usable in XActions
  • res-url: If the report-definition stream has been given, then this defines the context-url for loading resources with relative paths. (only usable in XActions)

Deprecated properties

  • action: The name of the xaction within the repository (use name instead)
  • paginate: Boolean (DEPRECATED: use output-target parameter instead)
  • content-handler-pattern: when exporting to HTML, the name of the content handler servlet that sends images and css files to the browser. (DEPRECATED: configure that via a global configuration setting)
  • layout (BISERVER 3.6): vertical or flow (DEPRECATED: use report attribute instead)
  • ignoreDefaultDates: boolean (DEPRECATED: use configuration instead)
  • output-type: (DEPRECATED: use output-target parameter instead)
    The output type specified as mime-type. This provides a generic way to select the output-target and possibly requires additional parameters to work.
    • text/html
    • application/vnd.ms-excel
    • text/csv
    • application/rtf
    • application/pdf
    • text/plain
    • mime-message/text/html

in addition to that, the following deprecated output-types are supported, but will yield a warning everytime they are used. These output-types should no longer be used and support for them will be removed in a future version.

    • html
    • xls
    • csv
    • rtf
    • pdf
    • txt

How the output-target is selected by the simple-reporting-component

The algorithm to determine the output target from the given parameters is as follows:

  • If the report attribute "lock-preferred-output-type" is set, and the attribute preferred-output-type is set, the report will always be exported to the specified output type.
  • If the component has the parameter "output-target" set, this output target will be used.
  • If the component has the parameter "output-type" set, the mime-type will be translated into a suitable output target (depends on other parameters like paginate as well.
  • If neither output-target or output-type are specified, the report's preferred output type will be used.
  • If no preferred output type is set, we default to HTML export.

If the output type given is invalid, the report will not be executed and calls to
SimpleReportingComponent#getMimeType() will yield a generic "application/octet-stream" response.

Examples

To download a PRPT file from the server:

/content/reporting?renderMode=download&solution={0}&path={1}&name={2}

To run a report with the parameter-UI:

/content/reporting/reportviewer/report.html?solution={0}&path={1}&name={2}

To run a report without a Parameter-UI.

/content/reporting?renderMode=report&solution={0}&path={1}&name={2}&output-target{3}
/content/reporting?renderMode=report&solution={0}&path={1}&name={2}&output-type{3}

Note that all report-parameters must be specified in addition to the parameters here, as the report will not run if the report-parameter validation fails.

  • No labels