ImageNow Interact for eCopy - Kofax Interact for eCopy Installation and Setup Guide Page 7 of 30 Customiz e ImageNow Interact for eCopy After you install ImageNow Interact for eCopy,

ImageNow Interact for eCopy Installation and Setup Guide ImageNow Version: 6.7.x

Written by: Product Documentation, R&D Date: September 2016

© 2015 Perceptive Software. All rights reserved.

Lexmark and Perceptive Software are trademarks of Lexmark International, Inc., or its subsidiaries, registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Perceptive Software.

Page 3 of 30 ImageNow Interact for eCopy Installation and Setup Guide

Table of Contents Overview ...................................................................................................................................................... 5

Install ImageNow Interact for eCopy ......................................................................................................... 5

Download the Interact for eCopy files ....................................................................................................... 5 Run the Interact for eCopy installation wizard ........................................................................................... 6

Customize ImageNow Interact for eCopy ................................................................................................. 7

Global settings ........................................................................................................................................... 8 Allow users to add documents to ImageNow without logging in ........................................................... 8

Change the format of the serial number ................................................................................................ 8

Change the starting value of the serial number ..................................................................................... 9

About Capture profiles ............................................................................................................................... 9 Create a capture profile ......................................................................................................................... 9

Restrict user access to a capture profile ................................................................................................ 9

Show or hide a capture profile ............................................................................................................. 10

Show or hide a field ............................................................................................................................. 10 Enable or disable modifications for a field ........................................................................................... 10

Limit the number of document types to display ................................................................................... 11

Change user access to pages per document setting .......................................................................... 11

Enable automatic document numbering .............................................................................................. 11

Set pages per document ...................................................................................................................... 12

Set workflow queue .............................................................................................................................. 12 Clean up images .................................................................................................................................. 12

Change the default value displayed for a field ..................................................................................... 13

Add a custom property field ................................................................................................................. 13

Use DataCapture with ImageNow Interact for eCopy ............................................................................. 14 How using DataCapture affects other settings .................................................................................... 14

Designate a scan user for DataCapture .............................................................................................. 14 Enable DataCapture processing .......................................................................................................... 15

Implement ImageNow Interact for eCopy ............................................................................................... 16

Add scanned images to ImageNow ......................................................................................................... 18 Appendix A: Examples of capture profiles ............................................................................................. 21

Global statements .................................................................................................................................... 21 Capture profile with DataCapture disabled .............................................................................................. 21

Capture profile with DataCapture enabled .............................................................................................. 23


Appendix B: eCopy.ini settings ............................................................................................................... 24

Index ........................................................................................................................................................... 30


Overview ImageNow Interact for eCopy provides integration to ImageNow from any eCopy enabled multi-function peripheral (MFP) device running eCopy ScanStation, Version 4.0 or higher, and ImageNow. This document explains how to install ImageNow Interact for eCopy and how to change settings for ImageNow Interact for eCopy by modifying the eCopy.ini file. End user procedures are explained in the section called “Implement ImageNow Interact for eCopy.” You can extract this section and distribute it as a quick reference to non-administrative users.

Note Interact for eCopy 6.7.x supports eCopy ShareScan embedded software on supported Ricoh and Canon MFPs. To ensure communication between devices, install Interact for eCopy on the device where the ShareScan administration application is running.

Install ImageNow Interact for eCopy Perform the following steps on a computer that has internet access to both ImageNow Server and your MFP devices. You must install Interact for eCopy on the computer that is attached to your MFP. This ensures that communication between the server,

Download the Interact for eCopy files 1. Go to the Perceptive Software website at www.perceptivesoftware.com and log in to the Customer

Portal.

2. In the Product Downloads page, search for all downloadable items for the specific product and version you want to use. These files may include a product installer, product documentation, or set of supporting files.

3. Download the relevant files to a temporary directory on your computer.

about:blank


Run the Interact for eCopy installation wizard 1. Double-click the EXE file you just downloaded.

2. On the Welcome page, click Next.

3. On the License Agreement page, review the terms in the License Agreement, scroll to the end of the agreement, click I accept the terms in the license agreement, and then click Next.

4. On the ImageNow Server Information page, in the Server IP / name box, enter the name or IP address of your ImageNow Server and, in the Port number box, its port number, normally 6000. To continue, click Next.

