You are on page 1of 399

InputAccel

Fundamentals and
Administration
Book 1
(P/N IAFA-60-0209-01)

Participant Guide

2009 EMC Corporation. All rights reserved.

Copyright statement: Copyright 1994-2009. EMC Corporation. All Rights Reserved.


Trademark Statement: Captiva and the Corporate Logo are trademarks or registered
trademarks of EMC Corporation in the United States and throughout the world. All other
company and product names are used for identification purposes only and may be
trademarks of their respective owners.
This is an unpublished work containing confidential and proprietary information.
Use, disclosure, reproduction, or transfer of this work without the express, written consent
of EMC Corporation is prohibited.

Intro - 1
2009 EMC Corporation. All rights reserved.

Dear EMC|Documentum Education Student:


This letter will serve to confirm that all information that is disclosed orally,
visually, and in printed form during your training class is to be treated as
"Confidential" in accordance with the terms of the applicable confidentiality
agreement (the "Agreement") between EMC|Captiva and your Company.
Under the terms of the Agreement, please be advised that you may not:
1. disclose such information or materials except as specified in the Agreement,
nor
2. use such information or materials other than for the specified purpose set forth
in the Agreement.
Also, the materials you receive during your visit are copyrighted works of EMC
Corporation (regardless of whether they bear a copyright mark) and may be used
only for the purpose of supporting the training of your employees who attend
EMC|Captiva training courses. You may not reproduce, disclose, or distribute
these materials, in whole or in part, nor may you prepare derivative works of
them. These copyrighted works include the Student Guides, Lab Manuals,
Instructor Guides, and all course materials used in EMC|Captiva courses and
workshops.

Intro - 2
2009 EMC Corporation. All rights reserved.

Intro - 3
2009 EMC Corporation. All rights reserved.

Course Modules
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.

Captiva Overview
Installation
InputAccel Overview
Licensing
ScaleServer
Security
Client Modules
Administering Servers, Processes and Batches
ScanPlus
Image Enhancement
Book 1
OCR
IndexPlus
Book 2
Forms Processing
Standard Export
Troubleshooting
Logging and Reporting
Documentum Export
Other Modules
Web Services
Introduction to Process Development

Note: To download lab files for this course, please go to:


http://mylearn.documentum.com/labfiles/ia/iafa0209.zip
Intro - 4
2009 EMC Corporation. All rights reserved.

Course Objectives

Describe the InputAccel Products


Install and license the InputAccel database, server,
and client modules

Understand security requirements for InputAccel


users

Learn how to deploy client modules using


ClickOnce

Describe, perform setup, and use common client


modules such as ScanPlus, IndexPlus, Image
Enhancement, OCR, and Documentum Advanced
Export

Understand how to configure and use the Web


Services Subsystem

Describe logging and reporting

Manage processes and batches

Describe Client-side Scripting


Gain an understanding of how processes are
developed

Intro - 5
2009 EMC Corporation. All rights reserved.

Course Prerequisites
Understanding of Client/Server Technology
Familiarity with imaging and Enterprise
Content Management concepts (desired)

Intro - 6
2009 EMC Corporation. All rights reserved.

Course Logistics
Schedule

Breaks / Lunch

Restrooms

Phones

Access/Security

Intro - 7
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration

Table of Contents
Book 1
Module 1: EMC Captiva Overview
Imaging Concepts...................................................................................................................1-3
EMC Captiva...........................................................................................................................1-5
InputAccel Process Overview ...............................................................................................1-14
Captiva Products ..................................................................................................................1-15

Module 2: Installation
Hardware and Software Requirements...................................................................................2-3
Software Installation ...............................................................................................................2-8

Module 3: InputAccel Overview


InputAccel Overview ...............................................................................................................3-3
Processes and Batches ........................................................................................................3-14

Module 4: InputAccel Licensing


Activation and Licensing Overview .........................................................................................4-3
License Parameters................................................................................................................4-9
License Management ...........................................................................................................4-16

Module 5: ScaleServer
Overview.................................................................................................................................5-3
Example Operation .................................................................................................................5-7
Creating ScaleServer Groups...............................................................................................5-17

TOC- 1
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration

Module 6: Security
Overview.................................................................................................................................6-3
Roles and Role Management .................................................................................................6-5
Permissions and ACLs .........................................................................................................6-14

Module 7: Client Modules


Setup and Production .............................................................................................................7-3
Departmental Routing...........................................................................................................7-22
Commonly Used Modules.....................................................................................................7-27

Module 8: Administering Servers, Processes, and Batches


Server Settings .......................................................................................................................8-3
Managing Processes ............................................................................................................8-11
Managing Batches ................................................................................................................8-20
Connections..........................................................................................................................8-36

Module 9: ScanPlus
ScanPlus Overview ................................................................................................................9-3
Setup Mode ............................................................................................................................9-6
Production Mode...................................................................................................................9-19

Module 10: Image Enhancement


Overview...............................................................................................................................10-3
Color Filters ..........................................................................................................................10-5
Binary Filters.......................................................................................................................10-18
Run Mode Options..............................................................................................................10-25

Module 11: OCR


Overview...............................................................................................................................11-3
NuanceOCR .........................................................................................................................11-6

Book 2
TOC- 2
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration

Module 12: IndexPlus


IndexPlus Overview ..............................................................................................................12-3
Setup ....................................................................................................................................12-6
Production...........................................................................................................................12-23

Module 13: Forms Processing


Overview...............................................................................................................................13-3
Page Registration .................................................................................................................13-8
Setup Mode ........................................................................................................................13-12
Production Mode.................................................................................................................13-19

Module 14: Exporting to Standard Systems


Export Modules.....................................................................................................................14-3
Image Export ........................................................................................................................14-5
PDF Export ...........................................................................................................................14-8
Index Export........................................................................................................................14-10
Values to XML ....................................................................................................................14-12
ODBC Export ......................................................................................................................14-17

Module 15: Troubleshooting


Database Problems ..............................................................................................................15-3
Log Files ...............................................................................................................................15-5
Debugging a Batch .............................................................................................................15-12
Input Management Console................................................................................................15-18

Module 16: Logging and Reporting


Logging .................................................................................................................................16-3
Reporting ............................................................................................................................16-16
Purges ................................................................................................................................16-22

Module 17: Documentum Advanced Export

TOC- 3
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Overview...............................................................................................................................17-3
Setup ....................................................................................................................................17-5

Module 18: Other Modules


Import Modules .....................................................................................................................18-3
Image Processing Modules ..................................................................................................18-6
Utilities ..................................................................................................................................18-8

Module 19: Web Services


Web Services Overview........................................................................................................19-3
Configuring Services and Hostings.....................................................................................19-10
Web Services Input Setup ..................................................................................................19-22
Web Services Output Setup ...............................................................................................19-25

Module 20: Introduction to Process Development


Development Cycle...............................................................................................................20-3
Process Components ...........................................................................................................20-5
Creating a Process .............................................................................................................20-10
Task Levels.........................................................................................................................20-28
Debugging Batches ............................................................................................................20-33

TOC- 4
2009 EMC Corporation. All rights reserved.

Module 1

EMC Captiva Overview

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-1

Module Objectives

Describe the EMC Captiva Solution


List Captiva Products

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-2

1-2

Imaging Concepts
Captiva Products

Electronic Imaging

Electronic imaging uses optical scanners to


convert paper content into electronic content

Examples include:
- Structured or unstructured documents
- Invoices
- Billing statements
- Forms

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-3

1-3

Benefits of Capturing Paper Documents and


Information
Reduce operating costsdocument preparation,
data entry, etc.
Reduce paper costslost, duplicated, shipped, handled, filed, etc.
Improve the quality of the information that is driving your critical
business processes
Accelerate business processesimmediate access to all
information and supporting documentation
Stronger compliance controlenforced electronic retention
Provide better and faster customer service

InputAccel Overview

1-4

2009 EMC Corporation. All rights reserved.

Customers receive tremendous benefits in automating their paper-based, manual processes.


Some of these benefits include:
-30-50% productivity increases in streamlining processes by eliminating the inefficiency, expense
and paper environment in which documents are handled sequentially and can be easily misplaced
or lost. In the case of Cincinnati Insurance Company they were able to reduce the claims entry
time from 30 days to one day.
-15% of all paper handled in a typical business gets lost (Bostons Delphi Group). Capturing the
documents at the beginning of the process will eliminate lost or misplaced files. In addition, each
lost piece of paper costs a business on the average of $120 (Bostons Delphi Group)
-The Boston Delphi Group states that 30% of all employees time is spent looking for documents.
Digitized documents stored in a central repository can provide immediate and simultaneous
access to all files, information and supporting documents, regardless of geographic location.
-The control and accessibility of an end-to-end transactional content management system can
save significant research costs and potential compliance penalties. Such a system can:
Eliminate the inherent risk of paper documents
Ensure the integrity of documents
Provide a verifiable audit trail
Set and enforce policies
Enable fast and cost-efficient access to documents in the event of litigation
-Managing business files in digital form gives employees the global, on-demand access to content
that is necessary to ensure a 360-degree view of customer data and business transactions.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-4

EMC Captiva
Input Management
Captures digital and paper content and enhances image quality
Identifies document types and extracts data
Validates index data against backend business applications
Delivers to EMC Documentum, ERP, and other systems

Metadata
Author
Date
From
Subject
Customer

Capture

Classify

Extract

Validate

InputAccel Overview

Deliver
1-5

2009 EMC Corporation. All rights reserved.

EMC Captivas input management solutions capture information from a wide variety of file format and document types.
The EMC Captiva family helps you capture business critical information from paper, fax and electronic data sources into businessready content suitable for processing by enterprise applications. Youll easily automate the processing of billions of documents
annually, quickly and accurately converting their contents into information that is usable for all enterprise business processes in
a timely and cost-effective manner.
All documents, regardless of format, are either scanned, faxed or received electronically. These documents will go through an image
enhance process making optimal to begin to identify the document, whether it is a contract, PO, or correspondent. Metadata is
then extracted from the document based on its classification. As an option, the data can be validated against a third party
application, such as ERP / LOB, to ensure that the information extracted from the document is accurate. At the end of the
process the digitized documents and metadata are delivered and stored within EMC Documentum and / or ERP systems.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-5

Capture from All Types of Sources

INPUTACCEL PLATFORM

Scanners

CAPTURE

CLASSIFY

EXTRACT

VALIDATE

DELIVER

Faxes

Key Points
MFPs

Capture of various content types through


fax, scanner, network drives, remote sites

Network
Directories

Includes paper and electronic documents


(structured and unstructured), and data
streams

E-mail

eForms

Applies image quality checks, cleans up


images improving image clarity and
readability and speeds processing, without
manual intervention

InputAccel Overview

1-6

2009 EMC Corporation. All rights reserved.

There are many types of information that organizations need to capture such as paper, faxes, film,
images, and sometimes electronic files. Captiva provides solutions to capture these paper and
electronic files, automatically identify them, extract data within them, then deliver that data and
images of the documents to back end systems such as ECM, ERP, and databases. IA is a perfect
fit when an organization has several sources where they need to capture documents.
Key points:
Email strips out attached files (TIFF images) and processes them through IA
Faxes receives incoming images via fax servers (e.g. Captaris Rightfax)
eForms Accept a data stream from eForms
Scanners Supports document scanning in both an hoc (low volume/distributed capture) or high
volume (centralized production capture)
Network servers IA polls specific network folders and processes images as they become
available on the server
MFP Supports distributed capture using MFPs (Multi-functional peripherals supplied by
companies like Xerox, Ricoh, and others)
Once documents are scanned, IA applies image enhancement techniques to clean up the image
(e.g. applies deskew, despeckle, line removal, etc)

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-6

Classify Documents
INPUTACCEL PLATFORM
CAPTURE

CLASSIFY

EXTRACT

VALIDATE

DELIVER

InputAccel
Server

Key Points
Classify documents while reducing
or eliminating manual document
preparation and sorting

claims
tax
returns

Index and route documents to the


appropriate business process and
assemble complex document
packages

quotes
contracts

apps/
forms

Mailroom functionality within a


business-critical TCM solution

InputAccel Overview

1-7

2009 EMC Corporation. All rights reserved.

Customer Example (Morgan Stanley):


Chose EMC Captiva InputAccel and Dispatcher as their solution
The new process opens the envelopes and pulls out
the documents automatically
Dispatcher classify account documents and extracts
key information such as Account #, Name and Address
Dispatcher uses freeform OCR to find keywords and extract related data, and database lookups for matches are made against an internal database with
automate the data validation where possible

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-7

Identify Documents
INPUTACCEL PLATFORM
CAPTURE

CLASSIFY
IDENTIFY

EXTRACT

VALIDATE

DELIVER

Key Points
InputAccelUtilize
separator sheets,
patch codes, bar codes,
or advance document
identification for batch
processing
DispatcherAdvanced
classification techniques
reduces or eliminate manual
document preparation and
sorting

Doc Set 1

Doc Set 2

Patient folder:
0045128

Doc Set 3

Doc Set 4

Patient Folder:
0045670

Associate attachments with


a template
Index and route documents
to the appropriate business
process

InputAccel Overview

1-8

2009 EMC Corporation. All rights reserved.

Two Ways to identify documents:


1)Sort documents into logical sets and use separator sheets, patch codes, or barcodes to indicate
to IA when a new document starts. This approach is most applicable in scenarios where it is easy
to come up with these doc sets, and the data being extracted is minimal.
2) Separating out documents automatically based on the lay out analysis or specific keywords.
Related to the classification technologies, Dispatcher can naturally separate images to create
batch folder without separators or bar code. Dispatcher uses some natural separators define
during the learning base. The benefit here is users do not have to manual sort and prepare
documents prior to scanning.
Once a document has been classified, an appropriate template can be applied to extract the
business data and perform all business rules defined.
In the example, above, documents sets are broken out into a logical set when a document is
recognized as a given template. Doc Set 1 and 2 are from the same patient and the pages that
follow the top page are attachments that are associated with the identified template.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-8

Advanced Document Identification


INPUTACCEL PLATFORM

InputAccel and Dispatcher

CAPTURE

CLASSIFY
IDENTIFY

EXTRACT

VALIDATE

DELIVER

Multiple technologies to determine


each document type

Forms

Invoices

EOBs

Tax Returns

Checks

Patient
Records

POs

SemiStructured

Structured

Unstructured

Global Image Analysis

Global Image Analysis

Handwritten detection

High Precision Anchors

High Precision Anchors

Keywords Analysis

Keywords Analysis

Text Matching Analysis

InputAccel Overview

1-9

2009 EMC Corporation. All rights reserved.

1.

2.

3.

Structured documents these are document types where data is always in the same area or region of the page. This document type usually
requires zonal OCR or forms processing for highly complex forms such as mortgage applications, credit applications, etc. Examples of these
types are address forms, health claim forms, benefit forms, tax forms, etc. A typical product mix to handle this document type would be
InputAccel or InputAccel with FormWare for highly complex forms, and Dispatcher to identify them.
Semi structured documents these are document types where data required from the page is the same but varies in location from one vendor to
another. This document type usually requires free form technology to find the data in question and extract/validate them from other systems
eventually triggering transactions. Examples of these types are invoices, purchase orders, shipping documents, bill of lading, phone bills, etc. A
typical product or configuration would be InputAccel for Invoices.
Unstructured documents these are document types where data or information is in the page but not always in the same area. This document
type usually requires conversion of text into electronic format such as PDF or text recognition could be used to identify what the document is all
about. Examples of these document types are correspondence and letters.

Techniques:

Global Image Analysis - Dispatcher uses a completely automatic learning process (fuzzy logic approach) for
unlimited document types, building dynamically a knowledge base. This method does not rely on being able to
read text data from the document but instead analyses the significant structural elements of the document, making
it completely language independent!
HPA - An HPA is defined manually by placing anchors on the graphical zones that are specific to a document in order
to discriminate between documents. This technology should be applied when there is a high variability of
documents within the same template. For example, in the case of documents such as cheques, it is not useful to
discriminate too much by creating one template per bank if it is only necessary to identify that these documents are
cheques, regardless of the issuing banks.
Keyword - To classify documents based upon the text they contain and not according to their visual aspect or
similarity with the template. Based on dictionaries of keywords often associated to the company document
referential, Dispatcher reads the information on the document with specific OCR engines and identifies the
type of incoming mail.
Text Matching - New classification technology dedicated to unstructured documents. Easy to implement and set up you
can on fly manage and control unstructured document classification. The objective is to extract the complete text
and to compare sentences and characters sequence between documents. Therefore you can easily classify legal
documents which can have different lay out or design but legal text will be exactly the same. This approach is
unique on the market today and help our customers to optimize their unstructured information process. Mortgage,
Legal application, HReven financial services can get benefits of the Text Matching technology.
This feature will be included into Dispatcher for the 5.0 release Q2 08.
Handwritten - Handwritten document is really different from others. Because of the algorithms of the fuzzy logic
and of the learning base it is quite easy to distinguish the lay out of a handwritten document.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-9

Intelligent Data Extraction


INPUTACCEL PLATFORM
CAPTURE

Key Points
InputAccel provides keyfrom-image indexing
support, zonal OCR, and
OCR rubber banding for
quick document indexing

CLASSIFY

EXTRACT

Zonal Extraction

VALIDATE

DELIVER

Freeform Extraction

Dispatcher performs
zonal OCR extraction and
free-form keyword rules to
extract any kind of
information at a field,
table, page, or document
level
Reduces the amount of
data entry an index
operator has to perform

InputAccel Overview

1-10

2009 EMC Corporation. All rights reserved.

Two Major Technologies:


Template: locate which fields to capture, work well when the layout of forms is the same or where clear
identifiers define the format. Used for recurring information.
Free Form Approach: based on keywords and text analysis to catch out the data. You extract the same
information than a template used but without any layout analysis. Used for non recurring information.
IA data extraction
At a basic level images are scanned and index operators key information into index fields based on image
data. IA provides more advanced techniques which include the following.
Zonal OCR At setup time, an admin can specify where on a document to apply OCR (Optical Character
Recognition). For example, a customer may want to extract a loan document number from a page. Rather
than keying this information, IA applies OCR to read the loan number and have it pre-populate an index
field. Dispatcher support zonal OCR as well.
OCR Rubber Banding IA supports full page OCR. As a document is being indexed, an operator can
select a certain location on a document image and extract the OCR results. For example, rubber banding
around the SSN on a page will take the OCR results and insert it into the SSN index field on screen. This
provides a quick and easy way to extract data from a document without manually keying.
Dispatcher extraction capabilities
-Performs both zonal OCR and free form OCR extraction.
Free form OCR looks for keywords on a document image and once it locates the word, applies the
extraction rules. For example, look for the keyword P.O. and once located look below P.O to find the
purchase order number. This provides flexibility around being able to extract data from a semi-structured
document.
Table Extraction Supports the extraction of line item details on a document. For example an invoice.
Dispatcher Table Extraction will OCR the data and based on setup rules defined will extract the line item
details (e.g. Quantity, Description, Amount) into Dispatcher index fields.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-10

Intelligent Data Extraction


INPUTACCEL PLATFORM
CAPTURE

CLASSIFY

EXTRACT

VALIDATE

DELIVER

Key Points
Data extraction based
on document type and
business requirements
Extract data from key
fields or perform full
data extraction for
forms processing

Multi-language OCR/ICR engines


support
Voting system (optimistic,
pessimistic, average method)
Bar Code
Handprint (ICR)
Mark Sense (OMR)
Machine Print (OCR)
Complex Tables and Columns

InputAccel Overview

1-11

2009 EMC Corporation. All rights reserved.

Data Extraction
Optical Character Recognition (OCR) type written information
Voting System Where multiple recognition engines are used in order to gain the highest
confidence on data read from an image
Barcodes supports the reading of most 1D barcodes as well PDF417 2D barcodes
ICR handprint recognition
OMR bubbles, checkboxes
Multi-language support supports various European languages, as well as Chinese and Japanese

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-11

Validation
INPUTACCEL PLATFORM
CAPTURE

Full P
age
O

CLASSIFY

CR

EXTRACT

VALIDATE

DELIVER

Key Points
Key data from images

Do

ep
cs S

Data extracted using OCR,


ICR, OMR, and bar code
recognition

ed
arat

Supports rubberband
OCR-assisted indexing
xD
Inde

x
ata E

on
tracti

Maintains the data integrity


Real-time validations
against back-end
databases and business
systems

InputAccel Overview

Define specific business


rules for each document
type

1-12

2009 EMC Corporation. All rights reserved.

Validation
Once the data is read from the document, rules can be applied. These rules can be as simple as
specifying the expected format in an index field (alpha, numeric, etc), it can include template
rules (e.g. SSN index field = NNN-NN-NNNN), and database validations can be used to connect
to a backend system to automatically validate what has been extracted from a document (e.g.
Purchase Order Number)
Validations can happen automatically (connect to a database to perform a lookup and prepopulate other index fields based a key value that was extracted) or some cases require human
intervention (a field is marked as always review)

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-12

Export to Back-end System and Processes


INPUTACCEL PLATFORM

Key Points

CAPTURE

CLASSIFY

EXTRACT

VALIDATE

DELIVER
EXPORT

Export both images


and index data to
leading content
management systems,
ERP, BPM, databases,
and other systems
Supports conversion to
PDF (image, normal,
and image + text), full
text OCR, and PDF
compression
API to API enterprise
content management
exports

InputAccel Overview

1-13

2009 EMC Corporation. All rights reserved.

Exports enable the connection between InputAccel and the backend system that allow for the
deliver of index data and documents (images). Exports like the ones to Documentum,
ApplicationXtender, Filenet CS/PS, and IBM Content Manager export the index data and
documents to various folders depending on the document type and index data. These exports also
can kickoff workflows in backend CM systems enabling the routing and approval of the
documents and information.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-13

InputAccel Process Overview

How it Works

eInput
(browser-based
scanning and
indexing)

INPUTACCEL PLATFORM
CAPTURE

CLASSIFY

EXTRACT

VALIDATE

DELIVER

Document, ECM,
File Storage

Scanner

Scan
Classify
Extract

Validate
Index

Export to
Documentum
Repository

InputAccel Overview

1-14

2009 EMC Corporation. All rights reserved.

How it works:
The following slide provides a diagram on the overall flow of images through IA.
Key points:
A capture flow process can be as simple as scan, image enhancement, recognition,
index/validation, and export. Or the capture workflow can be more complex and include
conditional steps where documents get routed to certain individuals for review, data validations
occur where an IA capture flow validates extracted data against a bus application, or have extra
steps for rescanning bad document images.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-14

Product Information (1 of 2)

9 Imaging Concepts
Captiva Products

InputAccel
- Customizable document capture platform
Dispatcher
- Enabling intelligent classification and extraction functionality
into process flow

Dispatcher for InputAccel


- Leveraging the InputAccel architecture
FormWare
- Enterprise level Forms Processing
FormWare for InputAccel
- Leveraging the best of both products
InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-15

1-15

Product Information (2 of 2)

9 Imaging Concepts
9 Captiva Products

InputAccel Express
- Capture made fast, powerful, flexible and affordable
InputAccel For Invoices
- Processing any and all invoices
ClaimPack
- Processing HCFAs and UB92 claims
Digital Mailroom
- Capture, classify, and deliver all digital input
Pixel Translations
- ISIS Drivers, QuickScan Pro and imaging toolkits
SDK
- Software Development Kit used to develop InputAccel
compatible modules
InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


1-16

1-16

Module 2

Installation

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-1

Module Objectives

Describe the hardware and software requirements


Describe the installation steps
Describe the ClickOnce Deployment Utility
Describe upgrade steps
Install the InputAccel server
Install InputAccel client modules
License the InputAccel Server and modules

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-2

2-2

Server Hardware Requirements

Hardware and Software


Requirements
Software Installation

Minimum hardware requirements for the InputAccel server


- CPU:
2.8 GHz Pentium 4
- Hard drive:
At least 10GB free space
- Memory:
4 GB RAM
- Networking:
Network interface card that supports TCP/IP
- Video:
Minimum resolution of 1024 x 768, 256 colors
Refer to the InputAccel Installation Guide for more details and
recommended hardware

Installation

2-3

2009 EMC Corporation. All rights reserved.

The requirements listed above are minimums. Performance may be increased by exceeding the
minimums.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-3

Server Software Requirements

MS SQL Server 2005 SP2


Windows Server 2003 R2 with SP2 or Windows Server 2003 SP1
or later

IIS 6.0 is required for web components


- Administration console
- InputAccel Remoting

Installation
2009 EMC Corporation. All rights reserved.

Datacenter, enterprise, and standard editions of Windows 2003 Server are supported.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-4

2-4

Client Hardware Requirements

Minimum requirements
- CPU:
2.0 GHz Pentium 4
- Hard drive:
At least 2GB free space
- Memory:
1 - 3 GB RAM
- Networking:
Network interface card that supports TCP/IP
- Video:
Minimum resolution of 1024 x 768, 256 colors

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-5

2-5

Client Software Requirements

Operating system
- Windows XP SP2
- Windows Server 2003 R2 SP2 or Windows Server 2003 SP2
- Vista - Enterprise x32 SP1, Enterprise x64 SP1
- Vista Business x32 SP1
The administration console also requires Internet Explorer 7.0
In addition, some modules may have specific software
requirements

Installation
2009 EMC Corporation. All rights reserved.

Refer to the InputAccel Version 6.0 Installation Guide for more information.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-6

2-6

Database Requirements

InputAccel database user account


- Used by the InputAccel server to connect to the SQL server
-

