Module 15 -- Customization Options - Kofaxclass.kofax.com/KC10/KC10Mod15.pdf · Module 15 --...

Module 15 -- Customization Options

Kofax Technical Training

Module 15Customization Options

Slide 2 Module 15 -- Customization Options

Customization Options

Customization Options

•Reference material

•Custom scripting

•Export connectors

•Custom elements

•Custom extensions

•Custom modules

•Batch workflow

•Workflow agents

•Customization deployment

•Custom notes


Customizing Kofax Capture

• In addition to the standard “out of the box” features, Kofax Capture can be customized to better suit unique and varied capture requirements.

• Reasons why Kofax Capture might be customized include:

• Streamline or bypass unnecessary operations

• Insert additional processes into the workflow or modify the operation of a workflow step

• Customize the user interface

• Customization is enhanced through a variety of Kofax-supplied tools and code samples (many of these in the form of source code).

Learn more details on how to customize Kofax Capture and get hands-on experience through the Customizing Kofax Capture course.




Development Environment Support

• Kofax Capture supports the following development languages for export and import connectors, custom modules, workflow agents, and OCX panels:

• Visual Basic .NET version 2005, 2008, 2010, 2012

• Visual C# .NET version 2005, 2008, 2010, 2012

• For validation and recognition scripts and field macros:

• Softbridge Basic Language (SBL) 5.3

• Visual Basic .NET 2005, 2008, 2010, 2012


Reference Material -- Sample Source Code

• Sample source code is included with Kofax Capture 10 at: C:\Program Files(x86)\Kofax\Capture\Source\Sample Projects

• Samples are written in VB.NET


Reference Material – Kofax Capture Developer’s Guide

The Kofax Capture Developer’s Guide provides guidance

information for customizing KofaxCapture and instructions to do so.

Several examples and code segments are provided to enhance

Kofax Capture processing. Available from the documentation link on the

Kofax Capture media.




Reference Material – Kofax Capture Export Type Library API Ref

The Kofax Capture Export Type Library API Reference contains the details of the Kofax Capture

Export Type Library and is designed for use with the Kofax

Capture Developer's Guide. Available from the

documentation link on the KofaxCapture media.


Reference Material – Kofax Capture API Reference

The Kofax Capture API Reference is available

from the documentation link on the Kofax Capture

media.


Kofax Capture API Reference

• The Kofax Capture API Reference contains the details for each API library needed to customize Kofax Capture.

• Designed to be used with the Kofax Capture Developer’s Guide as a primary resource for customizing Kofax Capture.




Options for Customizing Kofax Capture

• Custom Scripting

• Softbridge Basic Language (SBL) scripts for field type macros, recognition scripts, validation scripts, and folder scripts

• VB.NET scripting

• Export connectors

• Custom Elements

• Uses ActiveX Controls to change Scan, QC, Validation and Verification

• Custom Extensions

• Setup OCXs

• Custom modules

• Workflow agents


Softbridge Basic Language (SBL)

• A powerful tool providing flexibility and added processing

• SBL is a complete programming language: powerful, easy to use, GUI adaptation of BASIC (compiled)

• SBL code may be written to accomplish special tasks during batch processing

• Tasks may calculate and supply values, check data for structure and content and reformat accordingly, even update or change data that is inside or outside Kofax Capture

• SBL scripts can be used to save keystrokes and improve accuracy when validating data

• Provided FREE


Options for SBL Scripting

• SBL scripts for field type macros, recognition scripts, validation scripts, and folder scripts

• Field type macros are associated with field types and supplement field type processing rules

• Recognition scripts are attached to custom recognition profiles and operate in the Recognition Server queue

• Validation scripts and folder scripts change the way a document class or a folder class works during Validation or Verification

• Two editors available:

• Launched from within Kofax Capture

• External (SBLDemo.exe)




Creating a Script from the Ribbon

Scripts can be created from the

script icons in either the Home or

Tools tabs.


Creating a Script from a Kofax Capture Object

Scripts can also be created from an object (document class, folder class, or field type) within Kofax Capture.


Creating a Script from a Custom Profile

Scripts can also be created from custom profiles. The scripts will then run when the profile is used in batch

processing.




SBL Code – Updating a Database

