Interface 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
executeAndDistribute(java.lang.String path, org.python.core.PyDictionary parameters, java.lang.String projectName, java.lang.String action, org.python.core.PyDictionary actionSettings)
byte[]
executeReport(java.lang.String path, java.lang.String fileType, org.python.core.PyDictionary arguments, java.lang.String projectName)
Dataset
getReportNamesAsDataset(java.lang.String projectName)
Dataset
getReportNamesAsDataset(java.lang.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.java.util.List<java.lang.String>
getReportNamesAsList(java.lang.String projectName)
-
-
-
Method Detail
-
executeReport
byte[] executeReport(java.lang.String path, java.lang.String fileType, org.python.core.PyDictionary arguments, java.lang.String projectName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
executeAndDistribute
void executeAndDistribute(java.lang.String path, org.python.core.PyDictionary parameters, java.lang.String projectName, java.lang.String action, org.python.core.PyDictionary actionSettings) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getReportNamesAsDataset
Dataset getReportNamesAsDataset(java.lang.String projectName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getReportNamesAsDataset
Dataset getReportNamesAsDataset(java.lang.String projectName, boolean includeReportName) throws java.lang.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:
java.lang.Exception
-
getReportNamesAsList
java.util.List<java.lang.String> getReportNamesAsList(java.lang.String projectName) throws java.lang.Exception
- Throws:
java.lang.Exception
-
-