imagenow connector for sap archivelink · create an sap application ... archivelink is a service...

ImageNow Connector for SAP ArchiveLink Installation and Setup Guide ImageNow Version: 6.7.x

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

© 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.

ImageNow Connector for SAP ArchiveLink Installation and Setup Guide of 15

Table of Contents Overview ...................................................................................................................................................... 4

Prerequisites for installation ...................................................................................................................... 4 Installation Instructions .............................................................................................................................. 4

Download the ImageNow ArchiveLink files ............................................................................................... 4

Run the ImageNow ArchiveLink installation wizard .................................................................................. 4 Install ImageNow SAP ArchiveLink client .............................................................................................. 4

Install ImageNow ArchiveLink server ..................................................................................................... 5 Install the ImageNow Connector for SAP ArchiveLink license .............................................................. 5

Configure Apache Tomcat ......................................................................................................................... 6

Install the Content Server license key ....................................................................................................... 6

Edit the catalina.properties file .................................................................................................................. 6

Open a firewall port ................................................................................................................................... 6 Test the connection ................................................................................................................................... 7

Configure ImageNow ArchiveLink ............................................................................................................ 7

Create an SAP application ........................................................................................................................ 7

Create an SAP protocol ............................................................................................................................. 8

Create an SAP repository .......................................................................................................................... 9

Configure SAP certificates......................................................................................................................... 9 Create an application plan ....................................................................................................................... 10

Create a capture profile ........................................................................................................................... 10 Appendix A: Auto-archive the currently open document ..................................................................... 12

Modify the SAP application...................................................................................................................... 12

Create an SAP protocol ........................................................................................................................... 12 Appendix B: inSAPALink.ini settings ..................................................................................................... 12 Index ........................................................................................................................................................... 15


Overview This guide provides pre-installation, installation, and setup instructions for ImageNow Connector for SAP ArchiveLink. ArchiveLink is a service integrated in the SAP Web Application Server for linking archived documents and the application documents entered in the SAP system.

Linking documents according to content guarantees long-term, easy access to the documents. From the screen of the application document, you can directly display the stored document that is associated with it. You can also use attributes to search for documents. This replaces time-consuming processes such as making copies of originals and searching for procedure-related information.

Prerequisites for installation Before you install ImageNow ArchiveLink, verify that the following components are installed on the computer where you install ImageNow ArchiveLink.

• Java, version 1.6.x (32-bit)

• Apache Tomcat, version 6.0.26 or later

• SAP R/3 4.6c and later for the client

Install ImageNow ArchiveLink on Microsoft Windows NT 4.0, Microsoft Windows XP Professional, or Microsoft Vista.

Installation Instructions Download the ImageNow ArchiveLink files

1. Go to the Perceptive Software website at www.perceptivesoftware.com and log in to the Customer Portal.

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

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

Run the ImageNow ArchiveLink installation wizard Complete the following procedures to run the installation wizard.

Install ImageNow SAP ArchiveLink client If you are installing ImageNow SAP ArchiveLink client, perform the following steps.

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 ArchiveLink 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 Select Installation Type page, select Client and click Next.

about:blank


6. On the ImageNow ArchiveLink Configuration page, in the WebNow URL box, verify the WebNow URL or type in a URL, and then click Next.

7. In the Ready to Install the Program page, click Install.

8. Optional. To view the log files, select the Show the Windows Installer log check box.

9. In the Installation Wizard Completed page, click Finish.

Install ImageNow ArchiveLink server To install ImageNow Connector for SAP ArchiveLink on a Tomcat web application server, perform the following steps.

1. Stop the web server if it is currently running.

2. Double-click the EXE file you downloaded.

3. In the Welcome to the Installation Wizard for ImageNow ArchiveLink 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 Select Installation Type page, select Server and click Next.

6. In the ImageNow ArchiveLink Configuration page, complete the following actions to customize your installation:

1. If the ImageNow Server is remote, select Installed on another computer from the Location list.

2. If the ImageNow server is not remote, select Installed on this computer from the Location list.

3. Type the Host name/IP address and Port number of the ImageNow Server where ImageNow ArchiveLink will submit documents.

7. In the Ready to Install the Program page, click Install.

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

9. In the Installation Wizard Completed page, click Finish.

Install the ImageNow Connector for SAP ArchiveLink license Before entering your licenses, you must have installed the ImageNow Server and at least one ImageNow Client. You must have Service Administrator privileges to install ImageNow licenses. To install the ImageNow product licenses, the ImageNow Client must be available on a Windows machine.

