Skip to main content
Version: 7.9

system.report.getReportNamesAsDataset

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​

note

This function accepts keyword arguments.

system.report.getReportNamesAsDataset(project)

Parameters​

TypeParameterDescription
StringprojectThe name of the project where the reports are located. Optional in Client scope.

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​

All

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()