Copystar KYOCERA Capture Manager User guide

Legal notes

Unauthorized reproduction of all or part of this guide is prohibited.

The information in this guide is subject to change without notice.

We cannot be held liable for any problems arising from the use of this product,

regardless of the information herein.

©

2020 KYOCERA Document Solutions Inc.

Regarding trademarks

Microsoft

®

, Windows

®

, and Active Directory

®

are registered trademarks of Microsoft

Corporation in the U.S. and/or other countries.

ABBYY and FineReader are registered trademarks of ABBYY.

All other brand and product names herein are registered trademarks or trademarks of

their respective companies.

Table of Contents

Chapter 1 Overview

Conventions....................................................................................................................................... 1-1

System requirements......................................................................................................................... 1-2

Chapter 2 Installation

Prerequisites...................................................................................................................................... 2-1

Installing Capture Manager................................................................................................................2-1

Updating and uninstalling.................................................................................................................. 2-2

Modifying Capture Manager using the Installer Package..................................................................2-2

Installing Capture Manager with an existing SQL database............................................................. 2-2

Installing Capture Manager offline.....................................................................................................2-3

Logging in.......................................................................................................................................... 2-3

Chapter 3 Home

Navigation pane................................................................................................................................. 3-1

Chapter 4 Configuration

License............................................................................................................................................... 4-1

Activating a license online........................................................................................................... 4-1

Activating a license offline........................................................................................................... 4-1

Deleting a license........................................................................................................................ 4-2

Adding devices.............................................................................................................................4-2

Adding folders.............................................................................................................................. 4-3

Adding email accounts.................................................................................................................4-4

License types............................................................................................................................... 4-5

License summary.........................................................................................................................4-6

View license information.............................................................................................................. 4-6

System settings..................................................................................................................................4-7

Adding local users....................................................................................................................... 4-7

Adding Active Directory users................................................................................................... 4-10

Synchronizing Active Directory users........................................................................................ 4-12

Setting PIN length......................................................................................................................4-12

Configuring SMTP server settings.............................................................................................4-13

Configuring KNM settings..........................................................................................................4-13

Configuring Smart Information Manager settings......................................................................4-14

Adding a plug-in.........................................................................................................................4-15

Configuring Audit logs................................................................................................................4-16

Setting the Language.................................................................................................................4-17

KYOCERA Capture Manager i

Configuring Proxy settings.........................................................................................................4-17

Configuring Google Drive.......................................................................................................... 4-18

Chapter 5 Classification

Before you begin............................................................................................................................... 5-1

Classifying sample documents.......................................................................................................... 5-1

Training...............................................................................................................................................5-2

Importing a model..............................................................................................................................5-3

Exporting a model..............................................................................................................................5-3

The Classification task in a workflow, two types...............................................................................5-3

Run Template OCR......................................................................................................................5-4

Select task................................................................................................................................... 5-5

Chapter 6 Workflows

Creating a workflow........................................................................................................................... 6-1

Configuring workflow configuration options....................................................................................... 6-2

Input....................................................................................................................................................6-3

MFP client configuration options................................................................................................. 6-3

Email configuration options..........................................................................................................6-4

Folder configuration options........................................................................................................ 6-4

Mobile Client input....................................................................................................................... 6-4

Web browser input.......................................................................................................................6-5

Output.................................................................................................................................................6-5

Copy to folder configuration options............................................................................................6-5

Send to email configuration options............................................................................................ 6-6

FTP configuration options............................................................................................................6-6

SharePoint configuration options.................................................................................................6-7

Google Drive configuration options............................................................................................. 6-7

Metadata export configuration options........................................................................................ 6-7

Database configuration options................................................................................................... 6-8

Plug-in configuration options..................................................................................................... 6-10

Smart Information Manager configuration options.................................................................... 6-10

Image Processing............................................................................................................................ 6-11

Image pre-processing configuration options..............................................................................6-12

Full OCR configuration options................................................................................................. 6-13

Template OCR Scan configuration options............................................................................... 6-13

Barcode configuration and Profile options.................................................................................6-14

Split configuration options..........................................................................................................6-16

Digital signature configuration options.......................................................................................6-17

Verification........................................................................................................................................6-18

Verification configuration options...............................................................................................6-18

Condition configuration options................................................................................................. 6-19

