3.6 Example 6: Creating and Configuring a File Management Job
This example demonstrates the use cases described in section 2.5.4.1.
The admin client creates a file management job and configures it.
Prerequisites
The participating client and server computers are configured to belong to the same Active Directory domain.
The admin tool has acquired an RPC calling context that provides the FSRM server name ([MS-FSRM] section 1.3).
Initial System State
None.
Final System State
A file management job is created and configured on the FSRM server.
The following sequence diagram shows the steps to create and configure a file management job.
Figure 19: Sequence diagram for creating and configuring a file management job
Sequence of Events
The admin client creates a file management job by calling the IFsrmFileManagementJobManager::CreateFileManagementJob method, ([MS-FSRM] section 3.2.4.2.50.2). The FSRM Service returns a pointer to the file management job and returns a success code.
The admin client sets the Name property of the file management job by calling the IFsrmFileManagementJob::Name(put) method ([MS-FSRM] section 3.2.4.2.48.3), and the server returns ERROR_SUCCESS.
The admin client sets the NamespaceRoot property of the newly created file management job by calling the IFsrmFileManagementJob::NamespaceRoot(put) method ([MS-FSRM] section 3.2.4.2.48.5). The FSRM Service returns a success code.
The admin client sets the Enable property of the newly created file management job by calling the IFsrmFileManagementJob::Enable(put) method ([MS-FSRM] section 3.2.4.2.48.7). The FSRM Service returns a success code.
The admin client sets the ExpirationDirectory property for a new namespace by calling the IFsrmFileManagementJob::ExpirationDirectory(put) method ([MS-FSRM] section 3.2.4.2.48.110. The FSRM Service returns a success code.
The admin client sets the Operation type for new namespace by calling the IFsrmFileManagementJob::OperationType(put) method ([MS-FSRM] section 3.2.4.2.48.9). The FSRM Service returns a success code.
The admin client sets the list of report formats that the report job will create when the report job is generated by calling the IFsrmFileManagementJob::Formats(put) method ([MS-FSRM] section 3.2.4.2.48.19). The FSRM Service returns a success code.
The admin client adds a notification period to the file management job's list of notification periods by calling the IFsrmFileManagementJob::AddNotification method ([MS-FSRM] section 3.2.4.2.48.44). The FSRM Service returns a success code.
The admin client calls the IFsrmFileManagementJob::Task(put) method ([MS-FSRM] section 3.2.4.2.48.32), with the name of the scheduled task to be used in step 11. The FSRM Service returns a success code.
The admin client calls the IFsrmFileManagementJob::Commit method ([MS-FSRM] section 3.2.4.2.48.1) to commit the modifications to the file management job.
The admin client creates a scheduled task by calling the IFsrmReportScheduler::CreateScheduleTask method ([MS-FSRM] section 3.2.4.2.36.2) to pass in the name as it was used in step 9, namespaces, and serialized text of the task. The FSRM Service returns a success code.