com.inductiveautomation.reporting.gateway.actions

Class RunScriptAction

java.lang.Object

com.inductiveautomation.reporting.gateway.actions.AbstractReportAction

com.inductiveautomation.reporting.gateway.actions.RunScriptAction

public class RunScriptAction
extends AbstractReportAction

Filename: RunScriptAction Author: Perry Arellano-Jones Created on: 6/8/15 Project: Reporting 3.0

An "Extension Function Style" Report Action that allows the running of a script upon generation of a scheduled report.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUDIT_FAIL_MSG

Constructor Summary

Constructors

Constructor and Description
RunScriptAction(GatewayContext context, long projectId, ReportExecutionContext reportContext)

Method Summary

Modifier and Type	Method and Description
void	perform(RMDocument report, ReportResource reportResource, AbstractReportActionConfig config, java.lang.String reportPath, java.lang.String reportName, java.util.Map<java.lang.String,java.lang.Object> parameterData)
void	perform(RMDocument report, ReportResource reportResource, AbstractReportActionConfig config, java.lang.String reportPath, java.lang.String reportName, java.util.Map<java.lang.String,java.lang.Object> parameterData, java.util.Map<java.lang.String,java.lang.Object> configData) Called by system.report.executeAndDistribute.

Methods inherited from class java.lang.Object

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

Field Detail

AUDIT_FAIL_MSG

public static final java.lang.String AUDIT_FAIL_MSG

See Also:

Constant Field Values

Constructor Detail

RunScriptAction

public RunScriptAction(GatewayContext context,
                       long projectId,
                       ReportExecutionContext reportContext)

Method Detail

perform

public void perform(RMDocument report,
                    ReportResource reportResource,
                    AbstractReportActionConfig config,
                    java.lang.String reportPath,
                    java.lang.String reportName,
                    java.util.Map<java.lang.String,java.lang.Object> parameterData)

Specified by:

perform in class AbstractReportAction

perform

public void perform(RMDocument report,
                    ReportResource reportResource,
                    AbstractReportActionConfig config,
                    java.lang.String reportPath,
                    java.lang.String reportName,
                    java.util.Map<java.lang.String,java.lang.Object> parameterData,
                    java.util.Map<java.lang.String,java.lang.Object> configData)

Description copied from class: AbstractReportAction

Called by system.report.executeAndDistribute. This parses the configData that applies to this distribution type, updates a distribution config, and calls the other overload of perform.

Specified by:

perform in class AbstractReportAction

Parameters:

report - The RMDocument generated from the report template

reportResource - The ReportResource

config - A new blank config of the appropriate type. May be altered by the configData before calling the overload.

reportPath - Path to the report we want to perform.

reportName - Name of the report we want to perform.

parameterData - Optional parameter overrides.

configData - Optional data to apply to the configuration. Missing values will be left at the default values.