Filter configuration options.........................................................................................................6-21

Database lookup configuration options..................................................................................... 6-22

Classification configuration options........................................................................................... 6-24

Custom code configuration options........................................................................................... 6-24

General.............................................................................................................................................6-25

Email notification configuration options..................................................................................... 6-25

Adding Metadata..............................................................................................................................6-25

Adding Value Lists........................................................................................................................... 6-26

Error handling.................................................................................................................................. 6-27

Custom code....................................................................................................................................6-29

ii Admin Guide

Chapter 7 Templates

Template Editor.................................................................................................................................. 7-1

Creating a new template............................................................................................................. 7-1

Capture Manager............................................................................................................................... 7-5

Adding a template........................................................................................................................7-6

Deleting a template......................................................................................................................7-6

Downloading a template.............................................................................................................. 7-6

Chapter 8 Logs

Viewing Process logs.........................................................................................................................8-1

Viewing the System log............................................................................................................... 8-1

Viewing Audit logs............................................................................................................................. 8-2

Viewing Classification logs................................................................................................................ 8-3

Classification log summary..........................................................................................................8-3

Chapter 9 Configuration Tool

Prerequisites...................................................................................................................................... 9-1

Running the Configuration Tool......................................................................................................... 9-1

Devices...............................................................................................................................................9-1

Discovering devices..................................................................................................................... 9-2

Communicating with Net Manager.............................................................................................. 9-2

Setting up KNM Embedded Lite..................................................................................................9-4

Verifying Communication settings................................................................................................9-5

Configuring System settings........................................................................................................ 9-6

HyPAS................................................................................................................................................ 9-8

Installing the HyPAS app.............................................................................................................9-8

Designing and installing HyPAS layouts......................................................................................9-9

Downloading Device logs.......................................................................................................... 9-14

KYOCERA Capture Manager iii

iv Admin Guide

1

Overview

Capture Manager is an automated server-based capture, scanning, and distribution

workflow system. The Capture Manager environment uses the main server

application, and a Template Editor utility for zone OCR scans.

In the Capture Manager workflow section, you can:

• Design workflows with input sources, metadata, email notification, image

processing types, data extraction from specific forms, and data validation by the

system or a user, and output destinations.

• Design zone OCR templates in the Template Editor then drag and drop them in

Capture Manager. Capture Manager can be trained to recognize documents so

that minimal user verification is needed for processing.

• Set up licenses to manage users, folders, email, and devices. Logs of system

activity are available for download.

Capture Manager can be synchronized with Active Directory based on your selected

schedule.

Administrators, Capture Manager users, and system users are the audience for this

guide.

Features and options vary depending on the installed Lite or Pro version.

Conventions

The following conventions may be used in this guide:

• Bold text is used for menu items and buttons

• Screen, text box, and drop-down menu titles are spelled and punctuated exactly as

they are displayed on the screen

• Italics are used for document titles

• Text or commands that a user enters are displayed as text in a different font or in a

text box as shown in these examples:

1. On the command line, enter net stop program

2. Create a batch file that includes these commands:

net stop program

gbak -rep -user PROGRAMLOG.FBK

• Icons are used to draw your attention to certain pieces of information. Examples:

This is a NOTE icon. This indicates information that is useful to know.

KYOCERA Capture Manager 1-1

Overview

This is a CAUTION icon. This indicates important information that you

should know, including such things as data loss if the procedure is not

done properly.

System requirements

Refer to the Release Notes or ReadMe that accompany this product.

1-2 Admin Guide

2

Installation

The Capture Manager installer uses a two-part wizard, which evaluates your system,

installs the necessary prerequisite software, then installs and configures Capture

Manager. Administrator rights are required to run the installation.

Capture Manager includes both Pro and Lite versions in one installer. This

guide covers both versions. Features vary depending on the license type.

For activating and assigning licenses, see the Configuration chapter.

Prerequisites

The Prerequisites Setup wizard checks if your computer has the required components

for running Capture Manager.

Refer to the Release Notes or ReadMe that accompany this product.

Installing Capture Manager

Use Next and Back on each page of the installer to navigate through the Installation

wizard.

1

Run Capture Manager via the supplied executable file. The Prerequisites Setup

wizard checks your computer for several required components.

2