database
Must use SQL Server authentication
Must be a member of the db_owner role for both the InputAccel
database and the msdb database
This must be performed after the IA database installation step
Used during server and web components installation

Do not use the sa account or other SQL Server account that has
full permissions

Installation

2-7

2009 EMC Corporation. All rights reserved.

MS SQL Server 2005 Express edition may be used in development or testing environments, but
there are limitations to using this edition. Refer to the InputAccel Installation Guide for details.
Using the default MS SQL Server sa account or any account that has full permissions is not
recommended as it can pose a security threat.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-7

9 Hardware and Software


Requirements
Software Installation

Software Installation

Server installation
- InputAccel database
- Server software
Client installation
- Necessary
modules

Web component
installation
- Administration
console

Installation

2-8

2009 EMC Corporation. All rights reserved.

The software installation is comprised of three main types: server software, client software and
web components, which provides the administration console.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-8

Installation Steps
1) Install and configure the InputAccel database
2) Install the InputAccel server(s)
3) Install the administration console and (optionally) IA remoting
4) Activate and license the servers
5) Install the client modules
6) Create roles and add users to them

Installation
2009 EMC Corporation. All rights reserved.

Creating roles will be covered in a later module of this course.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-9

2-9

Installing the Database (1 of 2)

Select the Step 1 link in the installer to install the InputAccel


database

Installation

2-10

2009 EMC Corporation. All rights reserved.

The user account being used when selecting to install the InputAccel database must be a member
of the local Administrators group.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-10

Installing the Database (2 of 2)

Choose the database files destination

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-11

2-11

Database Server and Name

Select the database server and choose a name for the InputAccel
database (IADB is the default)

Installation
2009 EMC Corporation. All rights reserved.

The Login ID used at this point in the installation must be a SQL Server account that is a
member of the sysadmin role. In this example the sa account is used.
Port 1433 is the default MS SQL Server port.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-12

2-12

Finishing the Installation

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-13

2-13

Server Installation (1 of 8)

Once the database is installed, proceed with the server installation

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-14

2-14

Server Installation (2 of 8)

Review supporting software that will be installed and click Install

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-15

2-15

Server Installation (3 of 8)

Remove the USB port hardware key, if applicable

Installation
2009 EMC Corporation. All rights reserved.

The USB port hardware security key is only applicable to customers upgrading from older
systems. Hardware security keys are no longer issued.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-16

2-16

Server Installation (4 of 8)

Choose Typical or Custom installation

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-17

2-17

Server Installation (5 of 8)

Choose the number of servers that will be deployed if a side-byside installation will be performed

Installation

2-18

2009 EMC Corporation. All rights reserved.

The recommended number of InputAccel server instances is one for every two processors.
Benefits of installing multiple server instances:
Total virtual address space is increased using this formula: Number of processes x 2GB. This
allows more batches to be loaded simultaneously on a single machine.
Each servers VBA engine will run in a separate thread, allowing parallel execution of batches
on server instances running on multi-processor machines.
Read/write operations can be distributed across multiple processors to enable parallel
processing of multiple tasks.
Each server instance must be licensed. Licensing will be covered in a later module in this course.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-18

Server Installation (6 of 8)

Select the server software destination

and the data directory

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-19

2-19

Server Installation (7 of 8)

Specify the service login account and service startup mode

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-20

2-20

Server Installation (8 of 8)

Register the Data Access Layer with the InputAccel database

Installation
2009 EMC Corporation. All rights reserved.

The Login ID specified in the data access layer (DAL) registration screen is the SQL Server
login created for use with InputAccel. This should not be the SQL Server SA login.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-21

2-21

Server Installation Completion

Once the server software has been installed, re-insert the hardware
security key, if applicable

Installation
2009 EMC Corporation. All rights reserved.

The USB port hardware security key is only applicable to customers upgrading from older
systems. Hardware security keys are no longer issued.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-22

2-22

Web Component Installation (1 of 2)

There are two web components that may be installed


- Administration console
- InputAccel Remoting
Web components must be installed on a Windows 2003 server
running IIS 6.0
- The admin console and
IA Remoting must be
installed on separate
computers
- InputAccel Server and
the admin console can
be installed on separate
computers
Installation

2-23

2009 EMC Corporation. All rights reserved.

The administration console is required in order to administer InputAccel. It should always be


installed. InputAccel Remoting is only necessary if remote clients need to access the IA server
and database. In this context, remote clients refers to any client modules that will be outside of
the firewall.
The administration console should be installed prior to any client modules that will run as
services. Client modules will try to connect and use the single pre-license connection (needed by
the administration console).

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-23

Web Component Installation (2 of 2)

Installation

2-24

2009 EMC Corporation. All rights reserved.

First, the installer will install any prerequisite software. Next, select the web component to install
and click Next.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-24

Destination and DAL Registration

Installation

2-25

2009 EMC Corporation. All rights reserved.

Choose the destination directories for the application files and the location of the web site files.
As with the IA server installation, the Login ID used here in the DAL registration should be the
SQL Server account created for use with IA and not the SQL Server SA account.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-25

Web Site Setup

Installation

2-26

2009 EMC Corporation. All rights reserved.

Enter the Windows account that will be used to run the InputAccel web components web site.
Enter the name, IP address, and TCP port number to be used by the InputAccel web site. The
installer will create and configure the web site. No manual creation or configuration by the IIS
administrator is required.
IIS uses port 80 for the Default website, therefore, it is important to pick an unused TCP port or
change the default website to use a different port number. If there is a conflict at installation
time, the installer will notify the user of the conflict.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-26

Installation

Ready to install

Installation
2009 EMC Corporation. All rights reserved.

After entering the web site settings, click Install to perform the installation of the software.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-27

2-27

Licensing

Prior to installing any client modules, licensing must be performed


from the administration console

Why are the Licenses required?


- Required for servers and client modules to run and process
pages

How are licenses installed?


- Automatic installation
Importing the license file using Administration Console

- Manual installation
Use the Administration Console to manually enter individual
license codes

Installation

2-28

2009 EMC Corporation. All rights reserved.

In addition to licensing, servers must be activated. The InputAccel server uses either a hardware
security key (USB or parallel port) or an activation file (CAF). Licensing will be covered in
detail in a later module in this course.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-28

Client Installation Phase

The client installation involves installing attended (ScanPlus,


IndexPlus, etc.) or unattended client modules on workstations

Unattended modules may be executed as services


- Multi Directory Watch
- Documentum Advanced Export
- Others
Attended modules may be installed using the ClickOnce utility
- Deploys installation packages which allow the end-users to
perform the installation

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-29

2-29

Client Module Installation

Step 4 installs client modules

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-30

2-30

Setup Type

Choose Typical or Custom installation

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-31

2-31

Server Connection

Specify the InputAccel Server connection information

Installation

2-32

2009 EMC Corporation. All rights reserved.

The dialog shown here is displayed if the InputAccel server is found. The Server port number
defaults to 10099.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-32

Scanner Selection

Choose the scanner to use

Installation
2009 EMC Corporation. All rights reserved.

Even if no scanner driver is installed, image files can still be imported to simulate scanning.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-33

2-33

ClickOnce Deployment Overview (1 of 2)

Microsoft technology that enables the creation


of self-updating Windows-based applications

Deployments can be installed and run with minimal user


interaction

Published to and downloaded from a web site or file share


Overcomes three deployment issues
- Issues with updating applications
- Impact to the client computer
- Security permissions

Installation

2-34

2009 EMC Corporation. All rights reserved.

Issues with updating applications: Typical installers require the entire application be re-installed.
The ClickOnce deployment utility provides automatic updates and only downloads the parts of an
application that have changed.
Impact to the client computer: ClickOnce deployments are self-contained and do not interfere
with other applications, whereas with a typical installer, it may rely on shared components, which
may be out of date or newer that what is needed.
Security permissions: A typical installer will require Administrative permissions on the local
machine. ClickOnce deployments allow non-admin users to install and only grants the Code
Access Security (CAS) permissions necessary.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-34

ClickOnce Deployment Overview (2 of 2)

ClickOnce can be used for the following attended modules:


- ScanPlus
- RescanPlus
- IndexPlus
Intended to be used by remote clients accessing the server via IA
Remoting
- End-users can easily install attended client modules
- Deployments can be made available as on-line only

Administrators using the ClickOnce Deployment utility should be


familiar with Microsofts ClickOnce technology

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-35

2-35

Silent Installations

In many installations, it will be desirable to install client modules


remotely
- Not all client machines are accessible
- Third-party software can be used to push installations out to
remote machines

Silent installations provide the capability to install client modules


without interaction from a user
- Batch files and/or Windows scripting can be used to install the
appropriate modules in the background
Refer to the Unattended Installations section of the Installation
Guide for detailed information

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-36

2-36

Upgrading

InputAccel versions 5.2.3 and 5.3 can be upgraded to version 6.0


Upgrade steps
- Archive irreplaceable files and data
- Install the InputAccel database
- Upgrade the InputAccel server
- Install the Administration Console
- Upgrade the client modules
- Install new client functionality
- Assign permissions to users of the upgraded or new modules
- Upgrade existing processes and customizations
- Upgrade audit extensions
- Upgrade custom callback and index validation functionality
Installation

2-37

2009 EMC Corporation. All rights reserved.

When upgrading client modules, there are two choices: 1) Install the Backward Compatibility
pack to use existing modules with the 6.0 server or 2) Upgrade the installed versions to version
6.0.
Refer to the Upgrading to InputAccel 6.0 chapter of the InputAccel Installation Guide for
detailed information on upgrading.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-37

9 Hardware and Software


Requirements
9 Software Installation

Test Your Knowledge

1. True/False: An InputAccel database is only required


for enterprise installations.
2. True/False: The administration console is a web-based
component that runs on an IIS server.
3. True/False: A side-by-side installation may include up
to eight InputAccel servers.
4. Which of the following installation steps is performed during
both server and client module installation?
a) Data access layer registration
b) Scanner selection
c) InputAccel connection information
d) Side-by-side setup
Installation

2-38

2009 EMC Corporation. All rights reserved.

1.
2.
3.
4.

False. An InputAccel database is required for all 6.0 installations.


True.
True.
a - Data access layer registration.
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-38

Exercise

Estimated time: 60 min

Goals
- Install the InputAccel database, server,
-

web components, and client modules


License the server and modules

Tasks
- Prepare for the software installation
- Install the InputAccel database
- Install the InputAccel server
- Install the InputAccel web components
- License the server and modules
- Install the InputAccel modules

Installation
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


2-39

2-39

InputAccel Fundamentals and Administration


Lab 2

Module 2 Installation

Estimated Time: 60 minutes


Install the InputAccel database, server, and client modules

Goals

License the server and client modules


Tasks

1.

Prepare for the software installation

2.

Install the InputAccel Database

3.

Install the InputAccel Server

4.

Install the InputAccel Web Components

5.

Use the administration console to activate the server

6.

Use the administration console to import a license file

7.

Install the InputAccel Client Modules

Background
In this lab, you will install the InputAccel database, server software, and client software. SQL
Server and IIS have been installed on the system already.
Before you begin:

Answers to the questions asked in the lab are at the end of the lab instructions

Windows login/password: dmadmin/training

Task 1 - Prepare for the software installation


1.1.

Login to Windows using the login and password shown above (dmadmin/training).

1.2.

Start the SQL Server service.


1.2.1.

Double-click the Services shortcut on your computer's desktop.

1.2.2.

Scroll down and find the service labeled SQL Server (SQL1).

Lab 2-1
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 2

1.3.

1.2.3.

Double-click the SQL Server (SQL1) service to open the service properties
window.

1.2.4.

Set the Startup type to Automatic. This will ensure that the service is started
whenever the system is rebooted.

1.2.5.

Click the Start button to start the service.

1.2.6.

Click OK to close the service properties window.

Start the World Wide Web Publishing Service.


1.3.1.

Scroll down to the bottom of the services listed in the Services window.

1.3.2.

Double-click the World Wide Web Publishing Service service.

1.3.3.

Set the Startup type to Automatic.

1.3.4.

Click the Start button to start the service.

1.3.5.

Click OK to close the service properties window.

1.3.6.

Close the Services MMC window.


Congratulations! You have successfully prepared the system for
installation.

Task 2 - Install the InputAccel Database


2.1.

Using Windows Explorer, navigate to C:\builds\Captiva\InputAccel.

2.2.

Double-click the autorun.exe file to display the installer dialog window.

2.3.

Below the InputAccel Products heading, click the Install Products link.

2.4.

From the Installation Choices list, click the Step 1 - Install the InputAccel Database link.
The InstallShield wizard will start.

2.5.

At the Welcome screen, click Next > (it may take a few seconds to compute space
requirements).

2.6.

Select to accept the terms in the license agreement and click Continue.

2.7.

Click Next > to accept the default Destination Folder.

2.8.

Ensure the Create the InputAccel Database checkbox is checked, the Port is set to 1433,
and (local)\SQL1 is selected in the Database server dropdown list.
Lab 2-2

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 2

2.9.

Leave the Database name field as IADB.

2.10.

Enter sa/training as the Login ID/Password and click Next >. The database connection
will be tested and if all is correct, then the window displays Ready to Install the Program.

2.11.

Click Install to install the InputAccel Database.

2.12.

Once the installation has completed, click Finish to dismiss the dialog, but do not close the
installer at this point.

Congratulations! You have successfully installed the InputAccel


Database!
Task 3 - Install the InputAccel Server
3.1.

Create a SQL Server account for use with InputAccel.


3.1.1.

Select Start > Programs > Microsoft SQL Server 2005 > SQL Server
Management Studio Express.

3.1.2.

Verify the Server name field is correct.


The default server name is STUDENT53X\SQL1. If you are in an EMC
classroom that has unique server names, then you will need to change the
selection in the connection dialog.
3.1.2.1.

If necessary, click the Show Desktop icon on the taskbar to minimize


all windows.

3.1.2.2.

Right-click the My Computer icon on your computer desktop and


select Properties.

3.1.2.3.

Select the Computer Name tab.

3.1.2.4.

Write down the value for Full computer name here:


___________________________________________

3.1.2.5.

Click Cancel to dismiss the computer properties window.

3.1.2.6.

Restore the SQL Server Management Studio Express window.

3.1.2.7.

If the Server name field contains your computer name, then skip to
step 3.1.3 below. Otherwise, follow these sub-steps:

Lab 2-3
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 2

3.1.2.8.

Open the Server name dropdown list and select <Browse for
more>.

3.1.2.9.

Expand the Database Engine node on the Local Servers tab.

3.1.2.10.

Select the node labeled <Your computer name\SQL1> and click OK.

3.1.3.

In the Connect to Server dialog, ensure that the Authentication field is set to
SQL Server Authentication.

3.1.4.

Enter sa as the Login and training as the Password

3.1.5.

Click Connect.

3.1.6.

In the Object Explorer pane (on the left), expand the Security > Logins folders.

3.1.7.

Right-click the Logins folder and select New Login from the menu. A window
appears which will be used to create the new login.

3.1.8.

Enter ia_admin as the Login name.

3.1.9.

Select SQL Server Authentication.


a) Does the InputAccel Server support Windows Authentication for use with SQL
Server?
__________________________________________________________________
b) Why is the InputAccel login being created now and not prior to installing the
InputAccel Database?
__________________________________________________________________
__________________________________________________________________

3.1.10.

Enter training for the Password and the Confirm password fields.

3.1.11.

Uncheck the Enforce password policy checkbox. The other two checkboxes will
automatically uncheck and become disabled.

3.1.12.

Select IADB from the Default database dropdown list. This is the InputAccel
Database that was created in the last task.

3.1.13.

In the Select a page pane (upper-left) select the User Mapping node. A list of
databases and roles will appear.

3.1.14.

Check the checkbox next to IADB and check the db_owner checkbox in the
Database role membership for: IADB list.
Lab 2-4

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 2

3.1.15.

Now check the checkbox next to msdb and check the db_owner checkbox in the
Database role membership for: msdb list.

3.1.16.

Click OK to complete creation of the ia_admin security login. This is the login
account that will be used by the InputAccel Server to connect to SQL Server.

3.1.17.

Close Microsoft SQL Server Management Studio Express.

3.2.

Navigate back to the installation dialog and select Step 2 - Install the InputAccel Server.

3.3.

Click Install to install any pending software requirements.

3.4.

Click Continue when prompted to remove your USB port hardware key.

3.5.

Click Next > at the welcome screen to continue the installation.

3.6.

Select to accept the terms in the license agreement and click Continue.

3.7.

Click Next > to perform a Typical setup.

3.8.

In the InputAccel Service Accounts window, ensure that the Specify a user account option
is selected and enter dmadmin for the Username, training for the Password, and your
computer name for the Domain.

3.9.

The checkbox to start the service automatically should be checked. Do not uncheck it.

3.10.

Click Next > to continue.

3.11.

The next step registers the server with the data access layer (the InputAccel Database).
Select (local)\SQL1 for the Database server.

3.12.

Enter ia_admin/training for the Login ID/Password.

3.13. Click Next > to continue.


3.14.

Review the information in the Ready to Install the Program window and click Install to
install the InputAccel Server.

3.15.

Once complete, ensure that the checkbox to start the InputAccel Server service is checked
and click Next >.

3.16.

Once the server has started, you will be prompted to re-insert the USB port hardware security
key. Because we are not using one, just click Finish to complete the installation.

Congratulations! You have successfully installed the InputAccel


Server!

Lab 2-5
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 2

Task 4 - Install the InputAccel Web Components


4.1.

From the list of installation choices in the InputAccel installer, select Step 3 - Install the
InputAccel Web Components.

4.2.

Click Install to install any pending software prerequisites.

4.3.

Click Next > at the welcome screen to continue the installation.

4.4.

Select to accept the terms in the license agreement and click Continue.

4.5.

You will only be installing the Administration Console for this course, so click Next > to
continue and install it.
c) Under what circumstances would InputAccel Remoting be installed?
_______________________________________________________________________
d) Can the Administration Console and InputAccel Remoting be installed on the same
computer?
_______________________________________________________________________

4.6.

Accept the default Destination Folder locations and click Next > to continue.

4.7.

When the Data Access Layer Registration screen appears, enter the same information you
entered in Task 3 above (during the IA Server install), and click Next > to continue.

4.8.

For the InputAccel Web Site User Account, use dmadmin as the Username, training as
the Password, and your computer name as the Domain. Click Next > to continue.

4.9.

Next, the desired web site information (on the local computer) must be completed. Accept
the default information and click Next >.

4.10.

Because the Default Web Site uses the port number that was entered on the previous screen
(80), the installer is unable to use that port unless the default web site is stopped. Check the
checkbox to Stop the web site and click Next >.

4.11.

When ready, click Install to begin the installation.

4.12.

Once the installation is complete, click Finish to return to the list of installation choices.
Congratulations! You have successfully installed the InputAccel
Web Components! In this lab, you only installed the
Administration Console.

Lab 2-6
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 2

Task 5 - Use the administration console to activate the server


5.1.

Start the administration console.


5.1.1.

Using Internet Explorer, navigate to the URL of the administration console


(http://localhost).

5.1.2.

Once the logon screen appears, enter dmadmin for the Username, training for
the Password, and your computer name or a period (.) for the Domain.

5.1.3.

Click Log On. Once successfully logged on, the Batch Traffic screen will
appear. The screen that appears when logging on is called the Start Page. It can
be changed by clicking the Options tab, selecting My Preferences, and choosing
a new Start Page. Do not change the start page at this time.

5.2.

Select the Licensing / Security tab.

5.3.

Click the View Server Activations link. The list of Server Activations is displayed. The
State of the current server should show as Not Activated.

5.4.

Click the row containing the name of your server in order to highlight it. The Browse
button below will become enabled.

5.5.

Click the Browse button.

5.6.

Navigate to C:\Student\IA Fundamentals\Lab 02, select the .caf file and click Open.
After several seconds, the file name will disappear from the text box labeled Install
activation file and the properties of the server activation will change.
Do not click the Activate Server button or click the server activation link during this lab
exercise
e) What is the State of the server now?
__________________________________________________________________________

Congratulations! You have successfully activated the server.

Task 6 - Use the administration console to import a license file


6.1.

Lab 2-7
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 2

6.2.

In the administration console, click the Licensing / Security tab and then click View
License Codes. Alternatively, you can click the License Codes link in the lower left corner
of the browser, assuming you did not navigate away from the server activations page from
the last task.

6.3.

Click the Import License button to begin the import of a new license file.

6.4.

Click the Browse button, and if necessary, navigate to C:\Student\IA Fundamentals\


Lab 02.

6.5.

Select the .lic file and click Open. The list of licenses contained in the file will be displayed
in the window. Pay particular attention to the upper-right corner of the license listing. You
will see that there are links for paging through the list of licenses.

6.6.

Click OK to complete the license import. If you were to navigate away from this page prior
to clicking OK, then the import would not succeed. You should now be back at the license
listing and buttons for importing, deleting, and adding should appear at the bottom.

6.7.

Log out of the Administration console and close the browser.

Congratulations! You have successfully imported a license file.

Task 7 - Install the InputAccel Client Modules


7.1.

The last thing that you will install in this lab exercise are the client components or modules.
Switch back to the InputAccel installer. Click Step 4 - Install the InputAccel Client
Components from the list of installation choices.

7.2.

At the welcome screen, click Next > to continue.

7.3.

Select to accept the terms in the license agreement and click Continue.

7.4.

Choose a Complete installation and click Next >.

7.5.

A list of client modules that cannot be installed due to missing requirements will be
displayed. Click Next > to continue.

7.6.

A list of client modules that require third-party software in order to be used will now be
displayed. Click Next > to continue.

7.7.

Click Next > to accept the default Destination Folder location.

7.8.

Enter dmadmin/training for the Username/Password fields and your computer name for
the Domain. Leave the default checkbox selections and click Next >.
Lab 2-8

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 2

7.9.

The InputAccel Server Connection Information screen will appear. Ensure the Server
name is set to your computer name, the Server port is set to 10099, the Try to contact this
server during installation checkbox is checked, and click Next >.

7.10.

If the installer is able to connect to the server, a success message will be displayed. Click
Next > to continue.

7.11.

When prompted for Scanner Selection, check the checkbox labeled Do not install a
scanner driver at this time and click Next > to continue. By not installing a scanner driver,
the ScanPlus client module will only be able to import files when creating batches.

7.12.

Review the installation list and click Install to begin the installation.

7.13.

Once the installation is complete, click Finish to return to the list of installation choices.

7.14.

Click Exit to exit the installation choices screen.

7.15.

Finally, click Exit to exit the main installation screen.


Congratulations! You have successfully installed the InputAccel
Client Components! In the next lab exercise, you will license the
server.

Solutions:
a)

No. InputAccel only supports SQL Server Authentication.

b)

The InputAccel SQL Server administration login is being created now because the IADB
database was not created earlier and it is one of the two databases to which the login will
have db_owner access. The login could have been created at an earlier time, but it would
need to be modified after creating the IADB database.

c)

IA Remoting would be installed whenever there will be remote clients. In this context,
remote clients refers to any clients that will access the IA server outside of the firewall.
These are typically client modules that are deployed using ClickOnce.

d)

No. The Administration Console and the IA Remoting server must be installed on separate
computers.

e)

Initial grace period.

End of Lab
Lab 2-9
2009 EMC Corporation. All rights reserved.

Module 3

InputAccel Overview

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-1

Module Objectives

Describe the Captiva InputAccel Solution


Define the Captiva InputAccel Architecture
Define Captiva InputAccel Terminology
Use an process to become familiar with batch processing

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-2

3-2

InputAccel Overview
Processes and Batches

What is InputAccel?

Captiva InputAccel is a document capture solution


- Captures images and data
- Indexes data
- Exports information to a local or networked hard drive, or to
some back-end system

The InputAccel solution consists of four main components


- Database
- Server
- Client Modules
- Processes

InputAccel Overview
2009 EMC Corporation. All rights reserved.

Captiva InputAccel modules perform all of the work involved with capturing, indexing, and
exporting. These three operations consist of many modules. For example, one module might
scan a document, while another module might perform image quality assurance, or image
correction. These three modules would all be considered capture modules.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-3

3-3

InputAccel Components (1 of 2)

Database
- Microsoft SQL Server database
- Stores configuration information, license codes, logging rules,
and information related to processing

Server
- Open integration platform that manages and controls the document
capture process
- Workload balancing, queue manager
- Ensures reliability and scalability

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-4

3-4

InputAccel Components (2 of 2)

Client modules
- A set of plugins that perform specific tasks and can run on any
number of machines
- Image capture, data capture, and export

Processes
-

Tie Server and client modules together


Determine modules used and their order of execution
Determine how each module needs to process a task
Define what to do with the data generated by each module

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-5

3-5

Component Diagram
InputAccel Database
InputAccel Server
Import

Image
Enhancement/Quality
check

Data Capture
Key From Image
Image
QA

IndexPlus
ScanPlus

FW/IPP

RescanPlus

FW/
Enhance

Universal

ESS

FW/ Form
ID

FW/
Recog

ODBC

Custom
Export

IQA/
IndexPlus

Email
Import

Values to
XML

PDF/text
Prime OCR

Utilities and
Exception
Handling

FW/
Completion

Data extraction

Image
Enhance

Multi
Directory
Watch

Export

ReScanPlus

Timer

Spawn

Multi

NuanceOCR

Excel
Graph

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-6

OCR

Administrator

Copy

3-6

InputAccel Architecture

InputAccel is a client/server application


