25
ImageNow Interact for ArcGIS Server Installation and Setup Guide ImageNow Version: 6.7.x Platforms: .NET and Java Written by: Product Documentation, R&D Date: June 2012

ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

Embed Size (px)

Citation preview

Page 1: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide

ImageNow Version: 6.7. x Platforms: .NET and Java

Written by: Product Documentation, R&D Date: June 2012

Page 2: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

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

Page 3: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 3 of 25

Tab le o f Conten ts

Overview ........................................................................................................................................ 4

Pre-Installation Instructions ........................................................................................................... 4

ImageNow Interact for ESRI – ArcGIS Server Installation Instructions............................................. 6

Download the Interact for ESRI – ArcGIS Server files .............................................................................. 6

Run the Interact for ERSI – ArcGIS Server installation wizard .................................................................. 6

Setup for the .NET Edition with ArcGIS Server Manager ................................................................. 7

Setup for the Java Edition with Eclipse .......................................................................................... 9

Create a new Eclipse mapping project ..................................................................................................... 9

Test the website ........................................................................................................................................ 9

Modify the build file ................................................................................................................................. 10

Import ImageNow Interact files to the project folder ........................................................................... 11

Edit the configuration files ....................................................................................................................... 11

Encrypt the bridge user password ...................................................................................................... 11

Edit the faces-config.xml file ............................................................................................................... 11

Edit the web.xml file............................................................................................................................. 16

Edit the mapViewer.jsp file .................................................................................................................. 17

Using ImageNow Interact for ArcGIS Server ................................................................................. 18

What is the ImageNow repository? ......................................................................................................... 18

Using the ImageNow Interact toolbar ..................................................................................................... 18

Show the ImageNow toolbar ............................................................................................................... 18

Review documents linked to a feature or features ................................................................................. 19

Link existing documents to a feature ...................................................................................................... 21

Upload documents and link to a feature ................................................................................................. 23

Clear selected features ........................................................................................................................... 24

Index ........................................................................................................................................... 25

Page 4: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 4 of 25

Over v iew This guide provides you with pre-installation, installation, and setup instructions for ImageNow Interact for ESRI – ArcGIS Server. Separate setup sections are included for users with .NET and Java platforms. Complete the installation and setup procedures in the following order:

1. Pre-installation Instructions

2. Run the Installer wizard

3. Perform the appropriate setup instructions that apply to the platform you are using:

• Setup for the .NET edition using ArcGIS Server Manager

• Setup for Java edition using Eclipse

Pre- Ins ta l l a t ion Ins t ruc t ions The following instructions describe how to configure your ImageNow and ESRI environments before proceeding with the installation of the ImageNow Interact for ArcGIS Server. The ImageNow administrator should perform these steps in coordination with your ESRI systems administrator. Perform the procedures outlined within this section only once.

1. Download ImageNow Message Agent from the Perceptive Software, Inc. website. Make sure you download the same version of Message Agent as your ImageNow Server version.

2. Install Message Agent using the steps provided in the Message Agent Installation and Configuration Guide. For future reference, make note of the name or IP address of the server on which it is installed as well as the Message Agent Server port number. The default port number is 6070.

3. Use ImageNow Client to ensure that the following licenses are installed. Contact your Perceptive Software representative if you have not received them.

• Message Agent Server

• ImageNow Interact for ArcGIS Server

4. Create a user to serve as a generic ImageNow Interact for ArcGIS Server bridge to ImageNow. ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge and make a note of this name, which is required in the setup section of this document.

Note Because all other ImageNow data access is governed by the end user’s ImageNow security profile, and not the bridge user, the bridge user does not require any Drawer or Document Type privileges within ImageNow.

5. Within your current ImageNow authentication source (for example, LDAP, Active Directory, or the local Windows User Accounts control panel on the ImageNow Server), create a user account that corresponds to the user you created in the previous step and make a note of the password you define for this user.

6. In ImageNow, create new custom properties within ImageNow using the attributes shown below.

• Name: Latitude Type: string

• Name: Longitude Type: string

Page 5: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 5 of 25

• Name: Layer Name Type: list

• Name: ID Type: string

To create custom properties, follow these steps:

1. On the ImageNow toolbar, click the Manage arrow, and then click Custom Properties.

