Node: Job Log
Information about processed files is kept in a job log, regardless of whether the respective job succeeded or failed. This log can help you figure out the causes of errors and determine which input file was used to create which output file. Entries are stored in chronological order and may be filtered.
Information about jobs that ended in errors is also recorded in Failed Jobs. This node has no customizable settings.
|Files||The files that have been processed.|
|Workflow||The name of the workflow in which this job was created.|
|Processing Notes||The first message from the list of error messages.|
|Date||The job completion date and time.|
|Pages||The number of processed pages.|
|Processing Time||The time that elapsed from the moment the job processing is started to the moment it was completed.|
|Total Time||The total time that elapsed from the moment the job entered the queue to the moment its processing was completed.|
The percentage of uncertain characters in the document.
Note. For failed jobs, the logged value can be smaller than the specified limit. This may happen because the job is discarded if the number of uncertain characters exceeds the limit at least in one document of the job.
|User||The name of the user who created the job. The name can be obtained from the client application, or taken from the incoming e-mail message. If the name cannot be detected, the word "unknown" will be displayed in this column.|
The Files tab of the additional details pane contains a list of input files and their matching output files. Note that one input file may result in several output files (e.g. files with recognized data and XML files). For convenience, the input files and their corresponding output files are shown in a tabular format.
The shortcut menus of the Files tab
The shortcut menu of an input file contains the following items:
- Open folder opens the folder that contains the input file
- Copy copies the path to the input file
The shortcut menu of an output file contains the following items:
- Open file opens the output file
- Open folder opens the folder that contains the output file
- Copy copies the path to the output file
The Details tab of the additional details pane contains information about the job, including all of the errors and warnings that occurred during processing and the time that it took the program to complete the job (i.e. waiting time, processing time, and total time).
|Icon||What it means|
Information message. Contains information about the actions of a Verification Station or Indexing Station operator:
The message contains the name of the operator (in DOMAIN\user format) that performed the action and the time of the action.
Note. If an operator rejects a document on a Verification Station or on an Indexing Station, an error message is created which also contains the name of the rejecting operator and the time of the action.
|Notification. Contains information about the problems that occurred when processing the document.|
|Error. Contains information about a job that was rejected or caused an error.|
Note. To copy the text of an error or warning to the Clipboard, right-click the error or warning and then click Copy.
Filtering entries in the job log
Information about processed jobs is recorded in a job log. The log contains an entry for every job processed since the log was created. These entries can be filtered. To filter jobs, create a custom view and specify filtering parameters as described below:
- Click button (Create Custom View...) on the Job Log toolbar.
- Type the name of the filter in the dialog box that opens.
- Specify the time period of the entries you want to display.
- Select the workflows you want to see.
- Select the jobs you want to see - successfully completed jobs and/or jobs that resulted in errors and warnings.
To edit a filter, right-click it and click Edit Custom View... on its shortcut menu or click the Edit Custom View button on the Job Log toolbar. To delete a custom view, click Delete Custom View on its shortcut menu.
Finding a file in the job log
To search for a file in the job log, click the button on the Job Log toolbar or press (Ctrl + F) to open the Find dialog box. In this dialog box, type the name of the file you want to find and specify which of the following three categories you want to search:
- Search in input file names searches input files
- Search in output file names searches output files
- Search in processing notes searches error messages
Any entries that contain the file name you specified will be highlighted. If there are no such entries, a message will be displayed.
The search range includes all entries starting with the entry currently selected in the Details pane and ending with the last entry. This means that the first entry in the Details pane must be selected if you want to search the entire list.
Note. The search query can include wildcard characters. Note that you do not have to include an asterisk (*) to indicate that any character can be included in the query.
Exporting the job log
To export the job log to a text file, click Export to *.csv on its shortcut menu. In the dialog box that opens, specify the folder in which you want to save the job log and the name of the file. The resulting file will contain the following information:
This parameter can have two possible values: false indicates that the job was successfully processed, and true indicates that problems occurred during processing.
The files of the job.
The workflow that was used to process the job.
The name of the folder that contained the input file.
The first message from the list of error messages.
The path to the output file.
The date and time when the processing was completed.
The number of pages the job contained.
The time it took the program to process the job in milliseconds.
The ratio of uncertain characters to all characters in the document, in percent.
The name of the user that created the account. This name can be acquired from a client application or from an e-mail message. If the name could not be determined, the user name will be «unknown».
The job's priority:
- 4 high
- 3 above normal
- 2 normal
- 1 below normal
- 0 low
Job log settings
To customize the Job Log, click (the Options button) on its toolbar or press Ctrl + O to open the dialog box that contains the following settings:
- Enable logging: enables/disables logging.
- Days to keep log file: the time period during which data will be entered into the log. The longest possible period is 360 days.
- Maximum log size (MB): the maximum size of the log (cannot be higher than 10 000 MB).
Click the Clear Log to delete all entries in the job log. The jobs log must be refreshed after it has been cleared.
Select the Enable jobs statistics collection option to enable the collection of statistics about processed jobs.
Note. The number of records directly affects statistics collection, which may take a significant amount of time.
Note. Selecting this option a second time will begin statistics collection from scratch.
Job log shortcut menu
|Create Custom View...||Use this command to filter the job log.|
|Export to CSV file||Exports log entries to a text file.|
|Clear Log||Deletes all entries in the job log. The job log must be refreshed after it has been cleared.|
|Properties||Sets a limit on the number of log entries and on how long they should be stored.|
|View||Commands in this group change the way the list of completed jobs is displayed.|
|Refresh||Refreshes the job log.|
11/29/2022 5:26:42 PM