Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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)

...