File Archive Tasks

Document created by user.oxriBaJeN4 Employee on Sep 9, 2015Last modified by user.oxriBaJeN4 Employee on Oct 29, 2018
Version 5Show Document
  • View in full screen mode

File Archiving Tasks are required to apply Mimecast Synchronization Engine task definitions to specific groups of users at specific time schedules.  Existing Task Definitions and Schedules can be used or created as part of configuring a new File Archiving Task.  The Task will reference a Directory Group or Organizational Unit (OU), which must be setup up in Active Directory prior to being linked to.


To configure file archiving:

  • A task definition should be created, which specifies what you want archived
    • User Folder Archiving
    • Shared Folder Archiving
  • A schedule should be configured to determine when the tasks should run
  • A Group of users that are to be affected by the task should be configured
  • A File Archive Task is required to assign the task to the relevant schedule and user group

For the initial folder archive, all files (except for those listed as excluded extensions) will be archived. This results in the first task run being the most resource intensive. Subsequent archive jobs will only archive any differences to those existing files, or any new files.

File Archiving tasks instruct Mimecast when to assign a specific Task Definition to a Group. This is done with the use of Scheduling,  i.e. what time and how often the task should run.

MSE tasks will not run until the Task is created and applied to a valid Directory Group of users or OU.

Creating a File Archiving Task


To create a file archive task:

  1. Log in to the Administration Console.
  2. Click on the Administration toolbar button. A menu drop down is displayed.
  3. Click on the Services | File Archive. The File Archiving Dashboard provides a few options to manage and create File Archiving Tasks, and to view recent task activity
  4. Click on the New File Archive Task button in the task toolbar, or click the relevant (x) tasks link within the appropriate widget:


  5. The following Task Options screen is displayed:


  6. Select the Mimecast Synchronization Engine Site where the task should run
  7. Either select an existing Schedule definition that should apply, or click on the Create New button to configure a new Schedule
  8. For Task Type, select the Task Definition type, e.g. User Folder Archiving etc.

    A definition that has been assigned to an File Archiving Task cannot be removed until the File Archiving Task has been deleted.

  9. Once selected, the additional Definition field is displayed. Using the drop down menu, select an existing task definition, or click on the Create New button to configure a new definition
  10. Click on the Lookup button to select an Active Directory security or distribution Group for this File Archive Task.  Once the Group has been selected, the Selected DN field is populated automatically with the distinguished name of the group
  11. Alternatively, select the radio button next to the field Enter DN Manually to edit the distinguished name of the Group manually, then type in the name using the example format below:


  12. Click the Save and Exit button to create the task.


Your File Archiving Task has now been created, and will run according to the schedule.

If a new File Archiving Task is created while other tasks are running, the new task will not take effect until the current jobs are completed.

Managing File Archiving Tasks

To view or edit existing tasks, navigate to Administration | Services | File Archive.  Within the relevant File Archiving Task widget, click on the tasks link to display a list of existing tasks:



When a task is selected and opened, Task Options and Task Information are displayed:



The Task Options section contains the task settings that were configured when the task was created. The Task Information section provides details on the task itself:


CreatedDate and time that the File Archiving task was created
Last ModifiedDate and time that the task was modified
Last Modified byAdministrator who last modified the task
StatusThe current status of the task, e.g. Active
CommandAny command that is currently in progress, if the task is currently Active
Error DetailError codes generated if tasks cannot execute


Tasks can also be deleted using the Remove Definition button.


Task Logs


Detailed logs for each File Archiving Task are available via the task toolbar by selecting Task Summary Logs from the Logs drop down menu (when viewing the specific task).


Each time the task is run, a log is created to monitor the task activity, and a list of these logs is available when viewing Task Summary Logs.  By clicking on a specific log report, further information is available on the execution of the task.



Additional detailed logs on each task execution are also available on the server where the Mimecast Synchronization Engine has been installed.