Run a maintenance plan

To run a maintenance plan:

  1. Using Manager, click Administration > Maintenance. The Maintenance dialog is displayed.
  2. Select the maintenance plan that you want to run.
  3. Click Start. A new dialog is displayed to confirm your choice.
    • Click Yes to run the maintenance plan.
    • Click Cancel to go back to the Maintenance dialog.

Log files

Running a maintenance plan creates two log files in the location specified in the maintenance plan:

  • Maintenance log file – Summarizes maintenance results.
  • Detailed log file – Contains database details intended for Kofax personnel. This file uses the same location and name, except the file name is appended with _detailed.

Run a maintenance plan from the command prompt

Type the path to eimngr.exe, followed by the switch /M and the name of the maintenance plan. Example:

C:\Program Files\ReadSoft\INVOICES\Bin\eimngr.exe /M maintenance_plan_name

This is helpful if you want to use Windows Scheduled Tasks to run maintenance plans automatically. Select Start menu > Settings > Control Panel > Scheduled Tasks > Add Scheduled Tasks. For more information on Scheduled Tasks, visit the Help and Support Center for your operating system.  

If you specify a maintenance plan name that does not exist, an error message is displayed. This can cause problems, for example if you use scripts to run the maintenance plan automatically.

Running maintenance plans from the command prompt returns one of the following result codes:

  • 0 – Success. No errors.
  • 1 – Maintenance plan executed but with minor errors or warnings.
  • 2 – Maintenance plan not completed due to critical errors or locked objects.

Only database integrity check errors will return the above error codes.

You can use these result codes to activate notifications or other actions. See an example maintenance batch file.

Locked objects

You cannot run maintenance plans when objects in the database are locked. You must unlock them first. You can do this two ways:

  • Unlock them using Manager.
  • Use the AllowMaintenanceOnLockedObjects setting (see INI file help for more information) to perform maintenance plans in spite of locked objects. (Use this setting with care. ReadSoft recommends running maintenance plans when there are no locked objects in the database.)