1. In the Resource Manager dialog box, in the right pane, click New.

2. In the Custom Property dialog box, type the name of custom property in the Name box.

2. In the Type list, select String for the Latitude, ID and Longitude custom properties, and select List for the Layer Name custom property. Note that the Layer Name custom property is a list of values.

3. Repeat the previous substeps for each of the custom properties above: Latitude, Longitude, Layer Name, and ID.

4. Add all ESRI layer names to the Layer Name custom property list in ImageNow, which contains placeholder values for actual layer names. You can optionally leave the Default value box unspecified.

Note Add only those layers that contain features that you want to link to ImageNow documents to this list.

5. Create a new project type named ESRI within ImageNow. Interact uses this project type to generate all projects created in ImageNow Interact for ESRI ArcGIS Server. To create the project type, perform the following substeps:

6. On the ImageNow toolbar, click Manage.

7. In the Resource Manager dialog box, in the left pane, click Project Types.

8. On the Projects tab, click New and then type ESRI in the name box.

9. With the ESRI project type selected, verify that the Project Type is Active check box is selected.

10. Click the Custom Properties tab and then continue with the next step.

11. Add the Latitude, Longitude,, ID, and Layer Name custom properties to the ESRI project type in ImageNow and click the icon to the left of each added property to mark it as a required property.

12. Ensure that each user of ImageNow Interact for ESRI ArcGIS Server possesses the View, Create, Delete, Edit Properties, Add Documents, and Remove Documents global Project privileges within ImageNow.

Note To decrease the administration required to implement privileges, you can optionally create a new group within ImageNow that possesses the Project privileges named above. Users automatically inherit these privileges when you add them to the group.

Page 6: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 6 of 25

13. For the ESRI administrator, create a new field within each ESRI feature class to store the unique ImageNow document and ESRI feature link identification value.

Note While you can select the name of this field (the suggested value is IN_ESRI_ID), it must be the same across all feature classes. This rule only applies to feature classes that contain features that you want to link to ImageNow documents. Use the following attributes when creating this new field in each required feature class:

Type: text Length: 50 characters

ImageNow In te rac t fo r ESR I – ArcG IS Ser ver Ins ta l l a t ion Ins t ruc t ions The following procedure shows you how to perform the initial installation of ImageNow Interact for ESRI – ArcGIS Server. You must install ImageNow Interact for ESRI – ArcGIS Server on the same computer on which the ESRI developer creates a website project.

Download the Interact for ESRI – ArcGIS Server f i les 1. Go to the Perceptive Software website at www.perceptivesoftware.com, 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.

Run the Interact for ERSI – ArcGIS Server instal lat ion wizard 1. Double-click the EXE file you just downloaded.

2. On the Welcome to the ImageNow Interact for ESRI – ArcGIS Server Installation Wizard page, click Next.

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

4. If the Version Selection page appears, click Microsoft .Net Framework Edition or Java Platform Edition, depending upon the specific version of ArcGIS Server you intend to use.

Note The Version Selection page only displays if you do not have ESRI ArcGIS Server installed.

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

6. If the Locate ArcGIS Installation page appears, click Change, browse to the location of your ArcGIS Server and then click Next.

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

Page 7: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 7 of 25

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

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

Setup fo r the .NET Ed i t i on w i th ArcG IS Ser ver Manager The following instructions assume that you have installed all required ArcGIS server products and that you ran all the recommended service packs on these products.

1. Start ArcGIS Server Manager and log in.

2. On the Welcome to ArcGIS Server page, click Create a Web application.

3. On the Web Applications page, perform the following actions:

• In the Host box, enter the name of your ArcGIS Server.

• In the Name box, enter a name for your server, such as Interact for ArcGIS Server, and then enter an optional description.

4. Click Next.

5. In the Select Layers tab, select the map you want, click Add, and then click Next.

6. On the Select Tasks tab, in the Available Task Items list, click ImageNow and then click Add.

7. In the Current Tasks list, click ImageNow Interact for ArcGIS Server and then click Configure.

8. On the Task Configuration page, enter the following values:

Under this heading: In this field Enter

ESRI Settings ESRI Field The name of the new field added to each ESRI feature class. The default is IN_ESRI_ID.

