Kofax Transformation Modules 6.3.1 Fix Pack 18 English

Release Date: February 22, 2022

© 2022 Kofax. All rights reserved.
Use is subject to license terms.

Introduction

Issues Resolved in This Fix Pack

Issues Resolved in Previous Fix Packs

Applies To

Files Included

Install This Fix Pack

Remove This Fix Pack

Introduction

You can install Kofax Transformation Modules 6.3.1.18 to resolve the issues listed below.

Issues Resolved in This Fix Pack

1776996 - Edit Training Document Window Causes Errors

The Edit Training Document window is now displayed as expected each time the window is opened.

Issues Resolved in Previous Fix Packs

Problems Resolved in Fix Pack 17

1699663 – Patch code not correctly recognized

By default, Patch codes should be recognized with the default FineReader recognition settings. However, if FineReader fails to recognize a Patch bar code using the default settings, you can improve the chances of bar code recognition by making use of the UseSpeedRecognition behavior via scripting.

If you want to recognize Patch bar codes, you can add the following code to the BeforeLocate event.

Private Sub Document_BeforeLocate(ByVal pXDoc As CASCADELib.CscXDocument, ByVal LocatorName As String)
if(LocatorName = "BarcodeLocator") Then
Dim Loc As CscBarcodeLocator
Set Loc = Project.ClassByIndex(0).Locators.ItemByName(LocatorName).LocatorMethod
Loc.UseSpeedRecognition = True
End If
End Sub

Problems Resolved in Fix Pack 16

1671463 - Perform check in Document Review for pending changes before closing a batch

It is no longer possible to close a batch in Document Review without a prompted to save any unconfirmed changes.

Problems Resolved in Fix Pack 15

1662118 - OCR results decreased from FineReader engine 11.1 to 12.2 in KTM 6.3

It is now possible to use the FineReader ProhibitModelAnalysis property in script to improve OCR Results in some cases. This option is available via script only and does not appear on the user interface. The value for this option is set to True by default.

When this option is set to False, the recognition engine uses model analysis to improve recognition in some cases.

Note: This property can be saved in the project. This means that the script does not need to be executed each time a project is processed. Execute the script from Project Builder and then save the project. The setting is then set when the project is used in production.

Use the following script sample to set this option, modifying it for your specific needs.

Private Sub Application_InitializeScript()
PreventModelAnalysis()
End Sub

Private Sub PreventModelAnalysis()
Dim pageProfile As IMpsRecogProfile
Dim pageProfileFr As MpsPageRecogProfileFR

Set pageProfile = Project.RecogProfiles.ItemByName("FineReader")
Set pageProfileFr = pageProfile
pageProfileFr.PreventModelAnalysis = False
End Sub

Problems Resolved in Fix Pack 14

1659361 - Retain Open Batch Windows Position for Dual Monitor Display

When using dual monitors, it is now possible to save the location of the Open Batch window. The next time you open a user module, the window appears in the same location.

1644370 - ValidationDocking3.xml can get into blocked state after starting many instances of Validation quickly one after the other

It is now possible to successfully open several back-to-back instances of the Validation module from the Batch Manager.

1640962 - Mixed Print Recognition Profile Crashes Project Builder and KTM Server On some Images.

Project Builder and Server no longer crash when processing a project that uses a Mixed Print Recognition profile.

1635715 - Getting object reference error while synchronizing the project in KC having unmapped fields

An error is no longer encountered when a project is synchronized in Kofax Capture.

Problems Resolved in Fix Pack 13

1617050 - Folder fields are not populated to Kofax Capture and are not preserved after suspend

Folder fields that have been changed by script in batch editing events are now successfully preserved and passed to Kofax Capture.

1617420 - Several registry settings like AutoNextBatchOpen, ConfirmBatchClosing, Pollintervall, PollToOpenBatch and ShowOnlylnvalidDocs of for Validation are stored in the registry under "ProjectBuilder", not "Validation"

The affected registry settings are now listed under Validation rather than Project Builder.

Problems Resolved in Fix Pack 12