Modules use a TCP/IP connection for connecting to the server
The Server maintains state information for each connection
InputAccel
Database

Scanner

InputAccel Server

Client
Workstations
InputAccel Overview

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-7

3-7

InputAccel Server Overview

Windows-based service or application


Communicates with InputAccel client modules using TCP/IP
Manages the sequencing of pages through the capture process
Balances the system workload across available resources
Serves as a temporary repository for image and data files
Provides centralized status reporting

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-8

3-8

InputAccel Module Overview

Performs a specific function


- Scanning, indexing, exporting, image enhancement, etc.
Connects via TCP/IP
Routes work asynchronously to clients from server
Client load is balanced by the server
Modules available through EMC or technology partners

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-9

3-9

Module Categories

Most modules fall into one of three categories


- Image capture
- Data capture
- Image and data export
Other types of modules
- Administration console
- Development of processes or extensions to modules
- Utility modules

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-10

3-10

Purpose of Image Capture Modules

Import images into the InputAccel system


- ScanPlus
- Multi Directory Watch
- Email Import
Verify readability
- Image quality assurance (IQA)
Improve quality
- Image enhancement
Replace images
- RescanPlus

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-11

3-11

Purpose of Data Capture Modules

Automatically capture data


- Bar code
- Optical Character Recognition (OCR)
- Optical Mark Recognition (OMR)
- Intelligent Character Recognition (ICR)
Also known as hand writing recognition

- Page and form identification


Manually capture data
Convert file types

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-12

3-12

Purpose of Export Modules

Map directly to back-end systems


- EMC Documentum
- File Net
Write image, PDF, text, and index data to specified locations
- Universal
- ODBC
- File system

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-13

3-13

9 InputAccel Overview
Processes and Batches

Process Overview

A process file defines


- Modules to use in the process
- The order in which to process the modules
- Module processing instructions
Consist of compiled Integrated Process Project files (IPP)
- Compiled IPP files have an IAP extension
Use the Process Developer module (VBA environment) to design
custom processes

A library of InputAccel processes are shipped with InputAccel

InputAccel Overview
2009 EMC Corporation. All rights reserved.

Refer to the InputAccel Process Development with VBA course for detailed information on
creating custom processes.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-14

3-14

Example Process

ScanPlus

InputAccel Server

Image
Enhancement

OCR

Export

ScanPlus

IE

OCR

Export

Data returned by Module


Data passed by Server
based on Process
InputAccel Overview

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-15

3-15

Batches (1 of 2)

All information scanned or imported into the system is stored in a


batch
- Created by image or data capture modules

Every batch is derived from a process


Batches consist of the following
- An InputAccel Batch (IAB) file
- Pages scanned or imported
- A tree structure of the batch
- Values, called IA Values, that represent

Page information
Setup and processing information
Files names
Other batch-related information
InputAccel Overview

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-16

3-16

Batches (2 of 2)

Batches are structured hierarchically, represented by a tree eight


levels deep
- The batch is represented by level 7
- Items at each level are also referred to as nodes

At the lowest level (0), batches contain pages


- A page is a single-sided image
- One page is counted for every image scanned or imported
- One or more pages make up a document
Individual nodes can be processed independently
- The entire batch does not have to be complete in order to start
-

the next task in the process


Increases throughput
InputAccel Overview

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-17

3-17

Tree Structure/View

Graphical display of the batch hierarchy


Level 7 Batch

...
Level 3 Stack

Level 2 Folder
Level 1 Document

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-18

Level 0 Pages

3-18

User-Defined Nodal Names

Nodal names can be based on the following


- IA values
- Numeric ordering
- Literal values

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-19

3-19

InputAccel Values

Variables that store setup and processing information


- Referred to as IA values
Batch-related information is stored in IA values
There are three types of IA values
- File Input/Output variables
- Input
- Output

InputAccel Overview

3-20

2009 EMC Corporation. All rights reserved.

File Input/Output variables are used to store the names of stage files. Each node in a batch may
have one or more stage files associated with it, depending on the stage in the overall process. For
example, a module might have both and input image and an output image. These images will be
represented by variables called InputImage and OutputImage, respectively. The value of these
variables are considered IA values.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-20

Terminology

Module An application that manages a specific Task


Step Specific use of a processing Module
Level InputAccel has eight different levels
- Page, Document, Folder, etc.

Tree Hierarchical structure of a batch


Node A specific Page, Document, Folder, etc. in the InputAccel
Tree

Task Unit of work for a Module (single or multiple images)


Trigger Value or file needed for a Module to start working on a
Task

Module Definition File (MDF) File defining all module triggers


and values
InputAccel Overview
2009 EMC Corporation. All rights reserved.

To learn more about triggers and module definition files, refer to the InputAccel Development
with VBA course

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-21

3-21

9 InputAccel Overview
9 Processes and Batches

Test Your Knowledge


1. True/False: Processes determine modules used
and their order of execution.
2. True/False: InputAccel consists of three main
components.

3. True/False: The InputAccel client modules are only


used to perform scanning - the server does everything
else.
4. Which of the following are part of a batch?
a) Batch file (IAB)
b) Tree structure
c) Module processing instructions
d) IA values
InputAccel Overview

3-22

2009 EMC Corporation. All rights reserved.

1. True.
2. False. InputAccel consists of four main components: InputAccel database, InputAccel server,
client modules, processes.
3. False. The client modules perform all work defined by a process, whether it is scanning,
indexing, exporting, etc. The server coordinates the processing.
4. a, b, and d. Module processing instructions are part of the process. Batches also contain the
scanned or imported pages.
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-22

Exercise

Estimated time: 15 min

Goals
- Configure a process and use it to process a batch
Tasks
- Import an existing process
- Configure the steps in the process
- Create and process a batch

InputAccel Overview
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


3-23

3-23

InputAccel Fundamentals and Administration


Lab 3

Module 3 InputAccel Overview

Estimated Time: 15 minutes


Goals

Configure a process and use it to process a batch

Tasks

1.

Import an existing process

2.

Configure the steps in the process

3.

Create and process a batch

Background
Before you begin:

Answers to the questions asked in the lab are at the end of the lab instructions

When using the Administration Console, the lab instructions refer to links in the left-side
pane as "tabs".

Windows login/password: dmadmin/training

Scenario
In this lab exercise, you will import a pre-defined process, configure its steps, and then process a
batch using it. The point of this exercise is to give you an understanding of process setup and batch
processing.

Lab 3-1
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 3

The steps in the process are defined as shown here:

Scan

Image
Enhance

Image
Export

Task 1 - Import an existing process


1.1.

If necessary, login to Windows using the login and password shown above
(dmadmin/training).

1.2.

Using Internet Explorer, launch the Administration Console by navigating to


http://localhost. Alternately, select Start > Programs > InputAccel > Administration
Console.

1.3.

Login as dmadmin/training and enter a period for the Domain.

1.4.

Select the Systems tab.

1.5.

Click the View Processes link.

1.6.

Click the Add button to add a new process.

1.7.

Click the Browse button and navigate to C:\Student\IA Fundamentals\Lab 03

1.8.

Select Lab 03.iap and click Open.


Lab 3-2

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 3

1.9.

Click OK to complete the import.


Congratulations! You have successfully imported a new process.

Task 2 - Configure the steps in the process


2.1.

In the Processes list, scroll down and select Lab 03. The steps for the Lab 03 process are
now displayed.

2.2.

Configure the IE step.


2.2.1.

Right-click the IE step and select Settings.

2.2.2.

Click OK to dismiss any licensing messages or just ignore them. The messages
will disappear after finishing the setup.

2.2.3.

When the Image Enhancement module starts in setup mode, a sample image must
be selected.
Navigate to C:\Student\IA Fundamentals\Lab 03, select HR_EX2.tif, and click
Open.

2.2.4.

Add a Deskew filter by selecting Filter > Insert > Deskew.

2.2.5.

Now add a halftone removal filter by selecting Filter > Insert > Halftone
Removal.

2.2.6.

As filters are added you will notice that the image in the results pane displays the
result after filtering. You will learn about image enhancement filters in a later
module in this course.
Select File > Exit and click Yes to save your changes.

2.3.

Configure the ImageExport step.


2.3.1.

From the list of steps in the Administration Console, right-click the ImageExport
step and select Settings.

2.3.2.

Change the File Path to C:\Temp.

2.3.3.

Click the Edit Schema button to use a schema for the output file name. A
schema uses special variables in order to create dynamic file names.

2.3.4.

Enter %s - %03d, @(BatchName), @07 for the Schema. You will see the
Sample File Names change after entering the new value.
Lab 3-3

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 3

2.3.5.

Click OK to save the schema changes.

2.3.6.

Now click OK to save the Image Export setup changes.


Congratulations! You have successfully configured the steps of
the new process.

Task 3 - Create and process a batch


3.1.

3.2.

Perform the Scan step.


3.1.1.

Select Start > Programs > InputAccel > ScanPlus.

3.1.2.

Check the Use Windows logon checkbox and click OK.

3.1.3.

Click the Create new batch link.

3.1.4.

Select the Lab 03 process from the process list.

3.1.5.

Enter Lab 03 Batch as the batch name.

3.1.6.

Click the Create button.

3.1.7.

Click the Import files to batch link.

3.1.8.

Navigate to C:\Student\IA Fundamentals\Lab 03, select HR2.tif, and click


Open. The Tree View and File View are now populated with information from
the file.

3.1.9.

Click Close Batch to close the current batch.

3.1.10.

Click the Release Batch button when prompted.

3.1.11.

Close ScanPlus.

Perform the Image Enhancement step.


3.2.1.

Start Image Enhancement by selecting Start > Programs > InputAccel >
Image Enhancement.

3.2.2.

Click OK to connect to your server, or wait several seconds for it to connect


automatically.

3.2.3.

Enter dmadmin/training as the User Name and Password, and click OK.

3.2.4.

Once the Image Enhancement module starts, click the Run Single Batch
button.

3.2.5.

Select Lab 03 Batch from the list of available batches and click OK.
Lab 3-4

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 3

3.2.6.

The images will be processed with the original shown on the left, and the
enhanced image shown on the right.
After the 5th page has been processed, click Stop and exit the Image Enhancement
module by selecting File > Exit.

3.3.

3.4.

Perform the Image Export step.


3.3.1.

Start the Image Export module by selecting Start > Programs > InputAccel >
Image Export.

3.3.2.

Click OK to connect to the server or wait for it to do so automatically.

3.3.3.

Loging using dmadmin/training and click OK.

3.3.4.

Click the Run Single Batch button.

3.3.5.

Select Lab 03 Batch and click OK.

3.3.6.

In a flash, the images will be processed and exported. Click Stop and then select
File > Exit.

3.3.7.

Verify that the images were exported.


3.3.7.1.

Using Windows Explorer, navigate to C:\Temp.

3.3.7.2.

You should see one TIF file for each page in the original file. Doubleclick one of the Lab 03 BatchTIF files to view the contents.

Close any open windows.

Congratulations! You have successfully processed your first


batch!
Solutions:

End of Lab

Lab 3-5
2009 EMC Corporation. All rights reserved.

Module 4

InputAccel Licensing

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-1

Module Objectives

Define the steps needed to activate an InputAccel server


Describe the types of licenses
Describe license parameters
Describe steps for managing license codes

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-2

4-2

Server Activation (1 of 3)

Activation and Licensing


Overview
License Parameters
License Management

The server must be activated before licenses


can be installed

Performed using the administration console


Install CAF activation file
The server ID and 27-character profile ID are returned
Captiva replies with a unique 27-character activation key which is
entered on the same screen

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

The website for retrieving the activation key is http://activation.captivasoftware.com.


Grace Periods:
Triggered by: Initial install of CAF file
Install new CAF file over existing CAF file
Changing machine profile past threshold

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-3

4-3

Server Activation (2 of 3)
1) Login to the
administration console
as an Administrator

2) Select Licensing/Security

3) Click View Server Activations

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

The default start page of the administration console is the Batch Traffic page. Alternatively,
the Server Activations link may be clicked in step 3.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-4

4-4

Server Activation (3 of 3)
4) Browse to and select the .caf file
5) Select the appropriate row in the Server Activations window and
click Activate Server

License keys can now be installed

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

After selecting the CAF file, the server activations list will be populated with the information.
Selecting a row in the server activations list will enable the Activate Server button.
CAF (Dongle-less) licensing Activation States:

Not activated (state at initial install)


Grace period (activated for limited time)
Grace period expired (inactivated)
Activated

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-5

4-5

Licensing Overview (1 of 2)

Licensing is based on a set of codes installed


on a server

License codes are stored in the InputAccel database


- Centralized access for installations with multiple servers
- Can be accessed and managed by the administration console
The license codes determine
- How many copies of a client module can connect to any
-

particular server at one time


How many pages can be processed
How long the module/server is allowed to work
What extra features are enabled

InputAccel Licensing

4-6

2009 EMC Corporation. All rights reserved.

IA uses a licensing scheme that allows Captiva and third-party module developers to regulate
how the software is used in an IA installation.
Licensing works by installing a set of license codes on the IA Server. The license codes are
uniquely keyed to the Server ID that the IA Server retrieves from either your Hardware
Encryption Key (dongle) or the Captiva Activation File (CAF).
Each license code can specify a single module and regulate how many copies of the module can
connect to the IA Server at once, how many pages it is allowed to process, how long the license is
allowed to work, and what extra features are enabled.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-6

Licensing Overview (2 of 2)

Uniquely keyed to the server ID


- Server ID is obtained by the hardware dongle or from a Captiva
Activation File (CAF)

Licenses can be viewed, created and modified using the


administration console

Without the license code, only the administrator console can


connect to the server

InputAccel Licensing

4-7

2009 EMC Corporation. All rights reserved.

There is one pre-license connection available after installation. This connection is intended to be
used by the administration console. Because of this, it is important to install the administration
console web component, license the server, and then install any client modules. Client modules
that run as services could potentially consume the pre-licensing connection, preventing the
administration console from connecting.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-7

License Key Categories

There are two types of license keys:


- Hardware key
USB - being phased out
Parallel Port being phased out

- Dongle-less
Replaces the need for a hardware key
Uses a CAF and activation key string to tie activation to a machines
hardware profile
Provides a grace period to allow customer time to obtain an activation key
after CAF installation or after hardware changes

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-8

4-8

License Parameters and Types

9 Activation and Licensing


Overview
License Parameters
License Management

License parameters
-

Name
Connections
Pages
Valid Until
Enter by
Features

Issue date
Disables
License code
Status
Server

Licensing types
-

Daily
Monthly
Annually
Non Periodic

- Module-specific
- Group

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-9

4-9

Understanding IA License Parameters (1 of 6)

Group Licenses

Single Licenses

InputAccel Licensing

4-10

2009 EMC Corporation. All rights reserved.

Group licenses allow modules that are a member of the group to pool page counts and/or
connections. Modules within the group reference the group license to determine the number of
pages they can process and the number of instances that can connect to the IA server. In the
example above, the GROUP1 license is referred to by five modules. These modules share the
total page and connection count for this group. In the example on the right, the SCANPLUS
module is licensed singly and not part of a group. Any other module would require its own
license.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-10

Understanding IA License Parameters (2 of 6)


InputAccel Server

Number of connections
allowed at the same time

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-11

4-11

Understanding IA License Parameters (3 of 6)

Modules will
not be allowed
to login with
this License

Nov 25, 2009


(091125)

Nov 25, 2008


(081125)

License Active
License Expired

Feb 23, 2009


(090223)
InputAccel Licensing

4-12

2009 EMC Corporation. All rights reserved.

Date format must be noted:


Valid until:
Specifies the last date the license code is allowed to work. The format of the date is YYMMDD
where any YY value less than 95 is treated as 2000+YY and values greater than or equal to 95
are treated as 1900+YY. If this field is blank, contains only a -, contains only a 0, or says
unlimited, then the license code does not expire.
Enter-by date:
Specifies the last date by which the license code must be entered into the system. Entering the
license code into the system after this date will result in Entered Too Late status in the license
codes window. The format of the date is YYMMDD where any YY value less than 95 is treated
as 2000+YY and values greater than or equal to 95 are treated as 1900+YY. If this field is blank,
contains only a -, contains only a 0, or says unlimited, then the license code is a daily license
and does not need to be entered on or before any particular date.
Issue date:
Specifies the date the license code was issued or generated. The format of the date is YYMMDD
where any YY value less than 95 is treated as 2000+YY and values greater than or equal to 95
are treated as 1900+YY.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-12

Understanding IA License Parameters (4 of 6)


ScanPlus
A Level 1 Scanner
B Level 2 Scanner
C Level 3 Scanner
D Kodak 7500 Scanners
Image Enhancement
Barcode Detection
B E and M
Prime OCR Plus
OCR Engine Features:
A-F
Number of CPU Features:
HM
Other Features:
NT

Features codes are listed in


the documentation under
Reference for most modules

All client modules


X and Y
InputAccel Licensing

4-13

2009 EMC Corporation. All rights reserved.

Each client module has a license that specifies its feature codes. Some modules have modulespecific features codes, as shown above. Some feature codes apply to all client modules.
In the example above, the IAIPI (Image Enhancement) module has feature codes BCDEMX.
Feature codes B, C, D, E, and M apply only to that module, while feature code X applies to all
modules.
For detailed information on the feature codes, refer to the Client module licenses and feature
codes topic in the Administration Guide.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-13

Understanding IA License Parameters (5 of 6)

Date the
License was
Created

Disables an existing
license. This allows EMC
Captiva to update/upgrade
an existing license
Encoded license. Encoded
to a specific IA server
number
InputAccel Licensing
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-14

4-14

Understanding IA License Parameters (6 of 6)

License code status

OK

Functioning license
code

Bad

Non-functioning code
(not entered correctly or
intended for a different
Server ID)

Duplicate

Code entered multiple


times

Entered too Late

Code entered after the


Enter-by date

Expired

Server date is past the


Valid Until date

Disabled

Disabled based on the


license, Enter-by date,
or module
InputAccel Licensing

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-15

4-15

License Regulation (1 of 2)

9 Licensing Overview
9 Licensing Parameters
License Management

Server page count calculation


- Server page count is decremented based on the number of pages
entered into the system
Not by the amount of times the page is processed through an
individual module

- Processing of pages that have the Discard page option set will
not affect the page count for the module nor the server

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

The ScanPlus (SCANPLUS) and RescanPlus (RSCANPLS) modules have a Discard page
option for select scanner events such as software patch codes, separator pages, barcodes, etc.
This option is found on the Event actions tab in the module setup screen.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-16

4-16

License Regulation (2 of 2)

Module page count calculation


- The server keeps track of how many pages have been processed
-

by a module
Each time a page is processed by a module that page count is
incremented
Based on usage which is determined dynamically by processes
Skipping a step does not affect page count
When the number of pages processed hits the licensed limit the
server will no longer assign tasks to that specific module

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-17

4-17

Monitoring IA Licenses

Use the administration console to perform the following:


- Import, edit, add, and delete license codes
- View license information regarding modules
Number used and available
Pages used and available
Feature codes

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-18

4-18

Managing License Codes (1 of 2)


1) Select Licensing / Security tab
2) Click View License Codes

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

A user must have the AC.LicenseModify permission to modify permissions, and the
AC.LicenseRead permission to view existing permissions. Permissions will be discussed in a
later module in this course.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-19

4-19

Managing License Codes (2 of 2)


3) Import, add, or delete expired licenses
Select a license code to change its settings, or delete it

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-20

4-20

Importing Licenses (1 of 3)
1) Login to the
administration console
as an Administrator

3) Click View License Codes

2) Select Licensing/Security

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-21

4-21

Importing Licenses (2 of 3)
4) Click the Import License button

5) Browse to the license (.lic) file

6) Click OK

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-22

4-22

Importing Licenses (3 of 3)

All license codes associated with the license file are displayed

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-23

4-23

Viewing Module Licenses


1) Select Licensing / Security tab
2) Click View Module Licenses

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

The module licenses page displays license-related information such as the number of module
licenses used and available, percent copies used, pages used and available, and features.
Right-click the column header to display a list of hidden and visible columns. The order of
display can also be changed.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-24

4-24

9 Licensing Overview
9 Licensing Parameters
9 License Management

Test Your Knowledge

1. True/False: Server activation is performed using


the administration console.
2. True/False: License codes are stored in the InputAccel
servers settings.ini file.
3. True/False: Group licenses allow multiple modules
to pool page counts and connections.
4. Which of the following are valid license management features?
a) Import license
b) Delete expired licenses
c) Add a license code manually
d) All of the above

InputAccel Licensing

4-25

2009 EMC Corporation. All rights reserved.

1.
2.
3.
4.

True.
False. License codes are stored in the InputAccel database.
True.
d - All of the above.
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-25

Exercise

Estimated time: 30 min

Goals
- Understand different types of licensing and
their statuses

Tasks
- Answer licensing questions based on license codes

InputAccel Licensing
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


4-26

4-26

InputAccel Fundamentals and Administration


Lab 4

Module 4 Licensing

Estimated Time: 30 minutes


Goals

Understand different types of licensing and their statuses

Tasks

1.

Answer licensing questions based on license codes

Background
Before you begin:

Answers to the questions asked in the lab are at the end of the lab instructions

Task 1 - Answer licensing questions based on license codes


Use the following license codes table to answer the questions that follow:

Name

Connections

Pages

Valid
Until

Enter
By

ANNUAL

Unlimited

10000

101231

091231

SERVER

Unlimited

ANNUA
L

101231

SCANPLUS

Unlimited

101231

IAIPI

Unlimited

101231

SSOCR

Unlimited

101231

Features

Issue
Date

License
Code

Status

090931

8645-1258

Entered
Too Late

090931

6548-4584

OK

ABC

090931

1685-4865

OK

090931

1685-4865

OK

010915

3258-4584

OK

a) Why are you not able to scan pages?


_____________________________________________________________________________

_____________________________________________________________________________

Lab 4-1
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 4

b) What does Entered Too Late mean?


_____________________________________________________________________________

c) How do you resolve the issue?


_____________________________________________________________________________
_____________________________________________________________________________
_____________________________________________________________________________
Use the following license codes table to answer the questions that follow:
Name

Connections

Pages

Valid
Until

Enter
By

ANNUAL

Unlimited

20000

101231

091231

SERVER

Unlimited

ANNUA
L

101231

SCANPLUS

Unlimited

101231

IAIPI

Unlimited

101231

SSOCR

Unlimited

101231

Features

Issue
Date

License
Code

Status

090931

8645-1258

Entered
Too Late

090931

6548-4584

OK

ABC

090931

1685-4865

OK

090931

1685-4865

OK

010915

3258-4584

OK

d) After how many pages would ScanPlus stop processing and generate a license error?
_____________________________________________________________________________
_____________________________________________________________________________
e) When the server license is completely used, will IAIPI and SSOCR still be allowed to process?
_____________________________________________________________________________
_____________________________________________________________________________

Lab 4-2
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 4

f) At what point would IAIPI and SSOCR quit processing?


_____________________________________________________________________________
_____________________________________________________________________________

Name

Connections

Pages

Valid
Until

Enter
By

ANNUAL

Unlimited

20000

101231

091231

SERVER

Unlimited

ANNUA
L

101231

SCANPLUS

Unlimited

101231

GROUP1

Unlimited

101231

IAIPI

GROUP1

GROUP1

101231

SSOCR

GROUP1

GROUP1

101231

Features

ABC

Issue
Date

License
Code

Status

090931

8645-1258

Entered
Too Late

090931

6548-4584

OK

090931

1685-4865

OK

090931

0406-2002

OK

090931

1685-4865

OK

010915

3258-4584

OK

Use the following license codes table to answer the questions that follow:
g) Which license is an example of a Group license?
_____________________________________________________________________________
_____________________________________________________________________________
h) How many licensed connections of IAIPI and SSOCR are there?
_____________________________________________________________________________
_____________________________________________________________________________

Lab 4-3
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 4

Solutions:
a)

The "ANNUAL" license does not work because it was installed on the server after the Enter
By date.

b)

Entered Too Late means the license was installed after the Enter By date.

c)

In order to correct this problem you need to call support and have the IA server date reset.
This is performed using the Administration Console. Support uses a special software tool to
help you reset the date.

d)

The ScanPlus station will start giving license warnings when the page count reaches 90% of
the total count (20000) and would halt when it reaches that limit.

e)

Yes. IAIPI and SSOCR will continue to process all of the pages that already exist on the IA
server.

f)

IAIPI and SSOCR will not quit processing until they reach their expiration dates. There is
not page limit.

g)

The Group1 license is an example of Group licensing as the licenses for both IAIPI and
SSOCR refer to it.

h)

There can be up to 5 connections of either IAIPI or SSOCR in whatever combination best fits
the processing needs.

End of Lab

Lab 4-4
2009 EMC Corporation. All rights reserved.

Module 5

ScaleServer

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-1

Module Objectives

Describe ScaleServer technology


Understand how to create a ScaleServer group

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-2

5-2

ScaleServer Overview (1 of 2)

Overview
Example Operation
Creating ScaleServer Groups

Allows multiple servers to be grouped such


that a module can receive tasks from a set of servers

Modules gracefully deal with the loss of a server


Servers share connection information so a module consumes just
one connection license

Side-by-side installation and ScaleServer are not the same


- Side-by-side utilizes multiple server instances on a single, multi-

CPU/Core computer
ScaleServer utilizes multiple servers each on their own
computer

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-3

5-3

ScaleServer Overview (2 of 2)
InputAccel 6.0 Servers Working in a Group

