Perceptive Connect. Installation and Setup Guide. Beta version: Compatible with ImageNow, versions 6.6.x and 6.7.x

Transcription

1 Perceptive Connect Installation and Setup Guide Beta version: Compatible with ImageNow, versions 6.6.x and 6.7.x Written by: Product Documentation, R&D Date: November 2013

2 2013 Perceptive Software. All rights reserved Perceptive Software is a trademark of Lexmark International Technology S.A., 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 Overview... 4 Prerequisites... 4 Licenses... 4 Overview of the setup process... 4 Install Perceptive Connect... 5 About the Perceptive Connect Landing Page... 5 Install the ImageNow Connector... 5 Configure ImageNow to use the connector... 6 Define the ImageNow Envoy service... 6 Create a Perceptive Connect user... 7 Appendix: Troubleshooting Perceptive Connect... 8 Configure Perceptive Connect logging... 8 Run the Perceptive Connect monitor program... 8 Configure the Perceptive Connect port setting and path (optional)... 9 Configure the port settings... 9 Configure the path... 9 Uninstall Perceptive Connect Perceptive Connect Installation and Setup Guide 0.12.x Page 3 of 10

4 Overview Perceptive Connect is the connector hub that allows you to configure, create, and enable channels between ImageNow and your various business applications. Perceptive Software offers a variety of connectors for use with Perceptive Capture, PeopleSoft, SAP, and more. For information about available connectors, contact your Perceptive Software representative. This guide outlines the installation procedures for Perceptive Connect and the ImageNow Connector. It also includes the configuration process for the ImageNow Connector. Prerequisites To use Perceptive Connect, you must have access to a working installation of either ImageNow version 6.6.x or ImageNow version 6.7.x and the following products. For ImageNow, version 6.6 environments ImageNow Client and Server, version 6.6 ImageNow Message Agent, version 6.6 For ImageNow, version 6.7 environments ImageNow Client and Server, version 6.7 Perceptive Integration Server, version 6.7 Java, version 1.7 (32-bit or 64-bit) Licenses The following licenses are required for Perceptive Connect. Integration Framework Transaction Pack ImageNow Message Agent 6.6 or Perceptive Integration Server 6.7 Overview of the setup process To set up Perceptive Connect, complete the following sections, in order. 1. Install Perceptive Connect 2. Install the ImageNow Connector 3. Configure ImageNow to use the connector Perceptive Connect Installation and Setup Guide 0.12.x Page 4 of 10

5 Install Perceptive Connect To download the ZIP file and install Perceptive Connect and the ImageNow Connector, complete the following steps. 1. Go to the Perceptive Software website at and log in to the Customer Portal. 2. In the Product Downloads page, download the Perceptive Connect for Windows ZIP file. 3. Extract the file to the directory where you want to install Perceptive Connect. 4. To install the Perceptive Connect scripts, navigate to [drive:]\<perceptive Connect directory>\script\ and move PerceptiveConnectExtensions.js to the \script\ directory of your ImageNow Server. For example, [drive:]\inserver6\script. 5. To run the installation batch file, in [drive:]\<perceptive Connect directory>, double-click install.bat. 6. In Windows Services, right-click the Perceptive Connect service and click Start. About the Perceptive Connect Landing Page The Perceptive Connect Landing Page includes links to the System Console, the URI for the Envoy Remote Service, and the Integration Queue channel creation page. Locate the landing page at Connect host name>:<port>. For example, Install the ImageNow Connector Perceptive Connect includes the ImageNow Connector files. To complete the installation, use the Perceptive Connect Web Console to define either Integration Server or Message Agent as a connection provider. The connector uses this provider to communicate with ImageNow. Complete the following steps. 1. In a browser, type the Web Console address in the format Connect host name>:<port>/connect/bundles. Note The Perceptive Connect service runs on port 80, by default. To configure the port number, such as for multiple instances of Perceptive Connect on the same host machine, refer to Configure the Perceptive Connect port setting and path (optional). 2. In the browser dialog box, in the User name box, type admin, and in the Password box, type admin, then login. Note To change the default user name and password for the Perceptive Connect web console, refer to the Apache Felix documentation, available at felix.apache.org. 3. In the Perceptive Connect Web Console, click Perceptive Connect > View Configuration. 4. In the Name column, under Perceptive Content Connector, click Connection Manager. Perceptive Connect Installation and Setup Guide 0.12.x Page 5 of 10