Message Agent Settings Server The name or IP address of the server where Message Agent is installed.

Port The port Message Agent monitors. The default is 6070.

Bridge User The exact user name of the bridge user you created in the “Pre-Installation Instructions” section of this guide.

Bridge Password The Windows password for the bridge user.

Linking Enable Linking Select this check box if you want ImageNow Interact to link map features to documents (this is the default setting).

Show custom properties during linking

Select this check box if you want ImageNow Interact to display custom property values of the documents you are linking to map features.

Page 8: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 8 of 25

Under this heading: In this field Enter

ImageNow Settings Default User The user name of the user who captures documents for ImageNow Server. This name appears in the properties list of each document.

WebNow Settings

Base URL The web address of your WebNow Server if you are using one.

Anonymous WebNow Select this check box if you want to allow anonymous login to WebNow. This setting requires anonymous authentication enabled in the WebNow.settings file on the WebNow Server.

Viewing Viewer type Select WebNow, Native Viewer, or Both.

Maximum Search Results Enter the maximum number of documents to display in the ImageNow Interact search grid.

Logging Log Level Select 0, 1, or 2 (0 = minimal logging detail; 1 = moderate logging detail; 2 = maximum logging detail).

Log Directory Make sure this path points to an existing folder on your computer.

Custom Document Key Labels

Folder

Tab

Field 3

Field 4

Field 5

If you want to rename your document key labels, enter the new name in the corresponding box.

9. Click Save.

10. Click Finish. The ImageNow Interact for ESRI - ArcGIS Server starts automatically.

Page 9: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 9 of 25

Setup fo r the Java Ed i t i on w i th Ec l ipse The following instructions assume you are a developer with experience using the ESRI plug-in for the Eclipse development platform, that you have installed all required ArcGIS server products, and that you have run all the recommended service packs on these products. These instructions also assume you installed the Java Development Kit (JDK) and Eclipse platform in accordance with system requirements published by ESRI and the Technical Specifications from Perceptive Software.

Create a new Ecl ipse mapping project If an ArcGIS Web Project already exists within Eclipse, skip this section and proceed to the “Modify the Build File” procedures.

1. Start Eclipse and then select your workspace.

2. In the Project Explorer, select New > Project.

3. On the Select a Wizard page, scroll to the ESRI Templates folder, open it, and then open the Server folder.

4. Under Server, click ArcGIS Web Project and then click Next.

5. On the Dynamic Web Project page, in the Project name box, enter the name of the web project and then click Next.

6. On the ArcGIS Web Project page, on the ArcGIS Server Local tab, enter values in the GIS Server, Username, Password, and Domain boxes that correspond to your local ArcGIS server installation.

7. Click Connect, which uses the values you entered in the previous step to connect to your ArcGIS server and populate the Server Objects pane.

8. Under Server Objects, select the map you want and then click the right arrow to add it to the web project.

9. Click Finish.

Eclipse creates a folder inside the new web project that contains the data for the map you selected in the previous procedure. It also creates the three files – faces-config.xml, web.xml, and mapViewer.jsp – that you modify in later sections of this guide. At this point, an ArcGIS user can connect to the web project and view the map and its layers and features, but no ImageNow Interact information is added.

Test the website Ensure that the new website is working before you add the ImageNow Interact plug-in. The following instructions reference the user interface of Eclipse version 3.2, which may differ from the version of Eclipse you are using. Steps 1 through 3 may be necessary to cause the embedded version of Apache Tomcat to load the appropriate library class. If not, begin with step 4.

1. In the Eclipse Project Explorer window, right-click the new web project name and then select Run As > Run.

2. In the Run dialog box, on the Arguments tab, under VM arguments, paste the following line at the bottom of the arguments list:

-Dsun.lang.ClassLoader.allowArraySyntax=true

3. Click Close and then click Yes when asked if you want to save.

Page 10: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 10 of 25

4. In the Eclipse Project Explorer window, right-click the new web project name and then select Run as > Run on Server. The title of this option varies with the version of Eclipse you are using.

5. Click Finish. If the map you selected appears, your web application is working properly.

6. Exit the web server.

