Interact for Xerox. Installation and Setup Guide. Perceptive Content Version: 7.1.x

Transcription

1 Interact for Xerox Installation and Setup Guide Perceptive Content Version: 7.1.x Written by: Product Knowledge, R&D Date: September 2016

2 2015 Perceptive Software. All rights reserved. Perceptive Software is a trademark of Lexmark International Technology S.A., registered in the U.S. and other countries. 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 Lexmark.

3 Table of Contents About Interact for Xerox... 5 Interact for Xerox installation... 5 Install Perceptive Interact for Xerox on Windows... 5 Install Perceptive Interact for Xerox for Tomcat... 5 Open a firewall port... 6 Test the connection... 6 Configure Perceptive Content Server... 7 Install the Perceptive Interact for Xerox license... 7 About privileges for the xeroxinteract user... 7 Assign drawer privileges... 7 Assign the Single Mode capture privilege... 8 Configurations for special purposes... 8 Create custom properties for system variables... 8 Assign queue privileges... 9 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 Modify options outside of the profile definition Set logging behavior Profile definitions Overview Create a Perceptive 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 Page 3 of 31

4 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 Send the profile definitions to an MFP Test the Application Using Interact for Xerox Use One Touch Mode Use Application Selection mode Troubleshoot Perceptive Interact for Xerox Scanned documents don't appear in Perceptive Content Interact for Xerox does not have security access to server objects Appendix A: Profile Definitions Sample for One Touch Scanning mode Sample for Application Selection mode Appendix B: System Variables Appendix C: INI Configuration Tables INInteractXerox.ini settings INXeroxProfiles.ini settings Index Page 4 of 31

5 About Interact for Xerox Perceptive 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 a Perceptive Content system, all with a few button clicks on the printer control panel. Once captured, the document is immediately available for subsequent retrieval and optional workflow processing using Perceptive Content Client or WebNow. Interact for Xerox requires you to have Microsoft WSE 3 for the Xerox client Registration working. Interact for Xerox is licensed per device. Your Perceptive Content Server software must match the version number of Interact for Xerox. For information about supported J2EE application servers to use with Interact for Xerox, refer to the Perceptive Content Technical Specifications specific to your Perceptive Content version. This document explains how to install Interact for Xerox and how to change settings for Interact for Xerox by modifying the INInteractXerox.ini and INXeroxProfiles.ini files. Refer to Using Interact for Xerox in this document for end user information. Interact for Xerox installation The following steps outline the high-level procedures that you perform when installing Interact for Xerox. Full instructions for each step appear in separate sections. 1. Install and test Perceptive Content Server and at least one Perceptive Content 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. 4. Download the Interact for Xerox file and install directly to your web server. 5. If necessary, open a firewall port for your web server. 6. Test the connection. After you complete these steps and review the following installation instructions, continue to the Setup Overview section for information on creating Interact for Xerox profile definitions. Install Perceptive 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 Perceptive Interact for Xerox for Tomcat Perform the following steps to run Perceptive Interact for Xerox on a Tomcat web application server. 1. Stop the web server if it is currently running. 2. Go to the Perceptive Software website at click Customer Portal, enter your user name and password, and then click Downloads. 3. In the Product Downloads page, download the WAR file to the [drive:]\program Files\Apache Software Foundation\Tomcat <version>\webapps directory on your computer. Page 5 of 31

6 4. Start the web server. 5. The WAR file you downloaded is extracted automatically in the [drive:]\program Files\Apache Software Foundation\Tomcat <version>\webapps directory when the web server is started. 6. Navigate to [drive:]\program Files\Apache Software Foundation\Tomcat <version>\webapps\<folder name>web-inf and open INInteractXerox.ini. 7. In INInteractXerox.ini, update server.name and server.port Open a firewall port You must have a firewall port open for your web server. If you have already opened a firewall port for the web application server on which Interact for Xerox will run, skip this procedure. 8. 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. 9. Click Add Port. 10. 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. 11. In the Port box, type the port number. The default port for the Apache Tomcat web server is Make sure TCP is selected and click OK. 13. In the Windows Firewall dialog box, click OK. Test the connection Regardless of the web application server you use, before you proceed, test the connection. 14. To make a note of the IP address of the web application server computer complete the following steps. 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. 15. On a different computer, use a web browser to connect to this URL: address>:<server port number>/<installation directory>/label.xml where <IP address> is the address you copied earlier in this procedure, <server port number> is the port opened for your web server application as described in the Open a firewall port section, and <installation directory> is the name of the directory where you installed Interact for Xerox on your local server. 16. 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 Interact for Xerox. <?xml version="1.0" encoding="utf-8"?> <displaytext> <label>perceptive Content</label> <description>scan and Send Document to Perceptive Content</description> </displaytext> Page 6 of 31

