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 data of all reports for a project. This dataset is particularly suited for display in a Tree View component

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

This function accepts keyword arguments.

system.report.getReportNamesAsDataset(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

Dataset - A dataset of report paths and names for the project. Returns an empty dataset 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 dataset of reports for the current project and displays
# them in a Tree View component.

event.source.parent.getComponent('Tree View').data = system.report.getReportNamesAsDataset()
Keywords

system report getReportNamesAsDataset, report.getReportNamesAsDataset

  • No labels