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


Panel
titleClient Permission Restrictions

This scripting function has no Client Permission 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 as of 8.0.5.

  • Returns

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

  • 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




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