Modify the bui ld f i le In the first part of the following procedure, you copy the path to the web server. In the second, you insert this information into the build file. Before proceeding, make a backup of the ImageNow Interact for ESRI – ArcGIS Server build.xml file. In the following instructions, <INSTALL_DIR> refers to the base directory to which ImageNow Interact for ESRI – ArcGIS Server was installed. By default, this directory is C:\Program Files\Interact\INArcGIS.

1. In the Eclipse Project Explorer window, right-click the new web project name and then select Properties.

2. In the Properties for <web project name> dialog box, under Info, select and copy the path displayed on the Location line to the clipboard.

3. Click OK.

4. Use a text editor to open the build.xml file, located within the <INSTALL_DIR>.

5. Locate the <property name=web.project.dir line and change the value setting in that line from “..ArcGISWebProject” to value=”project path” The following figure shows the result after pasting whichever project path value for your installation that you copied in the previous steps. Be sure to include the quotation marks around the path and the following slash and right angle bracket characters: />

6. Save and then close the build.xml file.

Page 11: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 11 of 25

Import ImageNow Interact files to the project folder The following procedure automates copying files to the appropriate subfolders in the web project folder. It assumes that the ant directory is in your Windows path string.

1. Open a Command Prompt window and then change directories to the <INSTALL_DIR> folder.

2. At the command prompt, type ant addtoproject and then press ENTER.

3. After the command window displays the Build Successful in Project Folder message, close the window.

4. To refresh the web project folder, in the Eclipse Project Explorer window, press F5 to refresh the display of files in your web project folder, in which you see new ImageNow Interact folders and files added in this procedure.

Edit the conf igurat ion f i les The following procedures explain how to add individual statements and blocks of statements to three configuration files to add ImageNow Interact for ESRI ArcGIS Server. In the following instructions, <INSTALL_DIR> refers to the base directory to which ImageNow Interact for ESRI – ArcGIS Server was installed. By default, this directory is C:\Program Files\Interact\INArcGIS.

Encrypt the bridge user password This procedure encrypts the password of your ImageNow bridge user in preparation for its insertion into the faces-config.xml file in the following procedure. It assumes that the ant directory is in your Windows path string.

1. Open a command window and change directories to the <INSTALL_DIR> folder.

2. At the command prompt, type ant setpassword and then press ENTER.

3. At the Enter your password prompt, type the Windows password you created for the bridge user in the “Pre-installation instructions” section and then press ENTER.

4. When the Encrypted Password line appears, copy the value following the colon to the clipboard and paste the clipboard to a temporary text file so that you can locate it easily for the following procedure.

Edit the faces-config.xml file In this procedure, you add a number of settings to the faces configuration file. Make sure that you have a current backup of the faces-config.xml file. This procedure applies to ArcGIS version 9.3 or later.

1. Using Eclipse or a separate text editor, open the faces-config.xml file. This file is located by default within the WebContent\WEB-INF folder, which Eclipse creates by default during the initial ArcGIS Web Project creation.

2. Change the scope of the mapContext bean from request to session by locating the <managed-bean-scope>request</managed-bean-scope> line of code and replace it with the following statement:

<managed-bean-scope>session</managed-bean-scope>

Page 12: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 12 of 25

3. Create a new line immediately below it and then add the following block of statements:

<managed-property> <property-name>webSession</property-name> <value>#{esriWebSession}</value> </managed-property>

4. Locate the <map-entry> block with the word defaultGraphicsResource and then remove the following block of statements:

<map-entry> <key>defaultGraphicsResource</key> <value>#{defaultGraphicsResource}</value> </map-entry>

5. Locate the <!—Managed-bean for ArcGIS Server resource [START] section header comment, create a new line immediately above it, and then add the following block of statements:

<referenced-bean> <description> The ADF webapp always puts this object in application scope when the app first starts up. </description> <referenced-bean-name>esriWebApplication</referenced-bean-name> <referenced-bean-class> com.esri.adf.web.data.WebApplication </referenced-bean-class> </referenced-bean> <managed-bean> <managed-bean-name>esriWebSession</managed-bean-name> <managed-bean-class> com.esri.adf.web.data.WebSession </managed-bean-class> <managed-bean-scope>session</managed-bean-scope> <managed-property> <property-name>webApplication</property-name> <value>#{esriWebApplication}</value> </managed-property> </managed-bean>