1619033 - Server error: "SeparatePages failed, StructuredException.

An error is no longer encountered when a user separates a document.

1604360 - The Verify flag in Kofax Capture Index Fields changes from True to False whenever a project is synchronized and the corresponding transformation project field does not require synchronization.

The Verify flag only changes to True if the corresponding transformation project field requires verification.

1604355 - Layout Classifier "Enable automatic rotation" not recognized when used with TDS (Trainable Document Separation)

The “Enable automatic rotation” setting for the Layout Classifier is now successfully executed as needed, when using Trainable Document Separation.

Problems Resolved in Fix Pack 11

1588378 - Specific PDF document throws error message in Project Builder during extraction when using a barcode locator

An error is no longer encountered for larger PDFs that use a Barcode Locator during extraction.

1588101 - file.delete(folderpath) operation results with error Could not open Folder.xfd

It is now possuble to use the file.delete(folderpath) operation without encountering an error.

Problems Resolved in Fix Pack 10

1566817 - Batch in dialog not opened after refresh

When a user refreshes the list of batches in the Open Batch window and then double-clicks on one of the batches, that batch opens successfully without error.

1564878 - Install from 6.3.1.9 breaks the access KSMS Standalone Server from within KTM Project

Accessing a KSMS standalone server from a project no longer causes an error.

1562713 - Enhance classification locator to provide more details

The full classification results are now attached to each alternative of the Classification Locator.

If the Classification Mode setting is set to the Complete document (hierarchical) value, this information is available to scripting for further analysis as needed.

Private Sub Document_AfterLocate(ByVal pXDoc As CASCADELib.CscXDocument, ByVal LocatorName As String)
Dim layoutresultxml As String
Dim layoutresult As New CscResult
layoutresultxml = pXDoc.Locators.ItemByName("ClassificationLocatorName").Alternatives(0).XValues.ItemByName("__LayoutClassificationResult__").Value
layoutresult.LoadFromXmlString(layoutresultxml)

Dim contentresultxml As String
Dim contentresult As New CscResult
contentresultxml = pXDoc.Locators.ItemByName("ClassificationLocatorName").Alternatives(0).XValues.ItemByName("__ContentClassificationResult__").Value
contentresult.LoadFromXmlString(contentresultxml)
End Sub

1546243 - In Validation Auto foldering with merge of documents results in index error

Merging documents using auto foldering in the Validation module no longer causes an error.

1561034 - 'Open Batch' operation failed with message 'only one batch may be open at a time' in Document Review module

An error is no longer encountered when a user opens a batch.

Problems Resolved in Fix Pack 9

1553366 - Enhance classification locator to provide more details

The full classification results are now attached to each alternative of the Classification Locator. This information is available to scripting for further analysis as needed.

1532329 - Vendor Locator incorrect database vs fields mapping

An error in a Vendor Locator no longer occurs when the Vendor Name 2 predefined field is mapped to a database column.

1530665 - Dateformatter fails with month dictionary and dates in YYYY-DD-MM format

The YYYY-DD-MM date format is now supported.

1524087 - Filtering feature within the Open Batch method in KTM Document Review the "values" button does not populate.

When filtering by Batch Field, a list of values is now successfully generated for Document Review, Correction, and Verification.

Problems Resolved in Fix Pack 8

1494664 - Wrong GUID when copying OMR profiles

The GUID is no longer copied to the destination OMR profile when cloning.

Problems Resolved in Fix Pack 7

1466122 - NLP does not work with Japanese documents

The NLP engine now successfully extracts Japanese named entities successfully.

1460797 - When processing batches through Kofax Transformation Modules the documents are not being classified correctly because they are being locked.

Due to a new retry mechanism, documents that are temporarily locked are now successfully processed once that lock is released.

Problems Resolved in Fix Pack 6

1456194 - Auto Folder feature no longer initializing fields on new folders

When used, the Auto Folder feature now initializes fields on new folders as expected.

1444843 - When users attempt to use the Filtering feature within the Open Batch window, the "values" button does not populate with any data for users to select from when a 'Batch Field' item is selected.