5. On the Destination Folder page, if you need to change the destination folder, click Change and select the folder you want. To continue, click Next.

6. On the Ready to Install the Program page, click Install.

7. Optional. If the Show the Windows Installer log check box appears, you can select the check box to view the log file.

8. On the Installation Wizard Completed page, click Finish.


Customize ImageNow Interact for eCopy After you install ImageNow Interact for eCopy, you need to edit a configuration (ini) file to customize ImageNow Interact for eCopy. You customize ImageNow Interact for eCopy by creating capture profiles. Each capture profile provides the functions that appear when a user clicks the corresponding button in the Select a Capture Profile window. In the following example, Interact created capture profiles for six buttons: HR1, HR2, HR3, AP1, AP2, and AP3.

ImageNow saves the capture profiles, along with global settings, in the eCopy.ini file. By editing the eCopy.ini file, you can show or hide individual capture profile buttons and enable or disable features within a capture profile, such as DataCapture processing or image cleanup. To perform any of the following tasks,

1. Navigate to the [drive]:\Program Files\ImageNow6\eCopy\lib folder

2. Open the eCopy.ini file with a text editor.

3. Save the file after performing each task.


Global settings The following actions affect the general behavior of ImageNow Interact for eCopy and are not confined to individual capture profiles. Changes you make to global settings take effect after you save the eCopy.ini file, stop eCopy ShareScan Manager, and then restart ShareScan Manager. Changes you make to capture profiles take effect the next time an MFP user clicks the button that activates the profile.

Allow users to add documents to ImageNow without logging in To allow users to add documents to ImageNow without entering a user name or password, use the anonymous login setting, which affects all profiles. You cannot limit its affect to individual profiles. When it is switched on, any user who scans documents with ImageNow Interact for eCopy is assigned a default user name of ecopyinteract. This user name value appears in the properties of the resulting document in the Created By field.

1. In the eCopy.ini file, in the [General] section, set enable.anonymous.login to TRUE.

2. Save the changes and close the file.

3. From the eCopy application, select the Capture Profile option. Note that the options are not enabled, nor have they been created.

4. From the ImageNow Management Console, select Manage.

5. From the left pane, select Groups.

6. Select the eCopy Interact Devices group, define the privileges and save the changes.

7. Return to the eCopy application and scan a document.

Change the format of the serial number

Use this procedure if you intend to use automatic numbering in any of your capture profiles. Use the format statement to designate fixed and variable sections within the serial number as well as the number of leading zeros. For example, in the following statement: serial.number.format = <%08d>[eCopy]

%08d means allow a maximum of eight digits and show any leading zeros. On the other hand, if you use %8d, the result is the same except that Interact omits any leading zeros.

< > indicates a variable section, where the number is incremented with each new document, and [ ] indicates a fixed section, which can appear before or after the variable characters. The format statement in the example generates a sequence of serial numbers that begins 00000001eCopy, 00000002eCopy, and 00000003eCopy.

• In the eCopy.ini file, go in the [Serial Number] section, set serial.number.format to the format definition you want.

To learn how to turn on automatic numbering within a capture profile, refer to the “Enable automatic document numbering” section.


Change the starting value of the serial number Use this procedure if you want auto numbering of documents to start at a value greater than one. It is optional if you intend to use automatic numbering in any of your capture profiles.

• In the eCopy.ini file, in the [Serial Number] section, set serial.number.next to the starting value you want and include any fixed text that is defined in the serial.number.format statement in the same position as it appears in the format statement. The following example lets the numbering to begin at 500: serial.number.format = [docnum]<%08d> serial.number.next = docnum00000499

About Capture profiles Capture profiles control most of the functionality of ImageNow Interact for eCopy. Each capture profile that you create affects the appearance and behavior of the controls displayed in the ShareScan OP window of the MFP device after the user selects the corresponding capture profile button.

You can use capture profiles to show or hide a button or field, change the default value displayed for a field, and change user access to a field. Within a capture profile, you can turn on automatic document numbering, which creates unique serial numbers for serial numbers, turn on DataCapture, and turn on image cleanup. You can use serial numbers to allow selection of pages per document.

For examples of capture profiles, refer to Appendix A in this document.

