Versions Compared

Key

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


Scripting_function



Panel
titleDescription

Immediately executes an existing report and returns a byte[] of the output.


Panel
titleClient Permission Restrictions

This scripting function has no Client Permission restrictions.


Panel
titleSyntax


Info

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 client scope. Optional in session scope as of 8.0.5.

PyDictionary parameters - A optional dictionary of parameter overrides, in the form name:value.

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

  • Returns

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

  • Throws

IllegalArgumentException - Thrown when any of the following occurs: If the file type is not recognized, path does not exist, project does not exist.

  • Scope

Gateway, Vision Client, Perspective Session


Panel
titleValues for filetype and format

The following is a list of values for the actionSettings filetype and format keys.

  • pdf
  • html
  • csv
  • rtf
  • jpeg
  • png
  • xml
New_in
Version8.0.4


The following values for filetype were added in 8.0.4:

  • xls
  • xlsx



Panel
titleCode Examples


Code Block
languagepy
titleCode 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")




Panel
titleKeywords

system report executeReport, report.executeReport