Ict.Petra.Server.MReporting.WebConnectors.TReportGeneratorWebConnector Class Reference

the connector for the report generation More...

Static Public Member Functions
static TProgressState	GetProgress (string AReportID)
	to show the progress of the report calculation; prints the current id of the row that is being calculated; More...
static string	Create ()
	prepare a UID for the report More...
static string	Start (string AReportID, System.Data.DataTable AParameters)
	Calculates the report, which is specified in the parameters table More...
static TParameterList	GetParameter (string AReportID, TDataBase ADataBase)
	get the environment variables after report calculation More...
static Boolean	GetSuccess (string AReportID, TDataBase ADataBase=null)
	see if the report calculation finished successfully More...
static String	GetErrorMessage (string AReportID, TDataBase ADataBase=null)
	error message that happened during report calculation More...
static string	DownloadHTML (string AReportID, TDataBase ADataBase=null)
	Download the result of the report as HTML. More...
static string	DownloadPDF (string AReportID, TDataBase ADataBase=null)
	Download the result of the report as PDF File in base64 encoding. More...
static string	DownloadExcel (string AReportID, TDataBase ADataBase=null)
	Download the result of the report as Excel File in base64 encoding. More...
static Boolean	SendEmail (string AReportID, string AEmailAddresses, bool AAttachExcelFile, bool AAttachPDF, out TVerificationResultCollection AVerification)
	send report as email More...

Detailed Description

the connector for the report generation

Member Function Documentation

Create()

static string Ict.Petra.Server.MReporting.WebConnectors.TReportGeneratorWebConnector.Create ( )

inlinestatic

prepare a UID for the report

Returns

ReportClientUID

DownloadExcel()

static string Ict.Petra.Server.MReporting.WebConnectors.TReportGeneratorWebConnector.DownloadExcel ( string  AReportID, TDataBase  ADataBase = null  )

inlinestatic

Download the result of the report as Excel File in base64 encoding.

DownloadHTML()

static string Ict.Petra.Server.MReporting.WebConnectors.TReportGeneratorWebConnector.DownloadHTML ( string  AReportID, TDataBase  ADataBase = null  )

inlinestatic

Download the result of the report as HTML.

DownloadPDF()

static string Ict.Petra.Server.MReporting.WebConnectors.TReportGeneratorWebConnector.DownloadPDF ( string  AReportID, TDataBase  ADataBase = null  )

inlinestatic

Download the result of the report as PDF File in base64 encoding.

GetErrorMessage()

static String Ict.Petra.Server.MReporting.WebConnectors.TReportGeneratorWebConnector.GetErrorMessage ( string  AReportID, TDataBase  ADataBase = null  )

inlinestatic

error message that happened during report calculation

GetParameter()

static TParameterList Ict.Petra.Server.MReporting.WebConnectors.TReportGeneratorWebConnector.GetParameter ( string  AReportID, TDataBase  ADataBase  )

inlinestatic

get the environment variables after report calculation

GetProgress()

static TProgressState Ict.Petra.Server.MReporting.WebConnectors.TReportGeneratorWebConnector.GetProgress ( string  AReportID )

inlinestatic

to show the progress of the report calculation; prints the current id of the row that is being calculated;

GetSuccess()

static Boolean Ict.Petra.Server.MReporting.WebConnectors.TReportGeneratorWebConnector.GetSuccess ( string  AReportID, TDataBase  ADataBase = null  )

inlinestatic

see if the report calculation finished successfully

SendEmail()

static Boolean Ict.Petra.Server.MReporting.WebConnectors.TReportGeneratorWebConnector.SendEmail ( string  AReportID, string  AEmailAddresses, bool  AAttachExcelFile, bool  AAttachPDF, out TVerificationResultCollection  AVerification  )

inlinestatic

send report as email

Start()

static string Ict.Petra.Server.MReporting.WebConnectors.TReportGeneratorWebConnector.Start ( string  AReportID, System.Data.DataTable  AParameters  )

inlinestatic

Calculates the report, which is specified in the parameters table

Returns

ReportClientUID

---

The documentation for this class was generated from the following file:

• csharp/ICT/Petra/Server/lib/MReporting/connect/WebConnector.cs