Package com.inductiveautomation.reporting.scripting

Class ClientScriptingFunctions

java.lang.Object

com.inductiveautomation.reporting.scripting.ClientScriptingFunctions

All Implemented Interfaces:

ReportScriptingFunctions

public class ClientScriptingFunctions
extends java.lang.Object
implements ReportScriptingFunctions

Filename: ClientScriptingFunctions.java Created on Mar 27, 2015 Author: Kathy Applebaum Copyright Inductive Automation 2015 Project: Reporting

Constructor Summary

Constructors

Constructor	Description
ClientScriptingFunctions(ClientContext context)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientScriptingFunctions

public ClientScriptingFunctions(ClientContext context)

Method Detail

executeReport

public byte[] executeReport(java.lang.String path,
                            java.lang.String fileType,
                            org.python.core.PyDictionary parameters,
                            java.lang.String projectName)
                     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