Filtering the Open Batch window now behaves as expected.

1402724 - Validation Fuzzy Database Lookup sorting issue.

When using a database that has one or more columns that are not imported in the fuzzy index, the column sorting of of the search results now works as expected.

Problems Resolved in Fix Pack 5

1441234 - Barcode value is empty once checksum option is enabled.

By default, Code39 bar codes that contains asterisks should be recognized with the default FineReader recognition settings. However, if FineReader fails to recognize a Code29 bar code using the default settings, you can use scripting to improve the chances of bar code recognition. This is possible because the IsCode39WithOutAsterisk behavior is now available for editing via script.

If you want to recognize code 39 bar codes with asterisks when checksum is enabled, you can add the following code to the BeforeLocate event.

Private Sub Document_BeforeLocate(ByVal pXDoc As CASCADELib.CscXDocument, ByVal LocatorName As String)
If(LocatorName = "BarcodeLocator") Then
Dim Loc As CscBarcodeLocator
Set Loc = Project.ClassByIndex(0).Locators.ItemByName(LocatorName).LocatorMethod
Loc. IsCode39WithOutAsterisk = False
End If
End Sub

1404073 - Calling CopyDocument() between MergeDocument() calls causes Out Of Range Exception in SynchronizeXRootFolderToKCBatch

When batch restructuring, the combination of merging and copying documents now performs as expected.

1398810 - Document routing fails in Validation as PDF file is still locked by another process.

A PDF can be successfully routed in Validation without causing an error.

1379752 - "Object reference not set to an instance of an object" on opening a batch in Validation - get_IsViewerDocked

This error no longer occurs because the Docking XML is now protected from corruption.

1342366 - Bad performance with Bar Code Locator using FineReader when extracting QR code on color image.

By default, QR bar codes should be recognized with the default FineReader recognition settings. However, if FineReader fails to recognize a QR bar code using the default settings, you can use scripting to improve the chances of bar code recognition. This is possible because the AdvancedExtractionMode behavior is now available for editing via script.

If you want to recognize QR bar codes, you can add the following code to the BeforeLocate event.

Private Sub Document_BeforeLocate(ByVal pXDoc As CASCADELib.CscXDocument, ByVal LocatorName As String)
If(LocatorName = "BarcodeLocator") Then
Dim Loc As CscBarcodeLocator
Set Loc = Project.ClassByIndex(0).Locators.ItemByName(LocatorName).LocatorMethod
Loc. AdvancedExtractionMode = False
End If
End Sub

Problems Resolved in Fix Pack 4

1399311 - The Document_Validated is not thrown anymore if Fixpack 16 is installed and reclassify is used

If using Reclassify in AfterFieldConfirmed the Document_Validated event is now successfully raised again when a field is confirmed.

1399142 - TDS Model not working after KTM 6.3 upgrade

Trainable document separation is now successfully classifying and separating documents without issue.

1397124 - If a field is confirmed with holding down the enter key and the next batch is opened automatically then an Object reference error occurs

It is now possible to confirm a field by holding down the Enter key and when the next batch is opened automatically, there is no error.

1396686 - Field Count data missing from "Field Recognition Accuracy Per Day” report.

Field Count data is no longer missing from the “Field Recognition Accuracy Per Day” report.

1381523 - Getting error during Validation when trying to confirm a field “… DocumentLoaded: Reclassify is not permitted in the current script function…”

It is now possible to use the Reclassify call in script without this error.

1379761 - Table Evaluation not possible in KTM.

Table Evaluation is now performed successfully.

1378131 - Debug DLL Fixes Validation Module "Object Reference" Errors

An error no longer occurs in the Validation Module.

1375723 - Child set reread setting is ignored and parent class setting is used.

When a child class has a different locator reread setting than its parent class, the parent reread settings are no longer executed during extraction.

1358297 - Paste grayed out after doing Copy (CTRL+V) once KTM Validation, so you cannot continue doing copy/paste

It is now possible to copy and then paste using the Ctrl-based keyboard shortcuts or the clipboard, as many times as necessary.

Problems Resolved in Fix Pack 3