Create a capture profile Use this procedure to define a new capture profile. You specify the behavior of this profile in the sections that follow.

1. In the eCopy.ini file, copy the entire section for an existing button.

Note Capture profiles begin after the [Serial Number] section. The first statement in a capture profile is [button name], where button name is a placeholder for the name you assign to the capture profile. This name appears on a button in the Select a Capture Profile screen of the ShareScan OP window on the MFP.

2. Paste the copied text in the desired position among the existing buttons. This placement determines the position of the button in the Select a Capture Profile screen.

3. Edit the new button section with the button name you want and the corresponding settings for document keys and custom properties.

Restrict user access to a capture profile Use this procedure to show a capture profile only to a specific number of users. The user names in this procedure must be among those defined by the manager of your ImageNow Server. For this feature to take effect, make sure that enable.anonymous.login is set to false.

1. In the eCopy.ini file, go to the capture profile you want to change.

2. Set restrict.viewable.users.to to a comma-delimited list of the user names, as shown in the example: restrict.viewable.users.to = bsmith,chayes,sthompson

Only the users specified in this parameter value can use the corresponding capture profile.


Show or hide a capture profile You can prevent a capture profile from appearing in the ShareScan OP window without removing the definition from the eCopy.ini file. This procedure allows you to redisplay the button by changing a single statement in the file.


2. Find the button.enabled line for the button you want to hide and set button.enabled to false. To redisplay the button, set button.enabled to true.

Show or hide a field You can show and hide individual fields within a capture profile.


2. Find the <object>.display line of the object you want to hide, where <object> is a placeholder for a document key such as drawer or document type.

3. Set <object>.display to false. To redisplay the object, set <object>.display to true, as shown in the following example: drawer.display = true

Enable or disable modifications for a field Perform the following steps to allow the MFP user to enter or change values for a field or to prevent the user from changing the values

1. In the eCopy.ini file, go to the capture profile you want to change, and find the <object>.user.modifiable field that you want to change, where <object> is a placeholder for a document key such as drawer or custom property.

Note Custom properties created with the data type of User are not currently available to ImageNow Interact for eCopy.

2. Do one of the following options:

• To allow users to change the value for this field, set <object>.user.modifiable to true.

• To prevent users from changing the value for this field, set <object>.user.modifiable to false, as shown in the following example: drawer.user.modifiable=false


Limit the number of document types to display In an environment where you define large numbers of document types, the ImageNow Server administrator can consolidate document types into document type lists and thus reduce the size of the list of document types displayed to the user. You can take advantage of this feature in a capture profile by showing just the document types the user needs to select.


2. Set doctype.display to true.

3. Set doctype.list to the name of a document type list defined in ImageNow. For example, the following statement would apply if you had a document type list named AP: doctype.display = true doctype.list = AP

Change user access to pages per document setting The statements in this section control the user’s ability to set the number of pages that become part of a single ImageNow document. Interact ignores the statements if DataCapture processing is enabled for the capture profile.


2. To hide the Number of pages per document field and the Add all pages to a single document field in the ShareScan OP window, set pages.per.document.display to false.

3. To prevent the user from changing the number of pages per document, set pages.per.document.user.changeable to false. The user can still see the Number of pages per document field in the ShareScan OP window but cannot change the number.

Enable automatic document numbering You enable document numbering when you need to assign serial numbers to the documents sent to ImageNow or when you want to specify a fixed number of pages per document. The following sections explain both of these functions.


2. Choose an unused document key, such as field5. In the remaining steps, the document key is represented as field<number>.

3. Set field<number>.default.value to <<Serial Number>>, as shown in the following example: field5.default.value=<<Serial Number>>

4. To hide the string <<Serial Number>> in the ShareScan OP window, set field<number>.display to false.


Set pages per document The statements described below require that you first perform the procedure in the “Enable automatic numbering” section. However, these statements are ignored if DataCapture processing is enabled for the capture profile.

• In the eCopy.ini file, locate the capture profile you want to change and perform one of the following options:

• To store all the images the user scans as a single ImageNow document with multiple pages, set pages.per.document.value to 0. This setting automatically selects the Add all pages to a single document option in the ShareScan OP window.

• To store each image the user scans as a one-page ImageNow document, set pages.per.document.value to 1. This setting automatically selects the Number of pages per document option in the ShareScan OP window and sets its value to 1.

