You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.

This function is used in Python Scripting.

Description

Gets a list of all reports for a project.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

This function accepts keyword arguments.

system.report.getReportNamesAsList(project)

  • Parameters

String project - The name of the project where the reports are located. Optional in client scope. Optional in session scope as of 8.0.5.

  • Returns

List - A list of report paths for the project. Returns an empty list if the project has no reports.

  • Throws

IllegalArgumentException - Thrown when any of the following occurs: If the project name is omitted in the Gateway scope, project does not exist.

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code Snippet
# Gets a list of reports for the current project and prints it
reports = system.report.getReportNamesAsList()
for report in reports:
    print report

"""Output from the above example looks like the following:
Comparisons
Line Reports/Line 1/Defect rates
Line Reports/Line 1/Production
Line Reports/Line 2/Defect Rates
"""
Keywords

system report getReportNamesAsList, report.getReportNamesAsList

  • No labels