7 Configure Perceptive Content Server After installing Interact for Xerox, use the following procedures to install the Interact for Xerox license and grant access privileges to a customized security group. Install the Perceptive Interact for Xerox license Prior to performing the following procedure, make sure you obtain an Interact for Xerox license. The type of license you purchase depends on the number of MFPs that run Interact for Xerox applications. Contact your Perceptive Software representative to obtain the required license. 17. Download the Interact for Xerox license to the folder on your Perceptive Content Server computer where you have saved your other Perceptive Content license files. 18. In the login screen, in the menu bar, click License Manager. 19. In the License Management dialog box, select Upload Licenses and click OK. 20. Browse to the folder that contains the Interact for Xerox license. 21. Double-click the license and, in the License Manager dialog box, click Upload. 22. In the License Generation Server Information dialog box, enter the values required for user authentication and server information and then click OK. 23. When the Successfully uploaded license message appears, click OK. 24. Restart Perceptive Content Server. About privileges for the xeroxinteract user After you enter your Interact for Xerox license information during installation and restart Perceptive Content Server, Interact for Xerox automatically creates a user named xeroxinteract. Therefore, when setting up Interact for Xerox, you do not need to create any users or groups in addition to the one you are already using with Perceptive Content Server. You must, however, set security privileges for the xeroxinteract user. To perform the following procedures, you must log into Perceptive Content Server as a user or manager with the ability to administer global and department privileges. Important Any time you make a change that involves items in the 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 user, complete the following steps. 25. Assign drawer privileges. 26. Assign the Single Mode capture privilege. 27. Optional. Create custom properties for system variables. 28. Optional. Assign queue privileges. Assign drawer privileges The following steps explain how to assign drawer privileges. 1. In Management Console, in the left pane, under Select Department, select a department from the list. 2. In the left pane, click Users. Page 7 of 31

8 3. In the right pane, in the Search for users box, type all or some of the xeroxinteract user name and click Search. 4. In the Select a user list, double-click the xeroxinteract user. 5. In the Modify User Profile dialog box, in the left pane, click Privileges and perform the following substeps. 1. In the right pane, click Drawer Privileges. 2. In the Drawer list, select a drawer. 3. Under Privileges, under Content, click the column in front of Create/Append until appears. 4. Repeat these substeps for each drawer to which you want to grant access to MFP users. 6. Click OK. Assign the Single Mode capture privilege The following steps explain how to assign the Single Mode capture privilege. 1. In Management Console, in the left pane, under Select Department, select Cross Department Settings from the list. 2. In the left pane, click Users. 3. In the right pane, in the Search for users box, type all or some of the xeroxinteract user name and click Search. 4. In the Select a user list, double-click the xeroxinteract user. 5. In the Modify User Profile dialog box, in the left pane, click Global Privileges. 6. Under Privileges, under Capture, click the column in front of Single Mode until appears. 7. Click OK. Configurations for special purposes The following sections describe procedures required for those applications of Perceptive Interact for Xerox that need to track MFP statistics or route new documents to a workflow queue. Create custom properties for system variables You can optionally create custom properties to capture system variable information generated when you scan documents with Perceptive 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. 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 Perceptive Content 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. Page 8 of 31

9 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 Perceptive 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. In Management Console, in the left pane, under Select Department, select a department from the list. 2. In the left pane, click Workflow, then double-click the workflow process. 3. In the 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 then click Add. 3. In the Select Users and Groups dialog box, on the Users tab, double-click xeroxinteract and then click OK. 4. In the Queue Properties dialog box, in the xeroxinteract row, click in the Add column until appears. 5. Click OK. 6. Repeat these substeps for each workflow process and queue to which you want to grant access to MFP users. 4. On the File menu, select Close to close the Workflow Designer window. Page 9 of 31

10 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. 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. Perform 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. Page 10 of 31

11 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. Configure Interact for Xerox After you finish setting up Perceptive Content Server to receive documents from Perceptive Interact for Xerox, you need to edit two initialization (INI) files to customize Perceptive 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 Perceptive 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, complete 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. Page 11 of 31