This example depicts the code for

a message box prompting the

Validation operator to update the

database. The SQL command updates

the external database.


Saving the SBL Script

When the script is compiled and saved, Kofax Capture names it and saves in the following folder: C:\ProgramData\Kofax\Capture\AdminDB\Scripts


Validation - Data to be Changed




SBL Code Working to do the Update


External SBL Editor

• SBL scripts can be modified using the free external editor located at: Program Files(x86)\Kofax\Capture\Bin\sbldemo.exe

• Scripts are stored in: C:\ProgramData\Kofax\Capture\AdminDB\Scripts


VB.NET for Scripting

• Kofax Capture supports VB.NET as an alternative to the SBL scripting language to create field, validation, and recognition scripts.

• Key advantages of the VB.NET programming environment over SBL are Unicode support for natural languages requiring multi-byte characters, support for regular expressions, and a large VB .NET knowledgebase for support in its use.

• When creating scripts, the option of using either VB.NET or the SBL scripting language is presented.

Select either SBL or VB.NET when creating a script




Creating a VB.NET Script

VB.NET scripts can be created using Visual Basic 2005, 2008, 2010 or Visual Basic Express

2005, 2008, 2010, 2012


Using Legacy VB 6 Components

• When using Kofax Capture 10 with custom components that were created with non .NET development languages (e.g., Visual Basic 6), additional installation files are needed

• Kofax Capture 10 media contains a “VB6 Components” directory (subdirectory of Export Connectors folder)

• Includes the following files:

• mscomct2.ocx

• MSCOMCTL.OCX

• TABCTL32.OCX

• OCX files should be copiedto the Kofax\Capture\Bindirectory and registered using RegSvr32


Export Connectors

• Provide a method to export images, OCR Full Text and PDF files, and data.

• Accomplishes

• Storage of documents and data

• High level Integration with the destination application

• Kofax Capture ships with four export connectors for exporting to:

• A flat text file

• A database

• A fax server

• An email server

• The four export connectors provided as part of Kofax Capture include source code so they can be modified




Export Connectors Have Been Rewritten

• The database and text export connectors have been rewritten in VB.NET and updated source code is included on the Kofax Capture media.

• Older release scripts that were written in VB 6 may require components that are no longer installed with Kofax Capture. These can be found in the following directory:“Export Connectors\VB6 Components”


Export Connector – Text

• The source code for the Text Export Connector is located in: Program Files(x86)\Kofax\Capture\Source\Export Connectors\KCEC-Text

• Source code is provided and can be opened up in a Visual Basic editing tool and modified.


Export Connector – Database

• The source code for the Text Export Connector is located in: Program Files(x86)\Kofax\Capture\Source\Export Connectors\Database





Export Connectors

• A variety of export connectors are available for download from the Kofax Electronic delivery site.


• Detailed information about these export connectors can be found on the Kofax Web site.


Export Connectors Details are Available Online

Details on the available export connectors may be found on the Kofax Web site:

Software | Kofax Capture | Extensions | Kofax Export Connectors


Kofax Capture Export Connectors Page

3 categories of export connectors are available: Kofax-supported export connectors, Partner-supported export connectors, and Freeware

export connectors




Export Connector Manager

Click on the Export Connectors icon in the Tools tab to launch the

Export Connector Manager

Use the Export Connectors Manager to register custom export connectors for

use with Kofax Capture.


Export Connector Manager Add

Export connectors are now available to all document classes

Follow the directions in the Kofax Capture

Developers Guide for creation and placement of the necessary files

Click on [Add] to register an export

connector


Custom Elements

• Custom Elements provide the ability to customize Administration, Scan, QC, Validation & Verification

• Custom panels

• Custom menus and context menus

• Import scripts

• Attached to Actions or Events

• Uses ActiveX objects (OCX) to add or change the GUI and/or functionality

• Offers a high level of customization in Kofax Capture

• Import scripts also allow batches to be created automatically (requires appropriate licensing)

Contact Kofax Technical Support or Kofax Professional Services for assistance.




Panel Customization – QC Queue

This custom panel is displayed in the Quality

Control module and represents a sample OCX

intended to be a visual depiction of available events


Panel Customization – Menus Added

