GenerateReport
Description:
Sends a report to a printer, exports it as a file, or sends it to the SMTP server for processing by an email client.
Input Properties
reportid
Description:
Identifier of the report as registered in LabVantage.
Required:
Yes, unless you are regerating a report using a ReportEventID.
reportversionid
Description:
Version number of the Report SDI.
Required:
Yes, unless you are regenerating a report using a ReportEventID
reporteventid
Description:
Identifier of a Report Event.
Required:
No, unless you are regenerating a report that has report event tracking enabled.
Comments:
If you want to regenerate a report event, you must pass the ReportEventID instead of ReportID.
addressid
Description:
Identifier of an Address SDI that specifies the target printer.
Required:
See Comments.
Comments:
If you want to send the report to a printer, you must enter the identifier of an Address SDI that specifies the target printer. In this case, you must also specify an addresstype.
addresstype
Description:
Address Type for the SDI identified by addressid.
Required:
Only if you specify an addressid.
destination
Description:
Target printer, service, or file. Possible values:
  • printer (default) = Sends the report to the printer defined by the addressid and addresstype.
  • email = Sends the report to your SMTP server with details specified by emailfrom, emailtolist, emailcclist, emailsubject, and emailmessage.
  • file = Exports the report as a file defined by the filename and filetype.
Required:
No (will apply the default if no value specified).
filetype
Description:
Format of the file specified by the File Name: PDF, XLS, or HTML.
Required:
Only if you specify a filename.
filename
Description:
Name of the file that is created to contain the report. When the destination is a TempFile, the path here is ignored; only the filename and extension are required.
Required:
Only if the destination is file.
debuglog
Description:
Determines whether or not (Y/N) the Action outputs debug messages. This is useful when tracing is off.
Required:
No
emailfrom
Description:
Email addresses to which the recipient can reply.
Required:
Only if the destination is email.
emailtolist
Description:
Email addresses to which the report is sent. Accepts multiple email addresses separated by a semicolon.
Required:
Only if the destination is email.
emailcclist
Description:
List of recipients copied on the email. Accepts multiple email addresses separated by a semicolon.
Required:
No
emailsubject
Description:
Email "Subject" (text description of email).
Required:
No
emailmessage
Description:
Body of the email message.
Required:
No
param1
Description:
First argument specified in the report.
Required:
No
Comments:
Use param1, param2, and param3 if your report expects parameters to be passed in. Set the value for each parameter so that the report can execute its query and return the expected results. Each parameter (argument) you specify must already be in the report, and you must specify them here in the same order as they appear in the report.
You can specify up to 10 parameters (arguments). This API starts you off with three (param1 through param3). You can add the additional parameters (arguments) by adding properties named param4 through param10.
param2
Description:
Second argument specified in the report.
Required:
No
param3
Description:
Third argument specified in the report.
Required:
No
reportlanguage
Description:
Language to which report content will be translated. Must be a match to a language identifier in LabVantage.
Required:
Only if you need the output to be translated into a specific language.
reporttimezone
Description:
Timezone to which the report's date-time data will be converted.
Required:
Only when the reader expects the report's dates and times to be presented in a specified timezone.
reportaddressid
Description:
Identifier of an Address SDI as registered in LabVantage.
Required:
No
Comments:
If no value is supplied, the 'Global' address ID is used.
By specifiying a value, you can change the origination address and logo used on a Jasper report. The logo is typically positioned in the top left of the report header. The report's origination address is read from the database.
Additional Information
Additional information concerning this Action:
When a property has a fixed set of possible values, you can code your calls to this action by setting properties.
In Java, the setProperty method uses (String key,String value). For example, you could write:
props.setProperty( PROPERTY_DESTINATION, "file" )
or, you could write:
props.setProperty( PROPERTY_DESTINATION, DESTINATION_FILE )
...which also sets the String value to "file".
Copyright © 1999-2025 LabVantage Solutions, Inc.