1. When you receive the license files from your Perceptive Software representative, copy them to a temporary folder where you can access them with an ImageNow Client.

2. Upload licenses, as explained in the following substeps:

1. Click Start, point to All Programs, and then select ImageNow 6.

2. In the login page, click License Manager.

3. In the License Management dialog box, select Upload Licenses and click OK.

4. Navigate to the folder where you stored the ImageNow license files, select the LIC files to upload, and click Open.


5. Enter the User Name, Password, and Server Location and click OK.

6. Optional. The License Upload dialog box lets you view the type name, actual license code, and current status of each license upload. To display detailed information for a specific license, select the appropriate row.

3. Click OK.

Configure Apache Tomcat After you install ImageNow ArchiveLink, you need to install the Content Server license, edit the Apache Tomcat configuration catalina.properties file, open a firewall port, and test the server connection. Note that this section is only for the server install option.

Install the Content Server license key Complete the following steps to install the Content Server license key.

1. Using a text editor, in the Apache installation director \conf folder, open the contentserver-config.properties file.

2. Find the ContentServer.CSLicenseKey= line and add the string license key: ContentServer.CSLicenseKey= <string license key>

3. Save and close the contentserver-config.properties file.

Edit the catalina.properties file The conf/catalina.properties configuration file is a regular Java properties file that sets important class loader paths, security package lists, and tunable performance properties.

1. Using a text editor, in the Apache installation directory \conf folder, open the catalina.properties file.