12 2. Make a backup copy of the original INInteractXerox.ini file in case you want to restore default behavior to Perceptive 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 Perceptive Content Server name. Optional. Setting logging behavior. Optional. Setting the number of retries for sending documents to Perceptive Content 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 Profile definitions The following sections describe the power and flexibility of Perceptive 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. 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. Perceptive 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. Page 12 of 31

13 User-modifiable values for Perceptive Interact for Xerox fall into two categories: 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, complete 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 Perceptive 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 a Perceptive Interact for Xerox profile definition The following procedure explains how to create an application by beginning with the generic template that is installed with Perceptive Interact for Xerox. You can also start with an application that already 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 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. Page 13 of 31

14 About MFP group names With Perceptive 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> 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 (?). 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). Page 14 of 31

15 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 Perceptive Content repository. Document keys include Drawer and Document Type, whose values are defined only by the Perceptive Content manager, and Field1, Field2, Field3, Field4, and Field5, whose values MFP users can create or reuse at the time a document is sent to Perceptive Content. 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. 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. Page 15 of 31

16 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 Perceptive Content 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. 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 Page 16 of 31

17 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. 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, Perceptive Content 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\interactxerox 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. 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 custom services. Page 17 of 31

18 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 you 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 Perceptive Content icon on the Xerox device. 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 Perceptive Content 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 Perceptive Content Client computer and log in to the Perceptive Content Server where the documents captured by Perceptive Interact for Xerox are deposited. 4. Inspect the documents in Explorer and 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. Page 18 of 31

19 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 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 Perceptive Content. 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 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 Perceptive Content. 6. On the Select an application screen, select the application you want to associate to this document and then press Next. 7. Optional. On the Document Keys tab, select the field for the document key you want to modify and then perform 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. Page 19 of 31

20 8. Optional. On the Custom Properties tab, press the field for the custom property you want to modify and perform 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. Troubleshoot Perceptive Interact for Xerox This section describes what to do if Perceptive Interact for Xerox fails to send the scanned documents to Perceptive Content Server. Scanned documents don't appear in Perceptive Content Explanation: For all errors that occur when the web server and Perceptive Content Server are connected to the MFPs, the job is not retried, and the user is not notified of the failure. Solution: Review log files for error information. The standard output log (stdout_yyyymmdd.log) is located in the logs folder of the web server folder. This log reports connection errors. You might be asked to inspect this file by your Perceptive Software Product Support representative. Note To enable logging for Interact for Xerox, in the INInteractXerox.ini file, set logging.enabled to. Page 20 of 31

21 Interact for Xerox does not have security access to server objects Explanation: Each MFP that is licensed for Interact for Xerox is automatically included in a user called xeroxinteract. The control panel displays only index keys (such as Drawer or Document Type) to which security access is granted through the xeroxinteract user. If the xeroxinteract user cannot access a drawer required by the application, an error message appears and prevents you from submitting a document. If the xeroxinteract user can access the drawer but the drawer field is not displayed on the control panel, Interact for Xerox submits a document with the default drawer value copied from the INI file. If the xeroxinteract user does not have access to a workflow queue required by the application, the import to Perceptive Content Server succeeds but Interact does not add the document to the queue. Solution: To grant drawer or queue access, refer to the Assign drawer privileges or Assign queue privileges sections. To display fields in the MFP control panel, edit the appropriate profile definition in the INXeroxProfiles.ini file and refer to the Show or hide a field and Change the user s access to a field sections. Page 21 of 31

22 Appendix A: Profile Definitions The following profile definitions illustrate all of the options you can set when creating your own Interact for Xerox application. All profile definitions are inserted in a single INXeroxProfiles.ini file. The introduction of each section describes some of the highlights of the profile definition. Sample for One Touch Scanning mode The first sample application, called Resumes 1, is listed with the applications that appear after the user selects the Perceptive Content button in the MFP control panel. The Resumes 1 sample uses One Touch Scanning mode. The application sets default values for Drawer, Document Type, Field1, and Field2. Because this is one touch scanning, the MFP user is not prompted to enter any index key values. Therefore, the Field3, Field4, and Field5 document keys remain unassigned throughout the scanning procedure. No documents are added to a workflow queue. The profile definition assigns a list of available groups (First Floor and Second Floor) for this application. All scanned pages are saved as a single document. When the auto-feeder is empty, the Done/New Job page appears. The MFP scans only one side of each page and scans pages of differing sizes. The pages are scanned in portrait orientation, in black and white, at 200 dpi, and are saved in TIFF file format. [Resumes 1] profile.enabled=true onetouchscan.enabled=true groups.name=first Floor,Second Floor drawer.default.value=ap doctype.default.value=default workflow.default.value= field1.default.value=2009 Spring field2.default.value=gi Bill Approved field3.default.value= field4.default.value= field5.default.value= scan.setting.duplex.mode=false scan.setting.page.size=mixed scan.setting.page.orientation=portrait scan.settings.color.mode=mono scan.settings.resolution=200 scan.settings.file.type=tiff Page 22 of 31