InputAccel License Sharing InputAccel


Server 1
Server 2
Cluster info

License Sharing
Cluster info

InputAccel
Server 3

Network
Scan

Index

OCR

Export

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-4

5-4

Compatible Modules

Most modules are compatible with ScaleServer


- Can connect to all servers in the group simultaneously
Modules not compatible with ScaleServer can connect to any
single server in a ScaleServer group

ScaleServer
compatible

ScaleServer

5-5

2009 EMC Corporation. All rights reserved.

Attended modules such as ScanPlus that are ScaleServer compatible, will have the Connect to
server group checkbox on the logon dialog.
Enter a Server name of a server in a ScaleServer group and check the Connect to server group
checkbox in order to connect to the servers in a ScaleServer group. Alternately, the user may
simply type the name of one server in the group followed by a semicolon. For example,
student53z; will connect the user to all servers in the ScaleServer group that contains the
computer named student53z.
For a complete list of ScaleServer compatible modules, refer to the InputAccel Installation Guide.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-5

High Availability and Failover

ScaleServer groups alone do not provide redundancy or failover


capabilities
- Process sharing and load balancing are the primary capabilities

ScaleServer groups can be clustered


- Active/Passive and Active/Active

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-6

5-6

Example Operation (1 of 10)

9 Overview
Example Operation
Creating ScaleServer Groups

Work queued for Index across 3 IA Servers

InputAccel License Sharing InputAccel License Sharing


Cluster info
Cluster info
Server 1
Server 2
Task 1-1
Task 1-2
Task 1-3
Task 1-4

Task 2-1
Task 2-2
Task 2-3

InputAccel
Server 3
Task 3-1
Task 3-2
Task 3-3
Task 3-4
Task 3-5

Network
Task 1-1

Index

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-7

5-7

Example Operation (2 of 10)

Index receives task from IA Server 1

InputAccel License Sharing InputAccel License Sharing


Cluster info
Cluster info
Server 1
Server 2
Task 1-2
Task 1-3
Task 1-4

Task 2-1
Task 2-2
Task 2-3

InputAccel
Server 3
Task 3-1
Task 3-2
Task 3-3
Task 3-4
Task 3-5

Network
Task 1-1

Index

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-8

5-8

Example Operation (3 of 10)

Task is completed and the next comes from IA Server 2

InputAccel License Sharing InputAccel License Sharing


Cluster info
Cluster info
Server 1
Server 2
Task 1-2
Task 1-3
Task 1-4

Task 2-2
Task 2-3

InputAccel
Server 3
Task 3-1
Task 3-2
Task 3-3
Task 3-4
Task 3-5

Network
Task 2-1

Index

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-9

5-9

Example Operation (4 of 10)

Task is completed and the next comes from IA Server 3

InputAccel License Sharing InputAccel License Sharing


Cluster info
Cluster info
Server 1
Server 2
Task 1-2
Task 1-3
Task 1-4

Task 2-2
Task 2-3

InputAccel
Server 3
Task 3-2
Task 3-3
Task 3-4
Task 3-5

Network
Task 3-1

Index

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-10

5-10

Example Operation (5 of 10)

Task is completed and the next comes from IA Server 1

InputAccel License Sharing InputAccel License Sharing


Cluster info
Cluster info
Server 1
Server 2
Task 1-3
Task 1-4

Task 2-2
Task 2-3

InputAccel
Server 3
Task 3-2
Task 3-3
Task 3-4
Task 3-5

Network
Task 1-2

Index

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-11

5-11

Example Operation (6 of 10)

IA Server 2 goes down while Index is processing task

InputAccel License Sharing InputAccel License Sharing


Cluster info
Cluster info
Server 1
Server 2
Task 1-3
Task 1-4

Task 2-2
Task 2-3

InputAccel
Server 3
Task 3-2
Task 3-3
Task 3-4
Task 3-5

Network
Task 1-2

Index

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-12

5-12

Example Operation (7 of 10)

Index gets task from Server 3

InputAccel License Sharing InputAccel License Sharing


Cluster info
Cluster info
Server 1
Server 2
Task 1-3
Task 1-4

Task 2-2
Task 2-3

InputAccel
Server 3
Task 3-3
Task 3-4
Task 3-5

Network
Task 3-2

Index

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-13

5-13

Example Operation (8 of 10)

Task is completed and the next comes from IA Server 1

InputAccel License Sharing InputAccel License Sharing


Cluster info
Cluster info
Server 1
Server 2
Task 2-2
Task 2-3
Task 1-4

InputAccel
Server 3
Task 3-3
Task 3-4
Task 3-5

Network
Task 1-3

Index

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-14

5-14

Example Operation (9 of 10)

Meanwhile, IA Server 2 comes online

InputAccel License Sharing InputAccel License Sharing


Cluster info
Cluster info
Server 1
Server 2
Task 2-2
Task 2-3
Task 1-4

InputAccel
Server 3
Task 3-3
Task 3-4
Task 3-5

Network
Task 1-3

Index

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-15

5-15

Example Operation (10 of 10)

Task is completed and the next comes from IA Server 2

InputAccel License Sharing InputAccel License Sharing


Cluster info
Cluster info
Server 1
Server 2
Task 2-3
Task 1-4

InputAccel
Server 3
Task 3-3
Task 3-4
Task 3-5

Network
Task 2-2

Index

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-16

5-16

Creating ScaleServer Groups

9 Overview
9 Example Operation
Creating ScaleServer
Groups

ScaleServer groups are created using the


administration console

In order to create a ScaleServer group, appropriate licensing must


be obtained

Steps:
1)
2)
3)
4)
5)
6)

Ensure that each server has been activated


Install the ScaleServer license with the appropriate feature codes
Use the administration console to add a new ScaleServer group
Specify the ScaleServer group name
Add servers to the group
Configure the same users on all IA servers in the ScaleServer
group

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-17

5-17

Adding the Group (1 of 2)


1) In the administration console, select the Systems
tab
2) Click the
View ScaleServer Groups link

3) Click the Add button

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-18

5-18

Adding the Group (2 of 2)


4) Enter a Name for the ScaleServer group
5) Add servers from
the list of Available
Servers

6) Click OK

Shows
registered
servers

ScaleServer
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-19

5-19

9 Overview
9 Example Operation
9 Creating ScaleServer Groups

Test Your Knowledge


1. True/False: ScaleServer technology is the same
as a side-by-side installation.

2. True/False: Servers share connection information,


so a module consumes just one connection license.
3. True/False: Modules not compatible with ScaleServer can
connect to any single server in a ScaleServer group.
4. Which of the following steps are necessary to create a
ScaleServer group?
a) Activate and license the servers for use with ScaleServer
b) Configure the same set of users on each IA server computer
c) Configure the servers to use Active/Passive clustering
d) Ensure that users check the Connect to server group
checkbox when logging on
ScaleServer

5-20

2009 EMC Corporation. All rights reserved.

2.
3.
4.
1.

False. ScaleServer allows multiple servers to be grouped such that a module can receive
tasks from a set of 2 - 8 servers. Side-by-side installation installs multiple IA server instances
on a single computer.
True.
True.
a and b. Clustering does not have to be in place to create or use ScaleServer groups. In order
to connect to a ScaleServer group, users must check the Connect to server group checkbox,
but it is not necessary in order to create the group.
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


5-20

Module 6

Security

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-1

Module Objectives

Describe an overview of security


Describe roles
Describe access control lists (ACL)
Differentiate roles and access control lists
Define the objects to which permissions can be applied
Create a role
Modify a role

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-2

6-2

Overview
Roles and Role Management
Permissions and ACLs

Security Overview (1 of 2)

Security consists of four main components


- Users and groups
- Roles
- Permissions
- Access control lists (ACL)
All InputAccel users and groups are based on Windows domain
users and groups

Roles associate a set


of users and/or
groups to a set of
permissions

Users
Bob
Jim
Mary
Training

Permissions
AC.Login
Server.Login
Server.Read.Module.Data

Limited Admin Role

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-3

6-3

Security Overview (2 of 2)

Permissions control access to functionality associated with


modules (including the admin console) and are named using the
following form:
<Module Name>.<Permission>
Example: AC.Login allows users login permission to the AC
(administration console) module

Access control lists (ACL) provide access to individual objects


including modules, batches, departments, and processes
- Simple permissions such as read, write, execute, delete
- Separate from role definitions
- Do not apply to administration console users
Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-4

6-4

9 Overview
Roles and Role Management
Permissions and ACLs

Pre-Defined Roles

InputAccel comes with five pre-defined roles


- Administrators
- System Monitor
- Module Operator
- Index Operator
- Scan Operator
Each of these roles contains a set of permissions necessary to
perform minimal operations
- Only the Administrators role is populated with associated
members
IIS Machine Administrators
To prevent unauthorized access, this member should be replaced
with a more restrictive group
Security

6-5

2009 EMC Corporation. All rights reserved.

The word members in this context refers to a set of user and/or groups. The IIS Machine
Administrators refers to the Administrators group for the machine on which Internet Information
Services (IIS) is installed. This is the machine on which the administration console is installed.
A user from this group should create an IA Admins group containing the domain accounts
representing users that are to be administrators, add it to the Administrators role, and then delete
the IIS Machine Administrators member from the role.
The pre-defined roles and their capabilities are listed below:
Administrator

Includes all permissions

System Monitor

Includes all of the necessary permissions to monitor the


status of the system. Read-only mode.

Module Operator

Includes all of the necessary permissions to work with


modules.

Index Operator

Includes all IndexPlus permissions. Members of this


role must also be a member of the Module Operator role.

Scan Operator

Includes all ScanPlus permissions. Members of this role


must also be a member of the Module Operator role

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-5

Viewing Roles (1 of 2)
1) Login to the administration console
2) Select the Licensing/Security tab
3) Click the View Roles link

3
2

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-6

6-6

Viewing Roles (2 of 2)
4) Select the desired role to view and click the Settings button
- Alternatively, double-click the role to view

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-7

6-7

Role Settings Layout

Role Name
and Description

Available/Selected
Permissions

Description of
selected permissions

Available/Selected
Members

Security

6-8

2009 EMC Corporation. All rights reserved.

Not shown above, but at the bottom-right of the screen are the Find Member, OK, and Cancel
buttons.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-8

Adding New Roles (1 of 4)

Add new roles when the existing roles do not have the appropriate
permissions for a set of users/groups

Users/groups may be a member of more than one role


- Be mindful when adding users to multiple roles or groups as
users may be granted permissions unexpectedly
Example: Joe is added as a member of the System Monitor role
and therefore has read-only access to the administration console.
Later, the Training group is added as a member of the
Administrators role, which as full access. The administrator has
unknowingly granted full administrative access to Joe because
he is a member of the Training group.

Security
2009 EMC Corporation. All rights reserved.

Roles cannot contain other roles.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-9

6-9

Adding New Roles (2 of 4)


1) Login to the administration console
2) Select the Licensing/Security tab
3) Click the View Roles link

3
2

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-10

6-10

Adding New Roles (3 of 4)


4) Click the Add button

5) Enter the role Name and optional Description


5

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-11

6-11

Adding New Roles (4 of 4)


6) Define Selected Permissions from the list of Available
Permissions using the add buttons

7) Add Selected Members from the list of Available Members or


use the Find Member button to add members not listed in the
available members list
7

Security
2009 EMC Corporation. All rights reserved.

After adding members from the list of available members, or by finding them, click OK to
complete the creation of the role.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-12

6-12

Finding Members

The Find Member button is used to populate the selected


members list from a search result selection

Filter based on
- Domain or workstation
- User or group name
- Built-in security
principals

Security

6-13

2009 EMC Corporation. All rights reserved.

Clicking the Find Member button in the add role screen displays the dialog shown above. The
find dialog allows the user to search for users based on specified criteria. Users that are found
and then selected, will be added to the selected members list and will also be available in future
available members lists.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-13

9 Overview
9 Roles and Role Management
Permissions and ACLs

Permissions

Permissions control access to functionality associated with

modules and the server


Permissions are associated with users via roles
Most roles should contain the following basic permissions
- Server.Login
- System.BatchModify
- System.BatchRead
- Server.Read.Module.Data
- Server.Write.Module.Data
Many attended modules also have a Login permission needed to
login to the module
Administration console, ScanPlus, RescanPlus, and IndexPlus
have additional module specific permissions
Security

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-14

6-14

Module Operator Permissions

Members of the Module Operator role have the following


permissions:
- Server.Login
- Server.Read.Module.Data
- Server.Write.Module.Data
- System.BatchModify
- System.BatchRead
- System.ProcessRead
- System.ServerRead

These are the basic permissions required by most users (module


operators)

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-15

6-15

Scan Operator Permissions

Members of the Scan Operator role have the following


permissions:
- ScanPlus/ReScanPlus.ChangeScanConfig
- ScanPlus/ReScanPlus.Login
- ScanPlus/ReScanPlus.ReorderImages
- ScanPlus/ReScanPlus.SetupInstance
- Server.CreateBatch

In addition to the permissions above, members must have


permissions defined in the Module Operator role
- Add users/groups to both roles

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-16

6-16

Index Operator Permissions

Members of the Index Operator role have the following


permissions:
- IndexPlus.Annotations
- IndexPlus.ChangeLayout
- IndexPlus.DeleteNodes
- IndexPlus.Login
- IndexPlus.PrintImages
- IndexPlus.SkipValidation

As with the Scan Operator role, members of the Index Operator


role must also be added to the Module Operator role

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-17

6-17

Modules with Login Permissions

These modules have their own login permission


- AC (administration console)
- DocumentumAdvancedExport
- ImageDivider
- IndexPlus
- NuanceOCR
- PrimeOCR
- RescanPlus
- ScanPlus
- ScriptEngine
- WebServices.WSInput/WSOutput

Security
2009 EMC Corporation. All rights reserved.

Users will not be able to use a module from the list above unless the user is granted login
permission via their role.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-18

6-18

Server Permissions (1 of 2)

Server.Copy.Batch.to.Server
- Copy batches to the InputAccel server
Server.Create.Batch
- Create batches
Server.Debug
- Obtain server debugging information
Server.Install.Process
- Install processes on the server
Server.Log.Message
- Obtain server log messages

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-19

6-19

Server Permissions (2 of 2)

Server.Login
- Login to the InputAccel server
- Required for all modules
Server.Read.Module.Data
- Read module data from the server
Server.Write.Module.Data
- Write module data to the server
Server.SetLogContext
- Set server log context data

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-20

6-20

System Permissions (1 of 2)

System.BatchModify
- Add or delete batches
- Used only for the administration console
System.BatchRead
- View batches in the system
System.ProcessModify
- Add, modify, and delete processes
System.ProcessRead
- View processes installed in the system

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-21

6-21

System Permissions (2 of 2)

System.SecurityModify
- Write non-module server data
System.SecurityRead
- Read non-module server data
System.ServerModify
- Update connection settings for servers
- Add and modify ScaleServer groups
System.ServerRead
- View servers installed in the InputAccel database
- Required for any client that connects to a ScaleServer group

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-22

6-22

Access Control Lists (1 of 2)

Access Controls Lists (ACL) contain a list of accessors and their


associated permissions

Used to define permissions on individual objects


- Process
- Batch
- Module
- Department
Permissions in ACLs are limited to the following, but not
necessarily applicable to all of the objects listed above
- Execute
- Read Only
- Read and write
- Delete
- Change permission
Security
2009 EMC Corporation. All rights reserved.

Prior to version 6.0, only ACLs were used - no roles.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-23

6-23

Access Control Lists (2 of 2)

Each object ACL specifies


- A list of users and groups
- Specified permissions for each of the users/groups listed in the
ACL

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-24

6-24

How Do Roles and ACLs Differ?

Roles are used for actions and ACLs are used for things
- Roles contain permissions and members (users/groups)
- ACLs define access to specific modules, batches, departments
or processes

Both roles and ACLs may be used in a system


- Use ACLs when finer-grain control is necessary

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-25

6-25

Viewing ACLs (1 of 2)

ACLs can be viewed in the administration console


To view ACLs for processes, new batches, modules, and
departments:
1) Select the Systems tab

2) Click the appropriate View link, for example, View Processes


Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-26

6-26

Viewing ACLs (2 of 2)
3) Right-click the
object and select
View Selected>
ACLs

3
Security

6-27

2009 EMC Corporation. All rights reserved.

Process objects also have the ACLs for New Batches selection. This allows the administrator
to define ACLs for all new batches. Setting ACLs on batch objects only affect the batches
selected.
Shown here to the right is the result
selecting the ACLs menu option for
the process above.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-27

Modifying ACLs (1 of 2)
1) Start by viewing an ACL for an object
2) Select Add to add new accessors or
choose an existing accessor and
select Delete

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-28

6-28

Modifying ACLs (2 of 2)
3) When adding, use the search screen to filter and select
users/groups
4) Select the added users/groups and assign the desired permissions

4
Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-29

6-29

9 Overview
9 Roles and Role Management
9 Permissions and ACLs

Test Your Knowledge


1. Which of the following objects have ACLs?
a) Roles
b) Processes
c) Batches
d) Departments

2. True/False: InputAccel comes with five pre-defined roles.


3. True/False: Any user can only be a member of one role.
4. True/False: Attended modules such as ScanPlus have their own
login permission.
5. True/False: When creating new roles, use the Find Member
button to add users/groups to the selected members list.

Security

6-30

2009 EMC Corporation. All rights reserved.

1.
2.
3.
4.
5.

b, c, and d. Roles define a list of permissions and associated users/groups.


True.
False. Users may be a member of any number of roles.
True.
True.
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-30

Estimated time: 30 min

Exercise

Goals
- Create and modify roles
Tasks
- Create a new role
- Test the new role
- Remove permissions from the role and test it

Security
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


6-31

6-31

InputAccel Fundamentals and Administration


Lab 6

Module 6 Security

Estimated Time: 30 minutes


Goals

Create and modify roles

Tasks

1.

Create a new role

2.

Test the new role

3.

Remove permissions from the role and test it

Background
Before you begin:

Answers to the questions asked in the lab are at the end of the lab instructions

When using the Administration Console, the lab instructions refer to links in the left-side
pane as "tabs".

Windows login/password: dmadmin/training

Task 1 - Create a new role


1.1.

If necessary, login to Windows using the login and password shown above
(dmadmin/training).

1.2.

Using Internet Explorer, launch the Administration Console by navigating to


http://localhost. Alternately, select Start > Programs > InputAccel > Administration
Console.

1.3.

Logon using dmadmin/training as the Username/Password. Enter your host name for the
Domain or simply enter a period instead. Click Log On to logon.

1.4.

Click the Licensing / Security tab in the navigation pane.

1.5.

Click the View Roles link. Currently there should be five default roles listed.

1.6.

Click Add to add a new role.

1.7.

Enter Scan and Index Operator as the Name of the new role.

1.8.

Enter Security Role for Scan and Index Operators in the Description.
Lab 6-1

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 6

1.9.

Select all of the Available Permissions prefixed with IndexPlus and click the add button
(
) to add them to the Selected Permissions list. Hold down the Ctrl key and click
each permission to select multiple permissions. You may also use the Shift key to select
multiple sequential items.

1.10.

Repeat the last step, but select all of the ScanPlus permissions and add them to the Selected
Permissions list.
a) What other permissions are necessary to use client modules?
___________________________________________________________________________
___________________________________________________________________________

1.11.

Using the answer from the question above (answers at the end of the lab), add those
permissions to the Selected Permissions list.

1.12.

In addition to the selected permissions, Scan operators are required to have the
Server.CreateBatch permission. Select it from the list of available permissions and add it to
the list of Selected Permissions.

1.13.

Add members to the role.

1.14.

1.13.1.

Currently there is only one available member - IIS Machine Administrators.


Click the Find Member button beneath the Selected Members list (you may
need to scroll to the right to see it).

1.13.2.

Using the Find Members dialog, you can search for Windows users and groups to
add. Check the Use domain or workstation filter checkbox and enter your
computer name (probably STUDENT53X).

1.13.3.

Check the Use name filter checkbox and enter cchan in the field to search for
user "cchan". This user represents someone that will perform both scanning and
indexing. A Windows account has already been created for this user.

1.13.4.

Click the Search button.

1.13.5.

Select cchan and click OK. The user is added to the Selected Members list.

Click OK to complete the role creation.

Congratulations! You have successfully created a role.

Lab 6-2
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 6

Task 2 - Test the new role


2.1.

Start ScanPlus by selecting Start > Programs > InputAccel > ScanPlus.

2.2.

Enter cchan as the Username, cchan as the Password, and a period (.) as the Domain.
Click OK. If you were successful, the ScanPlus module should launch. Note that you can
either click OK to dismiss any messages regarding the grace period; otherwise the message
will disappear on its own when you close the application.

2.3.

Click the Create new batch link.

2.4.

Select any available process from the list.

2.5.

Enter Lab 6 as the name of the new batch and click Create. The Scan window should now
be displayed. Do not worry about importing any files into the batch at this time.

2.6.

Click the Close Batch link.

2.7.

Close ScanPlus.

2.8.

Now verify that user cchan can logon to the IndexPlus module. Do not attempt to open or
process any batches.

2.9.

Close IndexPlus.

2.10.

Attempt to start ScanPlus and IndexPlus again, but this time enter gcarlson/gcarlson as the
Username/Password. This user is a Windows user, but is not a valid operator.
b) What happens when attempting to launch using gcarlson as the user?
__________________________________________________________________________
c) If it fails to launch, what error, if any, is displayed?
__________________________________________________________________________

2.11.

Click Close to dismiss the error message and click Cancel to dismiss the logon screen.

Congratulations! You have successfully tested your new role.


Task 3 - Remove permissions from the role and test it
3.1.

If necessary, logon to the Administration console, select the Licensing / Security tab, and
click View Roles.

3.2.

Remove permissions from the role.


Lab 6-3

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 6

3.2.1.

Select your Scan and Index Operator role and click the Settings button.

3.2.2.

In the last task, you only attempted to login to the ScanPlus and IndexPlus
modules. Your goal is to verify that only the .Login permission is required to do
that.
In the Selected Permissions list, remove ScanPlus.Login and IndexPlus.Login
permissions. Follow the sub-steps below if you need assistance doing so.
3.2.2.1.

From the Selected Permissions list, select the desired permission to


remove and click the delete button (

3.2.3.
3.3.

).

Click OK to update the role.

Test the updated role.


3.3.1.

Select Start > Programs > InputAccel > ScanPlus.

3.3.2.

When prompted to logon, enter cchan as the Username and Password along with
a period for the Domain. Click OK.
d) Were you successful logging in to the ScanPlus module?
__________________________________________________________________
e) What error message was displayed?
__________________________________________________________________

3.3.3.

Click OK to dismiss the error message.

Congratulations! You have successfully tested your updated role.

Solutions:
a)

Server.Login, Server.Read.Module.Data, Server.Write.Module.Data., System.BatchModify,


System.BatchRead, System.ProcessRead, System.ServerRead.

b)

An error message is displayed.

c)

The error is "Invalid access rights."


Lab 6-4

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 6

d)

No.

e)

Cannot start production mode. Error: Insufficient permissions to launch in production mode.

End of Lab

Lab 6-5
2009 EMC Corporation. All rights reserved.

Module 7

Client Modules

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-1

Module Objectives

Describe setup and production operation


Define module execution modes
Describe departmental routing
List commonly used modules and their uses

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-2

7-2

Module Execution Modes

Setup and Production


Departmental Routing
Commonly Used Modules

Modules run in two different modes


- Setup - Used to configure the module
- Production - Used during normal processing of batches
Using setup mode, a module can be configured for a process or a
batch
- Changing the module setup
At the process level affects all new batches
At the batch level only affects that batch

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-3

7-3

Running a Module in Setup Mode

Modules can be run in setup mode from the administration console


or from the command line
- ScanPlus can be setup at run-time by an administrator or those
with appropriate permissions
- Setup options include things such as how the module should run
and how it should handle errors

Client Modules

7-4

2009 EMC Corporation. All rights reserved.

The command-line example above should be entered all on one line. New modules such as
ScanPlus and IndexPlus are based on QuickModuleHost.exe and therefore must be launched
using it. Specify the -modulename: argument followed by the name of module. Specify the login: argument followed by the login domain, name, and password, or use an asterisk (as above)
to use the currently logged in users credentials. Refer to the ScanPlus Guide for more
information on command-line arguments.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-4

Changing Module Setup at the Process Level


(1 of 3)

1) Select the Systems tab in the administration console

2) Click the View Processes link

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-5

7-5

Changing Module Setup at the Process Level


(2 of 3)

3) Select the process


containing a module
whose configuration
should be changed

4) In the steps pane,


double-click the module
or right-click and select
Settings to configure it

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-6

7-6

Changing Module Setup at the Process Level


(3 of 3)

Client Modules

7-7

2009 EMC Corporation. All rights reserved.

The module setup screen is launched for the selected process and module. Notice the
Process/Batch name field is set to the selected process name. It also appears in the title bar of
the window.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-7

Changing Module Setup at the Batch Level


(1 of 2)

1) Select the Batch Traffic tab in the administration console

2) Right-click a batch
whose setup needs
changing and select
Settings

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-8

7-8

Changing Module Setup at the Batch Level


(2 of 2)

3) Choose Steps from the dropdown list in the batch window


4) Right-click the module/step to modify and select Settings

The module launches in setup mode

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-9

7-9

Running Modules in Production Mode

Modules execute in order to process batches


