Package com.inductiveautomation.reporting.gateway.scripting

Class GatewayScriptingFunctions

java.lang.Object

com.inductiveautomation.reporting.gateway.scripting.GatewayScriptingFunctions

All Implemented Interfaces:

ReportScriptingFunctions

public class GatewayScriptingFunctions
extends Object
implements ReportScriptingFunctions

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.reporting.common.scripting.ReportScriptingFunctions

ReportScriptingFunctions.ReportNameInfo

Field Summary

Fields inherited from interface com.inductiveautomation.reporting.common.scripting.ReportScriptingFunctions

SERIALIZER

Constructor Summary

Constructors

Constructor	Description
GatewayScriptingFunctions(GatewayContext context)

Method Summary

Modifier and Type	Method	Description
void	executeAndDistribute(String reportPath, org.python.core.PyDictionary pyParameters, String projectName, String action, org.python.core.PyDictionary actionSettings)	Executes a report and distributes it using the specified action.
byte[]	executeReport(String reportPath, String fileType, org.python.core.PyDictionary pyParameters, String projectName)	Executes a report and returns the result as a byte array.
List<ReportScriptingFunctions.ReportNameInfo>	getReportNames(String projectName)	Retrieves a list of report names for a project.

Methods inherited from class java.lang.Object

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

Constructor Details

GatewayScriptingFunctions

public GatewayScriptingFunctions(GatewayContext context)

Method Details

executeReport

public byte[] executeReport(String reportPath,
 String fileType,
 org.python.core.PyDictionary pyParameters,
 String projectName)
                     throws Exception

Description copied from interface: ReportScriptingFunctions

Executes a report and returns the result as a byte array.

Specified by:

executeReport in interface ReportScriptingFunctions

Parameters:

reportPath - The path to the report.

fileType - The format of the report (e.g., 'pdf', 'html', 'csv').

pyParameters - Parameters to pass to the report.

projectName - The name of the project.

Returns:

The executed report as a byte array.

Throws:

Exception - if execution fails.

executeAndDistribute

public void executeAndDistribute(String reportPath,
 org.python.core.PyDictionary pyParameters,
 String projectName,
 String action,
 org.python.core.PyDictionary actionSettings)
                          throws Exception

Description copied from interface: ReportScriptingFunctions

Executes a report and distributes it using the specified action.

Specified by:

executeAndDistribute in interface ReportScriptingFunctions

Parameters:

reportPath - The path to the report.

pyParameters - Parameters to pass to the report.

projectName - The name of the project.

action - The name of the distribution action (e.g., 'email', 'print', 'save').

actionSettings - Settings for the distribution action.

Throws:

Exception - if execution or distribution fails.

getReportNames

public List<ReportScriptingFunctions.ReportNameInfo> getReportNames(String projectName)
                                                             throws Exception

Description copied from interface: ReportScriptingFunctions

Retrieves a list of report names for a project.

Specified by:

getReportNames in interface ReportScriptingFunctions

Parameters:

projectName - The name of the project.

Returns:

A list of report name information.

Throws:

Exception - if retrieval fails.