2. Find the shared.loader= line and add the following information: shared.loader=$(catalina.base)/shared/classes,$(catalina.base)/shared/lib/*.jar

3. Save and close the catalina.properties file.

Open a firewall port Complete the following steps to open a firewall port. If you already have a firewall port open for the web application server on which ImageNow ArchiveLink 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, choose Start, point to Settings, point to Control Panel, then point to Windows Firewall and 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 8080.

5. Verify that TCP is selected and click OK.

6. In the Windows Firewall dialog box, click OK.


Test the connection Complete the following steps to test the connection.

1. To make a note of the IP address of the web application server computer, complete the following steps:

1. On the Start menu, click Run, type cmd in the Run dialog box, and then 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: http://<IP address>:<server port number>/SAPALink

where <IP address> is a placeholder for the address you copied earlier in this procedure and <server port number> is a placeholder for the port opened for your web server application, as described in the “Open a firewall port” section.

3. To display the status page and verify your connection is successful, click the Server Status link.

Configure ImageNow ArchiveLink This section provides instructions for configuring ImageNow ArchiveLink. Additionally, you can configure the Archive from Frontend functionality to archive automatically the document or workflow item displayed in the topmost window within ImageNow Viewer. To do this, complete the steps in this section and refer to Appendix A.

Create an SAP application Complete the following steps to create and configure an SAP application.

1. From SAPGUI, using your standard SAP method, launch transaction /noaa4.

2. In the Applications window, click the Create button.

3. In the Create Application dialog box, type DMSAUTOM.SAPOLE and click the Apply button.

4. Double-click the application you just created, DMSAUTOM.SAPOLE.

5. In the Windows SAPGUI OLE automation window, under Function, complete the following steps to configure the settings for each function listed.

1. Double-click Display Stored Document and complete the following substeps:

1. In the first entry, select the button under the M column and type GUIViewDoc @AID,@DID in the Command box.

2. In the second entry, select the button under the G column and type @EID=GUIGetViewDocRC in the Command box.

3. Click Back.

2. Double-click Retrieval on Frontend and complete the following substeps:

1. In the first entry, select the button under the M column and type GUIRetrieveLocalFile @AID,@DID,@DPA in the Command box.


2. In the second entry, select the button under the G column and type @EID=GUIGetRetrieveLocalFileRC in the Command box.

3. Click Back.

3. Double-click Display Local File and complete the following substeps:

1. In the first entry, select the button under the M column and type GUIViewLocalFile @DPA,@DTI in the Command box.

2. Click Back.

4. Double-click Archive from Frontend and then complete the following substeps:

1. In the first entry, select the button under the M column and type GUIScanDoc @AID,-2 in the Command box.

2. In the second entry, select the button under the G column and type @EID=GUIGetScanDocRC in the Command box.

3. In the third entry, select the button under the G column and type @DID=GUIGetScanDocID in the Command box.

4. Click Back.

5. Double-click Store File on Frontend and complete the following substeps:

1. In the first entry, select the button under the G column and type @DPA=GUIGetFileFromClient in the Command box.

2. In the second entry, select the button under the G column and type @EID=GUIGetFileFromClientRC in the Command box.

3. Click Back.

6. Double-click Close Window and complete the following substeps:

1. In the first entry, select the button under the M column and type GUICloseDoc @AID,@DID in the Command box.

2. Click Back.

6. Click the Save button.

Create an SAP protocol Complete the following steps to create and configure an SAP protocol.


2. In the Protocol window, click the Create button.

3. In the Create Protocol dialog box, type a name and a description for the new protocol and click the Apply button to continue.


4. Double-click Display Stored Documents and complete the following substeps:

1. In the Function: Display Stored Documents window, select TIF from the Document classes list and double-click TIF.

2. In the TIF settings dialog box, complete the following substeps:

1. In the Communication Type box, type Open.

2. In the Application box, type DMSAUTOM.SAPOLE.

3. Click the Apply button to continue.

3. Click the Save button to save the information.

5. Repeat the previous substeps for the document class FAX.

Create an SAP repository Complete the following steps to create and configure an SAP repository.

1. From SAPGUI, using your standard SAP method, launch transaction /noac0.

2. In the Display Content Repositories: Overview, double-click the repository for which you want to configure the SAP connection settings.

3. In the Display Content Repositories: Details window, click the Edit button.

4. In the Change Content Repositories: Details window, complete the following substeps:

1. From the Document Area list, select the document area for which you want to store documents.

2. From the Storage Type list, select HTTP Content Server.

3. In the Protocol box, type the value of the protocol you just created for ImageNow ArchiveLink. For example, PSI.

4. In the HTTP Server box, type the IP address or host name of the computer running Content Server. For example, PSI-Server.

5. In the Port Number box, type the port number on which Tomcat is running. The default is 8080.

6. In the HTTP Script box, type SAPALINK/ContentServer.


6. To test the connection, click the Test button.

7. To send the certificates, click the E-mail button.

Configure SAP certificates Complete the following steps to configure SAP certificates.

1. From SAPGUI, using your standard SAP method, click the Content Server Administration

button.

2. In the Content Server Administration window, click the Certificates tab.

3. Click the Edit button.


4. Under Certificate Properties, configure the certificate properties using any of the following actions:

• To activate the rows, click .

• To deactivate the rows, click .

• To delete the rows, click .


Create an application plan Complete the following steps to create an application plan.

1. On the ImageNow toolbar, click Manage.

2. In the Management Console, in the left pane, expand the Application Plans tree and click Interact.

3. In the right pane, on the Applications tab, click New.

4. In the Plan Settings dialog box, click the General tab.

5. Under Information, do the following actions:

• In the Name box, type a unique name for your application plan.

• In the Description box, type a description for your application plan.

• Select Is active if you want this application plan active.

6. Click OK.

7. When ImageNow opens Interact Application Plan Designer, select ImageNow Connector for SAP Archivelink from the drop down list.

8. Modify your Interact application plan as you normally would by mapping keys and configuring view actions for documents and folders.

Create a capture profile To perform this procedure, you must be a user with management privileges, a manager, or the owner.

1. In the ImageNow Management Console dialog box, in the left pane, click Capture.

2. On the Capture Profile tab, click New and select Connector for SAP ArchiveLink to open the Capture Profile Definition wizard.

3. In the Capture Profile Information page, complete the following actions:

• In the Name box, type SAP ArchiveLink.

• In the Description box, type a description for your capture profile.

• Select Profile is active to activate or deactivate the capture profile.

4. Click Next.


5. In the Capture Profile Options page, complete the following actions:

• In the Application plan list, select the application plan you want to associate with this capture profile.

• In the Workflow process list, select the workflow process you want to associate with this capture profile.

• From the Workflow queue list, select the workflow queue you want to associate with this capture profile.

• If you want capture objects submitted to the Content Server for full-text indexing, select Submit to Content Server.

• If you want the capture objects added to version control, select Submit to version control.

6. Click Next.

7. In the Capture Profile Verification page, verify that the capture profile settings are accurate. If you need to update the information, double-click the settings and make the necessary changes. Otherwise, click Finish.


Appendix A: Auto-archive the currently open document You can configure the Archive from Frontend functionality to archive automatically the document or workflow item displayed in the topmost window within ImageNow Viewer. If you use the frontend archiving functionality, you must use ImageNow Client to perform the archiving and then use either the ImageNow Client or the WebNow Viewer for subsequent viewings. Complete the steps below to set up this functionality.

Modify the SAP application Complete the following steps to configure an SAP application to auto-archive the currently open document.


2. In the Applications window, double-click the application you created (DMSAUTOM.SAPOLE).

3. In the Windows SAPGUI OLE automation window, under Function, double-click Archive from Frontend and complete the following substeps:

1. In the first entry, select the button under the M column and replace the existing text in the Command box with GUIScanDoc @AID,-10.

2. Click Back.

4. Click the Save button to save the information.

Create an SAP protocol Complete the following steps to configure an SAP protocol to auto-archive the currently open document.


2. In the Protocol window, double-click the ImageNow SAP protocol you created.

3. To create the document class TIF, double-click Archive from Frontend and complete the following substeps:

1. In the Function: Archive from Frontend window, select TIF from the Document classes list and double-click TIF.

2. In the TIF settings dialog box, complete the following substeps:

1. In the Communication Type box, type Open.

2. In the Application box, type DMSAUTOM.SAPOLE.

3. Click the button.

4. Click the Apply Save button.

4. Repeat the previous substeps to create the document class for FAX.

Appendix B: inSAPALink.ini settings The following table provides definitions and sample data for the settings in the inSAPALink.ini configuration file. This table displays the INI settings under group headings in brackets, for example,


[Logging], in the order the groups appear in the INI file. Each setting offers two or more options, defined in the table below along with a description of each setting and its options. Use this table as a guide when customizing the file.

Group Setting Options Description

Capture (server only)

repository.capture. profiles

string Default capture setting that distinguishes which repository is used when capturing data based on pre-defined setting.

general.capture. profile

String

Default capture setting that is used to capture documents when no repositiroy capture profile is specified.

Remote remoted TRUE

FALSE

Specifies whether the ImageNow ArchiveLink is installed on a different physical server than ImageNow Server.

TRUE = The ImageNow ArchiveLink is installed remotely.

FALSE = The ImageNow ArchiveLink is installed on ImageNow Server.

The default is FALSE.

server.ip.address Any valid IP address or a semicolon delimited string of valid IP addresses.

Specifies the IP address of ImageNow Server. You can supply multiple IP addresses with a semicolon delimited string. For example: 123.12.123.10; 234.23.234.2; 345.34.345.3.

When you use a delimited list of IP addresses, Import Agent Archivelink attempts to connect to the IP addresses in the order listed until it establishes a successful connection.

server.ip.port Any valid port number Specifies the port of the ImageNow Server.

The default is 6000.

Viewing (client only)

view.method 0

1

Specifies the method ArchiveLink uses for viewing documents.

0= ImageNow

1 = WebNow

The default is 0.

view.webnow.url Specifies the WebNow URL address ArchiveLink uses for viewing WebNow documents.

The default is http://hostname:8080/webnow.


Group Setting Options Description

view.close.other. viewers

TRUE

FALSE

If method 0 is used, then you can set view.close.other.viewers to true to indicate that all other document viewers should be closed when opening the current document.

Logging debug.level.file 0 through 6 Specifies the level ArchiveLink uses to log errors for troubleshooting.

Set minimal logging unless you are debugging an issue. If you increase the logging, make sure that you set the logging level back down after you finish debugging. Failure to do so can greatly affect performance and hard disk space.

0 = Logging is off.

1 through 6 = Logging is on. The higher the number, the more verbose the logging. For example, 1 offers minimal logging, whereas 6 offers the most information.


Index archive open document .................................... 12

configure

Apache Tomcat .............................................. 6 SAP certificates .............................................. 9

create

SAP application ........................................ 7, 12 SAP protocol ............................................. 8, 12 SAP repository ................................................ 9

edit

catalina.properties file ..................................... 6 contentserver-config.properties file ................ 6

firewall port, opening .......................................... 6

inSAPALink.ini ................................................. 13

install

client ............................................................... 4 Connector for SAP ArchiveLink ...................... 4 content server license .................................... 6 server ............................................................. 5

installation wizard............................................... 4

license installation .............................................. 5

open firewall port................................................ 6

overview ............................................................. 4

prerequisites ...................................................... 4

test the connection ............................................. 7