Wait for task
- Run a single batch
- Run all batches
Open batch
- Open batch
Unattended modules have no user interaction
- Should process all batches
- Run all batches
Attended modules are operated by a user
- Users may run only specific batches
- Run a single batch, run all batches, or open batch
Client Modules

7-10

2009 EMC Corporation. All rights reserved.

Not all modules have the open batch mode option. When a batch is opened using the open batch
functionality, it will usually have to be closed using an associated close batch command button
or link. If a batch is processed using the open batch option, it will not be marked as completed by
the server and will remain in the queue for processing.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-10

Run All Batches - Example

Batch 1
ScanPlus

Image
Enhancement

InputAccel Server

Batch 2
IE

Index

Export

Index

Export

Export

IE
Run all batches

Index 1
Run all batches

Index 2
Run all batches

Client Modules

7-11

2009 EMC Corporation. All rights reserved.

In this example, two batches (Batch 1 and Batch 2) are created by the ScanPlus module. Because
the image enhancement and index modules are setup to run all batches, both modules process
Batch 1 and Batch 2.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-11

Run Single Batch - Example

Batch 1
ScanPlus

Image
Enhancement

InputAccel Server

Batch 2
IE

Index

Export

Index

Export

IE
Run all batches

Index 1
Run Single
batch (1)

Client Modules

Index 2
Run Single
batch (2)

Export

7-12

2009 EMC Corporation. All rights reserved.

In this example, two batches (Batch 1 and Batch 2) are created by the ScanPlus module. Because
the index modules are setup to run single batch, each module processes only the batch selected
by the operator. In this example, Index Operator 1 selects Batch 1 and Index Operator 2 selects
Batch 2.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-12

Running Modules as Services or Applications

A service is a program that runs in the background


- No user interface or user interaction
- Managed from the Services MMC in Windows
- Startup may be automatic (starts at server boot) or manual
- Example services: InputAccel Server, World Wide Web
Publishing Service, Documentum Docbase

Unattended modules are usually run as a service


- May run as an application
Attended modules such as ScanPlus and IndexPlus must be run as
applications
- Create custom shortcuts to specify command-line arguments
such as department
Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-13

7-13

Specifying Modules to Run as Services

During client component installation, select the option to Install


services for all selected modules that can run as a services

Client Modules

7-14

2009 EMC Corporation. All rights reserved.

If this checkbox is not checked, then no client modules will be able to run as a service. When it
is checked, the installer will create a Windows service and also place a shortcut to the module on
the Start menu so that it can be run as an application.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-14

Starting, Stopping, and Pausing Services


Two ways to start, stop or pause services
- Services MMC in Windows
- Command line

Client Modules

7-15

2009 EMC Corporation. All rights reserved.

Client module services are set to manual startup. The administrator can change the startup to
automatic or simply start the services on demand. Service control from a command prompt: Net
[start] [stop] [pause] <service name>|<service display name>. Example: net start IMGDIVID
or net start InputAccel Image Divider

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-15

Behavior of Module Services

Starting
- Begins taking any available tasks
Stopping
- Finishes any current task and then the service will stop
- The service is released from memory and will no longer process
any tasks

Pausing
- Finishes any current task and will no longer receive any
-

additional tasks
The service itself is not terminated

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-16

7-16

Starting Modules as Applications (1 of 2)

Use the Windows Start menu


- Installer creates a default entry
Use a custom shortcut or command-line entry
- Necessary if the module must process specific departments
- Can pass arguments for auto login, run all batches, department,
etc.

Modules have an associated executable or use


QuickModuleHost.exe -modulename: to launch them
- Most newer modules use the latter

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-17

7-17

Command-Line Arguments

Auto login:
-login:<domain>\<username>, <password> | *@<server machine>

- Use * to use the currently logged in user


- Use a period in place of the domain if the user/server domains
are the same

Run all batches:


-autostart

Process department-related batches:


-department:<department1>[,<department2>,] | *

Client Modules

7-18

2009 EMC Corporation. All rights reserved.

The vertical bar (|) shown above means that the thing the left can be used or the thing to the right
can be used.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-18

Command-Line Examples

Start ScanPlus for processes using the Training department


C:\>QuickModuleHost.exe
-modulename:Emc.InputAccel.Scan
-department:Training

Start IndexPlus in run all batches mode, login automatically as


the currently logged in user, and process batches from any
department for which the current operator has permission
C:\>QuickModuleHost.exe
-modulename:Emc.InputAccel.Index
-autostart
-login:*@student53x
-department:*
Client Modules
2009 EMC Corporation. All rights reserved.

Despite the appearance above, all arguments should be on one single command line. The
arguments are put on separate lines above for clarity.
All client module executables are in the C:\Program Files\InputAccel\Client\binnt directory.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-19

7-19

Determining the Executable (1 of 2)


1) In the administration console, select the Systems tab
2) Click the View Modules link

3) Right-click the module in question and select Settings

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-20

7-20

Determining the Executable (2 of 2)

Launched using
QuickModuleHost.exe

Launched using
IAIPI.exe

Client Modules

7-21

2009 EMC Corporation. All rights reserved.

Modules whose launch name is Emc.InputAccel.<module name> are launched using the
QuickModuleHost.exe application. This typically applies to newer modules. If the launch name
is the same as the executable name, then there will be an associated executable file.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-21

Processing by Department

9 Setup and Production


Departmental Routing
Commonly Used Modules

By default, batch processing allows any module


instance to process tasks
- Any workstation or users

It may be desirable to delegate tasks to specific users or


workstations by department
- For example, only HR employees should work on human
resource-related documents
- Process designers specify the department to use for a step

Modules can be launched to process any department or specific


departments
- The logged in user must have permissions as defined by the
department ACL in order to process departmental tasks

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-22

7-22

Departmental Processing Examples (1 of 2)

Non-departmental tasks
- QuickModuleHost.exe -modulename:Emc.InputAccel.Index
- When starting modules from the Start menu, no department is
specified

Tasks by specific departments


- QuickModuleHost.exe -modulename:Emc.InputAccel.Index
-department:HR
- QuickModuleHost.exe -modulename:Emc.InputAccel.Index
-department:Accounting

Any departmental tasks for which operators have permissions


- QuickModuleHost.exe -modulename:Emc.InputAccel.Index
-department:*
Modules must be started using the -department: argument in order to
process tasks that are associated with a department

Client Modules
2009 EMC Corporation. All rights reserved.

If a module is executed without specifying a department, then that module will only be able to
process tasks associated with process steps that do not specify a department.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-23

7-23

Departmental Processing Examples (2 of 2)

InputAccel Server

ScanPlus

IE

IndexPlus - HR

Export

IndexPlus Accounting
Client Modules
2009 EMC Corporation. All rights reserved.

In this example, there are two instances of the IndexPlus module. One instance was started to
process only HR-related batches while the other one was started to process only Accountingrelated batches.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-24

7-24

Creating Departments (1 of 2)
1) Select the Systems tab in the administration console
2) Click the View Departments
link

3) Click the Add button

Client Modules

7-25

2009 EMC Corporation. All rights reserved.

Creating departments in the administration console allows permissions to be set on a department


before installing a process which uses it.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-25

Creating Departments (2 of 2)
4) Enter the new department name and click OK

Departments will be created automatically whenever a process


containing a department is added to an IA Server

Client Modules
2009 EMC Corporation. All rights reserved.

Department names will be displayed as entered, but in general are not case-sensitive.
Refer to the module on Security for detailed information on department ACLs.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-26

7-26

ScanPlus and RescanPlus

9 Setup and Production


9 Departmental Routing
Commonly Used Modules

Scan pages into InputAccel


Automatically divide documents
-

With Patch Codes


At nth page
By barcodes (with compatible scanner)
With separator page (scanner event)
New stack (scanner event)
With blank page

Indexing
Multi-Streaming (Scanner Feature)
Deployable via ClickOnce
Some ScanPlus settings are shared with RescanPlus
- Within a batch or process
Client Modules

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-27

7-27

RescanPlus
Why RescanPlus?

- RescanPlus handles any pages that exist on the InputAccel


-

Server that must be replaced


ScanPlus cannot be used because scan is not triggered to receive
tasks
Scan only creates tasks

RescanPlus station

- Typically a separate PC from the ScanPlus station


- Typically low-volume-feed or flatbed scanner

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-28

7-28

Image Quality Assurance (IQA)

Indexing
- At Page Level

Orientation
- Rotate 90, 180, 270

Quality Control Flags


-

Too light
Too dark
Noise
Skewed
Comment box

Bent corner
Wrong image
Double feed
Other
Delete

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-29

7-29

Image Enhancement

Runs page through enhancement filters


-

Border removal
Deskew
Crop
Hole removal
Halftone
Noise removal
Barcode recognition
Patch code detection
Color filters

Line removal
Smooth
Erosion
Dilation
Skeleton
Invert
Scaling
Blank page detection
2-D barcode recognition

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-30

7-30

Optical Character Recognition (OCR) (1 of 2)

NuanceOCR
- Multiple engines
- Output to more than 25 formats including MS Word, HTML,
-

and PDF
IA Values
Formerly known as ScanSoft OCR

PrimeOCR Plus
- Three to six engines
- Output to text file, PDF or IA Values
- Formerly known as PrimeOCR

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-31

7-31

Optical Character Recognition (OCR) (2 of 2)

Zonal OCR
- Multiple zones (default 20)
- Generates text strings
Full page OCR
- Generates text files
Multiple Languages
Custom Dictionaries

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-32

7-32

IndexPlus

Receive tasks at any level


Index as well as QA pages
Restricted indexing
Field initialization
Multi-level indexing
External validation options
Deployable via ClickOnce

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-33

7-33

Auto Annotate

Stamp the image with a combination of:


-

Text - Enables addition of text and/or InputAccel values to the image


Highlight - highlights a selection with a specified color
Redaction - Creates a black box to cover a portion of the image
Freehand line - Enables drawing lines on the page
Straight line - Draws a straight line of selected color and thickness
Lines may have arrow heads on either end
- Stamp - Enables the import of a .bmp file to add to annotations
- Rectangle - Creates rectangles on the page

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-34

7-34

Integrating Dispatcher Modules

Dispatcher modules integrate seamlessly into EMC Captivas


InputAccel product

Enables intelligent classification and extraction functionality in


your process flow

Administration and monitoring of production environment done


with InputAccel
Dispatcher modules

Document Classification
Classification Edit
Recognition
Validation

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-35

7-35

Export

Export features
-

Dynamic export paths using schemas


Dynamic export file names using schemas
Configurable error controls
Module retry options
Various export file type options
Overwrite controls

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-36

7-36

9 Setup and Production


9 Departmental Routing
9 Commonly Used Modules

Test Your Knowledge

1. True/False: Modules run in two different modes.


2. True/False: Changing the setup for a batch affects
all subsequent batches that are created.
3. Which of the following ways are batches processed
by unattended modules?
a) Run all batches
b) Run single batch
c) Open batch
d) Run specific batch
4. True/False: Unattended modules must run as a Windows service.
5. True/False: Specifying -department:all will allow a module to
process tasks associated with all departments.
Client Modules

7-37

2009 EMC Corporation. All rights reserved.

1.
2.
3.
4.
5.

True. Modules can be run in setup or production mode.


False. Changing the setup for a single batch only affects that batch.
a. Unattended modules execute in the run all batches mode.
False. Unattended modules can run as an application.
False. The -department: argument must use an asterisk as the value to process all
departments (-department:*).
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-37

Estimated time: 60 min

Exercise

Goals
- Configure modules using setup mode
Tasks
- Import an existing process
- Configure the steps in the new process
- Create a batch and test the process

Client Modules
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


7-38

7-38

InputAccel Fundamentals and Administration


Lab 7

Module 7 Client Modules

Estimated Time: 60 minutes


Goals

Configure modules using setup mode

Tasks

1.

Import an existing process

2.

Configure the steps in the new process

3.

Create a batch and test the process

Background
Before you begin:

Answers to the questions asked in the lab are at the end of the lab instructions

When using the Administration Console, the lab instructions refer to links in the left-side
pane as "tabs".

Windows login/password: dmadmin/training

The objective of this lab is to review a specific set of document capture requirements, select the
appropriate InputAccel modules, define the configuration for each module, and map out the process
flow chart.
Design Requirements
Your job is to save all of the companys internal HR employee files to a digital format usable by the
companys Web developer for on-line use.
Document Prep
Each document to be scanned will have a cover page containing:
Patch Code 2 (used for document separation)
Barcode (Code 39) containing the Employees Tax Identifier (SSN)

Lab 7-1
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

Sample Cover Page


Software Patch Code 2 - InputAccel can use this patch code to automatically create new levels in
the document structure (new Documents, Folders, etc.).
Barcode - This barcode contains an employee's tax identifier (SSN). We want to read this barcode
and store the decoded text with the other employee index data.
The cover page will be exported with the document.

Image Capture
Lab 7-2
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

Pages scanned into a batch must be separated into documents at scan time.
Images must be corrected for the following:

Borders generated by edge detection scanners

Page skewing from the scanning process

Barcode must be read from the first page of each document

Shading must be removed from all pages for readability when indexing

Document Set Sample


The following sample is one entire employee file. It is composed of an eleven-page document plus
one cover sheet. (See the "Cover Sheet Example" on the previous page.)

Data Capture
Lab 7-3
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

The HR department wants a comma-delimited text file containing SSN, Employee Name,
Department, Status, 401K, and Employee Stock Purchase Plan. Valid entries are as follows:
Department

Status

401K

Stock Purchase Plan

administration

full time

consultants

part time

10

marketing communications

exempt

20

accounting

bimonthly

40

support

nonexempt

60

test

hourly

80

professional services

100

sales

120

140

160

10

Required Fields
HR Database Fields

Format

Value(s)

Last Name

Last Name Only

Located on page 2

Employee Tax ID (SSN) None

Barcode located on Cover Page

Department

Located on page 2

Status

Located on page 2

401K

Located on page 2

Stock

Located on page 7

Image Path

None

The Image Export module produces this


value at run time.

Note: The SSN field will be pre-populated by the barcode value. This option is not configured through setup. The
process source code sets the value automatically with the data read from the barcode.

Export
Lab 7-4
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

There are two items that need to be produced with Export:


A text file in the C:\Temp directory named Batchname.txt. This file will contain the following
Index data in a comma-delimited format:

Employee Name

SSN

Department

Status

401K

Stock Purchase Plan

Path to the image files

There will be a single image file for each employee, with each named using the employees name.
The file will contain all the images the associated document. This file will also be saved in the
C:\Temp\ directory.

Lab 7-5
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

Initial Module Selection


Based on the requirement, determine which module to use. Solutions are at the end of this lab.

Requirement

Module

Scan the employee files. Create a new "employee folder"


for each new employee file, and label the folder with the
Employee's Name.

Perform some simple Image Enhancement processing on


each image. Recognize the barcode containing the
Employee SSN located on the cover page.

Send an employee file one folder at a time for manual


indexing (key entry).

Export all images to the directory structure


C:\Temp\Employee_Name.TIF

Export all indexes to the directory C:\Temp\


<BATCH NAME>.TXT. (See "Required HR Database
Fields".)

Lab 7-6
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

Module Breakdown
Image Capture / Image Quality

1.

2.

Data Capture

1.

2.

Export

1.

2.

Lab 7-7
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

Flow Chart
Hint: When creating a document flow, place Image Capture-Quality Modules first, Data Capture
Modules next, and finally Export modules last.

Lab 7-8
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

Task 1 - Import an existing process


1.1.

The process contains the InputAccel modules mapped out previously, but it is not finished
yet. It needs to have the settings added to all of the modules used in the process. The IA
Server will deliver the tasks to a module based on the flow specified in the process, but the
modules must be told "how" to process a particular task.
If necessary, login to Windows using the login and password shown above
(dmadmin/training).

1.2.

Using Internet Explorer, start the Administration Console (http://localhost) and login using
dmadmin/training.

1.3.

Click the Systems tab.

1.4.

Click the View Processes link. The list of existing processes is displayed.

1.5.

Click the Add button to add an existing process.

1.6.

Click the Browse button and navigate to C:\Student\IA Fundamentals\Lab 07.

1.7.

Select Lab 07.iap and click Open. You will be returned to the Install Process dialog.
Notice that the Name was filled in automatically.

1.8.

If necessary, from the Servers Available list, select student53x and click the add button
(

).

1.9.

Click OK to continue. The existing process has now been imported. Scroll down to the
bottom of the Processes list to verify that your process is listed there.

1.10.

Select the Lab 07 process. The Steps for process Lab 07 display will now list the steps for
the process.

Congratulations! You have successfully imported a process.

Task 2 - Configure the steps in the new process

Lab 7-9
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

2.1.

Use the Administration Console to configure the ScanPlus step in the process.
The ScanPlus module is used to scan in the employee files. The module will also create a
new grouping of employee scanned images (a Document) for each new employee file per the
setup (See "Cover Page Example").
2.1.1.

If it is not already selected, select the Lab 07 process in the Processes list.

2.1.2.

Right-click the ScanPlus step and select Settings. The ScanPlus module will
launch in setup mode.
Select the Levels tab.

2.2.

2.1.3.

Uncheck the Folder level checkbox.

2.1.4.

Select the Event Actions tab.

2.1.5.

Choose Software patch code from the first Scanner Events dropdown list.

2.1.6.

Select Kodak 2 from the Options dropdown list.

2.1.7.

Select New Document from the Actions dropdown list. This will cause a new
document to be created for each software patch code 2.

2.1.8.

Click OK to close the ScanPlus module and save the changes.

Configure the IE step of the process.


All pages will be run through some simple Image Enhancement processing to remove some
common image defects. Image Enhancement processing will also read the barcode
containing the text of the Employee SSN located on the cover page.
Image Enhancement setup requires selecting a sample image representative of the document
set. This image will be used when creating a sequence of Image Enhancement filters best
suited to clean up the images. This image does not affect how the module processes in
production, it is only used for display and positioning in setup mode
2.2.1.

Right-click the IE step and select Settings. Once the module connects to the
server and launches, it will display a file browser in order to select a sample
image.

2.2.2.

If necessary, navigate to C:\Student\IA Fundamentals\Lab 07, select


HR_EX1.tif and click Open.

2.2.3.

The requirements for this lab suggest applying some filters to do basic clean up
on the image. The following filters will be used:
- Border Removal
- Deskew
Lab 7-10

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

- Barcode Detection
- Halftone Removal
Add the border removal filter by selecting Filter > Insert > Border Removal.
Notice that as each filter is applied, the resulting image on the right changes.
2.2.4.

Add the deskew filter by selecting Filter > Insert > Deskew.

2.2.5.

Add the bar code detection filter by selecting Filter > Insert > Bar code
Detection.

2.2.6.

Finally, add the halftone removal filter by selecting Filter > Insert > Halftone
Removal.

2.2.7.

Change the filter properties for each filter.

2.2.8.

2.2.7.1.

Right-click the Deskew filter and select Properties. The Deskew


Properties window appears.

2.2.7.2.

Change the Detection area value to 60 percent. The page will still
look skewed, but the bar code will be corrected.

2.2.7.3.

Right-click the Bar Code Detection filter and select Properties.

2.2.7.4.

Uncheck all Symbologies except for Code 39.

2.2.7.5.

Click OK.

Some Image Enhancement filters allow application of the filter to a particular area
of the image instead of the entire image. This capability is enabled by creating a
region in the document image. The HR files cover page is designed to allow us to
apply the Bar Code Detection filter to the area labeled "Affix Employee barcode
here".
Create a region.

2.2.9.
2.3.

2.2.8.1.

Select the Bar Code Detection filter in the sequence.

2.2.8.2.

Click the image in the display (on the right of the setup screen) to
make it the active window.

2.2.8.3.

Draw the region by clicking and dragging with the left mouse button
over the area where you want the module to search for barcodes.

Select File > Exit and click Yes to save changes to the IE setup.

Configure the IndexPlus step of the process.


2.3.1.

Right-click the IndexPlus step of the process and select Settings.


Lab 7-11

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

2.3.2.

Select the Settings tab.

2.3.3.

Click the Settingsbutton.

2.3.4.

In the Index Family pane (left side of window), click the Create link to create a
new index family.

2.3.5.

Accept the default name of IndexFamily1 and click OK.

2.3.6.

Create six index fields.


2.3.6.1.
Caption

Using the table below, create six index fields.

Employee
Name
Employee SSN
Department

Edit Box

Tree
Level
1

Edit Box
Edit Box

1
1

Status

Drop
Down
List Box
Edit Box

Edit Box

401 K $
Amount
Stock
Percentage

2.3.7.

Type

Initial
Value

Editable

Auto
Validate

Population
Mode
Do not populate
Do not populate
This field gets
focus
Fields are loaded

This field gets


focus
This field gets
focus

For the Status field, click the Edit button under the Items column and enter
the following information on separate lines:
Full-Time
Part-Time
Hourly

2.4.

2.3.8.

Click OK to close the Enter Items dialog.

2.3.9.

Close the IndexPlus settings window when done.

2.3.10.

Click OK to complete IndexPlus setup.

Configure the ImageExport step.


Image Export allows for the saving of images using schema composed of IA values. For the
purposes of this lab, we want to save the images using the following naming convention:
C:\Temp\<employee_name>.tif
Lab 7-12

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

2.4.1.

Right-click the ImageExport step and select Settings.

2.4.2.

Enter C:\Temp for the File Path.

2.4.3.

Click the Edit Schema button in order to create the file name schema.

2.4.4.

The File Naming Schema dynamically creates subdirectory and file names for the
Export modules that can save output to files. For this Image Export, we are
configuring the Image Export module to create files for every employee using the
Employees name. Since the Employee Name is stored at the 1st grouping of
images (Level1 Document), then all images will be exported to the same
employee named file until a new grouping (Document) is exported.
Enter the value below in the Schema field:
%s, @(IndexPlus.Level1_Index0)

The File Naming Schema above has 2 parts:


%s a string placeholder that will return a string value as part of the file name.
@(IndexPlus.Level1_Index0) an InputAccel variable that stored the Employee
Name (Index field 0 at the Level 1 grouping of images). The first Index field
(Field 1 in the IndexPlus setup, Field 0 as stored in InputAccel) contains the
Employee Name.
2.4.5.
2.5.

Click OK to save the schema change and then click OK to save the changes and
exit the Image Export setup.

Configure the IndexExport step.


Index Export allows for the saving of data using schema composed of IA values. For the
purposes of this lab, we want to save the data to comma-delimited, flat text files using the
following naming convention:
C:\Temp\<employee_name>.txt
2.5.1.

Right-click the IndexExport step and select Settings.

2.5.2.

Enter C:\Temp for the Directory value.

2.5.3.

Click the Edit Schema button.

2.5.4.

Enter %s, @(IndexPlus.Level1_Index0) as the Schema value.

2.5.5.

Select Document from the Level dropdown list.


Lab 7-13

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

2.5.6.

The Index String field shows what data will actually be exported when Index
Export is run.
Enter the following value for the Index String field (all on one line):
@(IndexPlus.Level1_Index0), @(IndexPlus.Level1_Index1),
@(IndexPlus.Level1_Index2), @(IndexPlus.Level1_Index3),
@(IndexPlus.Level1_Index4), @(IndexPlus.Level1_Index5)

2.5.7.

Click OK to save the changes and exit setup.


Congratulations! You have successfully configured the steps of
the process.

Task 3 - Create a batch and test the process


3.1.

The objective of creating a batch is to run the HR files through InputAccel using the recently
configured HR process. As you process the batch, you will learn how to track your
documents through the modules using some built-in Administrator features.
Perform the Scan step.

3.2.

3.1.1.

Start ScanPlus by selecting Start > Programs > InputAccel > ScanPlus.

3.1.2.

Check the Use Windows logon checkbox and click OK.

3.1.3.

Click the Create new batch link.

3.1.4.

Select Lab 07 from the process list.

3.1.5.

Enter Lab 07 Batch for the batch name and click Create.

3.1.6.

Since there are no scanners hooked up to the lab machines, pages will be added in
a different way. Click the Import files to batch link.

3.1.7.

Navigate to C:\Student\IA Fundamentals\Lab 07, select HR.tif and click


Open. After importing you should receive the following results: There should be
60 pages grouped into 5 documents of 12 pages.

3.1.8.

Click the Close Batch link and then click the Release Batch button.

3.1.9.

Close ScanPlus.

Verify that the scanned images are now queued to the Image Enhancement module.
Lab 7-14

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

3.3.

3.2.1.

In the Administration Console, select the Batch Traffic tab.

3.2.2.

Select the Lab 07 Batch.

3.2.3.

The chart should display a gray bar next to the IE step, indicating that there are
tasks ready.

Perform the IE Step.


3.3.1.

Start the Image Enhancement module by selecting Start > Programs >
InputAccel > Image Enhancement.

3.3.2.

Login as dmadmin/training.

3.3.3.

Click the Run Single Batch button, select Lab 07 Batch, and click OK.

3.3.4.

Once Image Enhancement has processed every image, the module will be idle
waiting for more tasks. Check the Administration Console's Batch Traffic screen
again and verify that the processing has completed and moved on to IndexPlus.

3.3.5.

In the Image Enhancement module click the Stop button, and select File > Exit.
Why Five Tasks at IndexPlus?
Your first thought might be, "Where are the other 55 images"? When creating the
HR process, it was decided to send one employee document at a time for
indexing. One employee file consists of the cover page and 11 HR pages. The
index data is scattered across those 11 pages, so the index operator needs all 11
pages to completely key in the required data.
We scanned in five employee files, creating a new grouping of images called a
Document for every file. This is why there are five tasks queued at IndexPlus.
In InputAccel terms, each "Document" is an IndexPlus task, and is comprised of
12 individual pages.

3.4.

Perform the IndexPlus step.


3.4.1.

Start IndexPlus by selecting Start > Programs > InputAccel > IndexPlus.

3.4.2.

Check Use Windows login and click OK.

3.4.3.

Select Lab 07 Batch from the batch list and click Run Selected.

3.4.4.

Click on the thumbnail of page 2 to begin Indexing. Most of the information can
be found on page 2 (New Hire Data Sheet) of the document.

3.4.5.

Type the Employee Name into the field from the data on the displayed image.
Lab 7-15

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

3.5.

3.6.

3.4.6.

Click the Tab key until the Department field is highlighted.

3.4.7.

Enter the department information from the image. Tab to the Status field.

3.4.8.

The Status field is a dropdown list. Use the mouse to open it and select the
appropriate value.

3.4.9.

Continue entering values for the remaining fields. The Stock Percentage value is
located on page 7 of the document.

3.4.10.

Once all data has been correctly entered, click Accept Task when you have
verified the values.

3.4.11.

Click Yes to save the data and then click Yes to accept the current task and move
to the next employee file.

3.4.12.

Repeat steps 3.4.5 - 3.4.11 for each document.

3.4.13.

When all tasks are complete, close IndexPlus.

3.4.14.

In the Administration Console, you should now see that there are five tasks
queued to the ImageExport step.

Perform the ImageExport step.


3.5.1.

Start Image Export by selecting Start > Programs > InputAccel > Image
Export.

3.5.2.

Login as dmadmin/training.

3.5.3.

Click Run Single Batch, select Lab 07 Batch, and click OK. The batch will
now export the images to the directory configured in the Image Export Setup
(C:\Temp).

3.5.4.

When complete, you will see No Batch in the Export window. Select File >
Exit to exit.

3.5.5.

Verify that the tasks are now queued to the IndexExport step in the Batch Traffic
window.

Perform the IndexExport step.


3.6.1.

Start Index Export by selecting Start > Programs > InputAccel > Index Export.

3.6.2.

Login as dmadmin/training.

3.6.3.

Click the Run Single Batch button, select the Lab 07 Batch batch, and click
OK.

Lab 7-16
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

3.6.4.

The Index Export module will export flat text files to the directory configured in
the Index Export Setup (C:\Temp).
Select File > Exit after the Export is complete to quit the module.

3.7.

Verify that the image files were created.


3.7.1.

Using Windows Explorer, navigate to C:\Temp.

3.7.2.

There should be TIF files and txt files here for each employee. Double-click one
of the TIF files to open it in Microsoft Office Document Imaging. You will see
12 pages for the employee.

3.7.3.

Close any open windows.

Congratulations! You have successfully processed a batch!

Lab 7-17
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

Solutions:
Initial Module Selection - Solution

Requirement

Module

Scan the employee files. Create a new "employee folder"


for each new employee file, and label the folder with the
Employee's Name.
ScanPlus

Perform some simple Image Enhancement processing on


each image. Recognize the barcode containing the
Employee SSN located on the cover page.

Send an employee file one folder at a time for manual


indexing (key entry).

Image Enhancement

IndexPlus

Export all images to the directory structure


C:\Training\Employee_Name.TIF

Image Export

Export all indexes to the directory C:\Training\<BATCH


NAME>.TXT. (See "Required HR Database Fields".)
Index Export

Lab 7-18
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

Module Breakdown - Solution


Image Capture / Image Quality

1.

ScanPlus

2.

Image Enhancement

Data Capture

1.

IndexPlus

2.

Image Enhancement

Export

1.

Image Export

2.

Index Export

Lab 7-19
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 7

Flow Chart - Solution

End of Lab

Lab 7-20
2009 EMC Corporation. All rights reserved.

Module 8

Administering Servers, Processes,


and Batches

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-1

Module Objectives

Manage server settings


Manage processes
Use the Administration Console to find batches
Create and manage batches
Describe how to monitor module connections

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-2

8-2

Server Parameters

Server Settings
Managing Processes
Managing Batches
Connections

There are approximately 35 parameters that


control certain aspects of the InputAccel Server
- Stored in the InputAccel Database
- Managed using the Administration Console

Most parameters do not need to be changed


- Use default value
- Performance may be impacted

Administering Servers, Processes, and Batches

8-3

2009 EMC Corporation. All rights reserved.

Server parameters used to be stored in the Windows Registry prior to version 6.0 of InputAccel.
Changing parameters may negatively impact server performance. The default values are usually
sufficient for most installations and should only be changed if directed to by support personnel.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-3

Viewing Server Parameters (1 of 2)


1) Select the Systems tab

2) Click the View Servers link