Menu options may be added or deleted as needed for a

custom installation

Source Code is available at: C:\Program Files(x86)\Kofax\Capture\Source\Sample Projects\StdCust


Enable/Disable Menu and Toolbar Options

• Provides the ability to disable certain functionality to operators in the attended queues.

• An OCX can be written to block specific menu items and toolbar options.

• “BlockFunction” and “RestoreFunction” method calls are used.

OCX disables toolbar feature.

Feature not available.




Custom Extensions

• Setup OCX• Add user interface options and set runtime properties.

• Custom Modules• Develop custom processing modules to perform

special functions. Once the custom module is registered with Kofax Capture, it can be included in the batch processing workflow.

• Workflow Agents• Create a custom application that allows custom

routing of batches in Kofax Capture. A workflow agent is invoked whenever a batch is closed from any module.


Sample Setup OCX

Source code is available at: C:\Program Files(x86)\Kofax\Capture\Source\

Sample Projects\SetupOCX\SmpSetup


Example Sample Setup OCX

The Kofax Front Office Server menu is an example of a sample

setup OCX implementation

New menu items added to the Administration module




Custom Modules

• Additional targeted applications that become part of the Kofax Capture workflow.

• Provides for a user interface during runtime.

• Become additional queue(s) anywhere between Scan and Export.

• Use XML data stream (XML transport files) to transfer files in and out of the Kofax Capture workflow.

• Batches are processed through the new queues in the same manner as they are with standard Kofax Capture queues.

• Custom Modules are written in Visual Basic and must be registered with Kofax Capture.


Custom Module Examples

• Examples:

• A module for adding annotation to an image

• Check reader module

• A patient medical records module

• A module that compares and matches signatures to an existing history file

• A module to do document redaction


Custom Modules Available

Many custom modules are available via the Kofax Web site:

Software | Kofax Capture | Extensions | Kofax Custom Modules




Custom Modules Listed


Custom Module Manager

Click on the Custom Modules icon in the Tools tab to launch the Custom

Module Manager

Use the Custom Module Manager to set up user-defined modules.


Custom Module Manager Add

Click on [Add] to register a

custom module

Follow the directions in the Kofax Capture Developers Guide for creation and placement of the necessary files.




Custom Module is a Queue

Administrators can also register custom modules

directly from the Batch Class Properties window


Custom Module in the Kofax Capture Workflow

A custom module may be positioned anywhere in the workflow between

Scan and Export


Custom Standard Module

The Custom Standard Module is available for customizing, has

many of the attributes of Quality Control, and can easily be

changed and renamed. (Source code is not available.)

Remember: A Station license is required when running a custom module developed from the Custom Standard Module




Custom Standard Queue

Source is similar to the QC Module

Standard XML DTD is available

Manifest file provides for easy changes


Batch Workflow

• Divides a batch into multiple child batches based on any programmable criteria such as form type.

• Pages and documents can then be moved between the open parent and child batches.

• Custom routing can then be applied such that the new child batches will be dynamically routed to different locations within the workflow.

• Initial batch integrity is maintained.


Batch Workflow Example

Custom Module

Batch consisting of mixed document

types

50 documents, Home Insurance Claims

under 100,000

50 documents, Auto Insurance Claims under

100,000

50 documents, All claims over 100,000

For example, a parent batch can be split into multiple child

batches based on form type, then dynamically routed to different

locations for processing




CMSplit Custom Module Using Batch Workflow

• CMSplit – A sample custom module that utilizes the Batch Workflow feature and divides a batch based on form type.

• Creates new child batches for each additional form type in the batch.

• For example, if a scanned batch contains a mixture three different form types, CMSplit results in three separate batches, each containing only the documents of a single form type.

• Further routing of the resultant batches can be coded within CMSplit or via a custom workflow agent such that each batch containing documents of a certain form type get routed to a unique location in the workflow.


CMSplit Custom Module Source Code

• Source code is available at: C:\Program Files(x86)\Kofax\Capture\Source\Sample Projects\CustMod\CMSplit


Workflow Agents

• Agents that watch for conditions and route batches to queues automatically

• Skip normal processes

• Add additional processes

