FPCReportJob object

Applies to: desktop apps only

The FPCReportJob object represents a single report job. Report jobs specify the items to include in the reports and when to generate the reports.

Report jobs can be recurring, meaning that they generate reports at a regular frequency such as monthly or weekly, or run once, meaning that they generate a single report.

When you set up a report job, in addition to configuring how frequently a report will be generated, you configure the period of time that the report will cover.

The FPCReportJob object is an element of an FPCReportJobs collection, and a new report job can be created by calling the Add method of this collection.

Ff826061.bkbutton(en-us,VS.85).png Click here to see the Forefront TMG object hierarchy.

Inheritance

This object inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.

Members

The FPCReportJob object has these types of members:

  • Methods
  • Properties

Methods

The FPCReportJob object has these methods.

Method Description
AddCategory

Adds an Report Definition Language (RDL) report category to the report job.

AddParameterInstance

Adds an instance of an Report Definition Language (RDL) report parameter to the report job.

CreateReport

Generates the report defined in the report job.

RemoveAllCategories

Removes all Report Definition Language (RDL) report categories from the report job.

RemoveAllParameterInstances

Removes all instances of Report Definition Language (RDL) report parameters from the report job.

Run

Runs the report job if it is a recurring report job.

SetAsDailyReportJob

Sets the report job to run every day starting from a specified date.

SetAsMultipleDaysReportJob

Sets the report job to run on specific days of the week starting from a specified date.

SetAsOncePerMonthReportJob

Sets the report job to run once a month, on a specified day of the month, starting from a specified date.

SetAsRunOnce

Sets the report job to run only once over a specified period of time of a specified type.

SetAsRunOnceReportJob

Sets the report job to run only once over a specified period.

SetEmailing

Sets the properties for sending an email message when the report job is completed.

SetPublishing

Sets the properties for publishing reports generated by the report job.

SetPublishingCredentials

Sets the credentials for publishing reports generated by the report job.

SetServer

Sets the name of the server on which the report job will run. (This method is deprecated in Forefront TMG 2010.)

 

Properties

The FPCReportJob object has these properties.

Property Access type Description

AddLinkToPublishedReport

Read-only

Gets a Boolean value that indicates whether a link to the published report will be added in the body of the email message.

Categories

Read/write

Gets or sets a value from the FpcReportJobCategory enumerated type that specifies the category of the report job. (This property is deprecated in Forefront TMG 2010.)

Credentials

Read-only

Gets an FPCCredentials object that represents the credentials needed to generate a report.

Description

Read/write

Gets or sets the description of the report job.

EmailBody

Read-only

Gets the body of the email message that will be sent when the report job is completed.

EmailCC

Read-only

Gets the Cc line of the email message that will be sent when the report job is completed.

EmailFrom

Read-only

Gets the From line of the email message that will be sent when the report job is completed.

EmailTo

Read-only

Gets the To line of the email message that will be sent when the report job is completed.

Enabled

Read/write

Gets or sets a Boolean value that indicates whether the report job is enabled.

EnableEmailing

Read-only

Gets a Boolean value that indicates whether an email message will be sent when the report job is completed.

EnablePublishing

Read-only

Gets a Boolean value that indicates whether saving reports to a file is enabled.

GuidForAdHocReport

Read-only

Gets the string-formatted globally unique identifier (GUID) assigned to the report generated by this run-once report job. (This property is deprecated in Forefront TMG 2010.)

Name

Read/write

Gets or sets the name of the report job.

PeriodType

Read-only

Gets a value from the FpcReportJobPeriodType enumerated type that specifies the type of period that the report will cover.

PublishCredentials

Read-only

Gets an FPCCredentials object that represents the credentials for publishing reports generated by the report job.

PublishDirectory

Read-only

Gets the directory to which the reports will be saved.

RecurrenceType

Read-only

Gets a value from the FpcScheduledTaskRunningPeriod enumerated type that specifies the frequency with which a report will be generated.

RecurringReportJobDayOfMonth

Read-only

Gets the day of the month on which a monthly report job will run.

RecurringReportJobDaysOfWeek

Read-only

Gets a bitmask of the FpcDaysOfWeek enumerated type that specifies the days of the week on which a weekly report job will run.

RecurringReportJobStartDate

Read-only

Gets the starting date for a recurring report job.

ReportCategories

Read-only

Gets an FPCRefs collection that contains references to the FPCRdlReportCategory objects defining the Report Definition Language (RDL) report categories included in the report job.

ReportParameters

Read-only

Gets an FPCRdlReportParameterInstances collection that contains objects representing the instances of Report Definition Language (RDL) report parameters used in the report job.

RunAsSoonAsPossible

Read-only

Gets a Boolean value that indicates whether the report job has been set to run as soon as possible. (This property is deprecated in Forefront TMG 2010.)

RunOnceReportJobPeriodEnd

Read-only

Gets the concluding date of the period to be covered by a run-once report job.

RunOnceReportJobPeriodStart

Read-only

Gets the starting date of the period to be covered by a run-once report job.

Server

Read-only

Gets an FPCRef object that references the FPCServer object representing the server on which the report job will run. (This property is deprecated in Forefront TMG 2010.)

SmtpServer

Read-only

Gets the name of the SMTP server that will be used to send an email message when the report job is completed.

UsePublishingCredentials

Read-only

Gets a Boolean value that indicates whether credentials will be used in publishing reports generated by the report job.

 

Methods Inherited from FPCPersist

Name Description
CancelWaitForChanges Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document.
Export Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document.
ExportToFile Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML file.
GetServiceRestartMask Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage.
ImportFromFile Recursively copies the values of all the properties of the object and of its subobjects from the specified XML file to persistent storage.
LoadDocProperties Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved.
Save Recursively writes the current values of all the properties of the object and its subobjects to persistent storage.
WaitForChanges Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

 

Properties Inherited from FPCPersist

Name Description
PersistentName Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets Gets an FPCVendorParametersSets collection that can hold sets of custom data for extending the object.

 

Interfaces for C++ Programming

This object implements the IFPCReportJob, IFPCEEReportJob, and IFPCEEReportJob2 interfaces.

Requirements

Minimum supported client

Windows Vista, None supported

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)

Version

Forefront Threat Management Gateway (TMG) 2010

IDL

Msfpccom.idl

See also

COM Objects

 

 

Build date: 7/12/2010