• To store each set of two, three, or more scanned pages as a single ImageNow document with two pages or three pages, and so forth, set pages.per.document.value to the number of pages you want. This setting automatically selects the Number of pages per document option in the ShareScan OP window and sets its value to the number you specify.

Set workflow queue The statements described below are ignored if DataCapture processing is enabled for the capture profile unless no workflow queue is specified either in the DataCapture template or in the inserverDC.ini file.


2. To show the WF Queue list in the ShareScan OP window, set workflow.queue.display to true.

3. To allow the MFP user to select a queue in the WF Queue list, set workflow.queue.modifiable to true.

4. To preset the name displayed in the WF Queue list in the ShareScan OP window, set workflow.default.value to the name of a queue defined for the ImageNow Server to which the scanned images are submitted.

Clean up images ImageNow Interact for eCopy provides the following optional image processing features:

• Deskew The following statement instructs Interact for eCopy to straighten slanted images. image.processing.enable.deskew = true

• Despeckle The despeckle feature removes noise, or speckles, from images. Using the feature can reduce image file size dramatically as well as improve image readability. Despeckle is not recommended on colored forms. You can despeckle the image using the following setting: image.processing.enable.despeckle = true

• Scale Some applications, like barcode recognition and OCR, require images scanned at a uniform resolution (dots per inch). You can use this feature to allow the users to scan at a higher resolution (dpi) but enforce a standard resolution at the time the image is saved to ImageNow Server. image.processing.scale.dpi = <any positive integer>

If you set this value to zero or less than zero, the setting has no effect on the image.


Change the default value displayed for a field You can modify the default value of a field. For example, you can modify the default value of Field1 by editing the field1.default.value statement.


2. Find the <object>.default.value field that you want to change, where <object> is a placeholder for a field such as drawer or custom property.

3. Set <object>.default.value to the value you want. For example, if you want to default fieldF3 to “South Office”, the following assignment would apply: field3.default.value = South Office

Add a custom property field You must define any custom properties you add to your ImageNow Interact for eCopy application in ImageNow. The custom properties you add appear in the document type and workflow screen of the ShareScan OP window only when they are contained in the document type selected at the top of the screen.


2. Set custom.property1.name statement to the name of the first custom property you want to add, as shown in this example: custom.property1.name = Median Age

3. Repeat the previous step with the custom.property2.name and the next name you need to add, and so on for the remaining custom properties. If you need to add more custom properties than are available in the placeholder statements, continue with the following steps.

4. Copy the last pair of custom property statements in the section, and then paste the Windows Clipboard in the space immediately below, as shown in the examples below: custom.property8.name = Voucher Number custom.property8.user.modifiable = true custom.property8.name = Voucher Number custom.property8.user.modifiable = true

5. In the new statements, replace the number following “property” with the next highest number in each statement, and then replace the name value: custom.property8.name = Voucher Number custom.property8.user.modifiable = true custom.property9.name = Voucher Date custom.property9.user.modifiable = true


Use DataCapture with ImageNow Interact for eCopy DataCapture processing is an optional data extraction feature of ImageNow Interact for eCopy that is available to customers who have installed and licensed DataCapture software to work with their ImageNow capture profiles.

How using DataCapture affects other settings When you use DataCapture processing, you gain the use of some options and give control of certain others to the DataCapture software.

• If you enable the DataCapture feature in a capture profile, you can specify three additional parameters specifically related to the DataCapture technology. The following section explains these parameters. With the DataCapture parameters set, ImageNow Interact for eCopy scans the pages and sends them to ImageNow Server, where they appear in the batch grid of ImageNow Client. If DataCapture is able to extract data from the pages, it then allows the ImageNow Client user to verify the data before it moves the documents from the batch grid to the document grid.

• When you enable DataCapture feature in a capture profile, none of settings for document keys or pages per document needs to be included in the definition because ImageNow Interact for eCopy ignores those settings when DataCapture processing is enabled.

• When you enable DataCapture feature in a capture profile, the workflow statements in the eCopy.ini file are ignored unless no queue is specified either by the DataCapture template or by the complete.to.queue statement in the inserverDC.ini file.

