Versions Compared

Key

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


Panel
titleDescription

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 permissions restrictions


Panel
titleSyntax
Info

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.

  • Returns

Dataset - A dataset of report paths and names for the project. Return columns are Path, Text, and SelectedText. Returns an empty dataset if the project has no reports.

  • Scope

Gateway, Vision Client, Perspective Session

Editor_notes

On 8.1.5 release, replace the syntax panel above with the new panel below 

Panel
titleSyntax
Info

This function accepts keyword arguments.

system.report.getReportNamesAsDataset (

[ project], [includeReportName])

  • Parameters

String project - The name of the project where the reports are located. Optional in Client scope. Optional in Session scope.


New_in
Version8.1.5


Boolean includeReportName - 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. Return columns are Path, Text, and SelectedText. Returns an empty dataset if the project has no reports.

  • Scope

Gateway, Vision Client, Perspective Session


Panel
titleCode Examples
Code Block
languagepy
titleCode 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()
Panel
titleKeywords

system report getReportNamesAsDataset, report.getReportNamesAsDataset