Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

Description

Uses the Pentaho Reporting Engine to generate a report given a report specification and report input data.

...

Report Specification - The file that contains the Pentaho Report definition. The definition file may be either a JFreeReport definition or a Pentaho Report Design Wizard specification.

  • JDBC - Connect using a standard JDBC connection. The following inputs must also be provided.
    • JDBC Drive - Name of the JDBC driver class to use when connecting to the database.
    • Database URL - The database connection URL.
    • User Name - The username to use when connecting to the database.
    • Password - The password to use when connecting to the database.
  • JNDI - Connect using the specified JNDI name.
  • Shared - Connect to the database using the named shared connection. See the Shared Relational Connection action for further details

Result Set Type - Specifies the type of result set to use when returnin the query results. The options are:

  • Live Result - The query results are fetched from the dabase server on an as needed basis using a data set cursor. This is the preferred option when the data sets being returned are expected to be very large. Performance is slower but memory usage is reduced.
  • In-Memory Result Set - The query results are returned in their entirety from the database server and cached on the BI server.

Query - The SQL query to be executed.

Run Query - Determines when the query is to be executed. The options are:

  • Immediately - The query is run immediately by the Pentaho BI server.
  • From Pentaho Subreport - The query is prepared for execution, with the intention of being run later in the action sequence by a subreport within a JFree Report. See the JFree Report action for further details.

Result Set Columns - The names of each of the columns in the resulting data set. The names must be entered in the order in which they will appear in the data set. The column names need to be provide only if a column will be referenced by name within the action sequence.

Result Set Name - The name of the resulting output dataset. Following actions can refer to the data set using this nameReport Data - The data to be used when generating the report. This is only used when a JFreeReport definition is used. This is because Pentaho Design Wizard specifications have the data queries emedded within them.

Report Parameters - Action sequence parameters that are passed on to the reporting engine for use in generating the Pentaho Report. The report definition should reference these same parameters by name.

Subreport Data/Queries - The data sets or prepared queries referenced by subreports appearing in the report definition. Any queries used should be tagged for execution by the Pentaho Report engine (Refer to the various query actions for more details).

Report Format - The output report format.

Output Report Name - The name of the output parameter that will contain the generated report.