Package com.inductiveautomation.reporting.common.scripting

Interface ReportScriptingFunctions

All Known Implementing Classes:

ClientScriptingFunctions, GatewayScriptingFunctions, ReportScriptingFunctionsImpl

public interface ReportScriptingFunctions

Scripting functions for the Reporting module.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ReportScriptingFunctions.ReportNameInfo	Information about a report.

Field Summary

Fields

Modifier and Type	Field	Description
static final ProtoRpcSerializer	SERIALIZER

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)	Executes a report and distributes it using the specified action.
byte[]	executeReport(String path, String fileType, org.python.core.PyDictionary arguments, 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.

Field Details

SERIALIZER

static final ProtoRpcSerializer SERIALIZER

Method Details

executeReport

byte[] executeReport(String path,
 String fileType,
 org.python.core.PyDictionary arguments,
 String projectName)
              throws Exception

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

Parameters:

path - The path to the report.

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

arguments - 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

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

Executes a report and distributes it using the specified action.

Parameters:

path - The path to the report.

parameters - 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

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

Retrieves a list of report names for a project.

Parameters:

projectName - The name of the project.

Returns:

A list of report name information.

Throws:

Exception - if retrieval fails.