6. Locate the <!—Tasks [START] — section header comment, create a new line immediately below it, and then add the following block of statements:

<managed-bean> <managed-bean-name>interactArcGISTaskConfig</managed-bean-name> <managed-bean-class>com.imagenow.interact.arcgisserver.webcontrols.INInteractArcGISTaskConfig</managed-bean-class> <managed-bean-scope>session</managed-bean-scope> <managed-property> <property-name>esriField</property-name> <value>IN_ESRI_ID</value> </managed-property> <managed-property> <property-name>MAServer</property-name> <value>servername</value> </managed-property> <managed-property> <property-name>MAPort</property-name> <value>6070</value> </managed-property>

Page 13: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 13 of 25

<managed-property> <property-name>bridgeUser</property-name> <value>username</value> </managed-property> <managed-property> <property-name>bridgePassword</property-name> <value>password</value> </managed-property> <managed-property> <property-name>useSSL</property-name> <value>false</value> </managed-property> <managed-property> <property-name>enableLinking</property-name> <value>true</value> </managed-property> <managed-property> <property-name>showCustomProperties</property-name> <value>true</value> </managed-property> <managed-property> <property-name>defaultImageNowUser</property-name> <value>username</value> </managed-property> <managed-property> <property-name>webNowBaseURL</property-name> <value>http://servername:8080/webnow</value> </managed-property> <managed-property> <property-name>anonymousWebNow</property-name> <value>false</value> </managed-property> <managed-property> <property-name>viewerType</property-name> <value>Native</value><!-- [WebNow, Native, Both]--> </managed-property> <managed-property> <property-name>maxSearchResults</property-name> <value>200</value> </managed-property> <managed-property> <property-name>logLevel</property-name> <value>0</value> </managed-property> <managed-property> <property-name>logDirectory</property-name> <value>C:\Inserver6\log\</value> </managed-property> <managed-property> <property-name>folderLabel</property-name> <value>Folder</value> </managed-property> <managed-property> <property-name>tabLabel</property-name> <value>Tab</value> </managed-property> <managed-property> <property-name>field3Label</property-name> <value>Field3</value> </managed-property>

Page 14: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 14 of 25

<managed-property> <property-name>field4Label</property-name> <value>Field4</value> </managed-property> <managed-property> <property-name>field5Label</property-name> <value>Field5</value> </managed-property> </managed-bean>

7. Edit the following statements within the block that you just inserted.

After this <property-name> statement:

Modify the following text between <value> and </value>:

esriField If necessary, replace IN_ESRI_ID with the name of the field or attribute added to each ESRI feature class to which documents you can link.

MAServer Replace servername with the name of your Message Agent computer.

bridgeUser Replace username with the bridge user name you created in the “Pre-installation instructions” section.

bridgePassword

Replace password with the value you generated in the “Encrypt the bridge user password” section above.

useSSL Set this value to true to use the SSL (Secure Sockets Layer) protocol for all communication between Interact for ESRI – ArcGIS Server and Message Agent. You must configure Message Agent to use SSL before you set this parameter to a value of true.

enableLinking If you want to disable the ability to link ImageNow documents to ESRI features within the ImageNow Interact for ESRI – ArcGIS Server task toolbar, replace true with false.

showCustomProperties

If you do not want ImageNow Interact for ESRI – ArcGIS Server to allow searching of custom properties or to allow specifying of custom property values during the document- to-feature link process, replace true with false.

defaultImageNowUser Replace username with the ImageNow user name used to set data and document-level security access (for example, drawer lists and accessible documents). This setting is used only in the event that the ArcGIS Server user is not required to authenticate to the ArcGIS Server application or website. In the event that the user authenticates to the website, that individual’s login credentials are used to determine ImageNow security access levels.

webNowBaseURL If you are using WebNow to view documents, replace http://servername:8080/webnow with the base URL of your WebNow web application.

anonymousWebNow If you want all users to authenticate anonymously to WebNow when viewing documents, replace false with true. This setting requires anonymous authentication enabled within the WebNow Server.

Page 15: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 15 of 25

After this <property-name> statement:

Modify the following text between <value> and </value>:

viewerType If necessary, replace Native with the appropriate document viewing option. Available options are:

Native (allow viewing only in the native document viewer)

WebNow (allow viewing only within the WebNow Viewer – requires WebNow to be installed and licensed)

Both (allowing viewing in the native document viewer or within WebNow)

After this <property-name> statement:

Modify the following text between <value> and </value>:

maxSearchResults If necessary, modify the current value to indicate the maximum number of document results presented within the results list for a given feature or area selection.

logLevel To modify the level of verboseness within the Interact for ESRI – ArcGIS Server log files, update this with a value of 0 through 3. The higher the value, the more verbose the logging.

logDirectory Replace C:\Inserver6\log\ with the path to an existing folder on your server that is designated to hold the Interact for ESRI – ArcGIS Server log files.

Important Make sure that you already created the designated folder before running ImageNow Interact.

You can use the following optional settings to substitute your own labels for the following five document keys.

After this <property-name> statement:

Modify the following text between <value> and </value>:

folderLabel To replace the default folder label (Folder), modify the current value to the name you want.

tabLabel To replace the default tab label (Tab), modify the current value to the name you want.

field3Label To replace the default field3 label (Field3), modify the current value to the name you want.

field4Label To replace the default field4 label (Field4), modify the current value to the name you want.

field5Label To replace the default field5label (Field5), modify the current value to the name you want.

8. Save and then close the faces-config.xml file.

Page 16: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 16 of 25

Edit the web.xml file In this procedure, you link the fc-INInteractArcGIS.xml file to the Web Project via the web.xml file. Make sure that you have a current backup of the web.xml file.

1. Either within Eclipse or a separate text editor, open the web.xml file, located by default within the WebContent\WEB-INF folder, which Eclipse creates by default during the initial ArcGIS Web Project creation.

2. Locate the <context-param> tag and beneath it the <param-value> tag.

3. Immediately above the </param-value> end tag, add a comma at the end of the existing /WEB-INF/ line, create a new line below it, and then add the following entry:

/WEB-INF/fc-INInteractArcGIS.xml

4. Locate the <!--<security-filter-mapping>--> section header comment, create a new line immediately above it, and then add the following block of statements:

<filter> <filter-name>MyFacesExtensionsFilter</filter-name> <filter-class>org.apache.myfaces.webapp.filter.ExtensionsFilter</filter-class> <init-param> <param-name>uploadMaxFileSize</param-name> <param-value>10m</param-value> <description>Set the size limit for uploaded files. Format: 10 - 10 bytes 10k - 10 KB 10m - 10 MB 1g - 1 GB </description> </init-param> </filter> <!-- extension mapping for adding <script/>, <link/>, and other resource tags to JSF-pages --> <filter-mapping> <filter-name>MyFacesExtensionsFilter</filter-name> <!-- servlet-name must match the name of your javax.faces.webapp.FacesServlet entry --> <servlet-name>Faces Servlet</servlet-name> </filter-mapping> <!-- extension mapping for serving page-independent resources (JavaScript, style sheets, and images.) --> <filter-mapping> <filter-name>MyFacesExtensionsFilter</filter-name> <url-pattern>/faces/myFacesExtensionResource/*</url-pattern> </filter-mapping>

5. Update the uploadMaxFileSize property value as necessary, corresponding to the maximum size of an individual file you can upload to ImageNow through the Interact for ESRI ArcGIS Server interface.

6. Save and then close the web.xml file.

Page 17: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 17 of 25

Edit the mapViewer.jsp file In this procedure, you reference the ImageNow Interact JavaScript file, add the Interact task to the tasks pane, and add a JSF declaration for custom task. Make sure that you have a current backup of the mapViewer.jsp file.

1. Either within Eclipse or with a separate text editor, open the mapViewer.jsp file, located by default within the WebContent folder of your project, which Eclipse creates by default during the initial ArcGIS Web Project creation.

2. Locate the <head> … </head> section, which contains several statements that begin with <script type=.

3. Create a new line just before the </head> tag and then add the following statement, with no carriage return:

<script type="text/javascript" language="javascript" src="js/INInteractArcGIS.js"></script>

4. Near the end of the file, locate the statement <h:inputHidden id="taskWindows"/> and then create a new line above it.

5. In the new line, add the following statement with no carriage return:

<a:task mapId="map1" id="interactArcGISTask" value="#{interactArcGISTask}" taskInfo="#{interactArcGISTask.taskInfo}" style="width:100px;height:100px;"/>

6. Locate the section that begins with <div id=”task-menu” class=”task menu”> and then, inside the <ul> tag, add the following statement:

<li class="menu-bar"> <a href="#" class="menu-header" title="ImageNow" onclick="toggleWindow('win_EsriTaskCell_interactArcGISTask');"> <span>ImageNow</span> </a> </li>

7. Save and then close the mapViewer.jsp file.

8. Repeat the website test as described in the “Test the website” section.

Page 18: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 18 of 25

Us ing ImageNow In te rac t fo r ArcG IS Ser ver ImageNow Interact for ArcGIS Server is a document management solution for users of ESRI ArcGIS Server. With ImageNow Interact for ArcGIS Server, you can upload files of any type to the ImageNow repository and link them to individual features on an ArcGIS map layer. You can then use ImageNow Interact for ArcGIS Server to select a feature and display a grid of all the documents linked to that feature. Using your native viewer application or using WebNow (a separate product from Perceptive Software, Inc.), you can also open any of the linked documents for closer inspection.

What is the ImageNow repository? Files uploaded to the ImageNow repository are always saved in two ways. The file’s informational content, which may be in any file format, is saved in an object storage location from which it you can retrieve and view it. The file’s metadata, known as document keys and custom properties in ImageNow Interact, is stored as a record in a database that ImageNow Interact uses for editing document keys, searching for documents, and linking documents to map features.

Using the ImageNow Interact toolbar You use the tools on the ImageNow toolbar to review documents linked to features on your map and to link new or existing repository documents to those features.

Button Description

Selects a region on a map and search for all documents associated with the selected features. It is similar to a lasso tool that allows you to click and drag to select an area on a map.

Links documents to a selected feature on the map.

Clears the selection of all selected features.

Show the ImageNow toolbar Perform the following steps to show or hide the ImageNow toolbar:

1. Use your web browser application to open the ArcGIS map page you want.

2. Under Tasks, click ImageNow.

3. When the ImageNow toolbar appears, drag it to a convenient location on the map page.

4. To hide the ImageNow toolbar, click the Close button.

Page 19: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 19 of 25

Review documents l inked to a feature or features Before you add files to a map feature, you might want to see what files other users have already linked to a single feature or to any of the features in an area of the map, or you might simply need to locate and view a specific piece of information that pertains to a given feature.

1. If necessary, zoom in on the area of the map that contains the features you want.

2. On the ImageNow Interact toolbar, click the Selection tool and then click a map feature or drag a rectangle across the area that contains map features. One of the following actions results from the selection:

• If ImageNow Interact does not detect any documents in its repository linked to the selected features, it displays the message “No ImageNow documents found.” If this occurs, click OK, and, if you want to select another region, repeat this step.

• If ImageNow Interact returns documents linked to the selected features, the ImageNow search results grid appears as shown in the following figure.

Tip You can drag the search results grid to one side of the map window to verify the feature or area highlighted on the map. In the figure above, the selected map area is highlighted in light blue.

3. To expand a document row, in the Drawer column, click the plus (+) sign next to the document and then click the plus (+) sign next to the Pages node. You can also click the plus (+) sign next to the Custom Properties node to inspect additional information about the document.

Page 20: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 20 of 25

4. To view a document’s contents, click the hyperlink (for example, View Page 1) of the page you want to view.

5. In the File Download dialog box, do one of the following actions:

• To open the file with the viewer configured for your ImageNow Interact installation, click Open.

• To place a copy of the file on your local file system, click Save, browse to the destination folder you want, and then click Save again.

6. Close the ImageNow search results grid.

Page 21: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 21 of 25

Link exist ing documents to a feature You can link one or more documents in the ImageNow repository to any one feature within a map layer.

1. On the ImageNow Interact toolbar, click the Link tool and then click a map feature.

2. If ImageNow Interact detects a single map feature, that feature appears in the ImageNow dialog box under Layer Selection in the Select Layer and Select Feature rows, as shown in the following figure. Skip to step 4.

3. If ImageNow Interact detects multiple layers or multiple features or both, it displays one or two drop-down lists under Layer Selection, as shown in the following figure.

Because a link can have only one destination, you must narrow the selection to one layer and one feature. Select a single layer in the Select Layer list and then select a single feature in the Select Feature list.

4. Click Search existing documents and then click OK.

5. In the resulting dialog box, enter search criteria in one or more fields under Document Keys and, if applicable, in the Custom Properties list, select a custom property value.

Page 22: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 22 of 25

6. Click Search. If ImageNow Interact finds documents that satisfy your search criteria, it displays the search results grid, shown in the figure below. If Interact finds no documents, click Edit Search, return to the previous step, and then try using different search values.

Page 23: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 23 of 25

7. Click the document you want to link. To link multiple documents, hold down the CTRL key while you click additional documents. If you do not see the documents you were expecting, click Edit Search and return to step 5, and try using different search values.

8. To link the selected documents to the feature you chose in previously, click Link.

Upload documents and l ink to a feature You can upload documents from your file system to the repository and link them to a map feature.

1. On the ImageNow Interact toolbar, click the Link tool and then click a map feature.

2. If ImageNow Interact detects a single map feature, that feature appears in the ImageNow dialog box under Layer Selection in the Select Layer and Select Feature rows, as shown in the following figure. Skip to the following step.

3. If ImageNow Interact detects multiple layers or multiple features or both, it displays one or two drop-down lists under Layer Selection, as shown in the following figure.

Because a link can have only one destination, you must narrow the selection to one layer and one feature. Select a single layer in the Select Layer list and then select a single feature in the Select Feature list.

4. Click Upload new document and then click OK.

Page 24: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 24 of 25

5. In the resulting dialog box, under Document Keys, select or enter one or more document key values and, if applicable, under Custom Properties, enter custom property values that apply to the uploaded document in the ImageNow repository.

6. Click Browse, locate and select the file to upload, and then click Open.

7. When the file name appears in the Select File box, click Link.

Clear selected features

Click the Clear Selection tool to clear all selected features.

Page 25: ImageNow Interact for ArcGIS Server - Kofax · ImageNow Interact for ArcGIS Server uses this account to make a connection with ImageNow. Give the user a user name such as InteractBridge

ImageNow Interact for ArcGIS Server Installation and Setup Guide Page 25 of 25

I ndex

.NET setup ......................................................... 7

ant directory ..................................................... 11

ArcGIS Server Manager ..................................... 7

bridge user

creating ImageNow account .......................... 4

encrypting password .................................... 11

build file ......................................... See build.xml

build.xml file, modifying ................................... 10

clearing selected features ................................ 24

configuration files, editing ................................ 11

custom properties, creating ............................... 4

documents

inspecting ..................................................... 19

linking to a feature ........................................ 21

uploading ...................................................... 23

Eclipse

creating a new mapping project ..................... 9

Eclipse platform ................................................. 9

editing

configuration files ......................................... 11

faces-config.xml ........................................... 11

mapViewer.jsp file ........................................ 17

web.xml file ................................................... 16

encrypting bridge user password .................... 11

faces-config.xml ............................................... 11

hide toolbar ...................................................... 18

ImageNow Interact for ArcGIS ......................... 18

IN_ESRI_ID ........................................................ 6

inspecting linked documents ........................... 19

Java Development Kit ........................................ 9

Java setup ......................................................... 9

Latitude custom property .................................. 4

Layer Name custom property ............................ 5

linking documents ............................................ 21

Longitude custom property ............................... 4

mapping project, creating for Interact ............... 9

mapViewer.jsp file ............................................ 17

Message Agent .................................................. 4

port number of Message Agent Server ............. 4

pre-installation instructions ............................... 4

project folder .................................................... 11

project type, creating ......................................... 5

repository ......................................................... 18

show toolbar .................................................... 18

testing the website............................................. 9

toolbar

hide ............................................................... 18

show ............................................................. 18

using ............................................................. 18

uploading documents ...................................... 23

using

ImageNow Interact for ArcGIS ..................... 18

toolbar .......................................................... 18

web.xml file ...................................................... 16