Package com.inductiveautomation.reporting.gateway

Class ReportingGatewayHook.RPC

java.lang.Object

com.inductiveautomation.reporting.gateway.ReportingGatewayHook.RPC

All Implemented Interfaces:

ReportRpc, ReportScriptingFunctions

Enclosing class:

ReportingGatewayHook

public class ReportingGatewayHook.RPC
extends java.lang.Object
implements ReportRpc, ReportScriptingFunctions

Constructor Summary

Constructors

Constructor	Description
RPC()

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	execute(java.lang.String projectName, byte[] reportResourceBytes, byte[] reportScheduleBytes, AbstractReportActionConfig actionConfig, java.lang.String reportName, java.lang.String reportPath)
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 project)
long	getLastExecutionDuration(java.lang.String projectName, java.lang.String reportPath)
java.util.Date	getLastRun(java.lang.String projectName, java.lang.String reportPath)
java.util.Date	getLastScheduledRun(java.lang.String projectName, java.lang.String reportPath)
ReportExecutionData	getReportData(java.lang.String projectName, java.lang.String reportPath, ReportDataConfiguration dataConfig, java.util.Map<java.lang.String,java.lang.Object> parameters, java.util.Map<java.lang.String,java.lang.Object> extraConfig, boolean sampleData)
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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RPC

public RPC()

Method Detail

getReportData

public ReportExecutionData getReportData(java.lang.String projectName,
                                         java.lang.String reportPath,
                                         ReportDataConfiguration dataConfig,
                                         java.util.Map<java.lang.String,java.lang.Object> parameters,
                                         java.util.Map<java.lang.String,java.lang.Object> extraConfig,
                                         boolean sampleData)
                                  throws java.lang.Exception

Specified by:

getReportData in interface ReportRpc

Throws:

java.lang.Exception

execute

public java.util.List<java.lang.String> execute(java.lang.String projectName,
                                                byte[] reportResourceBytes,
                                                byte[] reportScheduleBytes,
                                                AbstractReportActionConfig actionConfig,
                                                java.lang.String reportName,
                                                java.lang.String reportPath)
                                         throws java.lang.Exception

Specified by:

execute in interface ReportRpc

Throws:

java.lang.Exception

getLastRun

public java.util.Date getLastRun(java.lang.String projectName,
                                 java.lang.String reportPath)

Specified by:

getLastRun in interface ReportRpc

getLastScheduledRun

public java.util.Date getLastScheduledRun(java.lang.String projectName,
                                          java.lang.String reportPath)

Specified by:

getLastScheduledRun in interface ReportRpc

getLastExecutionDuration

public long getLastExecutionDuration(java.lang.String projectName,
                                     java.lang.String reportPath)

Specified by:

getLastExecutionDuration in interface ReportRpc

executeReport

public byte[] executeReport(java.lang.String path,
                            java.lang.String fileType,
                            org.python.core.PyDictionary arguments,
                            java.lang.String project)
                     throws java.lang.Exception

Specified by:

executeReport in interface ReportScriptingFunctions

Throws:

java.lang.Exception

executeAndDistribute

public 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

Specified by:

executeAndDistribute in interface ReportScriptingFunctions

Throws:

java.lang.Exception

getReportNamesAsDataset

public Dataset getReportNamesAsDataset(java.lang.String projectName)
                                throws java.lang.Exception

Specified by:

getReportNamesAsDataset in interface ReportScriptingFunctions

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 interface ReportScriptingFunctions

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 interface ReportScriptingFunctions

Throws:

java.lang.Exception