• Unlike custom modules, workflow agents are not queues in the production workflow process. They act as “traffic cops,” monitoring settings at the close of every queue at runtime, then reacting accordingly by redirecting batch routing behavior.

• Typically they do not provide a user interface at runtime.

• Workflow agents are written in Visual Basic and must be registered with Kofax Capture.




Workflow Agents Running in Production

• Applications that watch for conditions in a batch.

• Configured at the batch class level.

• May have multiple workflow agents per batch class.

• Run in the background.

• Conditionally route batches for additional processing or limited processing.

• Conditional routing can save key strokes and time.

• Conditional routing can expose problem documents that need correction.


Workflow Agent Manager

Click on the Workflow Agents icon in the Tools tab

to launch the Workflow Agent Manager

Use the Workflow Agent Manager to register custom workflow agents.


Workflow Agent Manager Add

Click on [Add] to register a

workflow agent

Follow the directions in the Kofax Capture Developers Guide for creation and placement of the necessary files.




Workflow Agents in Batch Class

Administrators can also register workflow agents

directly from the Batch Class Properties.

A Workflow Agents tab is available in the Batch Class

Properties for assigning multiple workflow agents

Available workflow agents are listed and may be added to the batch class using the

[Add] button.


Multiple Workflow Agent can be Configured

The sample workflow agent is now available for this batch

class


The Validation Workflow Agent

The workflow agent is now

available in the batch class

A new menu item provides for changing properties of the batch class by setting

some conditions




Setting Validation Workflow Properties

The agent has a Properties window that will allow

setting properties for batch routing behavior based on

the Confidence Level


Batch is Routed Past Validation

Scan Station

Workflow as defined in batch class

Recognition Server

Validation Verification Export

This batch had Confidence Levels from the Recognition Engines that were at or above the threshold set for all fields

This batch skips Validation and Verification and is ready for Export

Scan Station

Revised workflow as direct result of workflow agent

Recognition Server

Validation Verification Export

This is an example of what the workflow agent can accomplish


Batch Routing with Workflow Agents

• APIs allow workflow agents to assign access to batches in-process.

• Method calls: “GrantUserAccessToBatch” and “GrantGroupAccessToBatch”

• Only the granted user or group can process the batch in the next queue.

• Workflow agents can dynamically redirect batches in-process to the appropriate queue for processing.

CMSplitRecognition Server

Scan

Auto Policy Clerks

Home Policy Clerks




Customization Deployment

• The Customization Deployment feature allows Kofax Capture developers to easily and automatically deploy customizations throughout an entire Kofax Capture system to any client workstation that is connected to a server and has the service installed and enabled.

• Developers can develop and test a customization on one node of the Kofax Capture system and then enable the deployment and registration to other client workstations and remote sites.

• Kofax Capture customizations include:• Workflow agents • Custom panels • Custom modules • Export connectors


Automatically Download to Clients

Kofax Capture Server or Central Site

Kofax Capture Client


MyCustomization.AEXMyCustomization.INFMyCustomization.DLLMyCustomization.EXE

Registration.cmdTime.txt

Version.txt

MyCustomization.AEXMyCustomization.INFMyCustomization.DLLMyCustomizatiion.EXE

Registration.cmd


Registration.cmd


Registration.cmd


Once a customization update is configured on a Kofax Capture server, it can be automatically

downloaded and installed to client workstations connected to that server per the posted time file.


Customization Deployment – Configuration Steps

1) Install Kofax Capture Deployment Service on Kofax clients that will receive customizations

2) Create a “Customization Deployment” directory on the server

• Specify the daily deployment time in the Time.txt file

3) Create a customization subfolders and update with the necessary files• Customization files (aex, inf, exe, dll)

• Registration.cmd

• Version.txt




Configuration Step #1 – Install the Deployment Service

• Install “KCDeploymentService.exe” on each client using InstallUtilC:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\InstallUtil

/username=.\administrator /password=password /unattended "C:\Program Files(x86)\Kofax\Capture\Bin\KCDeploymentService.exe"

• The service must:• Run as a user with read-write access to the Customization Deployment

folder on the Kofax Capture server

• Have Administrator rights to allow copying and replacing files in the Program Files(x86)\Kofax\Capture\Bin directory


