ImageNow Interact for Xerox

Transcription

1 ImageNow Interact for Xerox Installation and Setup Guide ImageNow Version: 6.7. x Written by: Product Documentation, R&D Date: September 2016

2 2014 Perceptive Software. All rights reserved CaptureNow, ImageNow, Interact, and WebNow are trademarks of Lexmark International Technology SA, registered in the U.S. and other countries. Perceptive Software is a stand-alone business unit within Lexmark International Technology SA. All other brands and product names mentioned in this document are trademarks or registered trademarks of their respective owners. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, or any other media embodiments now known or hereafter to become known, without the prior written permission of Perceptive Software.

3 Table of Contents About Interact for Xerox... 6 Interact for Xerox installation... 6 Install ImageNow Interact for Xerox on Windows... 7 Install ImageNow Interact for Xerox for Tomcat... 7 Open a firewall port... 9 Sharing web applications on the same web application server... 9 About web application installation... 9 Configure your web application server to run multiple web applications... 9 Test the connection Configure ImageNow Server Install the ImageNow Interact for Xerox license About privileges for the Xerox Interact Devices group Assign drawer privileges Assign the Single Mode capture privilege Configurations for special purposes Create custom properties for system variables Assign queue privileges Designate a scan user for DataCapture Xerox Extensible Interface Platform Compatibility requirements Verify custom services installation Install custom services Enable custom services Enable Secure Socket Layer Enable Scan Template Management Service Configure Interact for Xerox ImageNow Interact for Xerox Installation and Setup Guide Page 3 of 45

4 Modify options outside of the profile definition Set logging behavior Profile definitions Overview Create an ImageNow Interact for Xerox profile definition About MFP group names Restrict the application to certain MFPs Show or hide an application in the MFP control panel Turn off One Touch Scanning mode Document key settings in the profile definition Show or hide a field Change the default value displayed for a field Create an exclusive list of values for a field Allow a user to change a value Allow a user to change custom property values Using DataCapture in the profile definition Enable DataCapture processing Send the profile definitions to an MFP Test the Application Using Interact for Xerox Use One Touch Mode Use Application Selection mode Troubleshoot ImageNow Interact for Xerox Scanned documents don't appear in ImageNow ImageNow Interact for Xerox does not have security access to server objects Appendix A: Profile Definitions Sample for One Touch Scanning mode ImageNow Interact for Xerox Installation and Setup Guide Page 4 of 45

5 Sample for One Touch Scanning mode with DataCapture Sample for Application Selection mode Appendix B: System Variables Appendix C: INI Configuration Tables INInteractXerox.ini settings INXeroxProfiles.ini settings Index ImageNow Interact for Xerox Installation and Setup Guide Page 5 of 45

6 About Interact for Xerox ImageNow Interact for Xerox is a software application that lets any Xerox Multifunction Product (MFP) user convert paper documents to electronic images, index them, and store them in an ImageNow system all with a few button clicks on the printer's control panel. Once captured, the document is immediately available for subsequent retrieval and optional workflow processing using ImageNow Client or WebNow. ImageNow Interact for Xerox requires you to have Microsoft WSE 3 for the Xerox client Registration working. Interact for Xerox is licensed per device. Your ImageNow Server software must match the version number of ImageNow Interact for Xerox. For information about supported J2EE application servers to use with ImageNow Interact for Xerox, refer to the Product Technical Specifications specific to your ImageNow version. This document explains how to install ImageNow Interact for Xerox and how to change settings for ImageNow Interact for Xerox by modifying the INInteractXerox.ini and INXeroxProfiles.ini files. Refer to the Using Interact for Xerox section in this document for end user. Interact for Xerox installation The following steps outline the high-level procedures that you perform when installing ImageNow Interact for Xerox. Full instructions for each step appear in separate sections. 1. Install and test ImageNow Server and at least one ImageNow Client. 2. Install and test your J2EE-certified application server if it is not already installed. Note The application server must be a 32-bit server (not 64-bit). 3. Download and install Web Services Enhancements (WSE) 3.0 for Microsoft.NET from 4. Download and install ImageNow Interact for Xerox. 5. If necessary, open a firewall port for your web server. 6. Test the connection. After you complete these steps (see the following section for detailed instructions), continue to the Setup Overview section to learn how to create ImageNow Interact for Xerox profile definitions. ImageNow Interact for Xerox Installation and Setup Guide Page 6 of 45

