FPCReportJob Object

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.

This object is an element of an FPCReportJobs collection.

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.

Methods

The FPCReportJob object defines the following methods.

Method	Description
CreateReport	Generates the report defined in 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.
SetAsImmediateReportJob	Sets the report job to run only once during a specified period.
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 e-mail message when the report job is completed.
SetPublishing	Sets the properties for publishing reports generated by the report job.
SetPublishingCredentials	Sets the the credentials for publishing reports generated by the report job.

Properties

The FPCReportJob object defines the following properties.

Property	Description
AddLinkToPublishedReport	Gets a Boolean value that indicates whether a link to the published report will be added in the body of the e-mail message.
Credentials	Gets an FPCCredentials object that represents the credentials needed to generate a report.
Description	Gets or sets the description of the report job.
EmailBody	Gets the body of the e-mail message that will be sent when the report job is completed.
EmailCC	Gets the Cc line of the e-mail message that will be sent when the report job is completed.
EmailFrom	Gets the From line of the e-mail message that will be sent when the report job is completed.
EmailTo	Gets the To line of the e-mail message that will be sent when the report job is completed.
Enabled	Gets or sets a Boolean value that indicates whether the report job is enabled.
EnableEmailing	Gets a Boolean value that indicates whether an e-mail message will be sent when the report job is completed.
EnablePublishing	Gets a Boolean value that indicates whether saving reports to a file is enabled.
Name	Gets or sets the name of the report job.
PeriodType	Gets a value from the FpcReportJobPeriodType enumerated type that specifies the type of period that the report will cover.
PublishCredentials	Gets an FPCCredentials object that represents the credentials for publishing reports generated by the report job.
PublishDirectory	Gets the directory to which the reports will be saved.
RecurrenceType	Gets a value from the FpcScheduledTaskRunningPeriod enumerated type that specifies the frequency with which a report will be generated.
RecurringReportJobDayOfMonth	Gets the day of the month on which a monthly report job will run.
RecurringReportJobDaysOfWeek	Gets a bitmask of the FpcDaysOfWeek enumerated type that specifies the days of the week on which a weekly report job will run.
RecurringReportJobStartDate	Gets the starting date for a recurring report job.
RunOnceReportJobPeriodEnd	Gets the concluding date of the period to be covered by a run-once report job.
RunOnceReportJobPeriodStart	Gets the starting date of the period to be covered by a run-once report job.
SmtpServer	Gets the name of the SMTP server that will be used to send an e-mail message when the report job is completed.
UsePublishingCredentials	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

Client	Requires Windows Vista or Windows XP.
Server	Requires Windows Server 2008.
Version	Requires Forefront Threat Management Gateway (TMG).
IDL	Declared in Msfpccom.idl.