On the License agreement page, read and accept the license agreement.

3

On the Select the features page, select Capture Manager to install.

In addition to installing Capture Manager, the following items are installed:

Template Editor: A separate utility for defining OCR zones to improve

readability.

Listener Folder Service: A service that continuously monitors designated folders

for defined Folder input tasks in scan workflows.

Listener Email Service: A service that continuously monitors designated email

accounts for defined Email input tasks in scan workflows.

Listener Active Directory Service: A service that continuously monitors Active

Directory synchronization based on configured settings in Capture Manager.

4

On the Configuration page, accept the defaults or update any information

specific to your environment.

To access Capture Manager from a computer other than the server,

you must open TCP/IP port 9071 (HTTPS) or 9070 (HTTP) and

port 8282 in the Capture Manager server's firewall setting after

KYOCERA Capture Manager 2-1

Installation

installation. For a local firewall, the Capture Manager installer

automatically opens these ports.

SQL Configuration

Server: The instance name of the SQL server.

User: The user name for the SQL server instance. The default is sa.

Password: The password for the SQL server instance. The default is

SystemAdmin@2017.

Host Configuration

Protocol: Select HTTP or HTTPS. The default is HTTPS.

Port number: Enter the port number. The default for HTTPS is 9071. The default

for HTTP is 9070.

Host Name: Enter the name of the host where Capture Manager services are

hosted. The default is the computer name of the server.

Host IP: Enter the IP address or the host name.

For HTTPS, you can add certificate information:

Certificate: The PKCS#12.PFX file certificate is supported. If no certificate is

specified, the installer automatically generates a new one. Capture Manager

also supports self-signed certificates and Public key certificates for SSL.

Password: If the .PFX file is password protected, enter the password for the

private key certificate.

5

On the Select Installation Folder page, select the installation folder on your

computer.

6

On the Ready to Install page, select Install.

7

When the installation completes, select Finish.

Updating and uninstalling

You can update Capture Manager to a new version by running the installer.

Downgrading is not supported. To install an older version, you must uninstall Capture

Manager from Programs and Features in the Control Panel and reinstall the software.

For more information about uninstalling Capture Manager, contact regional technical

support.

Modifying Capture Manager using the Installer Package

You can run the installer package to update any Capture Manager setting, such as

changing the port number or installing a new certificate. You are required to run the

same installer package as the currently installed version.

Installing Capture Manager with an existing SQL database

2-2 Admin Guide

Installation

1

On the Prerequisites page, clear the SQL Server Express installation check

box.

2

On the Configuration page, enter the SQL Configuration that supports the

existing SQL server.

Installing Capture Manager offline

You can manually install Capture Manager without an internet connection. You have to

manually install or enable the prerequisite items, then continue to run the installer to

proceed with the Capture Manager installation.

Install these prerequisites prior to installing Capture Manager.

• .NET Framework 4.7.x Runtime installer

• IIS Web Deploy installation

• Microsoft SQL Server Express (2014 SP2 or later) installation

1

Download and execute the offline .NET Framework 4.7.x Runtime installer from

the Microsoft website.

There are no settings needed for this installation.

2

Download and run the Web Deployment Tool for IIS Web servers from the

Microsoft website.

3

In the installation steps, for Setup Type, select Typical.

4

Download and run the Microsoft SQL Server Express installer from the

Microsoft website.

5

In the Add Roles and Features Wizard, on the Select features page, under

Features, select .NET Framework 3.5 (Includes .NET 2.0 and 3.0).

6

Execute the SQL server installer and select New SQL Server.

7

Accept the license and use the default settings in the next steps.

8

On the Feature Selection page, under Feature Selection, for features, choose

Select All and select Next.

9

On the Instance Configuration page, set KCM for the instance name and ID.

Select Next.

10

On the Database Engine Configuration page, under Database Engine

Configuration, select Mixed Mode for authentication and enter the password

for the SQL Server system administrator (sa). This password will be used later

when installing KCM.

11

After completing the SQL Server installation, run the Capture Manager installer.

12

Enter the SQL configuration according to the SQL server settings.

Logging in

KYOCERA Capture Manager 2-3

Installation

1

From the Start menu, Kyocera, open the Capture Manager Admin Dashboard or

from a web browser, enter the following URL:

For HTTP

http://hostname:9070/ui