1370292, 1352443 - Object reference error is shown when confirming the field that reclassifies the document in script

An error no longer occurs when a document is reclassified in script using the AfterFieldConfirmed event.

1369734 - Datamatrix Barcode is not recognized in KTM anymore

By default, Datamatrix bar codes should be recognized with the default FineReader recognition settings. However, if FineReader fails to recognize a datamatrix bar code using the default settings, you can use scripting to improve the chances of bar code recognition. This is possible because the DetectInvertedZones behavior is now available for editing via script.

If you want to recognize Datamatrix bar codes, you can add the following code to the BeforeLocate event.

Private Sub Document_BeforeLocate(ByVal pXDoc As CASCADELib.CscXDocument, ByVal LocatorName As String)
If(LocatorName = "BarcodeLocator") Then
Dim Loc As CscBarcodeLocator
Set Loc = Project.ClassByIndex(0).Locators.ItemByName(LocatorName).LocatorMethod
Loc.DetectInvertedZones = False
End If
End Sub

1353640 - PDF file shows rendered without font (squares instead font) in Project Builder and Validation

Squares instead of the built-in PDF font are no longer displayed when rendering a PDF file.

1351693, 1349336 - Delete button grayed out in Validation when selecting multiple images

The Delete button is no longer greyed out in Validation when selecting multiple images.

1343422 - Inherited Advanced Evaluators Cause Crash in Project Builder

Project Builder no longer crashes when a Script Locator is defined before an Advanced Evaluator in the locator hierarchy of an inherited class.

Problems Resolved in Fix Pack 2

1330287, 1327445 - Document routing fails with PDF document if Batch.CopyDocument is used

It is now possible to successfully route PDF documents.

1329796, 1328209 - Server fails batches: Error in function ProcessBatch: Conversion from string "" to type 'Integer' is not valid

An error no longer occurs when an empty or non-existent custom storage string is encountered.

1328691 - Latency with Inbuilt Database script, delay in Validation module

In order to avoid this latency, a project Administrator needs to provide the database connection type to ODBC window in script. A new property called ‘ConnectionType’ is now available.

Here are the possible options for this new property.

EnumConnectionType_Unknown

EnumConnectionType_Odbc

EnumConnectionType_OdbcSql

EnumConnectionType_OdbcOracle

EnumConnectionType_SqlServer

When you provide the specific ‘ConnectionType,’ this bypasses any additional calls to the database that check the database schema.

Sample Script:

With odbDialog
.ConnectionType = EnumConnectionType_OdbcSql
mSupplier = .ShowDialog (CONNECTION_STRING,TABLE_NAME)
End With

Problems Resolved in Fix Pack 1

1321559, 1320959 - NLP: All entities have confidence 1

The confidence of an alternative is now the average confidence of all of the located mentions.

1321411, 1320885 - NLP: Locator is throwing error "Zone index out of range"

It is now possible to draw a region on a page and then test or use that region without it causing an error.

1317047, 1317053 - Named Entity Locator does not highlight the best mention

The best mention is now highlighted when viewing the Named Entity Locator results.

1317027, 1317030 - Named Entity Locator loses highlighting when you click TEST again

When testing the Named Entity Locator, all locator alternatives are displayed in the Document Viewer each time the Test button is pressed on the Test Results tab.

1317021, 1317033 - Missing entities in Named Entity Locator

When extraction is performed for the Named Entity Locator, a complete list of entities is now extracted as expected.

1317020, 1317037 - Missing scrollbar in Named Entity Locator

A scrollbar is now displayed when needed.

1315675, 1246992 - There are two processing windows coming for Training Extraction.

If there are no documents in a document set, the progress bar window is no longer displayed if Extraction training is performed for that document set.

1313696, 1320629 - Failed to extract entities with an error no language is specified.

The Test button on the locator is disabled if no language is configured at the class-level.

1310150, 1305677 - Validation crashing on reclassifying via script

Validation no longer crashes when a user reclassifies via script and then closes the module.

1280195 - Table Locator Extracting Lines Past End of Table Dictionary