6 5. In the Connection Provider Target list, click one of the following connection providers. For ImageNow 6.6: use Message Agent 6.6. For ImageNow 6.7: use Integration Server Perceptive Connect requires an ImageNow username and password to access ImageNow Server. In the User name and Password boxes, specify a username and password that is valid with your network authentication method. Note You add this user to ImageNow Server later in the installation process in Create the Perceptive Connect user. The recommended username is Perceptive Connect. 7. Click Save. Configure ImageNow to use the connector In this section, you define the ImageNow Envoy service, and create a user that Perceptive Connect uses to access the ImageNow system. Define the ImageNow Envoy service Perceptive Connect requires one Envoy service per Perceptive Connect instance. To define an ImageNow Envoy service, complete the following steps. To configure multiple Envoy services, repeat this process and name each service uniquely. 1. In Management Console, in the left pane, click Envoy Services and then click New. 2. In the Envoy Services dialog box, in the Definition page, set the following attributes. In the Name box, type a name to identify the remote service. The default is Perceptive Connect. In the URI box, type the URI for your Integration Server in the format Connect host name>:<port>/ws/workflowtrigger?wsdl. In the Authentication list, select None. Optional. To enable interceptor logging for the remote service, select the Enable interceptor logging check box. The logging files produced by the Interceptor are useful for troubleshooting issues with SOAP requests and responses. 3. Click Next. 4. In the Operations page, in the Perceptive Connect operation, select the check box for InvokeTrigger and click Finish. Perceptive Connect Installation and Setup Guide 0.12.x Page 6 of 10

7 Create a Perceptive Connect user Perceptive Connect requires a unique user account on ImageNow Server. This manager account is only for Perceptive Connect; you do not use the Perceptive Connect user as a login account. To create a Perceptive Connect user, complete the following steps. 1. On your operating system or LDAP server, create a unique user account for Perceptive Connect. 2. Using the ImageNow owner or administrator account, start ImageNow Client, and open Management Console. 3. In the left pane, click Users. 4. In the right pane, on the User Profiles tab, click New and type a username, such as Perceptive Connect. 5. To promote the user to Manager, on the Security tab, click the Perceptive connect user and click Promote. 6. In the confirmation dialog box, click Yes. Perceptive Connect Installation and Setup Guide 0.12.x Page 7 of 10

8 Appendix: Troubleshooting Perceptive Connect Use the methods in the following sections to troubleshoot Perceptive Connect. Configure Perceptive Connect logging You use the Perceptive Connect Web Console to configure the logging level and log directory. To access the console logging, complete the following steps. 1. In Perceptive Connect Web Console, click Perceptive Connect > View Configuration. 2. In the Name column, under General, click PIF Logger. 3. Set the Log Level and Log Directory, then click Save. Note You do not need to restart Perceptive Connect to implement the settings. Run the Perceptive Connect monitor program You use the Perceptive Connect Web Console monitor program to view the Perceptive Connect properties. To start the monitor program, navigate to the [drive:]\<perceptive Connect installation>\bin directory and run perceptiveconnectw.exe. You can view the properties in each tab of the program menu. To implement changes, restart the monitor program. General. Indicates the install path and the Startup type. Also shows whether the service is running. You can stop or start the service from this tab. Log On. Indicates the account settings. Logging. Indicates the logging level, the log path, and the log prefix. You can change the location of the log file from this tab. If specified, the log directory setting in the Perceptive Connect Web Console overwrites this log path. Java. Indicates the path of the Java Virtual Machine, the path of the Java Classpath, the port, the mapping path of the Perceptive Connect Service, memory settings, and stack size. To change the port setting or the mapping path, refer to Configure the Perceptive Connect port setting and path (optional) section. The memory settings and stack size should remain blank. Startup. Optional. Indicates the Perceptive Connect working path. Other settings in this box should remain blank. Shutdown. Optional. Settings in this box should remain blank. Perceptive Connect Installation and Setup Guide 0.12.x Page 8 of 10

9 Below is an illustration of the Perceptive Connect monitor program. Configure the Perceptive Connect port setting and path (optional) With the Perceptive Connect monitor program, you can configure the Perceptive Connect port settings and paths. To launch the monitor program for a Perceptive Connect instance, navigate to the [drive:]\<perceptive Connect installation>\bin directory and run PerceptiveConnect_ServiceConfig.exe. Configure the port settings The Perceptive Connect service runs on port 80, by default. However, each instance of Perceptive Connect on a single host machine must have a unique port number. To configure a Perceptive Connect instance port number, use the monitor program. 1. In the Perceptive Connect Properties dialog box, on the Java tab, in the Java Options box, change the value of Dorg.osgi.service.http.port to your port number. For example, if the port is 7000, the setting is: Dorg.osgi.service.http.port= Click OK. Configure the path In the monitor program, in the Java Options box, the second line is the path to the mapping folder. If the location of your Perceptive Connect directory is not the default, you can change the path location. To change the path location, complete the following steps. 1. In the Perceptive Connect Properties dialog box, on the Java tab, in the Java Options box, on the second line, change the value of Dpie.mapping.path to your path location, similar to the illustration shown below. 2. Click OK. Perceptive Connect Installation and Setup Guide 0.12.x Page 9 of 10

10 Uninstall Perceptive Connect If you need to uninstall Perceptive Connect, complete the following steps. 1. Navigate to the Perceptive Connect installation directory on your computer. 2. Double-click uninstall.bat. The script removes the Perceptive Connect service from Windows services. Note that the script does not delete the installation directory. Perceptive Connect Installation and Setup Guide 0.12.x Page 10 of 10