For HTTPS

https://hostname:9071/ui

2

On the Login dialog box, enter the Capture Manager User ID and Password.

The defaults are admin and password.

3

Select Login.

2-4 Admin Guide

3

Home

The Home window is the main page for Capture Manager after you log in. The

information displayed varies by the type of license in use.

The window displays a Favorites workflows row for your workflows. A Verification

tasks section that lists documents that require your attention. You can also upload

documents to be scanned and initiate scan workflows in a Scan workflow section.

The window also displays a navigation pane where you can configure Capture

Manager features.

Navigation pane

You can set preferences for Capture Manager in the navigation pane, which contains

the following:

Workflows

Opens the scan workflow management window where you create and design

scan workflows.

Templates

Opens the template management window where you upload zone OCR

templates, which were created with the Template Editor utility. The Template

Editor utility can be opened in the Start menu.

Models

Opens the models and training log window where you manually classify sample

documents into models that are used to train Capture Manager to recognize

document types. A training log displays the accuracy of the training.

Logs

Opens the log window where you check system logs, executed scan workflow

history, audit logs, and classification logs.

Config

Opens the Capture Manager system settings window where you configure

settings for authentication for local users or Active Directory, SMTP server,

proxy, language, and logs. You can also manage users and groups in User

Management. You can install and configure plug-ins.

License

Opens the License management window where you add licenses and manage

devices, folders, and emails.

KYOCERA Capture Manager 3-1

4

Configuration

After installing Capture Manager, set up the environment, which includes licenses and

system settings. This chapter discusses these procedures.

License

In License, you manage the licenses for devices, folders, email, and web and mobile

users. To set up Capture Manager, first request an Activation code from your regional

technical support for your work environment. Once you receive an Activation code,

you can generate it on the Capture Manager system that creates a System ID. The

System ID contains updated license information which displays on the Summary

and License Management tabs. You can also setup Capture Manager in an offline

environment.

The License > Summary tab displays your requests for the environment. The

License > License Management tab displays your System ID. You will need this

System ID for future support and additional licenses.

Activating a license online

Be sure you have an Activation code from your regional technical support so you can

generate a license.

License activation requires an internet connection. If your network

requires a connection to the internet via proxy server, enter the proxy

settings first. For information about proxy settings, see Configuring Proxy

settings later in this chapter.

1

In License > License Management, select Activate.

2

Enter the Activation code and select OK.

3

Select OK.

The Summary and License Management tabs reflect the updated license

information.

On the License Managment tab, select the > next to an Activation code to see

the type and number of software licenses activated for the code.

Activating a license offline

If your server does not have an internet connection, an administrator can activate a

license in offline mode. The Summary tab displays information about license type,

KYOCERA Capture Manager 4-1

Configuration

maintenance license and its expiration date, and the number of licenses for devices,

folders, emails, and users in your environment.

1

In License > Summary, select Export License Info, which downloads an

information file (activation.json) about your environment to your local computer.

2

Save the license file.

3

Contact your regional technical support for your license activation code.

4

Move the license file from your local computer via USB to a computer with an

internet connection.

a. Access this URL to activate the license.

https://ksim-license.nscale.eu/offline/kyocera/

b. On the Activate license screen, enter the activation code you received.

c. Upload the license file you exported from Capture Manager.

d. Select Activate.

e. Download the updated license file and save this file via USB to Capture

Manager.

5

In License > License Management, select Activate offline.

6

Enter the Activation code and upload the license file on your computer.

7

Select Update.

The Summary and License Management tabs reflect the updated license

information.

On the License Managment tab, select the > next to an Activation code to see

the type and number of software licenses activated for the code.

Deleting a license

If you upgrade your software version, delete your existing Lite license before you

upgrade to a Pro license.

1

In License > License Management, select Delete.

2

Select OK.

Adding devices

After you have activated a device license, you can activate devices to the maximum

requested in that license.

1

In License > Devices, select +Add.

2

Enter your Discovery settings.

4-2 Admin Guide

Configuration

3

Select Add.

If the device cannot be added, a message displays in the top banner.

Discovery settings options

Type Description

By local network IPv4, IPv6, or both

By IP address IP address or a host name

By IP address range Starting and ending IP addresses in a range

Adding folders

1

In License > Folders, select +Add.