The Table Locator now ignores lines extracted after the end of the table is found.

1266814, 1254229 - Name of representation is not changed after overwriting the recognition results

The name of a representation is now updated correctly when OCR is performed on a document that already has extraction results.

Applies To

This fix pack applies to Kofax Transformation Modules 6.3.1.

This fix pack is cumulative and includes the resolved issues released in previous Kofax Transformation Modules 6.3.1 fix packs.

Files Included

This fix pack includes the following files:

File name

Version

KofaxTransformationModules-6.3.1.18.exe

6.3.1.18

Kofax.ProjectExtension.dll

6.3.1.18

Kofax.ProjectExtension.resources.dll

6.3.1.18

ReadMe-KTM-6.3.1.18.html

N/A

Install This Fix Pack

Before installing this fix pack, note the following:

Do not remove or attempt to repair Kofax Transformation Modules using the .msp file provided with this fix pack. This can corrupt your installation and cause errors.

You must have full Windows administrative privileges to perform these procedures.

Make sure that Kofax Capture and Kofax Transformation Modules 6.3.1 are installed before applying the fix pack.

Install the fix pack on each client and standalone workstation running Kofax Transformation Modules. You can either run the installation from the .exe file or use the .msp file from the Command Prompt, which also gives you the option to run logging.

Install the Fix Pack with the .exe File

Use the following procedure to install the fix pack using the .exe file.

Close all Kofax Transformation Modules applications and services.

Run KofaxTransformationModules-6.3.1.18.exe to install the fix pack.

When you are notified that the installation process has been successfully completed, click OK to clear the confirmation message.

Install the Fix Pack with the .msp File

Use the following procedure to install the fix pack using the .msp.

Note: An MSP is no longer included with Kofax Transformation Modules.

For Kofax Transformation Modules fix packs, it is possible to extract the MSP from the executable as follows.

KofaxTransformationModules-6.3.1.18.exe /T: /C

In addition to these parameters, you can also use /Q for quiet mode.

The same goes for the Thin Client Server. You can extract the MSP from the executable using these same parameters.

Important: Do not remove or attempt to repair Kofax Transformation Modules using the extracted .msp file. This can corrupt your installation and cause errors.

Perform these steps on each client and workstation running Kofax Transformation Modules:

Start the Command Prompt as an Administrator.

Use the cd command to switch to the folder containing .msp file.

Run the following command:

msiexec /update KofaxTransformationModules-6.3.1.18.msp REINSTALL=ALL REINSTALLMODE=omus PATCHINSTALL=1

To enable logging, add the /L switch to the end of the command. The following command generates verbose logging to C:\KofaxTransformationModules-6.3.1.18.log:

/L*v C:\KofaxTransformationModules-6.3.1.18.log

Remove This Fix Pack

Before removing this Fix Pack, note the following:

You must have full Windows administrative privileges to perform these procedures.

Have access to KofaxTransformationModules-6.3.1.iso", the original installer program for Kofax Transformation Modules 6.3.1.

Mount the ISO image or use the network resource.

Use the following procedure to remove the fix pack.

Terminate all running Kofax Transformation Modules applications and services.

In Control Panel, select Programs and Features > View installed updates.

On the list of updates, in the Name column, select the item that corresponds to Kofax Transformation Modules 6.3.1 Fix Pack 18.

Right-click and select Uninstall.

Restart any applications/services that were stopped prior to removing the fix pack.

Log on Account for the System

Be sure that the log on account used to run the services has full Windows administrative privileges for the local system.

Changing the Server Scheduler Timeout Period

To change the Server Scheduler timeout period, do the following:

In the Registry Editor, select the following key:

For x64 operating systems: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Kofax\Transformation\4.0\Server

For x86 operating systems: HKEY_LOCAL_MACHINE\SOFTWARE\Kofax\Transformation\4.0\Server

Right-click the key and select New > DWORD (32-bit) Value.

In the Name field, enter ExtractionProcessTimeout.

In the Data field, enter the duration of the timeout in minutes. The default is 1440 for 24 hours.

Restart Server Scheduler.