2.5.4.1 Create and Configure a File Management Job

  • Article

Goal

To create and configure a file management job.

Context of Use

The administrator is setting up a file server and is required to schedule a task that applies a command to a set of files as determined by a list of conditions and a list of namespaces.

Actors

  • Admin tool

    The admin tool is the primary actor that triggers this use case. The admin tool is a program that offers management functionality to the administrator through the admin client. Typical admin tools are command-line tools and graphical shells, management utilities, and graphical management programs. The purpose of the admin tool is to correctly interpret, execute, and display the results of the commands that are issued by the administrator.

  • FSRM Service

    The FSRM Service is a supporting actor. It provides functionality for setting up and managing storage on folders and shares on a file server.

  • Admin client

    The admin client is a supporting actor that implements client-side protocol components and consumes the file server administration services that are offered by the file server. The admin client is internal to the File Services Management system.

Stakeholders

  • Administrator

    The administrator is the person who administers the file server. The administrator has administrative rights and uses the File Services Management system to provide SMB File Services.

Preconditions

The administrator has identified a file server and a set of files on the server to schedule the job.

Main Success Scenario

  1. Trigger: The admin tool receives a request from the Create and Configure a File management task. The admin tool establishes a communication channel to the File Server Resource Manager, which is a component of the File Service, as described in [MS-FSRM] section 3.1.3.

  2. The admin tool creates a file management job on the file server by using the CreateFileManagementJob method, as described in [MS-FSRM] section 3.2.4.2.50.2. It sets the Name, NamespaceRoot, and Format task by using the IFsrmReportScheduler::CreateScheduleTask method and ExpirationDirectory for the new namespace, as described in [MS-FSRM] sections 3.2.4.2.48.3, 3.2.4.2.48.5, 3.2.4.2.48.19, 3.2.4.2.37.2, and 3.2.4.2.48.11.

  3. The admin tool modifies properties of the newly created file management job, such as the ReportEnabled property and the Logging property, and associates a different task.

Postcondition

The requested file management task is created and configured.

Extensions

If the communication channel for the File Server Resource Manager Protocol [MS-FSRM] cannot be established, or it becomes disconnected:

  • The admin tool can attempt to establish connection multiple times; ultimately, the use case ends with failure. Depending on when the connection failed, the namespace could or could not have been created.