• If you disable DataCapture in the Interact profile, the following DataCapture features are not applied to the scanned images. Instead, documents scanned by eCopy are sent immediately to the ImageNow document grid.

For detailed descriptions of DataCapture concepts and procedures, refer to ImageNow Help DataCapture topics.

Designate a scan user for DataCapture If your capture profile uses DataCapture processing, perform the following procedure.

1. Start ImageNow Client and log in.

2. On the ImageNow toolbar, click Manage.

3. In the Resource Manager dialog box, click Users and Groups.

4. On the Users tab, click New and create a user with a generic name, such as ScanUser. This need not correspond to an actual ImageNow user, as it is used only as an identifier for a DataCapture setting in the eCopy.ini file. Do not assign any privileges to this user.

5. If you want ImageNow users who are not managers to access the Batch grid to inspect or verify the DataCapture results, perform the following substeps to grant the needed access:

1. On the Users tab, locate and select a user who needs to access the Batch grid.

2. Click Modify and then, in the Modify User Profile – User Name dialog box, on the Batch Users tab, click Add.

3. In the Select Users dialog box, select the generic user you created in step 3, click Add, and then click OK.

4. In the Modify User Profile – User Name dialog box, click OK.


5. Repeat the previous sub steps for any other users who require access to the Batch grid for processing DataCapture results.

6. Edit the eCopy.ini file and go to the capture profile that enables DataCapture processing.

7. Set datacapture.scan.user.name to the generic user you created in step 3, save, and then close the file.

Note Do not leave datacapture.scan.user.name unassigned, as DataCapture requires a user name.

Enable DataCapture processing The following steps include both mandatory and optional settings for the DataCapture feature.

1. In the eCopy.ini file, find the button section that will include DataCapture processing and edit the three statements in the following steps.

2. To enable DataCapture, set use.datacapture to true.

Note If the use.datacapture statement is set to false, the three statements described below are ignored.

3. To send the scanned images through the QA step in the batch grid of ImageNow Client, set bypass.qa to false.

Note Following this step allows manual modification of the image, such as rotation, as well as manual deletion of the image, before the image is sent to the DataCapture step.

4. If you want to skip the QA step in the batch grid, set bypass.qa to true.

5. Set datacapture.template to the exact name of the template to use with DataCapture processing. Do not leave this value blank. The template must be defined in ImageNow before you perform the scanning.

6. To handle any scanned images for which the DataCapture step does not extract values (for example, trailing pages of a multi-page invoice), choose one of the following options:

• To append the image to the most recent document in the batch that DataCapture was able to extract data from, set append.failed.to.last.successful to true. The appended image then becomes a page in the last successful document.

• To save the image as a separate document that uses default values, set append.failed.to.last.successful to false. The resulting document is indexed with document key values specified in the [Key Mapping] section of the inserverDC.ini file. This document is not associated with any other ImageNow document.

7. Before scanning pages for DataCapture, the user must set the MFP device to black and white scanning.


Implement ImageNow Interact for eCopy ImageNow Interact for eCopy provides integration to ImageNow from any eCopy enabled MFP device running eCopy ScanStation 4.0 or higher and ImageNow. This section describes end-user tasks performed at an MFP device. It assumes that ImageNow Interact for eCopy was installed and set up with the button definitions required for the document imaging and indexing needs of your organization.

Note Interact for eCopy 6.7.x supports eCopy ShareScan embedded software on eCopy ShareScan supported Ricoh and Canon MFPs. To ensure communication between devices, install Interact for eCopy on the device where the ShareScan administration application is running.

Start ImageNow Interact for eCopy and scan pages

The first phase of adding new pages to ImageNow is to scan them on your MFP device (printer, copier, or scanner).

1. Place pages to scan into the scanner document feeder.

Note If you plan to use DataCapture processing or annotations with the scanned image, set your MFP device to black and white scanning.


2. In the ShareScan OP window, select the ImageNow button and then click Next to begin scanning. The MFP scans your documents and retains the images in memory. The scanned images appear in the review window as shown in the following figure.

3. Using the Up Arrow, Down Arrow, Delete, and Scan More buttons, check over the images you

scanned and then rescan as necessary. When you are satisfied that with the quality and sequence of the images, click Next.

4. If prompted for your user name and password, in the ImageNow Interact for eCopy window, enter those values in the corresponding boxes and then click Next to move to the Select a Capture Profile page.


