Report

Runs a report on the Report Server. This function only schedules the report for execution. The running of the report is controlled entirely by the Report Server.

This function will start the specified report on the Reports Server to which the Plant SCADA computer is communicating. If you are using the Reports Servers in Primary/Standby mode, the report can run on the Standby Server. If you call this function on the Standby Server then the report will definitely run on the Standby Server, even if the Primary Server is active.

This function is a blocking function. It will block the calling Cicode task until the operation is complete.

Syntax

Report(ReportName [, sClusterName] )

ReportName:

The name of the report to run (can be prefixed by the name of the cluster that is ClusterName.ReportName).

sClusterName:

Name of the cluster in which the report resides. This is optional if you have one cluster or are resolving the report server via the current cluster context. The argument is enclosed in quotation marks "".

Return Value

0 (zero) if successful, otherwise an error code is returned.

Related Functions

RepSetControl, RepGetControl

Example

Buttons

Text: Shift Report

Command: Report("Shift", "ClusterXYZ")

Comment: Runs the Shift Report

System Keyboard

Key Sequence: Report ############ Enter

Command: Report(Arg1)

Comment: Runs a specified Report

Report("SHIFT","ClusterXYZ");

! Runs the report named "SHIFT".

Report("DAY","ClusterXYZ");

! Runs the report named "DAY".

/* The "SHIFT" and "DAY" reports are started. The order in which
the reports are run cannot be determined. If you want the "DAY"
eport to run after the "SHIFT" report, call Report("DAY") at the
end of the "SHIFT" report. */

See Also

Report Functions