Class GatewayScriptingFunctions
- java.lang.Object
-
- com.inductiveautomation.reporting.gateway.scripting.GatewayScriptingFunctions
-
- All Implemented Interfaces:
ReportScriptingFunctions
public class GatewayScriptingFunctions extends java.lang.Object implements ReportScriptingFunctions
-
-
Constructor Summary
Constructors Constructor Description GatewayScriptingFunctions(GatewayContext context)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
executeAndDistribute(java.lang.String reportPath, org.python.core.PyDictionary pyParameters, java.lang.String projectName, java.lang.String action, org.python.core.PyDictionary actionSettings)
byte[]
executeReport(java.lang.String reportPath, java.lang.String fileType, org.python.core.PyDictionary pyParameters, 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)
-
-
-
Constructor Detail
-
GatewayScriptingFunctions
public GatewayScriptingFunctions(GatewayContext context)
-
-
Method Detail
-
executeReport
public byte[] executeReport(java.lang.String reportPath, java.lang.String fileType, org.python.core.PyDictionary pyParameters, java.lang.String projectName) throws java.lang.Exception
- Specified by:
executeReport
in interfaceReportScriptingFunctions
- Throws:
java.lang.Exception
-
executeAndDistribute
public void executeAndDistribute(java.lang.String reportPath, org.python.core.PyDictionary pyParameters, java.lang.String projectName, java.lang.String action, org.python.core.PyDictionary actionSettings) throws java.lang.Exception
- Specified by:
executeAndDistribute
in interfaceReportScriptingFunctions
- Throws:
java.lang.Exception
-
getReportNamesAsDataset
public Dataset getReportNamesAsDataset(java.lang.String projectName) throws java.lang.Exception
- Specified by:
getReportNamesAsDataset
in interfaceReportScriptingFunctions
- Throws:
java.lang.Exception
-
getReportNamesAsDataset
public Dataset getReportNamesAsDataset(java.lang.String projectName, boolean includeReportName) throws java.lang.Exception
Description copied from interface:ReportScriptingFunctions
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.- Specified by:
getReportNamesAsDataset
in interfaceReportScriptingFunctions
- 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
public java.util.List<java.lang.String> getReportNamesAsList(java.lang.String projectName) throws java.lang.Exception
- Specified by:
getReportNamesAsList
in interfaceReportScriptingFunctions
- Throws:
java.lang.Exception
-
-