Add scanned images to ImageNow The second phase of adding new pages to ImageNow is to select any required options that affect how ImageNow Interact for eCopy sends the scanned images to ImageNow Server for further processing.

1. On the Select a Capture Profile page, select the button that initiates the scanning task you want. You may need to scroll this page to view all of the capture profile buttons.

2. When the document keys window appears, do as many of the following options as you are prompted

to complete:

• If no options appear in the window, skip to the following step.

• Enter any values required by your document indexing system for such fields as Drawer, Field1, and Field2. The fields displayed in your window may be different, depending on your configuration.


• To select a document type or a workflow queue, click the triangle in the lower right corner of the

document keys window to scroll the window down.

• If you want to specify a document type, select it in the Document Type list.

• If you want to add the document to a queue, select the queue in the WF Queue list.


3. Click Next, click Submit, and then do one of the following actions:

• If you are finished, then in the Document sent successfully window, click Done. This logs you

out of the ImageNow Interact for eCopy window.

• To remain logged in and to continue scanning other documents with the settings you selected above, click the New Document button.

If you want to send the already scanned images to a different output, such as fax or printer, without having to rescan them, click the New Destination button.


Appendix A: Examples of capture profiles The following sections contain statements in a single eCopy.ini file. Note that the file begins with three global sections that apply to the overall behavior of ImageNow Interact for eCopy no matter which button the user clicks in the ShareScan OP window. Following these are two capture profiles: the HR button and the AP button, each of which contains settings that apply exclusively to the behavior of that button.

Global statements [General] server.ip.address = thorntond server.ip.port = 6000 enable.anonymous.login = false [Logging] debug.level.file = 0 [Serial Number] serial.number.format =<%08d>[eCopy] serial.number.next=00000000eCopy

Capture profile with DataCapture disabled The HR button defined below does not use DataCapture processing. The button displays all document key values (such as Drawer, Field1, and Field2) to the user and lets the user change these values. When selecting a document type, the user views only the document types in a document type list on ImageNow Server called test list. In addition, the button displays five user-modifiable custom property values that are associated with document types in test list. The definition does not use any of the image clean-up options. [HR] button.enabled = true restrict.viewable.users.to = use.datacapture = false bypass.qa = false datacapture.template = append.failed.to.last.successful = false drawer.display = true drawer.user.modifiable = true drawer.default.value = Default doctype.display = true doctype.list = test list doctype.user.modifiable = true doctype.default.value = Default workflow.queue.display = true workflow.user.modifiable = true workflow.default.value = Start pages.per.document.display = true pages.per.document.value = 5 pages.per.document.user.changeable = true


field1.display = true field1.user.modifiable = true field1.default.value =<<Unique ID>> field1.display.name = field2.display = true field2.user.modifiable = true field2.default.value = field2.display.name = field3.display = true field3.user.modifiable = true field3.default.value = field3.display.name = field4.display = true field4.user.modifiable = true field4.default.value = field4.display.name = field5.display = true field5.user.modifiable = true field5.default.value =<<Serial Number>> field5.display.name = custom.property1.name = SocSecNum custom.property1.user.modifiable = true custom.property2.name = Age custom.property2.user.modifiable = true custom.property3.name = Gender custom.property3.user.modifiable = true custom.property4.name = I9_Status custom.property4.user.modifiable = true custom.property5.name = DateOfBirth custom.property5.user.modifiable = true image.processing.enable.deskew = false image.processing.enable.despeckle = false image.processing.scale.dpi = 0


Capture profile with DataCapture enabled The eCopy.ini file continues in this section with the AP capture profile, which uses DataCapture processing. For that reason, it does not include settings for document keys or pages per document because ImageNow Interact for eCopy ignores those settings when DataCapture processing is enabled.

Scanned images are sent directly to the DataCapture step of the ImageNow batch grid, skipping the QA step. DataCapture processing uses a template called TestTemplate. Any pages from which DataCapture is unable to extract data are assigned document key values from the [Key Mapping] section of the inserverDC.ini file.

