ReportScriptingFunctions

All Known Implementing Classes:: ClientScriptingFunctions, GatewayScriptingFunctions, ReportingGatewayHook.RPC

public interface ReportScriptingFunctions

Filename: ReportScriptingFunctions.java Created on Mar 27, 2015 Author: Kathy Applebaum Copyright Inductive Automation 2015 Project: Reporting

Method Summary

Modifier and Type

Method

Description

void

executeAndDistribute(String path, org.python.core.PyDictionary parameters, String projectName, String action, org.python.core.PyDictionary actionSettings)

byte[]

executeReport(String path, String fileType, org.python.core.PyDictionary arguments, String projectName)

Dataset

getReportNamesAsDataset(String projectName)

Dataset

getReportNamesAsDataset(String projectName, boolean includeReportName)

In 7.x the end of the Path returned did not include the report name, but in 8.x it does.

List<String>

getReportNamesAsList(String projectName)

Method Details
- executeReport
  
  byte[] executeReport(String path, String fileType, org.python.core.PyDictionary arguments, String projectName) throws Exception
  
  Throws:
  
  Exception
- executeAndDistribute
  
  void executeAndDistribute(String path, org.python.core.PyDictionary parameters, String projectName, String action, org.python.core.PyDictionary actionSettings) throws Exception
  
  Throws:
  
  Exception
- getReportNamesAsDataset
  
  Dataset getReportNamesAsDataset(String projectName) throws Exception
  
  Throws:
  
  Exception
- getReportNamesAsDataset
  
  Dataset getReportNamesAsDataset(String projectName, boolean includeReportName) throws Exception
  
  In 7.x the end of the Path returned did not include the report name, but in 8.x it does. This lets users have either behavior.
  
  Parameters:
  
  projectName - Name of the project where the report is located. Optional in client.
  
  includeReportName - If true, the Path returned ends with the report name.
  
  Returns:
  
  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.
  
  Throws:
  
  Exception
- getReportNamesAsList
  
  List<String> getReportNamesAsList(String projectName) throws Exception
  
  Throws:
  
  Exception