3) Select a server and click the Settings button

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-4

8-4

Viewing Server Parameters (2 of 2)

Parameters are displayed


- Active, Startup, and Default settings

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-5

8-5

Changing Server Parameters

Double-click the setting or use the appropriate menu option


- Some settings require a server restart to take effect

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-6

8-6

Server Parameters - Logging/Tracing

The following parameters affect logging and tracing


Setting

Default Value
(Decimal)

DebugLevel

EventLogLevel

147

FileTraceBackupFileCount

10

FileTraceLevel

116

MaxDebugOutSizeK
StringTraceLevel

100000
116

Administering Servers, Processes, and Batches

8-7

2009 EMC Corporation. All rights reserved.

DebugLevel - Error checking level for basic InputAccel Server operations. We recommend using the default value of
one, although setting this value to zero may slightly increase the performance of the InputAccel Server.
EventLogLevel - Levels at which events should be logged. To determine which events are logged, use the following
values:
1/0x01 Errors
2/0x02 Warnings
4/0x04 Information
8/0x08 Audit successes
16/0x10 Audit failures
128/0x80 Successes
To log multiple event levels, add the values for each level together. The events selected by the default value are shown
in bold type.
FileTraceBackupFileCount - Number of backup trace files to keep
FileTraceLevel - Enables various levels of debug output logging to the RootDir\debug.out file, where RootDir is the
directory where batch and process files are stored. Add the same values as for the value StringTraceLevel to determine
which strings are written to the debug file. Note: If you set the value for FileTraceLevel too high, then InputAccel
performance may be affected.
MaxDebugOutSizeK - Maximum size, in KB, allowed for the debug.out file. After the file reaches the maximum
size, debug messages begin overwriting the oldest debug messages in the file. A value of zero indicates unlimited size
for the file.
StringTraceLevel - Levels at which string tracing should occur. Strings are written to the console if the InputAccel
Server is running as an application. Add the following values to determine which strings are written:
1/0x01 Miscellaneous debugging information
2/0x02 Network debugging information
4/0x04 Console
8/0x08 Information
16/0x10 Warning messages
32/0x20 Error messages
64/0x40 Fatal messages
Note: To trace strings at multiple levels, add the values for each level together. If you set the value for
StringTraceLevel too high, then InputAccel performance may be affected.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-7

Server Parameters - Disk/Memory Usage

The following parameters affect disk and memory usage


Setting

Default Value
(Decimal)

BatchMaxAddressSpaceK
BatchMaxLoaded
BatchSync

1572864
100000000
300

DiskReserveK

1536000

MaxDebugOutSizeK

100000

Administering Servers, Processes, and Batches

8-8

2009 EMC Corporation. All rights reserved.

BatchMaxAddressSpaceK - Maximum amount of virtual address space that the InputAccel


Server allows batches to use. If batches require address space beyond this limit, then the
InputAccel Server unloads other batches to create the additional space. This value should be
approximately the value of BatchMaxLoaded multiplied by the size of your average batch.
1572864/0x180000 is the current Windows maximum, which means larger values are treated as
0x180000.
BatchMaxLoaded - Maximum number of batches that can be loaded at once. At a minimum, set
this value equal to the number of active batches or connected modules (whichever is less). To
determine if you should increase the value of BatchMaxLoaded, use the Windows Performance
Monitor (see page 160) to check the batches loaded per second statistic. If this number is
greater than 0.1 per second over sustained periods, then you may want to increase the value of
BatchMaxLoaded. For 6.0 and later, the default value is set to a very high number. This means
that the limit is really based on the BatchMaxAddressSpaceK value.
BatchSync - Commit interval, or the maximum number of seconds between when the InputAccel
Server commits batch and process files to disk. If the InputAccel Server must be restarted due to
a power failure, critical software failure, or other abnormal termination, then the state of the batch
is restored using information committed to disk during the last commit.
DiskReserveK - Specifies the number of KB of extra disk space to reserve on the volume
pointed to by RootDir. The InputAccel Server will stop processing and send a notification to the
client modules after the available disk space on this volume falls below the amount determined
by BatchMaxAddressSpaceK or DiskReserveK.
MaxDebugOutSizeK - Maximum size, in KB, allowed for the debug.out file. After the file
reaches the maximum size, debug messages begin overwriting the oldest debug messages in the
file. A value of zero indicates unlimited size for the file.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-8

Client Settings - Settings.ini

Module characteristics can be changed by modifying settings.ini


on the client computer
- Located in
Windows XP
C:\Documents and Settings\All Users\Application Data\EMC\InputAccel

Vista
C:\ProgramData\EMC\InputAccel

- Caching, debugging, module startup, networking, ScaleServer


- Module-specific settings
ScanPlus and RescanPlus
Blank page detection
Patch code options
Administering Servers, Processes, and Batches
2009 EMC Corporation. All rights reserved.

Settings stored in the settings.ini file were stored in the WIN.ini file prior to version 6.0.
Refer to the InputAccel Documentation for detailed information on settings.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-9

8-9

Client Settings - Win.ini

Some client module settings are stored in the win.ini file


- [InputAccel] section of the file
- Copy and Image Enhancement settings
- Third-party module settings

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-10

8-10

Managing Processes (1 of 2)

Server Settings
Managing Processes
Managing Batches
Connections

Processes control what happens during batch


processing
- Defines steps (modules) and what to do to the data during those
steps
- Processes are created and can be installed using Process
Developer

The administration console is used to manage processes


- Add, upgrade, modify, delete
- Copy and paste processes, process settings, and index values to
-

files or the Windows clipboard


Add empty batches

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-11

8-11

Managing Processes (2 of 2)

All process management features are available in the Processes


pane

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-12

8-12

Installing Processes

Developers use Process Developer to create a process (IPP file)


- Process is compiled into an IAP file
- Can be installed using Process Developer
- Can only install processes on one server at a time
Processes can also be installed using the administration console
- Requires access to the IAP file
- Ability to set priority of new batches
- Ability to install onto multiple IA servers at once

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

To learn more about process development, refer to the InputAccel Development with VBA
course.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-13

8-13

Using the Administration Console


to Install a Process (1 of 2)

1) Select the Systems tab


2) Click the View Processes link

3) Click the Add button

Administering Servers, Processes, and Batches

8-14

2009 EMC Corporation. All rights reserved.

A user must have the Server.Install.Process to add a new process via the administration console.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-14

Using the Administration Console


to Install a Process (2 of 2)

4) Complete the
fields, specify
the servers on
which to install
it, and click
OK

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-15

8-15

Creating the IAP File

Most IAP files will be created by a developer using Process


Developer

Using the administration console, an IAP file can be created by


exporting an existing process

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-16

8-16

Copying and Pasting Processes and Values

The Copy and Paste menus in the Processes pane offer many
choices for manipulating processes

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-17

8-17

Adding Empty Batches

Empty batches can be created using the administration console

Administering Servers, Processes, and Batches

8-18

2009 EMC Corporation. All rights reserved.

Right-click the process and select Add Batch. Enter the batch name, if not based on a schema,
optionally set the priority and description, and then click OK.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-18

Upgrading Processes

Developers make changes to processes over time and therefore the


existing process must be upgraded

Processes can easily be upgraded using the administration console

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

The step list must be the same for upgrading to work. If the step list is different then it is
considered a new process and must be added/installed via the normal steps.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-19

8-19

9
9

Batch Management

Server Settings
Managing Processes
Managing Batches
Connections

Information about all batches is available on


the Batch Traffic pane

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-20

8-20

Batch Traffic Information (1 of 2)

List of batches
in the system

Chart listing for


all processes

Chart listing for a


selected batch
Administering Servers, Processes, and Batches

8-21

2009 EMC Corporation. All rights reserved.

The chart shows either a listing of all processes (if nothing is selected in the batch listing) or step
information for a selected batch. The chart will show nothing, a red hatched bar, a gray bar, or a
white bar. The red hatched bar indicates batches in error, hold, or those with a priority of zero.
The gray bar indicates the batches or tasks in the ready, working, or sent status. Finally, the
white bar indicates the number of batches or tasks with any status. Also notice that by hovering
the mouse pointer over a chart bar that the actual number is displayed as a tool tip.
It is important to note that the chart displays information alphabetically, so the modules listed for
a particular batch do not necessarily represent the order of steps.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-21

Batch Traffic Information (2 of 2)

The modules table lists connected modules for all processes (if
none selected) or for a selected batch

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-22

8-22

Batch Status

Hold and Error states


- Batches in Hold or Error states will not have tasks sent to
-

modules
Administrators can manually put a batch into a Hold or Error
state via the Administration Console

Batch status is computed based on the overall error and hold states
of the individual tasks and the batch

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-23

8-23

Batch Priority

Indicates the urgency for processing tasks within a batch


- Ranges from 1 - 99
- Lower values indicate a higher priority
- A value of 0 causes the batch to be deactivated

Administering Servers, Processes, and Batches

8-24

2009 EMC Corporation. All rights reserved.

Prior to version 6.0 of InputAccel, a batch could be put on hold by setting the priority to zero.
Batches can now be put on hold manually via the Administration Console by checking the Hold
checkbox for a batch.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-24

Admin Review

Batches that are in an Error or Hold status will display in the


admin review pane
- Provides a quick way of seeing all batches in Error/Hold state

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-25

8-25

Finding Batches

When there are many batches in the system, it is sometimes easier


to search for a batch
- Simple searches using batch name
- Filters (pre-defined search)
- Advanced searches using batch name, description, server,
process, status, priority, creation date, and IA values

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-26

8-26

Advanced Batch Searching

Using the Advanced Search feature, one or more criteria can be


specified

Click OK to save the search for future use or click Run Search for
on demand searches

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-27

8-27

Batch Filters

Batch filters are really saved advanced searches


Select the desired filter and click View Results to re-run the saved
search

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

Batch filters can be modified or copied to a new filter.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-28

8-28

Batch Settings

There are many settings associated with batches


- Steps (modules)
- General settings
- IA Values
- Tasks
- Locks
Batch settings can be accessed from the Batch Traffic or Batch
Finder Results panes

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-29

8-29

Batch Settings Page

Settings appear in a popup browser window


- Select desired settings to view

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-30

8-30

Task Status

Task status indicates the current processing state of a batch


- Done
- Not Ready
- Ready
- Working
- Hold
- Error
- Sent
A task in the error state will not get sent to modules
- Setting an error on a task allows other tasks to be processed
- Task processing resumes if the error state is cleared
Sent and Working states
- Sent task is one that has been sent to a client
- Working means the module is working on it
Administering Servers, Processes, and Batches

8-31

2009 EMC Corporation. All rights reserved.

In previous versions of IA, an error handler for a process might set the priority of a batch or the
RetriesLeft trigger to zero. This would cause the entire batch to be put on hold. By setting the
task error instead, other tasks in the batch can continue to process.
Done - The module step has finished processing the task.
Not Ready - No tasks are currently queued for the module step.
Ready - Tasks are queued for the module step.
Working - The task is currently being processed by the module step.
Hold - Tasks associated with the module step are on hold.
Error - Tasks associated with the module step are flagged for error.
Sent - Tasks associated with the module step are sent by the InputAccel Server.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-31

Values View

Available for batch, process, and module values


Allows user to change IAValues
Allows user to export or replace stage files
Allows user to view images
Supports object values

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

This can be restricted with the appropriate application of permissions.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-32

8-32

Image View (1 of 2)

Displays the image


Values View

Tasks View

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-33

8-33

Image View (2 of 2)

Shows information about the image

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

The toolbar shown here is displayed at the bottom of the image window (shown on previous
slide). It allows the user to view image settings, zoom in/out, print the image, and rotate it.
Changes such as rotating are not saved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-34

8-34

Editing Values

Select the appropriate node and double-click the row to enable


editing

Use the paging links to display all values

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

Filter the values to display/edit by module name.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-35

8-35

Monitoring Connections

9
9
9

Server Settings
Managing Processes
Managing Batches
Connections

Modules used in batch processing have one or


more connections to the IA server

Ability to monitor
-

Module name as well as executable


Batches using the selected module
Count of tasks active, sent, not ready, working, and completed
All tasks currently being processed
Ability to disconnect a connection
Many more
Administering Servers, Processes, and Batches

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-36

8-36

Connections Listing

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-37

8-37

Test Your Knowledge

9
9
9
9

Server Settings
Managing Processes
Managing Batches
Connections

1. True/False: The administration console can


be used to add empty batches for specified processes.
2. True/False: Adding processes using the administration
console only allows the process to be added to a
single server.
3. True/False: The Admin Review pane displays batches
that are in an error or hold state.
4. True/False: When searching for batches, only the batch name can
be searched on.
5. True/False: Module connections cannot be disconnected using
the administration console.

Administering Servers, Processes, and Batches

8-38

2009 EMC Corporation. All rights reserved.

1. True.
2. False. Assuming appropriate permissions and network connectivity, etc., the administration
console allows a process to be added to one or more servers.
3. True.
4. False. Using the advanced search, many different aspects of a batch can be used in the
search.
5. False. Connected modules may be disconnected using the Disconnect button in the
Connections pane.
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-38

Exercise

Estimated time: 30 min

Goals
- Manage Processes and Batches
Tasks
- Add a new process using the administration console
- Use the new process to create empty batches using the
-

administration console
Import files into the batch using the ScanPlus module
Examine the batch settings, view values, and images associated
with the batch
Create an advanced batch search and save it as a filter
Display active module connections for select batches

Administering Servers, Processes, and Batches


2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


8-39

8-39

InputAccel Fundamentals and Administration


Lab 8

Module 8 Administering Servers, Processes and Batches

Estimated Time: 30 minutes


Manage Processes and Batches

Goals
Tasks

1.

Add a new process using the administration console

2.

Use the new process to create empty batches using the administration
console

3.

Import files into the batch using the ScanPlus module

4.

Examine the batch settings, view values, and images associated with
the batch

5.

Create an advanced batch search and save it as a filter

6.

Display active module connections for select batches

Background
Before you begin:

Answers to the questions asked in the lab are at the end of the lab instructions

When using the Administration Console, the lab instructions refer to links in the left-side
pane as "tabs".

Windows login/password: dmadmin/training

Task 1 - Add a new process using the administration console


1.1.

If necessary, login to Windows using the login and password shown above
(dmadmin/training).

1.2.

Using Internet Explorer, launch the Administration Console by navigating to


http://localhost. Alternately, select Start > Programs > InputAccel > Administration
Console. Login as dmadmin/training.

1.3.

Select the Systems tab.

1.4.

Click the View Processes link.


Lab 8-1

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 8

1.5.

Click the Add button to add a new process.

1.6.

Click the Browse button and navigate to C:\Student\IA Fundamentals\Lab 08.

1.7.

Select Lab 08.iap and click Open.

1.8.

Ensure that your server is listed in the Servers Selected list and click OK.

Congratulations! You have successfully added a new process.

Task 2 - Use the new process to create empty batches using the administration
console
2.1.

In the Processes list, scroll down and select the new Lab 08 process.

2.2.

Right-click the process and select Add Batch.

2.3.

Enter Lab 8 Batch 1 for the Batch name and click OK.

2.4.

Repeat the steps above and create a total of at least five batches. Be sure to change the name
of each new batch (Lab 8 Batch 2, Lab 8 Batch 3, etc.).
Congratulations! You have created empty batches using the
administration console.

Task 3 - Import files into the batches using the ScanPlus module
3.1.

Start ScanPlus by selecting Start > Programs > InputAccel > ScanPlus.

3.2.

Login as dmadmin/training.

3.3.

Click the Open saved batch link.

3.4.

Select Lab 8 Batch 1 from the list and click Open.

3.5.

Click the Import files to batch link.

3.6.

Navigate to C:\Student\IA Fundamentals\Lab 08, select HR.tif and click Open. The file
contains 60 pages.

3.7.

On the last page (60), click the Fit to Window button


see the entire image.

Lab 8-2
2009 EMC Corporation. All rights reserved.

below the image so that you can

InputAccel Fundamentals and Administration


Lab 8

3.8.

Click the Close Batch link and then click the Release Batch button.

3.9.

Perform the previous steps on at least two of the four remaining empty batches.

3.10.

Close ScanPlus when done.


Congratulations! You have successfully imported image files
into batches using ScanPlus.

Task 4 - Examine the batch settings, view values, and images associated with the
batch
4.1.

In the Administration Console, select the Batch Traffic tab. A list of batches will be
displayed along with their status and number of tasks.
a) For the batches processed using ScanPlus, what does the Status column show?
_________________________________________________________________

4.2.

Right-click Lab 8 Batch 1 and select Settings. A new browser window will open.
b) What things related to the batch are you able to View?
_________________________________________________________________

4.3.

The View dropdown list should be set to Settings. Once you change the selection, it will be
remembered the next time you access Batch settings.
Select Tasks from the View dropdown list.
c) After which Node do you see nodes representing the pages of the file that was
imported?
_________________________________________________________________
d) What status is listed for the nodes of the Scan step? What about the IE step?
_________________________________________________________________

4.4.

Scroll down to the bottom of the display.

4.5.

Right-click Node 67 - p. 60 and select Show Image. A new browser window opens and
displays an image.
Lab 8-3

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 8

4.6.

Use the Fit to Window button


at the lower-left to view the entire page. Is this the same
page you saw in the ScanPlus module? It should be.

4.7.

Close the image browser window.

4.8.

Select Values from the View dropdown list. Here you can view and edit all of the IA values
for the steps in the batch along with the nodes. Notice that you can select a Node and view
all of the associated values. The values may be filtered by step by changing the Filter
dropdown list above the list of values.

4.9.

Scroll to the bottom of the browser window and click OK to close it.

4.10.

In the Batch Traffic window, select one of your batches.

4.11.

The chart, shown below the Batch Traffic listing will display the status of the steps for that
batch. A gray bar indicates tasks ready at that step. A white bar usually indicates that the
step has processed.
Congratulations! You have viewed batch settings, values, and
images using the Batch Traffic window.

Task 5 - Create an advanced batch search and save it as a filter


5.1.

Select the Batch Finder tab in the Administration Console.

5.2.

In the lower-left corner below the Batch Finder node, select Advanced Search. The Batch
Finder - (New Search) window will appear.

5.3.

Enter Lab 8 Batches for the Name of the new search.

5.4.

Enter My Lab 8 Batch Finder for the Description.

5.5.

In the Batch Properties to Match section, check the Process checkbox.

5.6.

From the list of processes, select Lab 08.

5.7.

Click OK to save the search.

5.8.

Notice that your new search now appears in the Batch Filters listing.
Select Lab 8 Batches and click View Results to run the search. All of the batches that you
added in the earlier task should now be displayed.

5.9.

The search can be modified by clicking the Modify Search button in the upper-right corner
of the browser. Click the Modify Search button now.
Lab 8-4

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 8

5.10.

Check the Status checkbox and ensure the value is set to Not Ready.

5.11.

Click Run Search to run the modified search.

5.12.

The results should be quite different. It is important to note that when you click Run
Search, it does not save the search settings.
Click the Filters node in the lower-left corner of the browser, select Lab 8 Batches, and then
click the Settings button. You will notice that the last change you made was not saved. In
order to do so, you would click OK instead of Run Search.

5.13.

Click Cancel to return to the list of Batch Filters.


Congratulations! You have created a new batch filter in order to
search for batches.

Task 6 - Display active module connections for select batches


6.1.

Select the Systems tab in the Administration Console.

6.2.

Click the View Module Connections link.

6.3.

At this point, the display should be very simple. Only the Administration Console is
currently connected.
Start ScanPlus again and login as before.

6.4.

Click the Connections link in the lower-left corner of the browser to update the Connected
modules list. ScanPlus should now appear.

6.5.

Select ScanPlus in the listing of connected modules. You should now see a listing of
batches using the ScanPlus module.

6.6.

Open the Filter dropdown list in the upper-right corner of the browser. Notice the available
selections.

6.7.

Now click the Disconnect button to disconnect the ScanPlus module. Click Yes to confirm
the disconnect.

6.8.

Refresh the listing by clicking the Connections link in the lower-left corner again. The
Filters selection should no longer include ScanPlus.
ScanPlus may popup at this point and show the "Not connected" message at the bottom.

Lab 8-5
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 8

6.9.

Close ScanPlus.

6.10.

Log out of the Administration Console and close the browser.

Congratulations! You have viewed module connections and


learned to disconnect a module.

Solutions:
a)

Ready.

b)

Settings, Tasks, Locks, Steps, Values.

c)

After Node 7, the nodes (8-67) represent the pages of the file.

d)

Done. Ready.

End of Lab

Lab 8-6
2009 EMC Corporation. All rights reserved.

Module 9

ScanPlus

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-1

Module Objectives

Describe the ScanPlus module


Describe setup options for the ScanPlus module
Describe production mode operation of the ScanPlus module
Use the ScanPlus module to create new batches

ScanPlus
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-2

9-2

ScanPlus Overview
Setup Mode
Production Mode

Overview