The scanned documents are sent to the Start workflow queue only if no queue is specified either by TestTemplate or by the complete.to.queue statement in the inserverDC.ini file. The capture profile applies the Deskew, Despeckle, and Scale features to the scanned images. [AP] button.enabled = true restrict.viewable.users.to = use.datacapture = true bypass.qa = true datacapture.template = TestTemplate append.failed.to.last.successful = false datacapture.scan.user.name=ScanUser workflow.queue.display = false workflow.user.modifiable = true workflow.default.value = Start image.processing.enable.deskew = true image.processing.enable.despeckle = true image.processing.scale.dpi = 150


Appendix B: eCopy.ini settings The following table provides definitions and sample data for the settings in the eCopy.ini configuration file. This table displays the INI settings under group headings in brackets, for example, [Logging], in the order the groups appear in the INI file. Each setting offers two or more options, defined in the table below along with a description of each setting and its options. Use this table as a guide when customizing the file.

Group Setting Options Description

General server.ip.address Computer name or IP address

The address of ImageNow Server

The default is set during installation.

server.ip.port Any valid port number The port number of ImageNow Server

The default is 6000.

enable.anonymous. login

TRUE

FALSE

TRUE allows the MFP user to perform ImageNow Interact for eCopy tasks without loggin in.

The default is FALSE.

Logging debug.level.file 0 through 6 The level of detail saved in the log file in Program Files\ImageNow6\ \ecopy\log\ folder.

The default is 0.

Serial Number

serial.number.format <%##d>] <%##d>[string] [string]<%##d>

Examples:

<%8d> <%07d>[Jan09] [ID_Num ]<%04d>]

The definition of serial number format, where string is any text that accompanies the serial number and ## can be:

• an integer specifying the maximum number of digits in the serial number but suppressing leading zeros.

• zero followed by an integer, which results in the same format as above but including leading zeros to fill out the maximum specified number of digits.

< > means a variable value. This part of the format is required.

[ ] means a constant value. This part of the format is optional.

Serial Number

(continued)

serial.number.next The value varies with the format.

Examples: 1 0000000Jan09 ID_Num0001

The value of the serial number given to the first document created in a session. The value is increased by 1 for each subsequent document. The string must match the format defined by the serial.number.format parameter.



[button name]

button.enabled TRUE

FALSE

Show the button name button in the ShareScan OP window, where button name is a placeholder for the name you assign to the capture profile.

The default is TRUE.

restrict.viewable. users. to

A comma-delimited list of users as defined by an ImageNow manager.

Example:

rthompson, wtrilling, chowatt

Allows only the named users to view and use the capture profile.

image.processing. enable.deskew

TRUE

FALSE

Straighten slanted images after the user clicks the Submit button.


image.processing. enable.despeckle

TRUE

FALSE

Remove groups of black pixels surrounded by white pixels (or white pixels surrounded by black pixels) from images after user clicks the Submit button.


image.processing. scale.dpi

0 or any positive integer Scanning resolution in dots per inch. Specifying 0 causes ImageNow Interact for eCopy to use the scale setting of the MFP device.

The default is 0.

use.datacapture TRUE

FALSE

Toggle DataCapture processing. When enabled, this setting causes Interact to ignore some other parameters. For more information, refer to the “How using DataCapture affects other settings” section in this guide.


[button name]

(continued)

bypass.qa TRUE

FALSE

When images are sent to ImageNow, this setting causes ImageNow Interact for eCopy to skip the QA step in the batch grid.


datacapture. template

Any valid DataCapture template name

The exact name of the template to use with DataCapture processing. If DataCapture is enabled, you must specify this value. The template you name must be defined in ImageNow before you perform the scanning.



datacapture.scan. user.name

Any ImageNow user name

Allows a user who is not the owner or a manager to access the ImageNow batch viewer to inspect or verify the results of DataCapture processing.

append.failed.to. last.successful

TRUE

FALSE

For any image from which DataCapture could not extract values, append that image to the most recent document in the batch from which DataCapture was able to extract data.


drawer.display TRUE

FALSE

Show the ImageNow drawer field ShareScan OP window.


drawer.user. modifiable

TRUE

FALSE

Allow the MFP user to select a different drawer value.


drawer.default.value Any drawer name defined on the ImageNow Server to which the images are submitted.

Preset the value in the drawer field.

The default is DEFAULT.

doctype.display TRUE

FALSE

Show the ImageNow document type field in the ShareScan OP window.


