Skip to main content
Version: 8.1

system.report.getReportNamesAsDataset

This function is used in Python Scripting.

Description

Gets a data of all reports for a project. Throws an IllegalArgumentException when any of the following occurs: If the project name is omitted in the Gateway scope, project does not exist.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

note

This function accepts keyword arguments.

system.report.getReportNamesAsDataset([ project], [includeReportName])

Parameters

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

BooleanincludeReportName
New in 8.1.5
When set to False, the end of Path does not include the report name. Default is True. [optional]

Returns

Dataset - A dataset of report paths and names for the project. Returns an empty dataset if the project has no reports.

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