IFsrmFileManagementJob interface (fsrmreports.h)
[This interface is supported for compatibility but it's recommended to use the FSRM WMI Classes to manage FSRM. Please see the MSFT_FSRMFileManagementJob class.]
Defines a file management job. The job specifies a schedule, conditions, a command or actions to execute if a file meets all the conditions, user notifications, and reporting.
To create a file management job, call the IFsrmFileManagementJobManager::CreateFileManagementJob method.
The following methods return this interface:
- IFsrmFileManagementJobManager::EnumFileManagementJobs
- IFsrmFileManagementJobManager::GetFileManagementJob
Inheritance
The IFsrmFileManagementJob interface inherits from IFsrmObject. IFsrmFileManagementJob also has these types of members:
Methods
The IFsrmFileManagementJob interface has these methods.
| IFsrmFileManagementJob::AddNotification Adds a new notification value (period) to the file management job's list of notifications. |
| IFsrmFileManagementJob::Cancel Cancels the job if it is running. |
| IFsrmFileManagementJob::CreateCustomAction Creates a custom action object. |
| IFsrmFileManagementJob::CreateNotificationAction Creates a notification action and associates it with the notification value. |
| IFsrmFileManagementJob::CreatePropertyCondition Creates a new property condition and adds it to the collection of property conditions. |
| IFsrmFileManagementJob::DeleteNotification Deletes a notification value from the file management job's list of notifications. |
| IFsrmFileManagementJob::EnumNotificationActions Enumerates the actions associated with a notification value. |
| IFsrmFileManagementJob::get_CustomAction The action to execute when all the conditions are met. |
| IFsrmFileManagementJob::get_DaysSinceFileCreated The number of days that have elapsed since the file was created. (Get) |
| IFsrmFileManagementJob::get_DaysSinceFileLastAccessed The number of days that have elapsed since the file was last accessed. (Get) |
| IFsrmFileManagementJob::get_DaysSinceFileLastModified The number of days that have elapsed since a file was last modified. (Get) |
| IFsrmFileManagementJob::get_Enabled Indicates whether the job enabled (can run). (Get) |
| IFsrmFileManagementJob::get_ExpirationDirectory The root directory that will contain the expired files. (Get) |
| IFsrmFileManagementJob::get_FileNamePattern A condition property:_wildcard filter for names. (Get) |
| IFsrmFileManagementJob::get_Formats The formats of the report to generate when the job is run. (Get) |
| IFsrmFileManagementJob::get_FromDate The date from which you want the file management job to begin expiring files (moving files to the expired files directory). This property also applies to custom commands for the file management job. (Get) |
| IFsrmFileManagementJob::get_LastError The error message from the last time the job was run. |
| IFsrmFileManagementJob::get_LastReportPathWithoutExtension The local directory path where the reports were stored the last time the job ran. |
| IFsrmFileManagementJob::get_LastRun The last time the file management job was run. |
| IFsrmFileManagementJob::get_Logging The types of logging to perform. (Get) |
| IFsrmFileManagementJob::get_MailTo The email addresses to which to send the reports, if any. (Get) |
| IFsrmFileManagementJob::get_Name The name of the file management job. (Get) |
| IFsrmFileManagementJob::get_NamespaceRoots An array of local directory paths that will be scanned when the file management job is run. (Get) |
| IFsrmFileManagementJob::get_Notifications The list of notification periods defined for the job. |
| IFsrmFileManagementJob::get_OperationType The type of file management job. The type determines the operation to perform on a file when all conditions are met. (Get) |
| IFsrmFileManagementJob::get_Parameters The parameters for the file management job. (Get) |
| IFsrmFileManagementJob::get_PropertyConditions A list of property conditions specified for the job. |
| IFsrmFileManagementJob::get_ReportEnabled Indicates whether the job will generate a report when it runs. (Get) |
| IFsrmFileManagementJob::get_RunningStatus The running status of the job. |
| IFsrmFileManagementJob::get_Task The name of the scheduled task to associate with the job. (Get) |
| IFsrmFileManagementJob::ModifyNotification Change a notification value in the file management job's list of notifications. |
| IFsrmFileManagementJob::put_DaysSinceFileCreated The number of days that have elapsed since the file was created. (Put) |
| IFsrmFileManagementJob::put_DaysSinceFileLastAccessed The number of days that have elapsed since the file was last accessed. (Put) |
| IFsrmFileManagementJob::put_DaysSinceFileLastModified The number of days that have elapsed since a file was last modified. (Put) |
| IFsrmFileManagementJob::put_Enabled Indicates whether the job enabled (can run). (Put) |
| IFsrmFileManagementJob::put_ExpirationDirectory The root directory that will contain the expired files. (Put) |
| IFsrmFileManagementJob::put_FileNamePattern A condition property:_wildcard filter for names. (Put) |
| IFsrmFileManagementJob::put_Formats The formats of the report to generate when the job is run. (Put) |
| IFsrmFileManagementJob::put_FromDate The date from which you want the file management job to begin expiring files (moving files to the expired files directory). This property also applies to custom commands for the file management job. (Put) |
| IFsrmFileManagementJob::put_Logging The types of logging to perform. (Put) |
| IFsrmFileManagementJob::put_MailTo The email addresses to which to send the reports, if any. (Put) |
| IFsrmFileManagementJob::put_Name The name of the file management job. (Put) |
| IFsrmFileManagementJob::put_NamespaceRoots An array of local directory paths that will be scanned when the file management job is run. (Put) |
| IFsrmFileManagementJob::put_OperationType The type of file management job. The type determines the operation to perform on a file when all conditions are met. (Put) |
| IFsrmFileManagementJob::put_Parameters The parameters for the file management job. (Put) |
| IFsrmFileManagementJob::put_ReportEnabled Indicates whether the job will generate a report when it runs. (Put) |
| IFsrmFileManagementJob::put_Task The name of the scheduled task to associate with the job. (Put) |
| IFsrmFileManagementJob::Run Runs the job. |
| IFsrmFileManagementJob::WaitForCompletion Waits for the specified period of time or until the job has finished running. |
Remarks
When a file management job runs, it scans the files in the specified folders and if a file in the folder meets the conditions specified by the job, FSRM moves the file to the specified expired files folder if the type is expiration, or runs the custom action if defined. If notifications or actions are specified, FSRM sends the notifications and performs the actions.
Use the following properties to specify the expiration conditions:
- DaysSinceFileCreated
- DaysSinceFileLastAccessed
- DaysSinceFileLastModified
- PropertyConditions (use the CreatePropertyCondition method to create the property condition)
FSRM does not expire files in the system directories (for example, "\Windows", "\System Volume Information", "$Event", and "$Recycle").
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows Server 2008 R2 |
| Target Platform | Windows |
| Header | fsrmreports.h (include FsrmPipeline.h, FsrmQuota.h, FsrmReports.h, FsrmScreen.h) |