Difference between revisions of "Jobs"

[unchecked revision]

Revision as of 09:21, 12 June 2015

MailStore Server allows the creation of jobs to execute server side Management API-Commands in the background. Templates are available for the most important Management API-Commands, which ease the setup process.

Creating Jobs

To create a new job follow these steps:

Log on to MailStore Client as MailStore administrator.
Click on Administrative Tools > Management API and then Jobs.
Select a template for the job to be created in the Create Job section or click on Manual... to set up background execution of an other Management API-Command.
If a template was selected, it may be necessary to make additional settings in the Common Settings section of the New Job dialog. Otherwise enter the Management API-Command and all its arguments in the Action text box in the same way as you would in the Management Shell.
Specify when and how often the job is to be executed in the Schedule section.
Please note: Running storage maintenance commands too often may have a negative impact on the overall performance of the system and thus should preferably done outside of typical working hours.
Click OK to create the new job.

The newly created job will now be executed in the background based on its defined schedule. Jobs can be run manually already before its first automatic execution, in order to verify if the job execution results in the expected behavior.

Verifying Job Results

To show the result of the last job execution or to show the job results of all previous executions, follow the steps below:

Log on to MailStore Client as MailStore administrator.
Click on Administrative Tools > Management API and then Jobs.
Select a job in the Jobs table.
click on Details... in the Last Executions section next to the job list to show the result of the most recent execution or click on All Results.. to display a results list of all previous executions.
If All Results.. was clicked, double clicking on a list item in the Last Results dialog opens its details.

Further information about showing the results of all jobs can be found in Job Results.

Executing Jobs Manually

Follow the instructions below to to execute jobs manually:

Log on to MailStore Client as MailStore administrator.
Click on Administrative Tools > Management API and then Jobs.
Select a job in the Jobs table.
Click on Run in the Current State section next to the job list.

After the execution finished you can verify the job result.

Modifying Jobs

The following sections describe how the different job properties can be changed at any time.

Status

Newly created jobs are enabled by default and therefore will be automatically executed in the background based on their individual schedule. To suppress the executions, the job status can be changed accordingly. To do this, proceed as follows:

Log on to MailStore Client as MailStore administrator.
Click on Administrative Tools > Management API and then Jobs.
Right click on the job to be modified in the Jobs table and uncheck the Enabled option to disable the scheduled execution or check the Enabled option to re-enable the scheduled execution of a previously disabled job.

Rename

To rename a job, proceed as follows:

Log on to MailStore Client as MailStore administrator.
Click on Administrative Tools > Management API and then Jobs.
Right click on the job to be renamed and then click on Rename....
Enter a new name for the job.
Click OK to rename the job.

Change Owner

In rare cases it might be desired to change the owner of a job. Notice that the owner of a job can only be a MailStore administrator. Proceed as follow to change the owner of a job:

Log on to MailStore Client as MailStore administrator.
Click on Administrative Tools > Management API and then Jobs.
Right click on the appropriate job and then click on Change Owner....
Select the new owner in the Select User dialog.
Click on OK to change the owner.

Properties

To modify the properties of jobs proceed as follows:

Log on to MailStore Client as MailStore administrator.
Click on Administrative Tools > Management API and then Jobs.
Double click on the job to modify or right click on the job and then click on Properties.
Make the desired changed to to job properties.
Click OK to save the changes.

Templates

Template	Description
Storage
Synchronize with Directory Services	Synchronizes the MailStore user database with the configured directory service. The behavior is equivalent to clicking on Synchronize at Administrative Tools > Users and Privileges > Directory Services. 'Please note: Archiving profiles for multiple, journal or catch all mailboxes provide an option to synchronize user with a directory service prior to archiving. This option is to be preferred.
Create Backup	Based on the configured schedule an backup is created in the given target directory. Further information are available in Backup and Restore.
Maintain all FDB Files	All Firebird embedded database that are used in standard or advanced archive stores of type Directory (File System) are maintained. Further details can be found in Maintenance and Repair.
Rebuild Broken Serch Indexes	Rebuild all search indexes that are currently in the state Needs rebuild. Further details can be found in Maintenance and Repair.
Check Data Integrity	Verification of the data integrity between "Folder Information and Meta Data" as well as "Email Headers and Contents". Optionally search indexes can be include in the verification, yet it increased the time to run the integrity check. Further details can be found in Maintenance and Repair.
Profiles
Archive E-mail	Runs server side archiving profiles based on their configured schedule. Please note that server side archiving profiles are executed automatically and continuously in the background by default. Thus server side archiving profiles can only be executed from a job, if the execution of the profile is set to Manual in the profile management. Hint: We recommend using this execution method only in special scenarios where automatic and continuous archiving is not desired.
Export E-mail	Runs server side export profiles based on their configured schedule. Server side archiving profiles can only be executed from a job, if the execution of the profile is set to Manual in the profile management. 'Hint: If an automatic and continuous execution of an export profile is desired, it is recommended to change the execution of the profile to Automatic in the profile management.

@@ Line 7: / Line 7: @@
 * Click on ''Administrative Tools'' > ''Management API'' and then ''Jobs''.
 * Select a template for the job to be created in the ''Create Job'' section or click on ''Manual...'' to set up background execution of an other [[Administration_API_-_Function_Reference|Management API-Command]].
-* If a template was selected, it may be necessary to make additional settings in the ''Common Settings'' section of the ''New Job'' dialog. Otherwise enter the Management API-Command and all its arguments in the ''Action'' text box in the same way as you would in the [[Management Shell]].
+* If a template was selected, it may be necessary to make additional settings in the ''Common Settings'' section of the ''New Job'' dialog. Otherwise enter the Management API-Command and all its arguments in the ''Action'' text box in the same way as you would in the [[MailStore Server Management Shell|Management Shell]].
 * Specify when and how often the job is to be executed in the ''Schedule'' section.
 *: '''Please note:''' Running storage maintenance commands too often may have a negative impact on the overall performance of the system and thus should preferably done outside of typical working hours.