Module 15 -- Customization Options Kofax Technical Training Page 1 Module 15 Customization 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 Slide 3 Module 15 -- Customization Options 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.
28
Embed
Module 15 -- Customization Options - Kofaxclass.kofax.com/KC10/KC10Mod15.pdf · Module 15 -- Customization Options Kofax Technical Training Page 1 ... •Launched from within Kofax
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Module 15 -- Customization Options
Kofax Technical Training Page 1
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
Slide 3 Module 15 -- Customization Options
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.
Module 15 -- Customization Options
Kofax Technical Training Page 2
Slide 4 Module 15 -- Customization Options
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
Slide 5 Module 15 -- Customization Options
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
Slide 6 Module 15 -- Customization Options
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.
Module 15 -- Customization Options
Kofax Technical Training Page 3
Slide 7 Module 15 -- Customization Options
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.
Slide 8 Module 15 -- Customization Options
Reference Material – Kofax Capture API Reference
The Kofax Capture API Reference is available
from the documentation link on the Kofax Capture
media.
Slide 9 Module 15 -- Customization Options
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.
Module 15 -- Customization Options
Kofax Technical Training Page 4
Slide 10 Module 15 -- Customization Options
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
Slide 11 Module 15 -- Customization Options
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
Slide 12 Module 15 -- Customization Options
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)
Module 15 -- Customization Options
Kofax Technical Training Page 5
Slide 13 Module 15 -- Customization Options
Creating a Script from the Ribbon
Scripts can be created from the
script icons in either the Home or
Tools tabs.
Slide 14 Module 15 -- Customization Options
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.
Slide 15 Module 15 -- Customization Options
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.
Module 15 -- Customization Options
Kofax Technical Training Page 6
Slide 16 Module 15 -- Customization Options
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.
Slide 17 Module 15 -- Customization Options
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
Slide 18 Module 15 -- Customization Options
Validation - Data to be Changed
Module 15 -- Customization Options
Kofax Technical Training Page 7
Slide 19 Module 15 -- Customization Options
SBL Code Working to do the Update
Slide 20 Module 15 -- Customization Options
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
Slide 21 Module 15 -- Customization Options
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
Module 15 -- Customization Options
Kofax Technical Training Page 8
Slide 22 Module 15 -- Customization Options
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
Slide 23 Module 15 -- Customization Options
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
Slide 24 Module 15 -- Customization Options
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
Module 15 -- Customization Options
Kofax Technical Training Page 9
Slide 25 Module 15 -- Customization Options
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”
Slide 26 Module 15 -- Customization Options
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.
Slide 27 Module 15 -- Customization Options
Export Connector – Database
• The source code for the Text Export Connector is located in: Program Files(x86)\Kofax\Capture\Source\Export Connectors\Database
• Source code is provided and can be opened up in a Visual Basic editing tool and modified.
Module 15 -- Customization Options
Kofax Technical Training Page 10
Slide 28 Module 15 -- Customization Options
Export Connectors
• A variety of export connectors are available for download from the Kofax Electronic delivery site.
• Source code is provided and can be opened up in a Visual Basic editing tool and modified.
• Detailed information about these export connectors can be found on the Kofax Web site.
Slide 29 Module 15 -- Customization Options
Export Connectors Details are Available Online
Details on the available export connectors may be found on the Kofax Web site:
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.
Slide 45 Module 15 -- Customization Options
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.
Module 15 -- Customization Options
Kofax Technical Training Page 16
Slide 46 Module 15 -- Customization Options
Custom Module is a Queue
Administrators can also register custom modules
directly from the Batch Class Properties window
Slide 47 Module 15 -- Customization Options
Custom Module in the Kofax Capture Workflow
A custom module may be positioned anywhere in the workflow between
Scan and Export
Slide 48 Module 15 -- Customization Options
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
Module 15 -- Customization Options
Kofax Technical Training Page 17
Slide 49 Module 15 -- Customization Options
Custom Standard Queue
Source is similar to the QC Module
Standard XML DTD is available
Manifest file provides for easy changes
Slide 50 Module 15 -- Customization Options
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.
Slide 51 Module 15 -- Customization Options
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
Module 15 -- Customization Options
Kofax Technical Training Page 18
Slide 52 Module 15 -- Customization Options
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.
Slide 53 Module 15 -- Customization Options
CMSplit Custom Module Source Code
• Source code is available at: C:\Program Files(x86)\Kofax\Capture\Source\Sample Projects\CustMod\CMSplit
Slide 54 Module 15 -- Customization Options
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.
Module 15 -- Customization Options
Kofax Technical Training Page 19
Slide 55 Module 15 -- Customization Options
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.
Slide 56 Module 15 -- Customization Options
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.
Slide 57 Module 15 -- Customization Options
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.
Module 15 -- Customization Options
Kofax Technical Training Page 20
Slide 58 Module 15 -- Customization Options
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.
Slide 59 Module 15 -- Customization Options
Multiple Workflow Agent can be Configured
The sample workflow agent is now available for this batch
class
Slide 60 Module 15 -- Customization Options
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
Module 15 -- Customization Options
Kofax Technical Training Page 21
Slide 61 Module 15 -- Customization Options
Setting Validation Workflow Properties
The agent has a Properties window that will allow
setting properties for batch routing behavior based on
the Confidence Level
Slide 62 Module 15 -- Customization Options
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
Slide 63 Module 15 -- Customization Options
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
Module 15 -- Customization Options
Kofax Technical Training Page 22
Slide 64 Module 15 -- Customization Options
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.
• 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)
Module 15 -- Customization Options
Kofax Technical Training Page 24
Slide 70 Module 15 -- Customization Options
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
Slide 71 Module 15 -- Customization Options
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
Slide 72 Module 15 -- Customization Options
Files are Downloaded to Kofax Capture Clients
• The customization files are loaded to the client workstations, registered with Kofax Capture, and ready for use.
Module 15 -- Customization Options
Kofax Technical Training Page 25
Slide 73 Module 15 -- Customization Options
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
Slide 74 Module 15 -- Customization Options
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