2

Enter the folder options.

3

Select Add.

4

Select OK.

Folder options

Name Description

Name The destination folder name used for input from

scan workflows. Maximum 64 characters.

Folder path Path to the folder that Capture Manager monitors.

Maximum 260 characters.

Check subfolders Selection for checking all subfolders based on the

name.

User ID (Optional) User ID of the user with access to the

protected folder. Maximum 64 characters.

Password (Optional) Password of the user with access to the

protected folder. Maximum 64 characters.

Activating Folders

You can activate or deactivate a folder so that it is accessible in your scan workflows.

Managing the activation status of your folders is a way to manage a limited number of

license folders. It also helps to maintain a manageable list of available folders during

the creation of workflows.

1

In the navigation pane, select License.

KYOCERA Capture Manager 4-3

Configuration

2

Select Folders.

3

Select one or more inactive folders.

4

Select Activate.

5

Select OK.

The same procedure can be used for deactivating folders where active folders are

selected, and then you select Deactivate.

Adding email accounts

After you have activated an email license, activate up to the number of email accounts

requested in that license.

1

In License > Emails, select +Add.

2

Enter the email account information.

3

To verify the connection between the email account and Capture Manager,

select Test connection.

If successful, a message displays in green. Save these settings.

If unsuccessful, a message displays in red. Verify your settings and retry the

connection test.

4

Select Save.

To edit an existing email account, select on the name in the list of email accounts.

Email options

Name Description

Name Email profile name. The email profile is selected in

the Email configuration of the workflow designer.

Maximum 64 characters.

Email type Select POP3 or IMAP service.

Server host Email server IP address or host name to a

maximum 255 characters.

Server port Enter an email server port number for the POP3 or

IMAP service within a range from 1-65535.

Security type Select a Messaging Security protocol setting using

None, SSL/TLS, or STARTTLS.

Email The monitored email address by Capture Manager.

4-4 Admin Guide

Configuration

Name Description

User ID The User ID for accessing the monitored email

account. Maximum 64 characters.

Password The Password used for accessing the monitored

email account. Maximum 64 characters.

Test connection Connection test between Capture Manager and the

monitored email account.

License types

Name Description

Invalid (Default) Capture Manager is unavailable.

Trial A 60-day license for Pro or Lite versions. The trial

license supports:

• licenses for a maximum 5 devices

• unlimited folders, email addresses, and users in

the system

• 1500 OCR scan maximum every 30 days during

the licensing period

• scanning count begins upon license activation

NFR Not for Resale. A one year license for Pro or Lite

versions. The NFR license supports:

• licenses for a maximum 5 devices

• unlimited folders, email addresses, and users in

the system

• 1500 OCR scan maximum every 30 days during

the licensing period

• scanning count begins upon license activation

Lite Lite can be used with a Trial or NFR version of

Capture Manager.

Pro Pro version of Capture Manager and its features

• full support for Mobile, Web, TWAIN (via Web)

• support for Digital Signatures, Optical Mark

Recognition (OMR), and Intelligent Character

Recognition (ICR)

• SharePoint output

• Database output

• configuration settings for verifications,

conditions and filters

KYOCERA Capture Manager 4-5

Configuration

License summary

The License information window displays the license details.

Name Description

License type

• Invalid (default)

• Pro

• Lite

• Trial

• NFR (Not for Resale)

Maintenance The validity of the current maintenance license.

Maintenance expiration date The expiration date of the current maintenance

license.

Devices The number of in-use devices out of the total

available devices.

Folders The number of in-use folders out of the total

available folders.

Emails The number of in-use email accounts out of the

total available email accounts.

Web and mobile users The number of web and mobile users out of the

total available users. (Pro license only).

OCR pages The number of OCR scanned pages based on a

30-day allotment total of 1500.

This allotment applies only to NFR and Trial

licenses.

Expiration date License expiration date for Trial and NFR licenses.

Export License Info Capture Manager license information that can

be shared with regional technical support. Only

regional technical support can unencrypt the

license file.

View license information

You can view license activation codes and the type and number of software licenses

activated for the code on the License Management window.

4-6 Admin Guide

Page is loading ...

Copystar KYOCERA Capture Manager User guide

Copystar KYOCERA Capture Manager User guide

Related papers

Other documents