Gemstone Timeseries Library
Show/Hide TOC

# IReportingProcess Interface

Defines an interface for reporting processes.

## Definition

Namespace: Gemstone.Timeseries.Reports
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.138 -- Release Build+b4f8847fe309a44734617722bca179874d85b46d
C#
View Source Request Example

    public interface IReportingProcess : IProvideStatus

VB
View Source Request Example

    Public Interface IReportingProcess
    	Inherits IProvideStatus

C++
View Source Request Example

    public interface class IReportingProcess : IProvideStatus

JavaScript
View Source Request Example

    Gemstone.Timeseries.Reports.IReportingProcess = function();
    Gemstone.Timeseries.Reports.IReportingProcess.createInterface('Gemstone.Timeseries.Reports.IReportingProcess');

Implements
  IProvideStatus

## Properties

ArchiveFilePath | Gets or sets the path to the archive file to which the statistics required for reporting are archived.
Company | Gets or sets the name of the company to be displayed on reports.
EnableReportEmail | Gets or sets flag to enable e-mailing of reports.
FromAddress | Gets or sets the "from" address to use when e-mailing reports.
IdleReportLifetime | Gets or sets the minimum lifetime of a report since the last time it was accessed, in days.
Name | Gets the name of the object providing status information. (Inherited from IProvideStatus)
ReportLocation | Gets or sets the directory to which reports will be written.
ReportType | Gets report type (i.e., name) for this reporting process.
SmtpServer | Gets or sets SMTP server to use when e-mailing reports.
Status | Gets the current status details about object providing status information. (Inherited from IProvideStatus)
Title | Gets or sets the title to be displayed on reports.
ToAddresses | Gets or sets the comma separated "to" addresses to use when e-mailing reports.

## Methods

CleanReportLocation | Deletes reports from the ReportLocation that have been idle for the length of the IdleReportLifetime.
GenerateReport | Queues up a report to be generated on a separate thread.
GetArguments | Gets the command line arguments for the reporting process.
GetArguments(DateTime, Boolean) | Gets the command line arguments for the reporting process for a given report date.
GetPendingReportsList | Returns the list of reports which are in the queue but are yet to be generated.
GetReportsList | Returns the list of reports that are available from the report location.
SetArguments | Applies any received command line arguments for the reporting process.

## See Also

#### Reference

Gemstone.Timeseries.Reports Namespace