Configuration Step #2 – Create Deployment Folder

• In the Kofax server share folder:• Create a “Customization Deployment” folder

• Create a “Time.txt” file

• Time file contains once daily time for customization distribution

• Time is in 24 hour format – hh:mm (hh = 00 to 23; mm = 00 to 59)

• Time is local to each workstation

• If file does not exist or the format is incorrect, no deployments occur


Configuration Step #3 – Create Customization Subfolders

• In the server “Customization Deployment” folder:• Create a directory (or directories) for the customization (e.g., Workflow

Sample)• Directory name will be used for identification in logs

• Copy/paste in the customization assembly files (e.g., EXE or DLL files)




Registration and Version Files

• Create a “Registration.cmd” file with component registration commands

• Create “Version.txt” file that contains a version number (e.g., v1.09)

• Version value are used for identification in logs

• It is intended that this string indicates a version to distinguish subsequent updates to the customization

• File timestamp determines whether or not this customization will be updated


Kofax Capture Deployment Service Runs

• Kofax Capture Deployment Service does the following:• Polls the Time.txt to determine when to deploy custom components

• Polls the Version.txt files for each custom component subdirectory to determine if files need to be deployed

• Copies files into Kofax\Capture\Local folder, then copies to Bin directory

• Executes the Registration.cmd file if provided

• Updates log files with status messages


Files are Downloaded to Kofax Capture Clients

• The customization files are loaded to the client workstations, registered with Kofax Capture, and ready for use.




Customization Deployment – Operator Notification

• Deploying customization updates does not force Kofax operators to stop working

• If an operator is using a Kofax Capture attended application that requires a customization update, a message is displayed in the system tray (message will reappear once every 24 hours)

• Operators can decide when to reboot (which triggers the update)

• Workstations that have been installed after the initial deployment can still obtain customizations


Customization Deployment using KCNS

• Kofax Capture Network Server (KCNS)

• Deploy the customization update to the central site KofaxCapture server

• The Remote Synchronization Agent (RSA) automatically updates remote servers from a single source on the central site

• Deployment files are copied to the Kofax Capture server folder at the remote sites

• Customization files then become accessible to the remote workstations

• Synchronization does not result in immediate deployments – the Time.txt still determines when the customization is deployed (local time)

• Server Log Files record customization deployment activity

ProgramData\Kofax\CaptureSV\Customization Deployment\Logs\deployedyymm.txt

• Client Log Files on each workstation log the deployment service at various steps in the deployment process

ProgramData\Kofax\Capture\Local\Customization Deployment\DeploymentStatus.txt


Customization Deployment – Log Files




Customization Deployment Restrictions

• The Kofax Capture Deployment Service does not:

• Automatically delete customizations from workstations.

• Automatically deploy customizations before a batch needs it; deployments are set up by central site administrators.

• Deploy other types of Kofax software such as KTM.

• Deploy other types of generic software -- it deploys only Kofax Capture customized software.


Custom Notes

• Custom notes may be created for use if a document or page is rejected by an operator.

• The file created is: ACNotes.xml and is located in the Config folder of Kofax.

• When the file exists in the Config folder, it is active.

• The file may be created using almost any editor similar to Windows Notepad.

• The XML file contains elements and attributes that create the custom notes.


Custom Notes XML File

“All” = Scan, QC, Validation and Verification modules

Specific modules may have other or additional notes too




ACNotes.xml Rejection Note

Scan, QC, Validation and Verification modules are affected


Customization

• More tools available

• Easier development

• More sample code

• Complete modules ready to use


Demonstration

CMSplitRecognition Server

Scan

Auto Policy Clerks

Home Policy Clerks

Batch Workflow and CMSplit, adding and running a workflow agent, adding and running a

validation script




Lab

• Adding a custom module

• Running CMSplit and the batch workflow feature

• Adding and running a workflow agent

• Adding and running a validation script

Refer to the Kofax Capture 10 Lab and Reference Guide

Module 15 -- Customization Options - Kofaxclass.kofax.com/KC10/KC10Mod15.pdf · Module 15 --...

Documents

Transcript of Module 15 -- Customization Options - Kofaxclass.kofax.com/KC10/KC10Mod15.pdf · Module 15 --...