23 Sample for Application Selection mode The third sample application, called Resumes 3, appears after Resumes 2 in the list of applications in the MFP control panel. One Touch Scanning mode is turned off, which turns on Application Selection mode. The drawer value is locked at AP because the application does not allow the user to change it. Likewise, the document type is locked at Default. The user can optionally select a different destination queue for the documents or accept the default queue, ApproveReq. The definition allows the user to select any of four values for Field1 and presets work study as the suggested folder value. The application displays all custom properties in the selected document type, except those to which system variables are assigned, and it allows the user to change the values. By default, the application makes each scanned page a separate document, but it allows the user to change pages per document setting. [Resumes 3] profile.enabled=true onetouchscan.enabled=false groups.name= drawer.display=true drawer.user.modifiable=false drawer.default.value=ap doctype.display=true doctype.user.modifiable=false doctype.default.value=default workflow.queue.display=true workflow.user.modifiable=true workflow.default.value=approvereq folder.display=true folder.user.modifiable=true folder.list.values=financial assistance,work study,navy scholarship,retiree program field1.default.value=orange field1.display.name=language field2.display=false field2.default.value=gi Bill Status field3.display=false field3.default.value= field4.display=false field5.display= custom.properties.user.modifiable=true Page 23 of 31

24 Appendix B: System Variables Perceptive Content Server or Perceptive Content Xerox for Interact generates the following variables at runtime. Perceptive Content Variable UniqueID Description Returns a unique ID from Perceptive Content Server. Interact generates values for the following variables at run time by the MFP that is scanning your documents. Xerox Variables HostName DeviceIPAddress DeviceName Description The host name of the device performing the scan. The current IP address of the device performing the scan. The name of the device performing the scan. Page 24 of 31

25 Appendix C: INI Configuration Tables This appendix describes all of the options available for setting up Interact for Xerox. The first section describes global settings, which appear in the INInteractXerox.ini file. The second section describes settings that vary from one profile definition to another, depending on which features are enabled for each definition. INInteractXerox.ini settings The following table provides definitions and sample data for the settings in the INInteractXerox.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 that are defined in the following table 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.name Computer name or IP address Specifies the address of the Perceptive Content Server. The default is localhost. server.port Any valid port number Specifies the port number of Perceptive Content Server. The default is Logging logging.enabled Turns on logging. The default is. log.directory Any valid folder path Specifies the path of the folder that contains the Interact for Xerox log file. The default is C:\ Retry number.of.retries 0 or any positive integer Specifies how many times Interact for Xerox tries to communicate with Perceptive Content Server after a failed communication attempt. The default is 0. retry.interval 0 or any positive integer Specifies the length of time, in minutes, MFP waits between retries. The default is 1. Page 25 of 31

26 INXeroxProfiles.ini settings The following table provides definitions and sample data for the settings in the INXeroxPProfiles.ini configuration file. This table displays the INI settings under separate group headings for each profile definition, such as [Xerox], in the order the groups appear in the INI file. Each subsequent application requires its own group heading and as many of the settings as you want to enable for that application. Each setting offers two or more options that are defined in the following table along with a description of each setting and its options. Use this table as a guide when you customize the file. Group Setting Options Description General profile.enabled Shows the button name button in the MFP control panel, where button name is a placeholder for the name you assign to the profile definition. The default is. onetouchscan. enabled Turns One Touch Scanning mode on or off in the profile definition. The default is. groups.name A comma-delimited list of MFP names Specifies individual MFPs so that the application appears on the named MFPs and no others. For example: Floor 2, Floor 1 Document Keys drawer.display Displays or hides the Drawer row in the control panel. The default is. drawer.user. modifiable Allows the user to select a different Drawer. The default is. drawer.default.value A drawer name Presets the selected Drawer. The default is Default. doctype.display doctype.user. modifiable doctype.default.value Displays or hides the Document Type row in the control panel. The default is. Allows the user to select a different Document Type. The default is. Presets the selected Document Type. The default is Default. Page 26 of 31