The ScanPlus module serves as an entry point for images to be


processed by InputAccel
- Creates batches from hardcopy or electronic files
- Manipulation of scanned images
- Document separation
- Generation of scan reports
- Web-deployable using ClickOnce

ScanPlus allows operators to acquire images from:


- Scanners
- Imported images

ScanPlus
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-3

9-3

Who Uses ScanPlus?

Users added to both the Scan Operator and Module Operator roles
can use ScanPlus

Administrators can use ScanPlus to monitor production


- Manage multiple operators
- Monitor batches on remote sites

ScanPlus
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-4

9-4

Typical Process Flow

Most processes start with ScanPlus


Alternate forms of creating a batch include:
- E-mail Import, Multi-Directory Watch, Web Services Input
Example process: _Export5

ScanPlus

IndexPlus

EMC
Documentum
Export

ScanPlus

9-5

2009 EMC Corporation. All rights reserved.

The sample process (_Export5) shown above is distributed with the InputAccel server. Not
shown in the process are the IADONE and IAMULTI modules, which are used to signify that the
batch is complete, and then delete it.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-5

9 ScanPlus Overview
Setup Mode
Production Mode

Configuring ScanPlus

Start ScanPlus in setup mode to configure it

ScanPlus

9-6

2009 EMC Corporation. All rights reserved.

The status information tab displays status information related to the process step being setup and
the server and user name used when logging in to ScanPlus setup. Setup mode can be entered
from the administration console or a command prompt. The module must be installed on the
computer where the administration console is running.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-6

Levels

Define the name and number of levels that will be used in a batch

ScanPlus

9-7

2009 EMC Corporation. All rights reserved.

The number of levels defined here will determine how many levels all modules in the process can
display. Simply check the checkbox next to a level to include it in the tree. Enter a type name,
such as document, folder, drawer, box, etc. Enter the display name, which can be any
combination of text, a numbering schema, and IA values. Check the checkboxes which allow
certain operations at the specified level. For example, unchecking Delete at the Page level
prevents the operator from deleting pages.
Even if a level is not displayed, it still exists and can be used for separation.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-7

Event Actions

Define event actions to create new nodes or batches

ScanPlus

9-8

2009 EMC Corporation. All rights reserved.

Event actions are used to generate new nodes (Document, Folder, Stack, or any other level used
as defined on the Levels tab) and batches. The actions can occur based on selected scanner
events or if importing files, after every nth file has been imported. The possible scanner events
include: Software patch code, Kodak level change, separator page, every n pages, new stack, bar
code, and blank page. Depending on the scanner event selected, there may be available options.
Nest the events from largest to smallest, i.e. new batch before new document.
Check the Discard page checkbox to delete the entire page (both sides) from the batch when
using blank pages for example.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-8

Scanner

Update scanner settings or select a different scanner to use

ScanPlus

9-9

2009 EMC Corporation. All rights reserved.

By default, processes use the scanner settings of the scanner driver selected during installation.
Click the Change selected scanner link to display a list of available scanners and select the
new scanner. It is possible to configure scanner driver settings while in the scanner selection
window. Scanner configurations may be created for one or more scanners so that an operator can
select a configuration during production in order to switch scanners easily. Once a scanner is
selected and a configuration created for it, click the Modify scanner settings link to change
the selected scanner configuration settings.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-9

Index (1 of 2)

ScanPlus

9-10

2009 EMC Corporation. All rights reserved.

Indexing fields allow operators to add organizational information to batches during production.
For example, if a box of documents is scanned, it may be desirable to have the box number
associated with the batch. This can be accomplished through indexing fields. First, the level at
which an index field will be required must be specified. Next, determine when the operator will
enter the indexing data - while scanning, or after scanning. Select Do not index if no index
fields will be defined for the level (this is the default). Choose from where to read index
information: Current side, Next side, or Side after next. Finally, click the Define Indexing
Fields link to display the indexing setup screen.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-10

Index (2 of 2)

ScanPlus

9-11

2009 EMC Corporation. All rights reserved.

When defining indexing fields, the administrator must import a sample document and then draw
the index zones. This is accomplished by clicking and dragging on the sample shown. After
drawing the index field, enter a Field Title, optional Character Restriction to prevent unwanted
entries, and an optional Default Value. Each zone can have its own color as well. Click Save
changes and close when done.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-11

Import

Allow files to be imported into a batch

ScanPlus

9-12

2009 EMC Corporation. All rights reserved.

Operators can import files into a batch if allowed in the file import pane. It is important that this
be allowed if the scan station has no scanner and will be only importing files. Select the allowed
file formats from the File Formats list or leave it empty to allow all formats. Check the Process
image files checkbox to convert the imported image files into the format selected on the Image
Output tab. Checking this checkbox also allows multi-page image files to be converted into a
single page.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-12

Image Output

Specify the image output file format, rotation, and thumbnail size

ScanPlus

9-13

2009 EMC Corporation. All rights reserved.

The image output tab defines the file format for output images. Select the format from the File
format dropdown list. For each color depth (mode), select the compression algorithm to use.
Select and right-click the compression value to enable a dropdown list from which a selection can
be made. The page rotation options allow a page to be scanned and then rotated 90, 180, or 270
degrees at runtime. Typically the front side rotation will be 90 degrees while the back side
rotation will be 270 degrees. This enables landscape scanning while keeping the front/back side
orientation correct. During batch creation, thumbnails of scanned or imported pages are
displayed to the operator. The size of the thumbnail can be set to: Standard, Medium, Large,
Extra Large, or Maximum Size. The maximum size is approximately 2 inches square.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-13

Miscellaneous

Configure miscellaneous settings

ScanPlus

9-14

2009 EMC Corporation. All rights reserved.

Options available in the miscellaneous settings pane include the ability to verify page count when
closing a batch, prompting the operator before coming a batch, hiding scanner settings,
automatically deleting empty batches, disabling priority selection on the new batch window,
disabling the description field on the new batch window, and displaying the page level value in
the status bar.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-14

Auto Batch Creation

Define batch name schema and process schema for auto batches

ScanPlus

9-15

2009 EMC Corporation. All rights reserved.

If new batch creation was defined in the event actions tab, then complete this screen. Enter the
batch name schema to determine how new batches will be named. Any combination of text, IA
values, or numbering schemes can be used here. Next, select the process schema. Choices of
<Same Process>, <Ask User>, or any installed process can be selected. Or, type in a valid
schema.
Automatic batch naming can be used even if a new batch event was not specified.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-15

Scripting (1 of 2)

Add scripting for module and task events

ScanPlus

9-16

2009 EMC Corporation. All rights reserved.

Client-side scripting is available in version 6.0 and later of InputAccel. Modules and tasks
generate any number of events and a custom, client-side script can be executed in response to
those events. Some modules such as IndexPlus have other types of events. Scripts are written in
either C# or VB.NET. The scripts are compiled into DLLs which are then associated with the
module. Each event will have a corresponding script. For example, the BatchCreationError
event will be mapped to the Script.ScanPlusModuleEvents.BatchCreationError. Then, the
developer of the DLL needs to ensure that this event handler is defined. Scripts can be created
using MS Visual Studio or by clicking the Manage script files button.
Client-side scripting in the ScanPlus module takes the place of the scan-hook.dll.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-16

Scripting (2 of 2)

ScanPlus

9-17

2009 EMC Corporation. All rights reserved.

Click the Manage script files button displays the Manage Scripts window shown above, to the
left. New DLLs (scripts) can be added using the Add file button, or a new script can be created
using the Create text script button. Click it displays the Text Scripting File window shown
above to the right. Provide a new name for the script and select the language to develop in. The
script automatically includes all of the necessary interfaces to create ScanPlus event handlers.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-17

Other Support

Multi-Streaming and Kodak Image Address functionality are


supported when a scanner with the appropriate driver is installed

Setup information not shown unless the driver is selected

ScanPlus
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-18

9-18

Running ScanPlus in Production

9 ScanPlus Overview
9 Setup Mode
Production Mode

Scan operators must create a new batch or open an existing batch


in order to start scanning/importing

ScanPlus
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-19

9-19

Creating a New Batch

When creating a new batch, the operator must select the process to
use

- Available processes are based on operator permissions

ScanPlus
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-20

9-20

Open an Existing Batch

When opening a batch, the operator selects a batch from the list or
enters the batch name manually

ScanPlus
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-21

9-21

Views and Menus

During production, ScanPlus displays a thumbnail image for each


batch page
- Higher level nodes in the tree display as labeled rectangles

Popup context menus are available to manipulate the tree and file
views

ScanPlus
2009 EMC Corporation. All rights reserved.

Thumbnails are not generated for non-image files.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-22

9-22

Importing Files

Files may be imported as an alternative or in addition to scanning

ScanPlus
2009 EMC Corporation. All rights reserved.

As seen in the setup section, importing may be enabled/disabled on the Import screen.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-23

9-23

Previewing

ScanPlus allows operators to preview pages before adding them to


a batch or local file
- The page does not actually count as scanned until it is accepted
into the batch by the ScanPlus operator

They can also use the preview option to scan from a flatbed
scanner

Previewing pages with a Multi-stream scanner shows the first


image stream as a thumbnail

Only available when a


scanner is in use
- Cannot be used during
importing

ScanPlus

9-24

2009 EMC Corporation. All rights reserved.

Previewing gives the scan operator the opportunity to optimize scanner settings before and during
scanning. Previewing can also be used to create sample images for setting up index zones.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-24

Modify Settings

Scan operators can change various settings during production


- General settings
- View settings

ScanPlus

9-25

2009 EMC Corporation. All rights reserved.

Refer to the setup mode in this module for information regarding scanner settings. Miscellaneous
settings allows the operator to change the file view refresh rate during scanning and importing as
well as whether or not to automatically print the scan report when ScanPlus is exited. The view
settings allow the operator to change the file view and tree view settings. These settings define
things such as scaling, page orientation, background colors, and text colors.
Not shown above, but available when a batch is opened is the Set up step settings link. This
allows the operator to change most of the settings available in setup mode for the current batch.
The changes only affect pages entered into the batch after the settings are saved and they do not
affect any other batches.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-25

View the Scan Report

ScanPlus

9-26

2009 EMC Corporation. All rights reserved.

The summary report is used to view or print statistical information for the current session, batch,
or all batches. In order to create a report, click the Summary tab, choose the desired option (all
batches, current batch). A report is automatically generated and displayed in the preview
window. The operator can print or view the report.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-26

9 ScanPlus Overview
9 Setup Mode
9 Production Mode

Test Your Knowledge

1. True/False: ScanPlus is an attended module that


can be deployed using ClickOnce.
2. True/False: ScanPlus can only acquire images from
scanners.
3. True/False: The Event actions screen is used to
associate client-side scripts with ScanPlus.
4. True/False: Index fields can be displayed to the operator
either during or after scanning.
5. Which of the following tasks can be performed using ScanPlus?
a) Run all batches
b) Open saved batch
c) Create new batch
d) Run single batch
ScanPlus

9-27

2009 EMC Corporation. All rights reserved.

1. True.
2. False. ScanPlus can acquire images from scanners and imported files.
3. False. The Event actions screen is used to determine automated separation, up to and
including a new batch.
4. True.
5. b and c. Run all batches and Run single batch are typically options associated with other
modules.
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-27

Estimated time: 30 min

Exercise

Goals
- Create batches automatically using patch code 3
pages and automatic batch naming

Tasks
- Import a process
- Configure the steps in the process
- Test the process

ScanPlus
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


9-28

9-28

InputAccel Fundamentals and Administration


Lab 9

Module 9 ScanPlus

Estimated Time: 30 minutes


Create batches automatically using patch code 3 pages and automatic batch
naming

Goals
Tasks

1.

Import a process

2.

Configure the steps in the process

3.

Test the process

Background
Before you begin:

Answers to the questions asked in the lab are at the end of the lab instructions

When using the Administration Console, the lab instructions refer to links in the left-side
pane as "tabs".

Windows login/password: dmadmin/training

Scenario
Document Preparation - Documents will be transported to the scanning department in boxes labeled
with an identification number. Batches will be separated with a Patch code 3 separator page, which
will be deleted at scan time. Documents will be separated with a patch code 2 separator page
(employee cover page), which will also be deleted at scan time.
Image Capture - All pages will be scanned. Automatic batch naming will be used to give the batch
names uniformity. The document set sample is similar to that of a previous lab.
Export - Image files will be created in the C:\Temp directory. Each file will contain all pages for
one employee (document) excluding the employee cover sheet.

Lab 9-1
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 9

Initial Module Selection

Requirement

Module

Scan the employee files. Create a new batch for each


patch code 3 page. Create a new document for each
patch code 2 page. Batches should be named
automatically for uniformity.

Export all pages for an employee into one file. The file
should be named based on the batch along with the
document number within the batch.

Lab 9-2
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 9

Module Breakdown
Image Capture

1.

Export

1.

Task 1 - Import a process


1.1.

Import the process to use.


1.1.1.

If necessary, login to Windows using the login and password shown above
(dmadmin/training).

1.1.2.

Using Internet Explorer, launch the Administration Console by navigating to


http://localhost. Alternately, select Start > Programs > InputAccel >
Administration Console. Login as dmadmin/training.

1.1.3.

Select the Systems tab.

1.1.4.

Click the View Processes link.

1.1.5.

Click the Add button

1.1.6.

Click the Browse button and navigate to C:\Student\IA Fundamentals\


Lab 09.

1.1.7.

Select Lab 09.iap and click Open.

1.1.8.

Click OK to complete addition of the process.

Task 2 - Configure the steps in the process


2.1.

Start ScanPlus in setup mode.


2.1.1.

Select the Lab 9 process from the list of Processes.


Lab 9-3

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 9

2.1.2.

Right-click the Scan step and select Settings. ScanPlus will start in setup mode.

2.1.3.

Configure the Event actions.

2.1.4.

2.1.3.1.

Select the Event actions tab.

2.1.3.2.

Select Software patch code from the Scanner Events dropdown list.

2.1.3.3.

Choose Kodak 3 from the Options dropdown list.

2.1.3.4.

Select New Batch from the Actions dropdown list and check the
Discard page checkbox.

2.1.3.5.

Select Software patch code from the next Options dropdown list.

2.1.3.6.

Choose Kodak 2 from the Options dropdown list.

2.1.3.7.

Select New Document from the Actions dropdown list and check the
Discard page checkbox.

Configure auto batch creation.


Batch names can be entered manually by the Scan operator or they can be created
automatically using a batch name schema. Using the latter provides for
consistent, error-free naming of batches.

2.1.5.
2.2.

2.1.4.1.

Select the Auto Batch Creation tab.

2.1.4.2.

Enter HR_@(Index) for the Batch name schema. This will cause all
new batches for this process to have a prefix of "HR_" followed by a
sequential number. This will ensure that every new batch has a unique
name.

Click OK to save the ScanPlus settings and close the setup window.

Configure the Image Export step.


2.2.1.

In the Administration Console, right-click the ImageExp step and select Settings.

2.2.2.

Set the File Path value to C:\Temp. This will cause all files exported to be
placed in this directory.

2.2.3.

Click the Edit Schema button.

2.2.4.

Enter %s - %02d, @(BatchName), @17 as the Schema value. This will create a
file name consisting of a string (%s) followed by a dash and then a two character
signed decimal integer. The actual values will be the batch name
(@(BatchName)) and the document number within a batch (@17). The number 1
in @17 defines the node (document).
Lab 9-4

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 9

2.2.5.

Click OK to save the schema changes.

2.2.6.

Click OK to save the changes and exit setup.

Congratulations! You have successfully configured the process.

Task 3 - Test the process


3.1.

Perform the Scan step.


3.1.1.

Select Start > Programs > InputAccel > ScanPlus.

3.1.2.

Check the Use Windows logon checkbox and click OK.

3.1.3.

Click the Create new batch link.

3.1.4.

Select the Lab 9 process from the process list. The batch name will be created
automatically using the pre-defined name schema.
a) What is the name of the batch?
_________________________________________________________________

3.2.

3.1.5.

Click the Create button.

3.1.6.

Click the Import files to batch link.

3.1.7.

Navigate to C:\Student\IA Fundamentals\Lab 9 (if necessary), select HR


Multiple Batches.tif, and click Open. The Tree View and File View are now
populated with information from the file. As the patch code 3 pages are
encountered, ScanPlus will create new batches.

3.1.8.

Click Close Batch to close the current batch.

3.1.9.

Click the Release Batch button when prompted.

3.1.10.

Close ScanPlus.

Perform the Image Export step.


3.2.1.

Start Image Export by selecting Start > Programs > InputAccel > Image
Export.

3.2.2.

Login as dmadmin/training.
Lab 9-5

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 9

3.3.

3.2.3.

Click the Run Single Batch button. Notice that there are three new batches
(HR_02, HR_03, HR_04). These batches were created automatically when the
patch code 3 page was encountered.

3.2.4.

Click Cancel.

3.2.5.

Click the Run All Batches button.

3.2.6.

When all of the batches have been processed, click the Stop button.

3.2.7.

Select File > Exit.

Verify that the files were exported.


3.3.1.

Using Windows Explorer, navigate to C:\Temp.

3.3.2.

You should now see multiple TIF files named <batchname> - <sequential
number>. The files represent the individual employee files (document) within
each batch. Double-click one of the files to view it and verify that this is the case.

3.3.3.

Close any open windows.

Congratulations! You have tested the process.

Solutions:
a)

HR_01.

Lab 9-6
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 9

Initial Module Selection

Requirement

Module

Scan the employee files. Create a new batch for each


patch code 3 page. Create a new document for each
patch code 2 page. Batches should be named
automatically for uniformity.

ScanPlus

Export all pages for an employee into one file. The file
should be named based on the batch along with the
document number within the batch.

Image Export

Module Breakdown - Solution


Image Capture

ScanPlus

1.

Export

1.

Image Export

End of Lab

Lab 9-7
2009 EMC Corporation. All rights reserved.

Module 10

Image Enhancement

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-1

Module Objectives

Describe the Image Enhancement module


List the types of color and binary filters
Describe run mode options

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-2

10-2

Image Enhancement Overview

Overview
Color Filters
Binary Filters
Run Mode Options

Image enhancement is used to clean up


scanned images before processing by modules
such as OCR
- Creates better readability
- Reduces overall file size

Can be run as an application or as a service


Enhancements performed are defined by the list of filters selected
during module setup
- Color and black and white (binary) filters
- Noise removal
- Deskew
- Color and bar code detection
Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-3

10-3

Setup Mode

Desired filters are selected from the toolbar


Filters are applied as they are selected
- Results are displayed
- Selecting filters in a different sequence will produce different results
- The filters are listed left-to-right on the toolbar in the generic best
sequence

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-4

10-4

Color Image Enhancement Filters

Overview
Color Filters
Binary Filters
Run Mode Options

Color detection
Binary thresholding
Color dropout
Color deskew
Black overscan removal
Color crop

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-5

10-5

Color Detection Filter

Useful for determining whether pages scanned in color were


originally black and white

Detects the percentage of color pixels on a 24-bit color image

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-6

10-6

Binary Thresholding Filter

This filter converts color images to binary (black and white)


24-bit color, 8-bit grayscale, and binary images are natively
supported
- Binary images are not modified

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-7

10-7

Thresholding Algorithms

Two available algorithms


- Intelligent thresholding
Superior for text conversion
Mangles some images and bar codes

- Simple thresholding
Mediocre text output
Mangles neither images nor bar codes

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-8

10-8

Color Dropout Filter (1 of 2)

The color dropout filter removes a color or colors specified by the


user

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-9

10-9

Color Dropout Filter (2 of 2)

Color removed is replaced by any desired color


- Typically white
Up to 100 colors may be removed per filter
Replaces color removal lamps in scanners
Only 24-bit color images are natively supported

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-10

10-10

Color Deskew Filter

Deskews 24-bit color, 8-bit grayscale, or binary images


Runs in three modes:
- Detect and deskew
Default

- Detect only
- Fixed-angle deskew
Rotate only

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-11

10-11

Black Overscan Removal (1 of 2)

Removes the black area around color images created by scanning


pages smaller than the image size
- Overscan

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-12

10-12

Black Overscan Removal (2 of 2)

Images should be color deskewed before being sent to this filter


Deskew fill color must be set to black
- Setup will warn users if they leave the Deskew fill color set to
white when using Black Overscan Removal

This filter natively supports 24-bit color, 8-bit grayscale, and


binary images

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-13

10-13

Color Crop Filter

The color crop filter crops 24-bit color, 8-bit grayscale, and binary
images

Settings and behavior are identical to those of the binary crop filter
- Fixed margin mode
- Fixed size mode
If no settings are specified, it will perform a white border removal

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-14

10-14

Image Color Formats (1 of 2)

Every color filter supports 24-bit color images


Some also support 8-bit grayscale images and binary images

What about unsupported color formats?

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-15

10-15

Image Color Formats (2 of 2)

The image enhancement module gives users three options for


handling unsupported color formats
- Convert images to the appropriate natively-compatible color
format
Default

- Skip incompatible images


- Generate an error
IA_ERR_COLOR (-4459)

Image Enhancement

10-16

2009 EMC Corporation. All rights reserved.

These settings are specified in the Run Mode Options, which will be shown later in this module.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-16

Miscellaneous

Copy filter settings to/from clipboard options in setup mode


Filter menu
- Filter settings can be copied to the clipboard and pasted from the
clipboard
- Facilitates reordering filters

Color statistics in setup mode


- Color depth is displayed in the statistics window
- Image size is not displayed for color images
Compressed size can not be determined without a big performance
hit

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-17

10-17

9
9

Binary Filters

Most commonly used filters


- Extended bar code detection
- Border removal
- Crop
- Deskew
- Halftone removal
- Noise removal
Other filters
- Skeleton
- Image scaling
- Erosion
- Hole removal
- Dilation
- Smooth
- Line removal - Invert image

- Patch code detection


- Blank page detection

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

Overview
Color Filters
Binary Filters
Run Mode Options

InputAccel Fundamentals and Administration


10-18

10-18

Border Removal

Inverts black borders around the edge of an image

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-19

10-19

Deskew

Straightens images

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-20

10-20

Noise Removal

Removes noise such as small dots and marks


- Apply before OCR

Image Enhancement
2009 EMC Corporation. All rights reserved.

The size and spacing (separation) of noise can be configured.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-21

10-21

Halftone Removal

Removes shaded backgrounds


- Apply before OCR

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-22

10-22

Crop
Fixed margins mode - Resizes the image by adjusting the width of
the margins

- Margins may be negative or positive


Fixed size mode - Resizes the image to a fixed size

If no settings are given, Crop will perform a white border removal

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-23

10-23

Extended Bar Code Detection

Extended bar code detection

Image Enhancement

10-24

2009 EMC Corporation. All rights reserved.

Extended bar code detection replaces the bar code detection filter. The bar code detection filter is
still available, but is no longer supported. Shown below are examples of some bar codes.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-24

Run Mode Options (1 of 4)

9
9
9

Overview
Color Filters
Binary Filters
Run Mode Options

Color conversion mode

Image Enhancement
2009 EMC Corporation. All rights reserved.

The color conversion mode defines what happens to images with incompatible color depths
before being passed to a filter.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-25

10-25

Run Mode Options (2 of 4)

Output images can be in different color formats


- Image compression formats preserve image quality or avoid
using excessive disk space

As in the ScanPlus module, a compression format can be selected


for each color format

The Image Enhancement module may be used to convert images


from one compression format to another, even when no filters are
used

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-26

10-26

Run Mode Options (3 of 4)

Image compression formats

Image Enhancement
2009 EMC Corporation. All rights reserved.

The default option is Use compression settings from Scan Instance.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-27

10-27

Run Mode Options (4 of 4)

Error handling and thumbnail options

Image Enhancement
2009 EMC Corporation. All rights reserved.

The Update thumbnail of Scan Instance option is not the default.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-28

10-28

9
9
9
9

Test Your Knowledge

Overview
Color Filters
Binary Filters
Run Mode Options

1. True/False: The Image Enhancement module


can run as a service.
2. True/False: Only color filters can be applied to
images using the Image Enhancement module.
3. True/False: The binary thresholding filter converts
color images to binary (black and white) images.
4. Which of the following are valid color conversion mode options?
a) Automatically convert the image to a compatible color format
b) Skip processing that image with that filter
c) Manually convert the image to a compatible color format
d) Generate an error

Image Enhancement

10-29

2009 EMC Corporation. All rights reserved.

1.
2.
3.
4.

True.
False. The Image Enhancement module can apply both color and binary filters.
True.
a, b, and d.
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-29

Exercise

Estimated time: 30 min

Goals
- Setup and use color filters for image enhancement
Tasks
- Import a process
- Configure the process
- Test the configured process

Image Enhancement
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


10-30

10-30

InputAccel Fundamentals and Administration


Lab 10

Module 10 Image Enhancement

Estimated Time: 30 minutes


Setup and use color filters for image enhancement

Goals
Tasks

1.

Import a process

2.

Configure the process

3.

Test the configured process

Background
Before you begin:

Answers to the questions asked in the lab are at the end of the lab instructions

When using the Administration Console, the lab instructions refer to links in the left-side
pane as "tabs".

Windows login/password: dmadmin/training

Scenario
Image Capture - All pages will be scanned in color. We want a binary image if the original physical
page was black and white. Color images are to have their overscan removed, and binary images will
be corrected for skew and noise.
Export - Each page is to be individually exported and named using the batch name, box number, and
the page number.

Lab 10-1
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 10

Initial Module Selection