7 Install ImageNow Interact for Xerox on Windows In this section, follow the instructions for the web application server you are using, open a firewall port, and then test the connection. Interact for Xerox requires you to have Microsoft WSE 3 for the Xerox client Registration working. Install ImageNow Interact for Xerox for Tomcat Perform the following steps if you run ImageNow Interact for Xerox on a Tomcat web application server. 1. Download Interact for Xerox, using the following substeps: 1. Go to the Perceptive Software website at click Customer Portal, enter your user name and password, and then click Downloads. 2. In the Product Downloads page, download the following files to a temporary directory on your computer: The product installer The product readme 3. Review the product readme. 4. Unzip the installer if applicable. 2. Install Interact for Xerox, using the following substeps: 1. Stop the web server if it is currently running. 2. Double-click the EXE file you just downloaded. 3. In the Welcome to the Installation Wizard for ImageNow Interact for Xerox page, click Next. 4. In 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. 5. In the ImageNow Server Information page, type the Server name/ip address and Port number of the ImageNow Server where ImageNow Interact for Xerox will submit documents and then click Next. 6. In the Web Application Server page, select Apache Tomcat and click Next. 7. In the Destination Folder page, if you need to change the destination folder, click Change and select the folder you want. To continue, click Next. 8. In the Ready to Install the Program page, click Install. 9. Optional. If the Show the Windows Installer log check box appears, select the check box to view the log file. ImageNow Interact for Xerox Installation and Setup Guide Page 7 of 45

8 3. In the Installation Wizard Completed page, click Finish. ImageNow Interact for Xerox Installation and Setup Guide Page 8 of 45

9 Open a firewall port Regardless of the web server you are using, you must have a firewall port open. If you have already opened a firewall port for the web application server on which ImageNow Interact for Xerox will run, skip this procedure. 1. Open the Windows utility that manages the firewall on the web application server computer. For example, on Windows 2003, click Start, point to Settings, point to Control Panel, click Windows Firewall, and then click the Exceptions tab. 2. Click Add Port. 3. In the Add a Port dialog box, in the Name box, type the name of the web application server that will be using the port; for example, Tomcat. 4. In the Port box, type the port number, for the Apache Tomcat web server, the default port is Make sure TCP is selected and click OK. 6. In the Windows Firewall dialog box, click OK. Sharing web applications on the same web application server You can configure your web application server to run multiple web applications on the same server. For example, you can run WebNow and Interact for Xerox on the same Tomcat server. Any web application that uses the INDesJNI65.dll file must share the encryption.jar file to run an additional web application on the same web application server. About web application installation When you install multiple web applications using the same web application server, you store each web application in a directory on the web application server. The default file location varies for each web application server. Examples are outlined below. Web Application Server Apache Tomcat Apache Tomcat Sample Web Application WebNow Interact for Xerox Default Installed Directory [drive:]\program Files\Apache Software Foundation\Tomcat <version>webapps\webnow [drive:]\program Files\Apache Software Foundation\Tomcat <version>webapps\xerox-interact Configure your web application server to run multiple web applications 1. Stop the web application server and close all internet browsers. ImageNow Interact for Xerox Installation and Setup Guide Page 9 of 45