doctype.user. modifiable

TRUE

FALSE

Allow the MFP user to select a different document type value.


[button name]

(continued)

doctype.default. value

Any document type name defined on the ImageNow Server to which the images are submitted.

Preset the value in the document type field.

The default is DEFAULT.

doctype.list Any document type list name defined on the ImageNow Server to which the images are submitted.

Limit the range of document types displayed in the ShareScan OP window to those document types assigned to the specified document type list.

pages.per. document.display

TRUE

FALSE

Show the Number of pages per document field and the Add all pages to a single document field in the ShareScan OP window.




pages.per. document.value

0 or positive integer The number of pages submitted together as a single ImageNow document.

0 means all scanned pages added to a single multi-page document.

1 means each scanned page becomes its own single-page document.

2, 3, 4, and so on indicate the number of scanned pages that are included in each multi-page document.

The default is 0.

pages.per. document.user. changeable

TRUE

FALSE

Allow the user to change the value in the Number of pages per document field.


workflow.queue. display

TRUE

FALSE

Show the WF Queue list in the ShareScan OP window.


workflow.queue. modifiable

TRUE

FALSE

Allow the MFP user to select a queue in the WF Queue list.

The default is TRUE

workflow.default. value

The name of any queue that is defined for the ImageNow Server to which images are submitted.

Preset the name displayed in the WF Queue list in the ShareScan OP window.

The default is START.

[button name]

(continued)

field1.display TRUE

FALSE

Show Field1 in the ShareScan OP window.


field1.user. modifiable

TRUE

FALSE

Allow the MFP user to enter a different Field1 value.


field1.default.value Any string Preset the Field1 value.

field1.display.name Any string Enter a Field1 label in the ShareScan OP window.

field2.display TRUE

FALSE

Show Field2 in the ShareScan OP window.


field2.user.modifiable TRUE

FALSE





field2.default.value Any string Preset the value in Field2.


field3.display TRUE

FALSE

Show the ImageNow Field3 field in the ShareScan OP window.



TRUE

FALSE



field3.default.value Any string Preset the value in the Field3 field.


field4.display TRUE

FALSE



[button name]

(continued)


TRUE

FALSE

Allow the MFP user to enter a different Field4 value. The default is TRUE.



field5.display TRUE

FALSE




TRUE

FALSE





custom.property1. name

name of a custom property in ImageNow; this is case-sensitive

Specify a custom property defined in ImageNow. If it matches a custom property associated with the document type currently selected in the doctype field, the custom property name and its value appear in the ShareScan OP window.



custom.property1. user.modifiable

TRUE

FALSE

Allow the user to change the value of the corresponding custom property.

custom.property#. name

name of a custom property in ImageNow; this is case-sensitive

You can include as many custom property statements as you need. # is a placeholder for an integer. If the same custom property is associated with multiple document types, enter only one statement for that custom property.

custom.property#. user.modifiable

TRUE

FALSE

Allow the user to change the value of the corresponding custom property.


Index anonymous login ................................................ 8

auto numbering ................................................ 11

capture profile

creating ........................................................... 9 examples ...................................................... 21

change scanning resolution ............................. 12

changing values, allowing ................................ 10

clean images .................................................... 12

custom properties fields ................................... 13

DataCapture

enabling ........................................................ 15

default value, changing .................................... 13

deskew ............................................................. 12

despeckle ......................................................... 12

document types, limiting display of .................. 11

formatting the serial number .............................. 8

hiding a capture profile ..................................... 10

hiding a field ..................................................... 10

installation .......................................................... 5

installing Fax Agent............................................ 5

numbering of documents ................................. 11

pages per document .................................. 11, 12

password, logging in without .............................. 8

scaling an image .............................................. 12

scan user, creating........................................... 14

scanning resolution .......................................... 12

serial number

formatting ....................................................... 8 starting value .................................................. 9

showing a capture profile ................................. 10

showing a field ................................................. 10

starting value of serial numbers ......................... 9

user editing of values ....................................... 10

workflow queue, specifying .............................. 12

Documents

ImageNow Interact for eCopy - Kofax Interact for eCopy Installation and Setup Guide Page 7 of 30 Customiz e ImageNow Interact for eCopy After you install ImageNow Interact for eCopy,