Welcome to Help > Dialog and Other information > The Maintenance plan – New plan dialog

The Maintenance plan – New plan dialog

Use this dialog to create or edit a maintenance plan. Note that the settings that appear can vary depending on the type of plan displayed.

Note You cannot remove document definitions that have documents connected to them.
Plan type
Database A plan for database maintenance.
Master data import A plan for master data import.
Log file
Log file name The name and location of the log files.
Note ) and navigate to the location where you want log files to be saved. Then specify a name in the File name box and click Save. The file name is then displayed in the Log file name box.

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.
Append Appends the maintenance log file if it already exists. Overwrites the detailed log file (to avoid it becoming too large).
New name Prompts you for the log file name when you run the maintenance plan if a log file with the specified name already exists.
Overwrite Overwrites the existing log file.
Autoname Automatically names the log file using the specified name (if present) and a time stamp.
Integrity
Check database integrity Checks the database for a variety of errors. Do this often.
Repair found errors Automatically fixes any errors that are found.
Do not repair found errors Records errors in the log file without correcting them. (Example of log file.)

CleanUp
Remove unknown document definitions not used during the last Deletes unknown document definitions that have not been used during the time specified.
Remove known document definitions not used during the last Deletes known document definitions that have not been used during the time specified.
Remove learned document definitions not used during the last Deletes learned document definitions that have not been used during the time specified.
Remove document definitions with no sender connection after Deletes document definitions that still have no sender connection after the time specified.
Note Use this setting only if your system uses imported sender data. Do not use this setting if the system does not use master data.
Remove document definitions with poor performance Deletes document definitions with low interpretation rates.

If more than 80% of the single item fields are corrected in Verify, the document definition is considered to have poor performance. This percentage is calculated using the total of all of the fields from all of the documents connected to the definition in question.

You can adjust the threshold using the PoorPerformanceThreshold setting in Eiglobal.ini. See INI file help for more information.

The Poorly interpreted column in invoice definition statistics gives you an indication of how well your document definitions are performing.

Remove document definitions with status unknown Deletes all Unknown document definitions.
Remove unused temporary data Deletes other miscellaneous data from the database.
Remove unused sender names Deletes unused sender names from the database. Only Kofax ReadSoft Entrance' own internal sender names are deleted.

If you import master data and Delete master data not included in import was selected (see below), this setting is not needed.

Note Use this setting with caution. Running a maintenance plan containing this setting shortly after you update your sender registry could delete perfectly valid senders, especially those whose documents have not yet entered the system.
Remove extra learning documents Removes unneeded learning invoices.
Remove batch report layout files Removes batch report layout files.
Remove user log older than Removes user activity data that is older than the specified number of days.
Remove parked documents older than Removes invoices that have been parked for more than the specified number of days.
Logs
Remove process log messages older than Deletes process logs that are older than the number of days specified in the days box.
Save deleted messages to file Saves deleted messages in the specified text file. If the file already exists when the maintenance plan is run, the file is appended.
Remove service log messages older than Deletes service logs that are older than the number of days specified in the days box.
Save deleted messages to file Saves deleted messages in the specified text file. If the file already exists when the maintenance plan is run, the file is appended.
Location - displayed when using a maintenance plan to import master data.
Import format The file format of the master data you want to import.
Senders The location of the master data for the senders.
SupplierBanks The location of the master data for the banks of the senders.
Receivers The location of the master data for the receivers.
Delete master data not included in import Ensures that Kofax ReadSoft Entrance' master data matches the master data in your financial system. What actually happens:
  1. Existing Kofax ReadSoft Entrance master data (if any) is updated. (This happens even if you do not select Delete master data not included in import.)
  2. Data not touched during the import and not included in the import master data is deleted from Kofax ReadSoft Entrance master data.