10 2. In the [drive:]\program Files\Apache Software Foundation\Tomcat <version> directory, create a folder titled shared. 3. In the [drive:]\program Files\Apache Software Foundation\Tomcat <version>\shared directory, create a folder titled lib. 4. Navigate to the directory that stores a web application on your web application server. This directory varies depending on the web application server you use. Refer to the table above for an example directory path. 5. In the ImageNow web application directory, open the WEB-INF directory. 6. In the WEB-INF directory, open the lib directory and cut the encryption.jar file. 7. Navigate to the shared directory that you created for your web application server, open the lib folder, and then paste the encryption.jar file. 8. Delete the encryption.jar from each ImageNow web application lib directory associated with individual web applications installed on the server. 9. In the [drive:]\program Files\Apache Software Foundation\Tomcat <version>\conf\ folder, open the catalina.properties file. 10. Set the shared.loader setting to the following value: shared.loader=${catalina.base}/shared/lib,${catalina.base}/shared/lib/*.jar. 11. Start the Apache Tomcat web server. Test the connection Regardless of the web application server you use, before you proceed, test the connection. 1. Make a note of the IP address of the web application server computer. To do this: 1. Click Start and click Run. In the Run dialog box, type cmd and click OK. 2. In the command window, type ipconfig and press ENTER. 3. Under Ethernet adapter Local Area Connection, copy the number in the IP Address row. 4. Close the command window. 2. On a different computer, use a web browser to connect to this URL: address>:<server port number>/interact-xerox/label.xml where <IP address> is the address you copied earlier in this procedure and <server port number> is the port opened for your web server application, as described in the Open a firewall port section. ImageNow Interact for Xerox Installation and Setup Guide Page 10 of 45

11 3. If the browser displays a page of XML code, such as that shown in the following example, you have confirmed that your web server is able to access files created by ImageNow Interact for Xerox. <?xml version="1.0" encoding="utf-8"?> <displaytext> <label>imagenow</label> <description>scan and Send Document to ImageNow</description> </displaytext> ImageNow Interact for Xerox Installation and Setup Guide Page 11 of 45

12 Configure ImageNow Server After installing ImageNow Interact for Xerox, use the following procedures to install the ImageNow Interact for Xerox license and grant access privileges to a customized security group. Install the ImageNow Interact for Xerox license Prior to performing the following procedure, make sure you obtain an ImageNow Interact for Xerox license. The type of license you purchase depends on the number of MFPs that run ImageNow Interact for Xerox applications. Contact your Perceptive Software representative to obtain the required license. 1. Download the ImageNow Interact for Xerox license to the folder on your ImageNow Server computer where you have saved your other ImageNow license files. 2. In the ImageNow login screen, in the menu bar, click License Manager. 3. In the License Management dialog box, select Upload Licenses and click OK. 4. Browse to the folder that contains the ImageNow Interact for Xerox license. 5. Double-click the license and, in the ImageNow License Manager dialog box, click Upload. 6. In the License Generation Server Information dialog box, enter the values required for user authentication and server information and then click OK. 7. When the Successfully uploaded license message appears, click OK. 8. Restart ImageNow Server. About privileges for the Xerox Interact Devices group When you enter your license information during installation and after you restart ImageNow Server, ImageNow Interact for Xerox automatically creates a group named Xerox Interact Devices. Therefore, when setting up ImageNow Interact for Xerox, you do not need to create any ImageNow users or groups in addition to the one you are already using with ImageNow Server. You must, however, set security privileges for the Xerox Interact Devices group. To perform the following procedures, you must log into ImageNow Server as a user with management privileges, a manager, or the owner. Important Any time you make a change that involves items in the ImageNow Resource Manager, you must stop your web application server before implementing changes and restart it after the changes are complete. To assign privileges for the group, you perform the following actions, described in the following procedures: ImageNow Interact for Xerox Installation and Setup Guide Page 12 of 45

13 1. Assign drawer privileges. 2. Assign the Single Mode capture privilege. 3. Optional. Create custom properties for system variables. 4. Optional. Assign queue privileges. ImageNow Interact for Xerox Installation and Setup Guide Page 13 of 45

14 Assign drawer privileges The following steps explain how to assign drawer privileges. 1. Start ImageNow Management Console and log in. 2. In the left pane, click Groups. 3. On the Security tab, click Xerox Interact Devices and click Modify. 4. In the Security Settings Xerox Interact Devices dialog box, perform the following substeps: 1. On the Drawer Privileges tab, in the Drawer list, select the drawer to which you want to grant access to MFP users. 2. In the Privilege list, under Content, click the column in front of Create/Append until appears. 3. Repeat these substeps for each drawer to which you want to grant access to MFP users. 5. Click OK. Assign the Single Mode capture privilege The following steps explain how to assign the Single Mode capture privilege. 1. Start ImageNow Management Console and log in. 2. In the left pane, click Groups. 3. On the Security tab, click Xerox Interact Devices and click Modify. 4. In the Security Settings Xerox Interact Devices dialog box, on the Global Privileges tab, scroll to Capture and click the column in front of Single Mode until appears. 5. Click OK. Configurations for special purposes The following sections describe procedures required for those applications of ImageNow Interact for Xerox that need to track MFP statistics, route new documents to a workflow queue, or extract values from scanned images using DataCapture. Create custom properties for system variables You can optionally create custom properties to capture system variable information generated when you scan documents with ImageNow Interact for Xerox. This information can include scan resolution or the model number of the MFP. Interact retains the value of the system variable at the time of scanning as a custom property value in the document. You can also use the INXeroxProfiles.ini file to assign system variables to document keys such as Field1, Field2, and Field3. ImageNow Interact for Xerox Installation and Setup Guide Page 14 of 45

15 Note Any system variable assigned to a custom property does not appear in the MFP control panel, even when the custom.properties.user.modifiable parameter is set to in the profile definition. 1. On the ImageNow toolbar, click Manage. 2. In the left pane, click Custom Properties and click New. 3. In the Custom Property dialog box, give the custom property a name that indicates its purpose, select String as Type, and then type the value in the Default value box. 4. Copy the same value name into the Sample box and click OK. 5. In the left pane, click Document Types and select the document type to which the custom property will be added and click Modify. 6. In the Document Types dialog box, perform the following substeps: 1. Select the new custom property in the Available list and click Add to move the property to the Added list. 2. Repeat these substeps to add custom properties and modify other document types as needed. 7. Click OK. Assign queue privileges If you want ImageNow Interact for Xerox to add newly scanned documents to workflow queues automatically, use this procedure to grant access to all of the queues that will receive documents. 1. On the ImageNow toolbar, click Manage. 2. In the left pane, click Workflow, select the workflow, and then click Modify. 3. In the ImageNow Workflow Designer window, perform the following substeps: 1. Double-click the queue. 2. In the Queue Properties dialog box, in the left pane, click Users and click New. 3. In the Add Workflow User dialog box, on the Groups tab, under Available Groups, click Xerox Interact Devices, click Add, and then click OK. 4. In the Queue Properties dialog box, in the Xerox Interact Devices row, click in the Add column until appears. 5. Click OK. 6. Repeat these substeps for each workflow and queue to which you want to grant access to MFP users. 4. On the File menu, select Close to close the ImageNow Workflow Designer window. ImageNow Interact for Xerox Installation and Setup Guide Page 15 of 45

16 Designate a scan user for DataCapture If your ImageNow Interact for Xerox profile definition uses DataCapture processing, perform the following procedure. The generic scan user name you create in this procedure does not need to correspond to an actual ImageNow user. This name is used only as an identifier for a DataCapture setting in the INXeroxProfiles.ini file. 1. Start ImageNow Management Console and log in. 2. In the left pane, click Users and Groups. 3. On the Users tab, click New and create a user with a generic name, such as ScanUser. Note Do not assign any privileges to this user. 4. 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, 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 scan user you created previously, click Add, and then click OK. 4. In the Modify User Profile User Name dialog box, click OK. 5. Repeat these substeps for any other users who require access to the Batch grid for processing DataCapture results. 5. Edit the INXeroxProfiles.ini file and go to the profile definition that enables DataCapture processing. 6. Set datacapture.scan.user.name to the generic scan user you created previously, save, and then close the file. Note Do not leave datacapture.scan.user.name unassigned, because this user name is required for DataCapture to work properly. Xerox Extensible Interface Platform Xerox Extensible Interface Platform (EIP) is a software platform upon which you can use standard webbased tools to create server-based applications that you can configure for the Xerox multifunction printer s (MFP) touch-screen user interface. ImageNow Interact for Xerox Installation and Setup Guide Page 16 of 45

17 Compatibility requirements To install a custom EIP application on a device, the device must be custom services capable and have the custom services option installed and enabled. The Xerox service representative or the system administrator may have installed this option. Verify custom services installation Complete the following steps to verify custom services installation: 1. Browse to the device using a web browser and enter the IP address or host name of the device as the destination location. 2. Select the Properties tab. 3. On the Properties page, select Services, and then Custom Services. If a Custom Services selection does display under the Custom Services heading, the custom services option was not installed. Note Custom Services is listed twice. 4. Do one of the following actions: If custom services are not installed, continue to the Install custom services section. If custom services are installed, continue to the Enable Secure Socket Layer section. Install custom services Complete the following steps to install custom services: 1. Browse to the device using a web browser and enter the IP address or host name of the device as the destination location. 2. Select the Properties tab. 3. On the Properties page, select General, Machine Software, and then Manual Upgrade. 4. Note On some devices, Machine Software may be located under Services. 5. Browse to the installcustomservices.dlm file that is part of the EIP SDK and install the software. Note You can find the installcustomservices.dlm file at To locate the file, search for your work center drivers and downloads. 6. Restart your device. Important After restarting your device, complete the steps in the Enable custom services, Enable Secure Socket Layer, and Enable Scan Template Management Service sections. ImageNow Interact for Xerox Installation and Setup Guide Page 17 of 45

18 Enable custom services Complete the following steps to enable custom services: 1. Browse to the device using a web browser and enter the IP address or host name of the device as the destination location. 2. Select the Properties tab. 3. On the Properties page, select Services and Custom Services. Note If Custom Services is not available, the device may not be custom services capable. Contact your Xerox representative for assistance. Enable Secure Socket Layer Complete the following step to enable Secure Socket Layer (SSL): Select Enabled and click Apply. Enable Scan Template Management Service Complete the following steps to enable the Scan Template Management service. 1. Browse to the device using a web browser and enter the IP address or host name of the device as the destination location. 2. On the Properties tab, select Services and, depending on the device, select Workflow Scanning or Network Scanning. 3. Select Scan Template Management. 4. Enable the Scan Template Management service. For devices such as the WorkCentre 5700 series, under Template Management Service, select the Enabled check box. For devices such as the WorkCentre 7300 series, click Settings, select the Enabled check box for Template Management Service, and then select Save. Note Refer to the System Administrator Guide for your Xerox device if the steps for enabling the Scan Template Management service are different for your device. ImageNow Interact for Xerox Installation and Setup Guide Page 18 of 45

19 Configure Interact for Xerox After you finish setting up ImageNow Server to receive documents from ImageNow Interact for Xerox, you need to edit two initialization (INI) files to customize ImageNow Interact for Xerox. The first section of customizing instructions contains tasks you can perform using the INInteractXerox.ini file. The second, longer section contains tasks you must perform using the INXeroxProfiles.ini file. Modify options outside of the profile definition This section describes settings that affect the behavior of ImageNow Interact for Xerox globally. You can only change these options by updating the INI file and not by updating parameters within a profile definition. To perform any of the customizing tasks in this section, do the following steps: 1. Browse to the \xerox-interact\web-inf folder in your file system, which is the same path as your web server. 2. Make a backup copy of the original INInteractXerox.ini file in case you want to restore default behavior to ImageNow Interact for Xerox. 3. Open the INInteractXerox.ini file with a text editor. Make the changes you need, as described in the following sections. 4. Save the file when you finish modifying it. The modifications you can make to INInteractXerox.ini include: Changing the ImageNow Server name. Optional. Setting logging behavior. Optional. Setting the number of retries for sending documents to ImageNow Server. Set logging behavior You normally leave logging switched off. However, if instructed by your Perceptive Software Product Support representative, in the [Logging] section, set logging.enabled to. The default folder for the log file, called XeroxInteract_<yyyymmdd>.log, is the root level of the file system, where <yyyymmdd> is a placeholder for the date the log was last updated. The following example demonstrates how to change the path to the log file, and set log.directory to the path you want. log.directory=c:\log files\interactxerox log files ImageNow Interact for Xerox Installation and Setup Guide Page 19 of 45

20 Profile definitions The following sections describe the power and flexibility of ImageNow Interact for Xerox custom applications. A profile definition contains all the information your MFP needs to process a particular type of scanning job while requiring minimal input from the user. You can create as many profile definitions as you need, although the user can work with only one application at a time. When sent to an MFP, applications appear in the control panel of the MFP, each in its own row, as illustrated in the following section. ImageNow Interact for Xerox Installation and Setup Guide Page 20 of 45

21 Overview Each application is defined in a section of the INXeroxProfiles.ini file. You can hide an application from this control panel by disabling it, which allows you to preserve the definition for later reuse. ImageNow Interact for Xerox provides two modes of interaction with the user: One Touch Scanning and Application Selection. In One Touch Scanning mode, the MFP user clicks one time to initiate scanning and automatic indexing. In this case, all the index values are preconfigured. You can confirm that your MFP is configured for One Touch Scanning mode if a button in the control panel precedes each application. In Application Selection mode, the MFP user selects the index values assigned to the documents the user is scanning. The number of user choices in this mode depends on how you set up the profile definition. Your MFP is configured for Application Selection mode if no buttons precede the applications in the control panel. When you finish creating your profile definitions, you must send them to the MFP for testing before making them available to users. For more information, refer to the Test the application section. User-modifiable values for ImageNow Interact for Xerox fall into two categories: ImageNow settings, such as drawer or workflow queue, and MFP scanner settings such as page orientation or file type. The settings appear in the MFP control panel in scrolling lists of fields or as option buttons. As the application designer, you control how these fields behave by editing statements in the profile definition. The following step-by-step procedures show you how to display fields, preset their values, and grant users the option of selecting or entering their own values for these fields. If you want to inspect completed profile definitions, refer to the Annotated Profile Definitions section in the Appendix. To perform any of the customizing tasks in the following sections, do the following steps: 1. In the C:\Program Files\<your web application folder>\interact-xerox\web-inf folder, make a backup copy of the original INXeroxProfiles.ini file in case you want to restore default behavior to ImageNow Interact for Xerox. 2. Open the INXeroxProfiles.ini file with a text editor. Make the changes you need, as described in the following sections. 3. Save the file when you finish modifying it. Create an ImageNow Interact for Xerox profile definition The following procedure explains how to create an application by beginning with the generic template that is installed with ImageNow Interact for Xerox. You can also start with an application that already ImageNow Interact for Xerox Installation and Setup Guide Page 21 of 45

22 contains many features you need and requires only a few changes to serve a new function or a different group of MFP users. 1. Perform one of the following options: To create a new application from the template at in the INXeroxProfiles.ini file, copy the first section, called [General], which extends up to the next set of square [ ] brackets. This section is called a profile definition. To create a new application using an existing profile definition as a template, make a copy of that part of the INI file instead of copying the [General] section. 2. Paste the copied section at the end of the INXeroxProfiles.ini file. Applications appear on the MFP control panel in the same order as they appear in the INI file. Note that the [General] application does not appear on the control panel because setting the profile.enabled property to false disables it. Note The term profile in the INXeroxProfiles.ini file is a synonym for profile definition. 3. Rename the new profile definition with the name you want inside the initial square brackets, for example: [HR Documents] 4. Edit the settings for document keys, custom properties, and other options, as explained in the following sections. 5. Save the INI file and proceed to the Test the application section. Note None of the changes you make to the profile definition appear on the MFP control panel until you save the INI file and restart the web server software. About MFP group names With ImageNow Interact for Xerox, you can target individual MFPs for one or more applications so that the applications appear on the selected MFPs and no others. You do this by defining group names and specifying that group name in the URL that you send to the MFP. In the following example, two group names are defined for all the MFPs in a facility: Floor 1 and Floor 2. The HR application is sent only to MFPs in the Floor 2 group, but the AP profile definition is sent to both groups. Selective display of applications on different MFPs [HR] <other settings> groups.name=floor 2 [AP] <other settings> ImageNow Interact for Xerox Installation and Setup Guide Page 22 of 45

23 groups.name=floor 2,Floor 1 If you use this feature, it is a good idea to maintain an up-to-date map of the groups you created as a reminder of where the MFPs are located and which departments can access them. Restrict the application to certain MFPs The following procedure shows you how to assign one or more MFP group names to an application. 1. In the INXeroxProfiles.ini file, go to the profile definition you want to change. 2. Type the names of the targeted MFP groups in the groups.name setting, as shown in the following example for the [AP] application. groups.name=floor2,floor1 Note Group names must not contain an ampersand (&), a slash (/), back slash (\), or a question mark (?). ImageNow Interact for Xerox Installation and Setup Guide Page 23 of 45

24 3. Save the INXeroxProfiles.ini file. 4. Send the profile definition to the MFPs. Refer to the Send the profile definition to the MFP section, which includes an option for assigning a group name. In the example used here, you send the profile definitions to each MFP in the Floor 2 group (using?group=floor%202) and to each MFP in the Floor 1 group (using?group=floor%201). Show or hide an application in the MFP control panel You can use this feature to hide an application that is under construction or that you use as a template for other applications. 1. In the INXeroxProfiles.ini file, go to the profile definition you want to change. 2. Immediately below the application name, set profile.enabled to (show the application) or (hide the application). Turn off One Touch Scanning mode When you turn off One Touch Scanning mode, you enable Application Selection mode. You must both disable one touch scanning in the profile definition and make sure that the URL that you send to the MFP does not enable one touch scanning, as explained below. 1. In the INXeroxProfiles.ini file, go to the profile definition you want to change. 2. Scroll to the onetouchscan setting and set onetouchscan.enabled to false. 3. Save INXeroxProfiles.ini and send the profile definition to the MFP. Refer to the Send the profile definition to the MFP section and do not include the?onetouchscan=true action. Note Any profile definitions that include the setting onetouchscan.enable=true do not appear on this MFP. Document key settings in the profile definition The procedures in this section define the index values assigned to new documents so that you can find them in the ImageNow repository. Document keys include Drawer and Document Type, whose values are defined only by the ImageNow manager, and Field1, Field2, Field3, Field4, and Field5, whose values MFP users can create or reuse at the time a document is sent to ImageNow. Every document must have values assigned to Drawer and at least two other document keys. In addition, you can define any number of custom properties for a document type. Custom properties, therefore, are a supplementary set of keys for documents that require more extensive indexing. These procedures explain how to show or hide specific document keys, including custom properties, in the MFP control panel and how to grant or deny the ability to change these values to the user at the MFP. ImageNow Interact for Xerox Installation and Setup Guide Page 24 of 45

25 ImageNow Interact for Xerox Installation and Setup Guide Page 25 of 45

26 Show or hide a field The following procedure determines whether the MFP user will see a specific field. It does not give the user the ability to change the value in the field. To do that, refer to the Allow a user to change a value section. 1. In the INXeroxProfiles.ini file, go to the profile definition you want to change. 2. Find the appropriate <object>.display field in the profile definition, where object is a placeholder for the item you are showing or hiding, such as drawer, Field1, or workflow.queue. 3. Change the values for the following settings: To display the item in the control panel, set <object>.display to true. To hide the item in the control panel, set <object>.display to false. Note By enabling display of the drawer, document type, or workflow.queue objects, the control panel displays a fixed list of the values previously defined for these objects. For document keys such as Field1 or Field2, or for a custom property, you can optionally prompt the user to enter a value. Change the default value displayed for a field A default value is a preset value for a field. You can either force the user to accept the value or let the user change it. Important ImageNow Server requires that every document must be submitted with at least three index keys defined: Drawer, Document Type, and any one of the following: Field1, Field2, Field3, Field4, or Field5. Therefore, when reviewing your profile definition, make sure that you have defined default values for the index keys. (You can always allow the user to select an alternate value for one or more keys.) 1. In the INXeroxProfiles.ini file, go to the profile definition you want to change. 2. Find the <object>.default.value setting that you want to change, where object is a placeholder for the item. 3. Set <object>.default to the default value you want, as in the example: drawer.default.value=vouchers Note Default values are case-sensitive. Create an exclusive list of values for a field You can display a group of values for a user to choose from when assigning a value to an index key, similar to the combo box control used in data entry applications. 1. In the INXeroxProfiles.ini file, go to the profile definition you want to change. ImageNow Interact for Xerox Installation and Setup Guide Page 26 of 45

27 2. Find the <object>.list.values setting that you want to change, where <object> is a placeholder for the item. 3. Set <object>.list.values to a comma-separated list of strings, as in the example. Do not type a space after the comma. field5.list.values=southeast,central,northwest You can select an option that appears in a column in the control panel. Note If you set a default value for an item that contains a list, the default value must be one of the items in that list. Allow a user to change a value The following procedure explains how to make a field modifiable by the MFP user or to deny that privilege to the user for a specific field. 1. In the INXeroxProfiles.ini file, go to the profile definition you want to change. 2. Find the <object>.user.modifiable field in the profile definition, where <object> is a placeholder for the item. 3. Set <object>.user.modifiable to or : to allow users to change the value for this field, as in the following example: field1.user.modifiable=true to prevent users from changing the value for this field, as in the following example: field2.user.modifiable=false Allow a user to change custom property values Custom properties are always associated with specific document types. You cannot reference them individually in the profile definition. The user sees only the custom properties associated with the selected document type. 1. In the INXeroxProfiles.ini file, go to the profile definition you want to change. To make all custom property fields mapped to the selected document type except those with assigned system variables in the Resource Manager user-modifiable, set custom.properties.user.modifiable to. To prevent users from changing any custom property fields with this setting, set custom.properties.user.modifiable to. ImageNow Interact for Xerox Installation and Setup Guide Page 27 of 45

28 Using DataCapture in the profile definition DataCapture processing is an optional data extraction feature of ImageNow Interact for Xerox that is available to customers who have installed and licensed DataCapture software to work with their ImageNow capture profiles. To use DataCapture, you must load the profiles as One-Touch scanning profiles. If you enable the DataCapture feature, you can specify three additional parameters specifically related to the DataCapture technology. With the DataCapture parameters set, ImageNow Interact for Xerox 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 user verify the data before the documents are moved from the batch grid to the document grid. When you enable DataCapture feature, none of settings for document keys, pages per document, or file type needs to be included in the definition because ImageNow Interact for Xerox ignores those settings when DataCapture processing is enabled. If you disable DataCapture in a profile definition, none of the DataCapture features described below are applied to the scanned images. Instead, documents scanned by the MFP are sent immediately to the ImageNow Client document grid. DataCapture profiles only display under the One-Touch mode. For detailed descriptions of DataCapture concepts and procedures, refer to ImageNow Help. Enable DataCapture processing The following steps include both mandatory and optional settings for the DataCapture feature. 1. In the INXeroxProfiles.ini file, find the button section that will include DataCapture processing and edit the four settings in the following steps. 2. Set use.datacapture setting to. Note If the use.datacapture setting is set to, Interact ignores the three settings described below. 3. To grant access to the scanned batch to a specific user, set datacapture.scan.user.name to the generic scan user name you created earlier. 4. To send the scanned images through the QA step in the batch grid of ImageNow Client, set the bypass.qa setting to. 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. 5. If you want to skip the QA step in the batch grid, in set the bypass.qa setting to. ImageNow Interact for Xerox Installation and Setup Guide Page 28 of 45

29 6. Set the datacapture.template setting value to the exact name of the template used with DataCapture processing. Do not leave this value blank. You must define the template you name in ImageNow Server before you perform the scanning. 7. 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 the append.failed.to.last.successful setting to true. The appended image then becomes a page in the last successful document; that is, it is assigned the same document key values as those of the document from which DataCapture could extra values. To save the image as a separate document that uses document key values copied from the inserverdc.ini file (located in the [drive]:\inserver6\etc folder), set the append.failed.to.last.successful setting false. The resulting document is indexed with document key values specified in the [Key Mapping] section of the inserverdc.ini file. It is not associated with the last document successfully ready by DataCapture. Send the profile definitions to an MFP Perform the following steps when you want to send new or modified profile definitions to your MFP. For multiple MFPs, repeat this procedure for each device. This procedure sends the configuration file, which contains all profile definitions. However, only enabled applications and those allowed by the groups.name option appear on the MFP control panel. Interact for Xerox requires you to have Microsoft WSE 3 for the Xerox client Registration working. Tip When testing new applications, send the configuration file to only one MFP and test them on that device. When you have verified that the applications are working to your satisfaction, send the updated configuration file to the other MFPs in your facility. 1. Make sure the MFP is on, ImageNow Server is started, and that you have a live IP connection to the MFP. 2. Stop and then restart the web server application. 3. Browse to the C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\interact-xerox folder. 4. Double-click the Xerox Registration Client.exe file. 5. In the Registration Client window, under Device Connection, complete the following substeps: 1. In the DNS or IP box, type the IP address of the MFP to which you want to send the profile definitions. 2. In the User Name box, type the user name for the MFP administrator. ImageNow Interact for Xerox Installation and Setup Guide Page 29 of 45

30 3. In the Password box, type the password for the MFP administrator. 4. Verify that Use SSL is selected. 6. Optional. Under Device Cert Trust, select any of the following check boxes: trust cert name. trust cert auth. truth expired cert. 7. Click Connect. 8. When you have successfully connected, click List. The system lists all the services available for your MFPs, including ImageNow custom services. 9. To create a new custom service, click Create New and, in the RegistrationDetailForm dialog box, complete the following substeps: 1. In the Registration Name box, type a name for your service and verify that Enabled is selected. 2. In the Service URL box, enter one of the following strings, depending on the scanning mode you want to enable, all a single line (without carriage returns): For Application Selection mode: address>:<port number>/interact-xerox/ For One touch Scanning mode: address>:<port number>/interact-xerox/?onetouchscan=true If you are using the MFP group names feature: address>:<port number>/interact-xerox/?group=<group name> where <group name> is a placeholder for one of groups in the group.names setting in your profile definition. If the name as entered in your groups.name= setting includes a space, replace the space with %20. Thus, if your included Floor 1 as part of your group names, when you send the application to that group, add?group=floor%201 at the end of the URL. If the group name you enter is not included in the group.names setting, the application does not appear on this MFP. For more information, refer to the About MFP group names section. 3. In the Description URL box, enter the following string: address>:<port number>/interact-xerox/label.xml Note The label.xml file contains the description text that displays next to the ImageNow icon on the Xerox device. ImageNow Interact for Xerox Installation and Setup Guide Page 30 of 45

31 4. In the Small Icon URL or Large Icon URL box, enter the following string: address>:<port number>/interact-xerox/<icon name> 5. In the Vendor box, type Perceptive Software or something similar to indicate the vendor associated to this custom service. 6. Click Create. The system adds your newly created custom services to the list. 10. Restart the web application server. Test the Application Before you proceed, make sure you sent the updated configuration file, which contains the profile definitions, to the MFP. 1. Go to the MFP, click the ImageNow button, and then select the new application. 2. Scan as many pages as necessary to use the options that you included in the application. 3. Return to your ImageNow Client computer and log in to the ImageNow Server where the documents captured by ImageNow Interact for Xerox are deposited. 4. Inspect the documents in ImageNow Explorer and ImageNow Viewer to verify that they are scanned and indexed according to your requirements. 5. If necessary, update your profile definitions, resend the configuration file, and repeat this procedure. ImageNow Interact for Xerox Installation and Setup Guide Page 31 of 45

32 Using Interact for Xerox In this section, you will learn how to scan documents using either One Touch mode or Application Selection mode. In One Touch mode, you need just a few clicks to initiate scanning and automatic indexing. All the index values are preconfigured, but you can still change scanner settings as needed. In Application Selection mode, it prompts you to select or enter index values to assign to the documents you scan. The number of choices you get depends on how the application was set up by the administrator. Use One Touch Mode This procedure explains how to scan pages into ImageNow using One Touch mode. 1. Load your pages into the auto-feeder of the MFP or place a single page on the glass pane (platen). 2. On your MFP device, select Features. 3. On the Features screen, select All Services. 4. On the All Services screen, select Custom Services. Note If Custom Services is not an option, select More Services until you see it listed. 5. On the Custom Services screen, select Send Document to ImageNow. 6. On the Select an application screen, if only one application appears in the list, press Scan. If multiple applications appear in the list, select the application you want and then select Scan. Use Application Selection mode The following procedure explains how to scan pages into ImageNow when you need to specify indexing and other information that is not accessible via One Touch scanning. 1. Load your pages into the auto-feeder of the MFP or place a single page on the glass pane (platen). 2. On your MFP device, select Features. 3. On the Features screen, select All Services. 4. On the All Services screen, select Custom Services. Note If Custom Services is not an option, select More Services until you see it listed. 5. On the Custom Services screen, select Send Document to ImageNow. 6. On the Select an application screen, select the application you want to associate to this document, and then press Next. ImageNow Interact for Xerox Installation and Setup Guide Page 32 of 45

33 7. Optional. On the Document Keys tab, select the field for the document key you want to modify and then do the following actions: If the field is modifiable, type a new name for the document key and click Save. If the field contains options, press the appropriate option from the list and click Done. If necessary, use the Up and Down arrows to scroll through the list Repeat for each document key you want to modify. Press Next when you are finished. 8. Optional. On the Custom Properties tab, press the field for the custom property you want to modify and do the following actions: If the field is modifiable, type a new name for the custom property and click Save. If the field contains options, press the appropriate option from the list and click Done. If necessary, use the Up and Down arrows to scroll through the list Repeat for each custom property you want to modify. Press Next when you are finished. 9. Optional. On the Workflow Queue tab, press the workflow queue you want to associate to this document. If necessary, use the Up and Down arrows to scroll through the list. 10. Optional. Your application may let you change scanner settings such as the document file type or page orientation. These options vary depending on the MFP model. On the Scan Settings tab, select the button of the option you need to change and then select from the values that appear. The following table shows examples of these options. Setting Choose from Duplex Scanning 1-sided, 2-sided, or 2-sided, rotate side 2 Original Type Color Format Orientation File Format Resolution Photo and text, Photo, or Text Black and white, Color, or Grayscale Portrait or Landscape TIFF, Multi-page TIFF, PDF, or JPEG 72 dpi, 100 dpi, 150 dpi, 200 dpi, 300 dpi, 400 dpi, or 600 dpi 11. Load your paper into the document handler and press Scan to start scanning. 12. Click Exit when the scan is successful. ImageNow Interact for Xerox Installation and Setup Guide Page 33 of 45