Requirement

Module

Scan all pages in color

Determine whether the original physical page


was black and white or color.

If black and white, change it to a binary image


and correct for skew and noise.

If color, remove the overscan.

Export the color images

Export the binary images.

Lab 10-2
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 10

Module Breakdown
Image Capture / Image Quality

1.

2.

Data Capture / Data Validation

1.

Export

1.

Lab 10-3
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 10

Lab 10 Flow Chart

Lab 10-4
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 10

Task 1 - Import a process


1.1.

Start the InputAccel Administration Console and login as dmadmin/training.

1.2.

Select the Systems tab.

1.3.

Click the View Processes link.

1.4.

Click the Add button.

1.5.

Click the Browse button, navigate to C:\Student\IA Fundamentals\Lab 10, select


Lab 10.iap and click Open.

1.6.

Click OK to complete the import process.

You have successfully imported the process.

Task 2 - Configure the process


2.1.

Configure the Scan step.


2.1.1.

Select the Lab 10 process from the list of Processes.

2.1.2.

Right-click the Scan step and select Settings.

2.1.3.

Define indexing.
2.1.3.1.

Select the Index tab to add a scan-time indexing field.

2.1.3.2.

Change the Level to 2 - Folder.

2.1.3.3.

Select the Display fields while scanning option.

2.1.3.4.

Click the Define Indexing Fields link.

2.1.3.5.

Navigate to C:\Student\IA Fundamentals\Lab 10, select


EE_Cover.tif, and click Open.

2.1.3.6.

Use your mouse to draw a zone over the entire page by clicking and
dragging. A new field called New Field 1 will be created.

2.1.3.7.

Change the name of the field to Box Number in the Field properties
window (upper-right).

2.1.3.8.

Click the Save changes and close link in the upper-left corner of the
screen.
Lab 10-5

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 10

2.1.4.

2.1.5.
2.2.

Configure automatic batch naming.


2.1.4.1.

Select the Auto Batch Creation tab.

2.1.4.2.

Enter Lab 10 - @(Now) for the Batch name schema value.

Click OK to save the changes to the ScanPlus setup.

Start Image Enhancement in setup mode.


2.2.1.

Right-click the ColorDetect step and select Settings. Image Enhancement will
start in setup mode and prompt for a sample image.

2.2.2.

Navigate to C:\Student\IA Fundamentals\Lab 10, select EE_Cover.tif and


click Open.

2.2.3.

Select Filter > Insert > Color Detection or click the Color Detection toolbar
button

2.2.4.
2.3.

2.4.

to add the color detection filter.

Select File > Exit and click Yes to save the changes when prompted.

Configure the ColorIE step.


2.3.1.

In the Administration Console, right-click the ColorIE step of the process and
select Settings. Image Enhancement starts in setup mode.

2.3.2.

Choose the EE_Cover.tif file again and click Open.

2.3.3.

Select Filter > Insert > Black Overscan Removal or click the toolbar button

2.3.4.

Select File > Exit and click Yes to save your changes when prompted.

Configure the BWIE step.


2.4.1.

In the steps list, right-click the BWIE step and select Settings. Image
Enhancement starts in setup mode.

2.4.2.

Once again, select the EE_Cover.tif file and click Open.

2.4.3.

Add the binary thresholding filter by selecting Filter > Insert > Binary
Thresholding

2.4.4.

Next, add the deskew filter by selecting Filter > Insert > Deskew

2.4.5.

Finally, add the noise removal filter by selecting Filter > Insert > Noise
Removal
.

2.4.6.

Select File > Exit and click Yes when prompted to save your changes.
Lab 10-6

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 10

2.5.

Configure the black and white image export step


2.5.1.

In the steps list for the Lab 10 process, right-click the BWExport step and select
Settings. The Image Export module starts in setup mode.

2.5.2.

Ensure that the Write to Directory option is chosen.

2.5.3.

Change the File Path value by clicking the Browse button, navigating to
C:\Temp, and clicking OK.

2.5.4.

Click the Edit Schema button.

2.5.5.

Enter the value shown below in the Schema field:


%s - %s - %d, @(batchname), @(Scan.Level_2_KeyEntry_0), @07

2.6.

2.5.6.

Click OK. The Use Schema checkbox should now be checked and the schema
that you entered is displayed below it.

2.5.7.

Click OK to save your changes and exit the image export module.

Configure the color image export step


2.6.1.

In the Administration Console, right-click the ColorExport step and select


Settings. The Image Export module starts in setup mode.

2.6.2.

Click the Browse button and navigate to C:\Temp and click OK.

2.6.3.

Click the Edit Schema button.

2.6.4.

Enter the following value shown below in the Schema field:


%s - %s - %d, @(batchname), @(Scan.Level_2_KeyEntry_0), @07

2.6.5.

Click OK.

2.6.6.

Select the File Content tab.

2.6.7.

Select 24 bit Color from the Color Format dropdown list.

2.6.8.

Select Sequential JPEG from the Compression dropdown list.

2.6.9.

Click OK to save your changes.

You have configured the process.

Lab 10-7
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 10

Task 3 - Test the configured process


3.1.

3.2.

Perform the Scan step.


3.1.1.

Start ScanPlus by selecting Start > Programs > InputAccel > ScanPlus.

3.1.2.

Check the Use Windows logon checkbox if necessary and click OK.

3.1.3.

Click the Create new batch link.

3.1.4.

Select the Lab 10 process that you imported. The batch name is automatically
created.

3.1.5.

Click Create.

3.1.6.

Click the Import files to batch link.

3.1.7.

Select ColorIE.tif from C:\Student\IA Fundamentals\Lab 10.

3.1.8.

Enter BR-549 as the Box Number index field and click Save.

3.1.9.

Click the Close Batch link and click the Release Batch button.

3.1.10.

Close ScanPlus.

3.1.11.

Look at the Batch Traffic in the Administration Console. You should see the Lab
10 batch. Select the batch. You should see (in the chart) that the Color Detect
step has triggered because it will have a gray bar.

Perform the image enhancement step.


3.2.1.

Start the Image Enhancement module by selecting Start > Programs >
InputAccel > Image Enhancement.

3.2.2.

Enter dmadmin/training for the User Name and Password and ensure that your
computer name is in the Domain field. Click OK.

3.2.3.

Click the Run Single Batch button.

3.2.4.

Select the Lab 10 - <datetime> batch and click OK.

3.2.5.

Once the images views have stopped updating, the image enhancement steps are
likely done. Use the Administration Console to verify this by clicking the batch
in the Batch Traffic window. If the batch is already selected, you may need to
click on another batch, and then again on the batch in question to update the chart.
The Batch Traffic chart should show that the BWExport step is ready (gray bar)
while the BWIE and ColorIE steps are complete (white bars). Note: The chart
displays steps in alphabetical order, not their order in the process.
Lab 10-8

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 10

3.2.6.
3.3.

Select File > Exit in the Image Enhancement module to exit it.

Perform the image export step.


3.3.1.

Start the Image Export module by selecting Start > Programs > InputAccel >
Image Export. Use dmadmin/training and your computer name for Domain and
click OK.

3.3.2.

Click the Run Single Batch button, select your batch (there will only be one),
and click OK.

3.3.3.

After a second or two, the processing should be complete and the window will
display No Batch.

3.3.4.

Select File > Exit to close the Image Export module.

3.3.5.

Using Windows Explorer, navigate to C:\Temp.

3.3.6.

Verify that there are new TIF files located here. The file names will be based on
the schema you entered in the Image Export setup (Batch name, Box Number,
Sequence number).
Double-click the files to see the resulting image enhanced pages.

3.4.

Log out of the Administration Console and close the browser.

You have successfully processed color images.

Solutions:
Initial Module Selection - Solution

Requirement

Module

Lab 10-9
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 10

Scan all pages in color


ScanPlus

Determine whether the original physical page


was black and white or color.

IE

If black and white, change it to a binary image


and correct for skew and noise.

IE

If color, remove the overscan.


IE

Export the color images


Image Export

Export the binary images.


Image Export

Module Breakdown - Solution


Image Capture / Image Quality

1.

ScanPlus

Lab 10-10
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 10

Image Enhancement

2.

Data Capture / Data Validation

ScanPlus

1.

Export

1.

Image Export

Lab 10-11
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 10

Lab 10 Flow Chart - Solution

Scan

Color
Detection
Yes

Color?

No

ColorIE

BWIE

Color
Export

BW Export

Lab 10-12
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 10

End of Lab

Lab 10-13
2009 EMC Corporation. All rights reserved.

Module 11

OCR

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-1

Module Objectives

Describe Optical Character Recognition


List the available Captiva OCR modules
Describe the NuanceOCR setup steps
Use the NuanceOCR module in a process

OCR
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-2

11-2

Overview
NuanceOCR

OCR Overview (1 of 3)

Optical character recognition (OCR) is used


to extract text data from images

Captiva provides two OCR modules


- NuanceOCR and PrimeOCRPlus
Zonal OCR
- Increases throughput
- Multiple zones
- Generates text strings
Full page OCR
- Generates text files
Multiple languages
Custom dictionaries
OCR
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-3

11-3

OCR Overview (2 of 3)

NuanceOCR
- Replacement for ScanSoft OCR
- Unattended module runs
-

as a service
Support for multiple
instances
Multiple output formats
including PDF/A
XML file for OCR-assisted
indexing
Support for more than 20
barcode standards
Supports client-side
scripting
OCR

2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-4

11-4

OCR Overview (3 of 3)

PrimeOCRPlus
- Replaces for PrimeOCR module
- Supports many output formats including: PDF/A and PDF
-

JBIG2
Supports auto-language identification
XML file for OCR-assisted indexing
Supports client-side scripting

OCR
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-5

11-5

9 Overview
NuanceOCR

NuanceOCR Setup

Information tab

OCR
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-6

11-6

Engine Settings

Time Out setting used by the engines Watch Dog component


to avoid deadlock conditions

Unload Engine setting forces an unload and re-initialization of


the engine

OCR
2009 EMC Corporation. All rights reserved.

If recognition time exceeds setting, an error is returned and the module is reset.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-7

11-7

Document Recognition
Auto-rotate
capability

Recognition and
spelling languages
--Additional characters
Character
substitution
Code page
definition

OCR
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-8

11-8

Zone Definition (1 of 2)
Zone definitions
(default is full page)
OCR-assisted
indexing

Filters to limit
characters recognized
Recognition
engine, Trade off,
Filing method
Optical mark
recognition (OMR)
OCR
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-9

11-9

Zone Definition (2 of 2)

Zone setup - instead of or in addition to full-page zone

OCR

11-10

2009 EMC Corporation. All rights reserved.

By specifying zones instead of using full-page zones (the default), throughput can be increased.
Sample images will be needed in order to specify the zones. When specifying a zone, each one
may have a different recognition setting. Zones may be created manually using a click and drag
technique. Find zones automatically by clicking the Find Zones button. By default, this button
will find only 50 zones. In order to find more, the zone value must be changed in the
SSOCR.MDF file.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-10

Output Formats (1 of 2)
Use the New Format
button to create new
output formats
Select the associated
Format and Level

Choose the location to


save the output
(server, local, or both)

Test the selected


output format

OCR

11-11

2009 EMC Corporation. All rights reserved.

For each new output format created, select the Format and Level as well as where to save the
output file. When the Save to file system option is selected, the Path, File, and If the file exists,
then options will become enabled. There are more than 30 output formats supported including
PDF, PDF/A, XML, and some popular text formats.
There are six different possible levels to choose from as shown below:
Auto uses the default output mode of the selected converter.
NOFORMAT ignores existing format information, font attributes, etc. and formats the output in
a single column, with left-aligned paragraphs.
RFP retains fonts and paragraphs.
TRUEPAGE has the highest layout accuracy maintained with text boxes or frames.
FLOWINGPAGE preserves the original layout of the pages.
SPREADSHEET exports the results in tabular form for later importing into spreadsheet
applications. Each page is created in a separate worksheet.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-11

Output Formats (2 of 2)
Override default
recognition settings

Image View displays


the sample image
Status displays realtime status of test

OCR

11-12

2009 EMC Corporation. All rights reserved.

Clicking the Test button (shown on the previous slide) displays the test window shown above.
This gives the user a chance to add up to five files for testing the settings already set on the
previous tabs. The Recognition Settings can be refined if necessary from within the test window.
When the test files have been selected and the recognition settings defined, specify an output file
and click the Run button. The Status window will display the test information while the Image
View window displays the image being recognized. Once complete, click the View button to
display the output file in its native application.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-12

Scripting and Errors

The Scripting tab allows the user to associate user-defined scripts


with module and task events, as with other modules

The Error tab defines what to do when errors occur and how to
recover, if possible

OCR
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-13

11-13

Production Mode

Application mode - Run All Batches


- Run Single Batch
- Open Batch

OCR
2009 EMC Corporation. All rights reserved.

NuanceOCR can be run as a service.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-14

11-14

9 Overview
9 NuanceOCR

Test Your Knowledge

1. True/False: OCR is used to extract graphics from


images.
2. True/False: Using zonal OCR versus full-page
OCR can increase throughput.
3. True/False: Document recognition in the NuanceOCR
module can correct spelling errors.
4. Which of the following OCR modules are available from
Captiva 6.0 and later?
a) NuanceOCR
b) ScanSoft OCR
c) PrimePlus OCR
d) PrimeOCRPlus
5. True/False: When testing output formats, it is possible to
override the default recognition settings for further refinement.
OCR

11-15

2009 EMC Corporation. All rights reserved.

1. False. OCR is used to extract text from images.


2. True.
3. True.
4. a and d. ScanSoft OCR was replaced by the NuanceOCR module. PrimePlus OCR is a made
up name.
5. True.
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-15

Estimated time: 30 min

Exercise

Goals
- Use NuanceOCR in a process to generate PDF
files with hidden text

Tasks
- Install a process for use with the lab exercise
- Configure the process
- Test the process

OCR
2009 EMC Corporation. All rights reserved.

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


11-16

11-16

InputAccel Fundamentals and Administration


Lab 11

Module 11 OCR

Estimated Time: 30 minutes


Use NuanceOCR in a process to generate PDF files with hidden text

Goals
Tasks

1.

Install a process for use with the lab exercise

2.

Configure the process

3.

Test the process

Background
Before you begin:

Answers to the questions asked in the lab are at the end of the lab instructions

When using the Administration Console, the lab instructions refer to links in the left-side
pane as "tabs".

Windows login/password: dmadmin/training

Scenario
Image Capture - All pages will be scanned into a single document. Some scanning defects may need
correction.
Data Capture - Text from each page is to be automatically captured.
Export - The text is to be exported to a multi-page PDF file named using the batch name.

Lab 11-1
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 11

Initial Module Selection


Requirement

Module

All pages are to be scanned into a single


document.

The scanning process leaves some pages


skewed and noisy, for which corrections must
be made.
Text is to be automatically captured.

PDF files are to be saved to C:\Temp\, named


using the batch name and page number.

Lab 11-2
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 11

Module Breakdown
Image Capture / Image Quality

1.

2.

Data Capture / Data Validation

1.

Export

1.

Lab 11-3
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 11

Flow Chart

Lab 11-4
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 11

Task 1 - Install a process for use with the lab exercise


1.1.

If necessary, login to Windows using the login and password shown above
(dmadmin/training).

1.2.

Using Internet Explorer, launch the Administration Console by navigating to


http://localhost. Alternately, select Start > Programs > InputAccel > Administration
Console. Login as dmadmin/training.

1.3.

Select the Systems tab.

1.4.

Click the View Processes link.

1.5.

Click the Add button to import a new process.

1.6.

Click the Browse button, navigate to C:\Student\IA Fundamentals\Lab 11, select


Lab 11.iap and click Open.

1.7.

Click OK to complete the process import.

You have successfully installed the process for this lab exercise.

Task 2 - Configure the process


2.1.

Select the Lab 11 process in the process list.

2.2.

Configure the Scan step.

2.3.

2.2.1.

Right-click the Scan step and click Settings. ScanPlus will launch in setup mode

2.2.2.

Select the Levels tab.

2.2.3.

Uncheck the checkboxes for levels 1 (Document) and 2 (Folder). This will
simplify the user interface for the scan operators.

2.2.4.

Click OK.

Configure the IE (Image Enhancement) step.


2.3.1.

Right-click the IE step and click Settings.

2.3.2.

Navigate to C:\Student\IA Fundamentals\Lab 11, select EE_Cover.tif, and


click Open.

Lab 11-5
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 11

2.3.3.

Only two filters are required for this step: Deskew and Noise Removal.
Add the deskew filter by selecting Filter > Insert > Deskew (

2.4.

2.5.

).

2.3.4.

Finally, add the noise removal filter by selecting Filter > Insert > Noise
Removal (
).

2.3.5.

Select File > Exit and click Yes when prompted to save your changes.

Configure the NuanceOCR step.


2.4.1.

Right-click the NuanceOCR step and click Settings.

2.4.2.

Select the Output Formats tab.

2.4.3.

Click the New Format button.

2.4.4.

Open the Format dropdown list and select Adobe PDF with image on text.

2.4.5.

Click OK.

Configure the PDF_Export step.


2.5.1.

Right-click the PDF_Export step and click Settings. It may take a few seconds
for the module to launch in setup mode. If you do not see an icon in the taskbar,
use Alt-Tab to find it.

2.5.2.

Set the Export File Name value to the following:


C:\Temp\@(BatchName)-@17

2.5.3.

Click OK.

You have configured the steps in the process.

Task 3 - Test the process


3.1.

Perform the Scan step.


3.1.1.

Start ScanPlus by selecting Start > Programs > InputAccel > ScanPlus.

3.1.2.

Check the Use Windows logon checkbox and click OK.

3.1.3.

Click the Create new batch link.


Lab 11-6

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 11

3.2.

3.3.

3.1.4.

Select Lab 11 from the process list.

3.1.5.

Enter Lab 11 Batch for the batch name and click Create.

3.1.6.

Click the Import files to batch link.

3.1.7.

Navigate to C:\Student\IA Fundamentals\Lab 11, select LEGAL.tif and click


Open.

3.1.8.

Click the Close Batch link and then click the Release Batch button.

3.1.9.

Close ScanPlus.

Perform the image enhancement step.


3.2.1.

Start the Image Enhancement module by selecting Start > Programs >
InputAccel > Image Enhancement.

3.2.2.

Login as dmadmin/training.

3.2.3.

Click the Run Single Batch button, select Lab 11 Batch, and click OK.

3.2.4.

When complete, select File > Exit.

Perform the NuanceOCR step.


3.3.1.

Start NuanceOCR by selecting Start > Programs > InputAccel >


NuanceOCR for InputAccel.

3.3.2.

Check the Use Windows logon checkbox and click OK.

3.3.3.

Click the Run Single Batch link. The Lab 11 Batch should be the only batch in
the Select a batch window.

3.3.4.

Click OK to select the batch.

3.3.5.

The Task Progress indicator will update. The Processing log shows the detail
and the Task remaining on server will be 0 when complete.
Close NuanceOCR for InputAccel when complete.

3.4.

Select the Batch Traffic tab in the Administration Console, and then select the Lab 11
Batch to view the status. The Status should show as Ready.

3.5.

Perform the PDF_Export step.


3.5.1.

Start PDF Export by selecting Start > Programs > InputAccel > PDF Export.

3.5.2.

Check Use Windows login and click OK.


Lab 11-7

2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 11

3.5.3.

Select File > Open Batch with Tasks, select Lab 11 Batch, and click OK.

3.5.4.

When complete, you will see Finished task in the PDF Export window. Select
File > Exit to exit PDF export.

3.6.

Using Windows Explorer, navigate to C:\Temp and verify that there is a PDF file named
Lab 11 Batch-1.pdf there.

3.7.

Double-click the PDF file to open it in Adobe Acrobat and view the result.

3.8.

Close Adobe Acrobat.

You have successfully processed a batch using NuanceOCR.

Solutions:
Initial Module Selection - Solution

Requirement

Module

All pages are to be scanned into a single


document.

ScanPlus

The scanning process leaves some pages


skewed and noisy, for which corrections must
be made.

IE

Text is to be automatically captured.


NuanceOCR

Lab 11-8
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 11

PDF files are to be saved to C:\Temp\, named


using the batch name and page number.

PDF Export

Module Breakdown - Solution


Image Capture / Image Quality

1.

ScanPlus

2.

Image Enhancement

Data Capture / Data Validation

NuanceOCR

1.

Export

1.

PDF Export

Lab 11-9
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Lab 11

Flow Chart - Solution

ScanPlus

IE

NuanceOCR

PDF
Export
`

End of Lab
Lab 11-10
2009 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Index - Book 1
Deskew, 10-3, 10-13, 10-20
Dispatcher, 1-15, 7-35
Dispatcher for InputAccel,
1-15

A
Access Control Lists, 6-23,
6-24
ACL, 6-3, 6-4, 6-23, 6-24
Adding New Roles, 6-9
Admin Review, 8-25
Advanced Batch Searching, 8-27
Auto Batch Creation, 9-15

E
Editing Values, 8-35
Electronic Imaging, 1-3
E-mail Import, 9-5
Event Actions, 9-8
Export, 7-36
Export Modules, 3-13
Extended Bar Code Detection,
10-24

B
Batch Filters, 8-28
Batch Management, 8-20
Batch Settings, 8-29
Batch Traffic, 8-21
Batches, 3-16, 3-17
Binary Filters, 10-18
Binary thresholding, 10-5,
10-7
Black overscan removal, 10-5,
10-12
Border Removal, 10-19

F
Finding Batches, 8-26
Finding Members, 6-13
H
Halftone Removal, 10-22
High Availability and Failover,
5-6
How Do Roles and ACLs Differ?,
6-25

C
Changing Server Parameters,
8-6
ClickOnce, 7-33, 9-3
ClickOnce Deployment, 2-34
Client Hardware Requirements,
2-5
Client Software Requirements,
2-6
Color crop, 10-5, 10-14
Color deskew, 10-5, 10-11
Color detection, 10-5, 10-6
Color dropout, 10-5, 10-9,
10-10
Color Image Enhancement Filters, 10-5
Command-Line Arguments, 7-18
Command-Line Examples, 7-19
Creating Departments, 7-25
Creating ScaleServer Groups,
5-17
Creating the IAP File, 8-16
Crop, 10-23
D
Data Access Layer, 2-21
Data Capture Modules, 3-12
Database Requirements, 2-7
Department, 7-22, 7-23

I
IA Remoting, 2-23
IA values, 3-20
IAP, 8-13, 8-16
IAValues, 8-32
IIS, 2-23, 6-5
Image Capture Modules, 3-11
Image Color Formats, 10-15
Image Enhancement, 7-30
Image Enhancement Overview,
10-3
Image Output, 9-13
Image Quality Assurance, 7-29
Image View, 8-33
Import, 9-12
Index, 9-10, 9-11
Index Operator Permissions,
6-17
IndexPlus, 7-33
InputAccel Architecture, 3-7
InputAccel Components, 3-4,
3-5
InputAccel database, 2-7, 2-21
InputAccel Values, 3-20
Installation Steps, 2-9
IPP, 8-13

Index-1
2006 EMC Corporation. All rights reserved.

InputAccel Fundamentals and Administration


Index - Book 1
L
Level, 3-21
Levels, 9-7
License Regulation, 4-16, 4-17
Licensing, 2-28
Licensing Overview, 4-6, 4-7
Logging, 8-7

Run Mode Options, 10-25


Running a Module in Setup Mode,
7-4
Running Modules as Services or
Applications, 7-13
Running Modules in Production Mode,
7-10
S

M
MDF, 3-21
Miscellaneous, 9-14, 10-17
Module, 3-21
Module Categories, 3-10
Module Definition File, 3-21
Module Operator Permissions,
6-15
Modules with Login Permissions,
6-18
Monitoring Connections, 8-36
Monitoring IA Licenses, 4-18
Multi-Directory Watch, 9-5
N
Node, 3-21
Noise removal, 10-3, 10-21
NuanceOCR, 7-31, 11-3, 11-4,
11-6

Scan Operator Permissions,


6-16
Scanner, 9-9
ScanPlus, 7-27, 9-3, 9-6, 9-19
ScanSoft OCR, 11-4
Security Overview, 6-3
Server Activation, 4-3, 4-4,
4-5
Server Hardware Requirements,
2-3
Server Parameters, 8-3, 8-4,
8-5
Server Permissions, 6-19, 6-20
Server Software Requirements,
2-4
Settings.ini, 8-9
Silent Installations, 2-36
SQL Server authentication, 2-7
Step, 3-21
Steps, 8-11
System Permissions, 6-21, 6-22

O
T
OCR, 7-31, 10-3, 11-3
OCR Overview, 11-3
P
Permissions, 6-4, 6-14
Previewing, 9-24
PrimeOCR, 7-31, 11-5
PrimeOCRPlus, 11-3, 11-5
Process, 8-11
Process Developer, 3-14, 8-11,
8-13
Process Overview, 3-14
Processes, 8-11

Task, 3-21
Thresholding Algorithms, 10-8
Tracing, 8-7
Tree, 3-21
Trigger, 3-21
Typical Process Flow, 9-5
U
Upgrading, 2-37
V
Values View, 8-32
Viewing Roles, 6-6, 6-7

Q
QuickModuleHost.exe, 7-17,
7-23

W
Web Services Input, 9-5
Win.ini, 8-10

R
RescanPlus, 7-27, 7-28
Roles, 6-3, 6-5

Index-2
2006 EMC Corporation. All rights reserved.

You might also like