Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.

Description

Immediately executes an existing report and returns a List[Byte] of the output. Throws an IllegalArgumentException when any of the following occurs: If the file type is not recognized, path does not exist, project does not exist.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

This function accepts keyword arguments.

system.report.executeReport(path, project, [parameters], fileType)

  • Parameters

String path - The path to the existing report.

String project - The name of the project where the report is located. Optional in Vision Client scope and Perspective Session scope.

Dictionary[String, Integer] parameters - A dictionary of parameter overrides, in the form name:value. [optional]

String fileType - The file type the resulting byte array should represent. Defaults to "pdf". Not case-sensitive.

  • Returns

List[Byte] - A byte array of the resulting report.

  • Scope

Gateway, Vision Client, Perspective Session

Values for the fileType Parameter

Acceptable values are:

  • pdf
  • html
  • csv
  • rtf
  • jpeg
  • png
  • xml
  • xls
  • xlsx

A Note on xls and xlsx Formats
The xls and xlsx format options may return less than pixel perfect results. This is due to how many spreadsheet programs interpret the resulting file. As a result, the pdf format is recommended in most cases. 

Code Examples
Code Snippet - Executing Report
# Executes the report, overriding two parameters.
overrides = {"myStringParam":"Hello world", "myIntParam":3}
bytesArray = system.report.executeReport(path="My Path", project="MyProject", parameters=overrides, fileType="pdf")
Keywords

system report executeReport, report.executeReport