Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture...

37
Perceptive Photo Capture Installation and Setup Guide Photo Capture version 2.1 Compatible with ImageNow version 6.7 Written by: Product Documentation, R&D Date: February 2014

Transcript of Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture...

Page 1: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Perceptive Photo Capture Installation and Setup Guide

Photo Capture version 2.1 Compatible with ImageNow version 6.7

Written by: Product Documentation, R&D Date: February 2014

Page 2: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

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

Page 3: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Tab le o f Contents

Perceptive Photo Capture ................................................................................................................. 5

Prerequisites .............................................................................................................................................. 5

User software ......................................................................................................................................... 5

Network software ................................................................................................................................... 6

Supported file types .................................................................................................................................. 6

How do I install Perceptive Photo Capture? ............................................................................................. 6

Install Perceptive Photo Capture ...................................................................................................... 7

Download the Photo Capture files ............................................................................................................ 7

Install the Desktop Experience feature ...................................................... Error! Bookmark not defined.

Run the Photo Capture attended installation ............................................................................................ 8

Install Photo Capture Client and Server ................................................................................................ 8

Install Photo Capture Transfer ............................................................................................................... 9

Run the Photo Capture unattended installation ...................................................................................... 10

Install Photo Capture Client and Server .............................................................................................. 10

Install Photo Capture Transfer ............................................................................................................. 11

Configure Photo Capture defaults .......................................................................................................... 12

Automatically configure ImageNow for Perceptive Photo Capture .................................................. 13

Manually configure ImageNow for Perceptive Photo Capture ......................................................... 14

Create the Staging Area and Sessions drawers ..................................................................................... 14

Create the custom properties ................................................................................................................. 15

Create the folder types and assign custom properties ........................................................................... 16

Create the folder type list ........................................................................................................................ 16

Create the folder hierarchy ...................................................................................................................... 17

Create the Indexing and Session document types ................................................................................. 17

Create the document type list ................................................................................................................. 18

Create the external application plans ..................................................................................................... 18

Create the Photo Capture – Staging application plan ......................................................................... 18

Example: The Staging application plan ............................................................................................... 21

Create the Photo Capture - Indexing application plan ........................................................................ 22

Create the capture profiles ...................................................................................................................... 22

Create the Photo Capture - Staging capture profile ........................................................................... 22

Create the Photo Capture - Indexing capture profile .......................................................................... 23

Create the System Administrator user group and assign privileges....................................................... 23

Perceptive Photo Capture Installation and Setup Guide Page 3 of 37

Page 4: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Create the user group and assign document type, drawer, and folder type privileges ...................... 23

Assign application plan privileges ....................................................................................................... 24

Assign capture profile privileges.......................................................................................................... 25

Assign view privileges .......................................................................................................................... 25

Customize Perceptive Photo Capture ............................................................................................. 26

Create the Photo Capture user ............................................................................................................... 26

Create custom fields in Photo Capture ................................................................................................... 27

Example: ppc.dictionary.settings ........................................................................................................ 28

Create custom properties ....................................................................................................................... 28

Create document types for Photo Capture indexing .............................................................................. 29

Complete the Indexing application plan ................................................................................................. 29

Build the Indexing application plan dictionary .................................................................................... 29

Map the Indexing application plan ...................................................................................................... 30

Configure the information banner ........................................................................................................... 31

Example: ppc.banner.settings ............................................................................................................. 32

Integrate an iScript .................................................................................................................................. 32

Photo Capture iScript layout ............................................................................................................... 32

Enable the iScript ................................................................................................................................. 32

Appendix A: Epic context and EXIF data fields ............................................................................... 33

Epic context information ......................................................................................................................... 33

EXIF data ................................................................................................................................................. 33

Appendix B: ppc.dictionary.settings ............................................................................................... 35

ppc.dictionary.settings ............................................................................................................................ 35

Appendix C: Configuration files ...................................................................................................... 36

ppc.server.settings .................................................................................................................................. 36

TransferClient.ini ...................................................................................................................................... 37

INEpicScan.ini ......................................................................................................................................... 37

Perceptive Photo Capture Installation and Setup Guide Page 4 of 37

Page 5: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Percept i ve Photo Capture The Perceptive Photo Capture application streamlines the process of capturing and indexing photos into ImageNow. Photo Capture completely automates the process: the user simply plugs in a photo device or navigates to a network location at his or her workstation, and then Photo Capture quickly processes the photos. It identifies which photos are new to ImageNow and which photos the user has previously viewed, indexed, or deleted.

With Epic integration, your clinical users can launch Photo Capture directly from within an Epic patient record. The Photo Capture user interface displays any patient, encounter, or photo data the users require. The user can quickly index the photo with a document type and any additional notes, then submit the photos and complete indexes with the click of a button.

Perceptive Photo Capture includes three components.

• Photo Capture Transfer transfers photos from your camera, USB device, or directory to the staging area in ImageNow. You must install Photo Capture Transfer on each computer that users access for photo capturing, or on your terminal server, such as Citrix.

• Photo Capture Client launches directly from your Epic application and allows you to select, sort, and index photos with important patient and contextual information. Photo Capture Client then saves the indexed photos in ImageNow. The Client is a web-based service that is accessible anywhere on your network.

• Photo Capture Server connects the Photo Capture Transfer and the Photo Capture Client with ImageNow Server.

Prerequis ites Before you install Perceptive Photo Capture, you must install and have access to each of the following programs on the network.

User software The following software must be on each end-user machine or on the server that provides end-user content, such as Citrix.

• One of the following versions of Epic

• Epic Spring 2008

• Epic Summer 2009 (v77)

• Epic 2010 (v78)

• Epic 2012 (v79)

• Epic 2014 (v81)

• ImageNow Interact for Epic Client 6.7.x

• Internet Explorer 8 or higher

• If using Windows Server 2008, refer to Appendix D: Install the Desktop Experience feature

Perceptive Photo Capture Installation and Setup Guide Page 5 of 37

Page 6: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Network software The following software components must be available on the network.

• ImageNow Server and Client 6.7.x

• Integration Server 6.7.x

• Apache Tomcat 7.0 with Java Runtime Environment (JRE) 1.7

Note Both Integration Server and Photo Capture Server/Client must run on a machine with Apache Tomcat. However, Integration Server and Photo Capture do not need to run on the same machine.

Supported f i le types Perceptive Photo Capture supports the following file types: BMP, GIF, JPG, PNG and TIFF.

How do I insta l l Percept ive Photo Capture? Installing and configuring Photo Capture consists of three consecutive phases.

1. Install Perceptive Photo Capture

This section of the guide aids you with downloading, installing, and completing basic server configuration for the Photo Capture Server, Client, and Transfer files.

2. Automatically configure ImageNow for Perceptive Photo Capture, or Manually configure ImageNow for Perceptive Photo Capture

These sections guide you through the processes of creating the ImageNow document types, folder types, application plans, and other components that Photo Capture requires. You can automatically create the components by installing the Photo Capture migration package. Alternately, you can manually create and configure each piece individually.

3. Customize Perceptive Photo Capture

To modify your instance of Photo Capture to fit your photo processing needs, follow the steps to customize Photo Capture. Photo Capture provides these flexible options.

• Create custom fields for indexing in Photo Capture Client. For example, add text boxes or pre-populated drop-down lists.

• Add a set of document types.

• Configure the mapping of Photo Capture values to ImageNow document keys or custom properties.

For detailed information on installing, configuring, and customizing Photo Capture, refer to the following sections.

Perceptive Photo Capture Installation and Setup Guide Page 6 of 37

Page 7: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

I ns ta l l Percept i ve Photo Capture To install the Photo Capture Server, Client, and Transfer components, complete each of these tasks in order.

• Download the Photo Capture files

• If using Windows Server 2008, Install the Desktop Experience feature

• Install Photo Capture with an attended or an unattended install process

• Configure Photo Capture defaults

For more information on each task, refer to the following sections.

Download the Photo Capture f i les To download the Photo Capture files, complete the following steps.

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

2. In the Downloads page, download the following files.

• PhotoCaptureSetUp_<version>.exe

This file includes Photo Capture Server and Photo Capture Client. You must install it in a network location that runs Apache Tomcat.

• PhotoCaptureTransferSetUp_<version>.exe

This file includes Photo Capture Transfer. You must install it on each end-user machine or on the server network that drives end-user content, such as Citrix.

• PhotoCapture_<version>.mpk

This file is the Photo Capture migration package. If you use this package, you will install it on ImageNow Server through Management Console.

The migration package creates many of the required ImageNow components, including drawers, custom properties, and application plans. If you plan to add these components to ImageNow Server manually, you do not need to download this file. This guide includes instructions for both configuring ImageNow with the migration package and manually adding all required components.

Perceptive Photo Capture Installation and Setup Guide Page 7 of 37

Page 8: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Run the Photo Capture attended instal la t ion To install Photo Capture Server, Client, and Transfer with installation wizards, complete the following tasks.

Install Photo Capture Client and Server To install Photo Capture Client and Server with the installation wizard, complete the following steps.

1. Stop Apache Tomcat.

2. Open PhotoCaptureSetUp_<version>.exe. To confirm that you stopped your Apache Tomcat server, in the confirmation window, click OK.

3. In the Welcome to the Installation Wizard for Perceptive Photo Capture page, click Next.

4. In the License Agreement page, read the agreement, click I accept the terms in the license agreement, and then click Next.

5. In the Destination Folder page, verify the location of, or click Change to select, your web application server and click Next.

Example: C:\Program Files\Apache Software Foundation\Tomcat 7.0\webapps\

6. In the Configure Photo Capture Server page, in the Photo Capture Client URL field, type the URL with these components in order.

• http:// or https://

• The Photo Capture Client/Server computer name or IP address, such as jsmith-win7

• The Apache Tomcat port number, such as :8080

• The Photo Capture Client directory on Apache Tomcat, such as /ppcclient

Note The installer creates this location if it does not already exist.

• /ImageGallery.html

Example: http://jsmith-win7:8080/ppcclient/ImageGallery.html

Perceptive Photo Capture Installation and Setup Guide Page 8 of 37

Page 9: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

7. In the Integration Server URL field, type the URL with these components in order.

• http:// or https://

• The Integration Server computer name or IP address, such as 127.0.0.1

• The Apache Tomcat port number, such as :8080

• The Integration Server directory on Apache Tomcat, such as /integrationserver

Example: http://127.0.0.1:8080/integrationserver

8. In the Photo Capture username and Password fields, assign an operating system user name and password for Photo Capture. There is no default. Click Next.

Note You create this user later in the installation and configuration process with the Create the Photo Capture user section.

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

10. When the installation completes, click Finish.

Install Photo Capture Transfer To install Photo Capture Transfer with the installation wizard, complete the following steps.

1. Open PhotoCaptureTransferSetUp_<version>.exe.

2. In the Welcome to the Installation Wizard for Perceptive Photo Capture Transfer page, click Next.

3. In the License Agreement page, read the agreement, click I accept the terms in the license agreement, and then click Next.

4. In the Destination Folder page, verify the location of, or click Change to select, the Photo Capture Transfer directory and click Next.

Example: C:\Program Files\Perceptive Software\PhotoCapture.

Note The installation wizard creates this location if it does not exist.

5. In the Configure Photo Capture Transfer page, in the Photo Capture Server location field, type the URL with these components, in order, and click Next.

• http:// or https://

• The Photo Capture Server computer name or IP address, such as jsmith-win7

• The Apache Tomcat port number, such as :8080

• The Photo Capture Server directory on Apache Tomcat, such as /ppcserver

Example: http://jsmith-win7:8080/ppcserver/

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

Perceptive Photo Capture Installation and Setup Guide Page 9 of 37

Page 10: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Run the Photo Capture unat tended insta l lat ion Installing Photo Capture silently is an automatic way to run your installation. If you follow the procedures below, you do not install Photo Capture using the installation wizard. Using this unattended installation method, you can perform a custom installation or use a combination of default and customized settings.

The following tables contain the arguments you can use when you install Photo Capture unattended. If you do not manually set argument values, then the installer uses the default values.

For strings that contain spaces, use escaped quotation marks, \", when setting the argument.

For more information on the Photo Capture user and password you name during the installation, refer to the Create the Photo Capture user section. However, you do not need to create this user name and password prior to the installation.

Install Photo Capture Client and Server

Argument Description Default Example

L*V If you use this argument, the path for the log file generation must be a valid, existing path. Use this argument to diagnose installation errors.

If you do not use the command line argument, it defaults to %TEMP%.

L*V \"C:\logs\Server_UnattendedInstall.txt\"

PPC_CLIENT_URL Specifies the URL for Photo Capture Client. You must set the URL with the Photo Capture Server machine name or IP address, Apache Tomcat port number, and the Photo Capture Client directory name on Apache Tomcat.

PPC_CLIENT_URL="http://jsmith-win7:8080/ppcclient /ImageGallery.html"

INTEGRATION_SERVER_URL

Specifies the URL for Integration Server. You must set the URL with the Integration Server computer name or IP address, Apache Tomcat port number, and the Integration Server directory name on Apache Tomcat.

INTEGRATION_SERVER_URL="http://jsmith-win7:8080/integrationserver"

USER_NAME Specifies the ImageNow username for the Photo Capture user account.

USER_NAME="PhotoCapture"

PASSWORD Specifies the password for the Photo Capture user account.

PASSWORD="Password123"

INSTALLED_DIRECTORY Specifies the Photo Capture Server and Client installation directory.

C:\Program Files\Apache Software Foundation\Tomcat 7.0\webapps\

INSTALLED_DIRECTORY=\" C:\Program Files\Apache Software Foundation\Tomcat 7.0\webapps\"

Perceptive Photo Capture Installation and Setup Guide Page 10 of 37

Page 11: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Argument Description Default Example

IS_CUSTOM_PATH If you use an installation directory other than the default, set to "TRUE".

IS_CUSTOM_PATH="TRUE"

Enter the following command using one of these methods.

• A Command Prompt window

• A command line script you create for your deployment software PhotoCaptureSetUp_<version>.exe /s /V"/qn <argument list>"

The following example shows a command line with argument values.

PhotoCaptureSetUp_2.1.0.286.exe /s /V"/qn PPC_CLIENT_URL="http://jsmith-win7:8080/ppcclient/ImageGallery.html" INTEGRATION_SERVER_URL="http://jsmith-win7:8080/integrationserver" USER_NAME="PhotoCapture" PASSWORD="Password123" INSTALLED_DIRECTORY=\"C:\Program Files\Apache Software Foundation\Tomcat 7.0\webapps\""

Install Photo Capture Transfer

Argument Description Default Example

L*V If you use this argument, the path for the log file generation must be a valid, existing path. Use this argument to diagnose installation errors.

If you do not use the command line argument, it defaults to %TEMP%.

L*V \"C:\logs\Server_UnattendedInstall.txt\"

PPC_SERVER_LOC Specifies the URL for Photo Capture Server. You must set the URL with the Photo Capture Server machine name or IP address, Apache Tomcat port number, and the Photo Capture Server directory name on Apache Tomcat.

PPC_SERVER_LOC="http://jsmith-win7:8080/ppcserver/"

INSTALLDIR Specifies the Photo Capture Transfer installation directory.

INSTALLDIR=\" C:\Program Files\Perceptive Software\"

Enter the following command using one of these methods.

• A Command Prompt window

• A command line script you create for your deployment software PhotoCaptureTransferSetUp_<version>.exe /s /V"/qn <argument list>"

The following example shows a command line with argument values.

PhotoCaptureTransferSetUp_2.1.0.286.exe /s /V"/qn PPC_SERVER_LOC="http://jsmith-win7:8080/ppcserver/" INSTALLDIR=\"C:\Program Files\Perceptive Software\""

Perceptive Photo Capture Installation and Setup Guide Page 11 of 37

Page 12: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Conf igure Photo Capture defaults To configure how Photo Capture Transfer interacts with Epic, complete the following steps.

1. On each user computer, or on the server that provides end-user content, open INEpicScan.ini with a text editor.

Note This file exists in the directory you selected during the Interact for Epic Client installation process. The default directory is [drive:]\Program Files\ImageNow6\Epic.

2. Optional. To set the default scan mode, under [Scan Mode], complete one of the following substeps.

• To set Photo Capture - Point of Care as the default scan mode for Epic, set scan.mode.prompt to false and scan.mode.source to 1.

• To prompt the Epic user to select a scan mode for each scan session, set scan.mode.prompt to true.

Note The Photo Capture - Batch mode is not available for use with Photo Capture 2.1. Do not set scan.mode.source to 2. If you prompt your Epic users to select a scan mode, they must select either ImageNow or Photo Capture - Point of Care. Selecting Photo Capture - Batch can cause the program to fail.

3. Optional. To configure how users initiate Photo Capture Transfer, configure ppc.launch.photo.capture.transfer with one of the following options.

• To launch both Photo Capture Transfer and Photo Capture Client from within Epic, set to true.

• To launch Photo Capture Transfer from the system tray as an independent application, and launch Photo Capture Client from within Epic, set to false.

4. Save and exit INEpicScan.ini.

Perceptive Photo Capture Installation and Setup Guide Page 12 of 37

Page 13: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Automat ica l l y con f igure ImageNow for Percept i ve Photo Capture The Photo Capture migration package creates the standard ImageNow components that Photo Capture requires. These include basic document types, folder types, application plans, capture profiles, and privileges.

If you prefer to configure ImageNow manually, skip this task and refer to the Manually configure ImageNow for Perceptive Photo Capture section. If you use the migration package, the manual configuration section provides a good reference point for the components and processes that the migration package handles for you.

To install the Photo Capture migration package, complete the following steps.

1. To modify the migration package for your ImageNow Server and database schema versions, open PhotoCapture_<version>.mpk with a text editor and complete the following steps.

1. Update <originSchemaVersion> with your ImageNow database schema version.

Tip To locate your schema version, you can run the INTool command intool –cmd get-db-version, or locate the version in your database, in the IN_PRODUCT_MOD_HIST table.

2. Update <originServerVersion> with your ImageNow Server version.

3. Update appVersion= with your Management Console version.

2. To import the migration package, in Management Console, click Migration and complete the following steps.

1. On the Migration tab, click Import Package.

2. In the Open dialog box, click PhotoCapture_<version>.mpk > Open.

3. In the Migration confirmation window, click OK.

3. To complete your Photo Capture set up, proceed to the Customize Perceptive Photo Capture section of this guide.

Perceptive Photo Capture Installation and Setup Guide Page 13 of 37

Page 14: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Manua l l y con f igure ImageNow for Percept i ve Photo Capture If the Photo Capture migration package is unavailable or undesired for your Photo Capture implementation, you need to configure ImageNow Server manually through Management Console. This section guides you through the process of creating the required components.

Complete each of these tasks in the specified order. Then, proceed to the Customize Perceptive Photo Capture section of this guide.

• Create the Staging Area and Sessions drawers

• Create the custom properties

• Create the folder types and assign custom properties

• Create the folder type list

• Create the folder hierarchy

• Create the Indexing and Session document types

• Create the document type list

• Create the external application plans

• Create the capture profiles

• Create the System Administrator user group and assign privileges

Create the Staging Area and Sessions drawers To stage and prepare photos for user indexing, Photo Capture Transfer requires the following two drawers.

• Photo Capture - Staging Area

• Photo Capture - Sessions

To create these drawers, complete the following steps.

1. In Management Console, in the left pane, click Drawers.

2. On the Drawers tab, click New.

3. In the Add Drawer dialog box, on the General tab, type Photo Capture - Staging Area.

Note The name is case-sensitive and must match this value exactly.

4. On the Drawers tab, click New.

5. In the Add Drawer dialog box, on the General tab, type Photo Capture - Sessions.

Note The name is case-sensitive and must match this value exactly.

Perceptive Photo Capture Installation and Setup Guide Page 14 of 37

Page 15: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Create the custom propert ies Photo Capture Transfer requires five custom properties to hold data during the capture process, prior to indexing.

String properties

• Photo Capture - Context Item Name

• Photo Capture - Context Item Value

• Photo Capture - Heartbeat Expiration

Later in this guide, you assign this to the Batch and Transaction folders in the Create the folder types and assign custom properties section.

• Photo Capture - Transfer ID

Later in this guide, you assign this property to the Batch folder in the Create the folder types and assign custom properties section.

Composite properties

• Photo Capture - Context Item

This property consists of the Photo Capture - Context Item Name and Photo Capture - Context Item Value string properties. Later in this guide, you assign this property to the Photo Capture – Session document type in the Create the Indexing and Session document types section.

To create these custom properties, complete the following steps.

1. In Management Console, in the left pane, click Custom Properties.

2. On the Custom Properties tab, click New > String.

3. In the New String Property dialog box, in the Name box, type Photo Capture - Heartbeat Expiration and click OK.

4. To create the following string custom properties, repeat the previous steps.

• Photo Capture - Context Item Name

• Photo Capture - Context Item Value

• Photo Capture - Transfer ID

5. To create the composite custom property, click New > Composite.

6. In the New Composite Property dialog box, complete the following substeps.

1. In the Name box, type Photo Capture - Context Item.

2. In the Available list, CTRL-click Photo Capture - Context Item Name and Photo Capture - Context Item Value, click Add, and then click OK.

Perceptive Photo Capture Installation and Setup Guide Page 15 of 37

Page 16: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Create the fo lder types and assign custom propert ies The Photo Capture content hierarchy includes the following four folder types.

• Photo Capture - User Machine

• Photo Capture - Batch

• Photo Capture - Transaction

• Photo Capture - Images

The Batch and Transaction folders contain the heartbeat custom property. To create these folders and associate the custom property, complete the following steps.

1. In Management Console, in the left pane, click Folder Types.

2. In the right pane, on the Folder Types tab, click New and type Photo Capture - User Machine.

3. To add the following folders, repeat the previous step.

• Photo Capture - Batch

• Photo Capture - Transaction

• Photo Capture - Images

4. To assign the Photo Capture - Heartbeat and Photo Capture - Transfer ID custom properties, complete the following substeps.

1. Click Photo Capture - Batch > Modify.

2. In the Folder Type dialog box, on the Custom Properties tab, in the Available list, CTRL-click Photo Capture - Heartbeat Expiration and Photo Capture - Transfer ID, click Add, and then click OK.

3. Repeat the previous steps to assign the Heartbeat Expiration custom property to the Photo Capture - Transaction folder type.

Create the fo lder type l ist To create the Perceptive Photo Capture folder type list and add the list members, complete the following steps.

1. In Management Console, in Folder Types, on the Folder Type Lists tab, click New.

2. Type the name of the list, Perceptive Photo Capture, and then double-click the name.

Note The name is case-sensitive and must match this value exactly.

3. In the Folder Type List dialog box, on the List Members tab, in the Types list, select each of the Photo Capture folder types, click Add, and then click OK.

Perceptive Photo Capture Installation and Setup Guide Page 16 of 37

Page 17: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Create the fo lder hierarchy To create a folder hierarchy in the Photo Capture - Staging Area drawer, complete the following steps.

1. In Management Console, in Folder Types, on the Hierarchy tab, under Folder Types, drag the Photo Capture - User Machine folder to the Photo Capture - Staging Area drawer.

2. To add the next folder level, drag the Photo Capture - Batch folder to the Photo Capture - User Machine drawer.

Result The Batch folder nests underneath the User Machine folder.

3. Drag Photo Capture – Transaction to the Photo Capture - Batch folder.

Result The Transaction folder nests underneath the Batch folder.

4. Drag Photo Capture – Images to the Photo Capture - Transaction folder.

Result The Images folder nests underneath the Transaction folder.

5. Click Save.

Create the Indexing and Session document types To handle the initial transfer of photos into ImageNow, Photo Capture Transfer requires the following two document types:

• Photo Capture - Indexing applies to all photos in the staging area. Photo Capture Client replaces this type with a user-selected type during the indexing process.

• Photo Capture - Session contains the photo context data for the session, in the form of composite properties.

Your Photo Capture users do not see or interact directly with either document type. To create these document types and assign the Photo Capture – Context Item property, complete the following steps.

1. In Management Console, in the left pane, click Document Types.

2. In the right pane, on the Document Types tab, click New.

3. Add the document types Photo Capture - Indexing and Photo Capture - Session.

Note The names are case-sensitive and must match these values exactly.

4. Click Photo Capture – Session > Modify.

5. In the Document Type dialog box, on the Custom Properties tab, in the Available list, click Photo Capture – Context Item > Add > OK.

Perceptive Photo Capture Installation and Setup Guide Page 17 of 37

Page 18: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Create the document type l ist To retrieve a list of document types for user indexing, Photo Capture Client polls the document type list Photo Capture – Type. Later in this guide, you map this list value in the Create the Photo Capture - Indexing application plan. Then you populate the list with document types in the Create document types for Photo Capture indexing section.

To create the document type list, complete the following steps.

1. In Management Console, in the left pane, click Document Types.

2. In the right pane, on the Document Type Lists tab, click New and type Photo Capture – Type.

Create the external appl icat ion plans Perceptive Photo Capture requires two application plans.

• Photo Capture - Staging handles the initial capture and storage of photos in a staging area, prior to user indexing with Photo Capture Client. With this application plan, Photo Capture indexes all photos with exchangeable image file (EXIF) data, transaction and image IDs, Photo Capture data, and the username of the ImageNow user initiating the transfer.

• Photo Capture - Indexing maps the Epic context information, EXIF data, document type and any configured fields you choose to ImageNow properties.

To create these application plans, complete the following tasks.

Create the Photo Capture – Staging application plan The Photo Capture - Staging application plan handles the initial capture and storage of photos in a staging area, prior to user indexing with Photo Capture Client. With this plan, Photo Capture provides a preliminary indexing of all photos with the following information:

• EXIF date and time, in one of three formats

• Epic username of the user initiating the transfer

• Image type, such as JPG or PNG

• Batch, transaction, and image ID

• The identifying document type Photo Capture - Indexing

• Any additional EXIF data that you want persisted to the final indexing of the photo

Create the Staging application plan

To create the Staging application plan, complete the following steps.

1. In Management Console, in the left pane, expand Application Plans and click External.

2. On the Applications tab, click New.

3. In the Plan Settings dialog box, on the General tab, in the Name box, type Photo Capture - Staging and click OK.

Note The name is case-sensitive and must match this value exactly.

Perceptive Photo Capture Installation and Setup Guide Page 18 of 37

Page 19: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Build the Staging plan dictionary

To build the dictionary, in the Dictionary pane, complete the following steps.

1. Click the New Field button.

2. In the Dictionary Field dialog box, in the Name box, type Photo Capture - User Machine and click OK.

Note All Dictionary Field values are case-sensitive and must match the provided values exactly.

3. Repeat the previous steps to add the following Dictionary Fields:

• Photo - Image ID

• Photo Capture - Batch ID

• Photo Capture - Transaction ID

• Photo Capture - Delete

• Photo Capture - Final Doc ID

• The Staging application plan requires one EXIF date/time value. Select any of these three options.

• EXIF - Date/Time

• EXIF - Date/Time Original

• EXIF - Date/Time Digitized

4. Optional. To add additional EXIF data fields, such as EXIF - Image Description, repeat the previous steps. You must create and map any EXIF values that you need for final indexing in both this application plan and the Photo Capture - Indexing application plan to follow. For a complete list of available EXIF fields, refer to Appendix A: Epic context and EXIF data fields.

Map the Staging application plan

To map the Staging application plan, complete the following steps. For an illustration of the mapped application plan, refer to the Example: The Staging application plan section.

1. To map the drawer, on the Map tab, under Drawer, double-click Drawer and complete the following substeps.

1. In the Drawer Attributes dialog box, in the Source list, click System Drawer.

2. In the Drawer list, click Photo Capture - Staging Area.

3. Click OK.

2. Add four folder levels. To add the folder levels, under Drawer, click Add folder level four times.

3. To map the top folder level, complete the following steps.

1. From the Dictionary pane, drag Photo Capture - User Machine to Folder Name.

2. Double-click Folder Type. In the Folder Type Attributes dialog box, in the Value list, click Photo Capture - User Machine.

Perceptive Photo Capture Installation and Setup Guide Page 19 of 37

Page 20: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

4. Map the second folder level.

1. From the Dictionary pane, drag Photo Capture - Batch ID to Folder Name.

2. Double-click Folder Type. In the Folder Type Attributes dialog box, in the Value list, click Photo Capture - Batch.

5. Map the third folder level.

1. From the Dictionary pane, drag Photo Capture - Transaction ID to Folder Name.

2. Double-click Folder Type. In the Folder Type Attributes dialog box, in the Value list, click Photo Capture - Transaction.

6. Map the fourth folder level.

1. In the fourth folder level, double-click Folder Name.

2. In the Folder Name Attributes box, in the Source list, click Literal.

3. In the Value box, type images and click OK.

4. Double-click Folder Type, and in the Folder Type Attributes dialog box, in the Value list, click Photo Capture - Images.

7. To set the document name, under Document - Default, double-click Document Name and complete the following steps.

1. In the Document Name Attributes dialog box, in the Source list, click Dictionary.

2. In the Value list, click Photo - Image ID.

3. Click OK.

8. To set the document type, under Document - Default, double-click Document Type and complete the following substeps.

1. In the Document Type Attributes dialog box, in the Source list, click Document Type.

2. In the Value list, click Photo Capture - Indexing.

3. Click OK.

9. To map the remaining required fields, drag each of the following dictionary values to the indicated field.

• Map Photo - Image ID to Document Name.

• Map Photo Capture - Batch ID to Field1.

• Map Photo Capture - Transaction ID to Field2.

• Map Photo Capture - Delete to any field or custom property, such as Field3.

• Map Photo Capture - Final Doc ID to any field or custom property, such as Field4.

• Map the EXIF date/time value, such as EXIF - Date/Time, to any field, such as Field5.

Note You cannot map the EXIF date/time value to a custom property.

• Map any additional EXIF dictionary values to any custom property.

10. Save and exit Application Plan Designer.

Perceptive Photo Capture Installation and Setup Guide Page 20 of 37

Page 21: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Example: The Staging application plan This image shows an example of the mapped Staging application plan. Your application plan will vary if you include additional EXIF fields.

Perceptive Photo Capture Installation and Setup Guide Page 21 of 37

Page 22: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Create the Photo Capture - Indexing application plan The Photo Capture - Indexing application plan maps the Epic context information, EXIF data, document type, and any configured fields you choose to ImageNow properties. At this point in the process, you only need to create this application plan. Later in this guide, after you create any optional ImageNow custom properties and Photo Capture custom fields, you complete the application plan with dictionary values and mapping.

To create the Photo Capture - Indexing application plan, complete the following tasks.

1. In Management Console, in the left pane, expand Application Plans and click External.

2. On the Applications tab, click New.

3. In the Plan Settings dialog box, on the General tab, in the Name box, type Photo Capture - Indexing and click OK.

Note The dictionary value names are case-sensitive and must match the provided values exactly.

Create the capture prof i les Photo Capture requires two capture profiles.

• The Photo Capture - Staging capture profile handles the initial capture of photos from the original location into ImageNow.

• The Photo Capture - Indexing capture profile processes the photos after user indexing with Photo Capture Client.

To create these capture profiles, complete the following procedures.

Create the Photo Capture - Staging capture profile To create the Photo Capture - Staging capture profile, complete the following steps.

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

2. On the Capture Profile tab, click New > External Interface.

3. On the Capture Profile Definition window, in the Name box, type Photo Capture - Staging and click Next.

Note This capture profile name is case-sensitive and must match the provided value exactly.

4. In the Application plan list, click Photo Capture - Staging, click Next, and then click Finish.

Perceptive Photo Capture Installation and Setup Guide Page 22 of 37

Page 23: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Create the Photo Capture - Indexing capture profile To create the Photo Capture - Indexing capture profile, complete the following steps.

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

2. On the Capture Profile tab, click New > External Interface.

3. On the Capture Profile Definition window, in the Name box, type Photo Capture - Indexing and click Next.

Note This capture profile name is case-sensitive and must match the provided value exactly.

4. Optional. To route photos indexed in Photo Capture Client into an existing workflow process, in the Workflow process and Workflow queue lists, click a workflow process and start queue.

5. In the Application plan list, click Photo Capture - Indexing, click Next, and then click Finish.

Create the System Administ rator user group and assign pr iv i leges This section instructs you to create the Photo Capture - System Administrator user group and assign the privileges necessary for Photo Capture. Complete the following tasks.

• Create the user group and assign document type, drawer, and folder type privileges

• Assign application plan privileges

• Assign capture profile privileges

• Assign view privileges

Create the user group and assign document type, drawer, and folder type privileges To create the Photo Capture group and assign the document type, drawer, and folder type privileges, complete the following steps.

1. In Management Console, in the left pane, click Groups.

2. On the Group Information tab, click New and type Photo Capture - System Administrator.

3. On the Security tab, click Photo Capture - System Administrator > Modify.

4. In the Security Settings dialog box, click Document Type Privileges and complete the following substeps.

1. In the Document Type list, click Photo Capture - Indexing.

2. For each of the following privileges, click the first column to add the Grant Privilege icon.

• Open

• Edit Keys

• Edit Custom Properties

• Delete

Perceptive Photo Capture Installation and Setup Guide Page 23 of 37

Page 24: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

5. To set the drawer privileges, click Drawer Privileges and complete the following substeps.

1. For the Default drawer, grant the Create/Append privilege.

2. For the Photo Capture - Staging Area drawer, grant each of the following privileges.

• Open

• Search

• Create/Append

• Move

• Rename

• Delete

• Edit Custom Properties

• Edit Keys

3. For the Photo Capture - Sessions drawer, grant each of the following privileges.

• Open

• Search

• Create/Append

• Delete

• Edit Custom Properties

• Edit Keys

6. To set the folder type privileges, click Folder Type Privileges and complete the following substeps.

1. In the Folder Type list, click Photo Capture - Batch.

2. Click the column in front of the Use privilege to add the Grant Privilege icon.

3. Repeat the previous steps to assign the Use privilege to the Photo Capture - Images, Photo Capture - Transaction, Photo Capture - User Machine folder types.

7. In the Security Privileges dialog box, click OK.

Assign application plan privileges To assign privileges to the Photo Capture - Indexing and Photo Capture - Staging application plans, complete the following steps.

1. In Management Console, click Application Plans > External > Photo Capture - Indexing > Settings.

2. In the Plan Settings dialog box, on the Security tab, under Users and Groups, click Add.

3. In the Select Users and Groups dialog box, on the Groups tab, click Photo Capture - Administration, click Add, and then click OK.

Perceptive Photo Capture Installation and Setup Guide Page 24 of 37

Page 25: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

4. In the Plan Settings dialog box, under Privileges, click the Photo Capture - Administration group

and for each of the following privileges, click the first column to add the Grant Privilege icon.

• Link Documents

• Auto Create Folders

• View

5. Click OK.

6. To assign the same privileges in the Photo Capture - Staging application plan, repeat the previous steps.

Assign capture profile privileges To assign privileges to the Photo Capture - Indexing and Photo Capture - Staging capture profiles, complete the following steps.

1. In Management Console, click Capture, double-click Photo Capture - Indexing, and complete the following substeps.

1. In the Configure Capture Profile dialog box, on the Security tab, under Users and Groups, click Add.

2. In the Select Users and Groups dialog box, on the Groups tab, click Photo Capture - Administration, click Add, and then click OK.

3. In the Configure Capture Profile dialog box, under Privileges, click the Photo Capture - Administration group, grant the Use privilege and click OK.

2. Repeat the previous steps to apply the Use privilege to the Photo Capture - Staging capture profile.

Assign view privileges To assign view privileges for the Photo Capture - Administration group, complete the following steps.

1. In Management Console, click Views > All Documents > Modify.

2. In ImageNow View Designer, click the Properties button.

3. In the View Properties dialog box, on the Security tab, under Users and Groups, click Add.

4. In the Select Users and Groups dialog box, on the Groups tab, click Photo Capture - Administration, click Add, and then click OK.

5. Grant each of the following privileges.

• Access

• Access by URL

6. Click OK.

7. Save and close ImageNow View Designer.

Perceptive Photo Capture Installation and Setup Guide Page 25 of 37

Page 26: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Customize Percept i ve Photo Capture To customize Photo Capture for your photo processing workflow, complete the following tasks.

• Create the Photo Capture user

• Create custom fields in Photo Capture

• Create custom properties

• Create document types for Photo Capture indexing

Optional tasks.

• Configure the information banner

• Integrate an iScript

Create the Photo Capture user Photo Capture requires a unique user account on your ImageNow Server. The user account allows Photo Capture to handle these actions.

• Initially transfer photos, and any desired EXIF data, from cameras and directories into ImageNow

• Send user-selected indexing values from Photo Capture Client to ImageNow

• Delete user-selected photos from ImageNow

You cannot use an ImageNow owner or manager login for the Photo Capture user account. This account is only for the Photo Capture application; you do not use the Photo Capture login for your clinical users.

Note You previously assigned the required security privileges at the user-group level in the Create the System Administrator user group and assign privileges section.

To create the user account and add it to the Photo Capture - System Administrator group, complete the following steps.

1. On your operating system, create the new user you specified during the Install Photo Capture Client and Server process, for example, PhotoCapture.

2. Using the ImageNow owner or administrator account, start ImageNow Client.

3. In Management Console, in the left pane, click Users > New.

4. Add the Photo Capture user name you specified during installation.

5. To add the user to the Photo Capture - System Administration group, complete the following substeps.

1. On the Security tab, click the Photo Capture username > Modify.

2. In the Security Settings window, in the left pane, click Group Membership.

3. In the Select Users and Groups dialog box, click Photo Capture - System Administrator, click Add, and then click OK.

4. In the Security Settings window, click OK.

Perceptive Photo Capture Installation and Setup Guide Page 26 of 37

Page 27: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Create custom f ie lds in Photo Capture Photo Capture Client provides the ability to index photos with an ImageNow document type, a description, laterality, and a selection of Epic context information and EXIF data options. You can also create a variety of custom fields to meet your solution needs. You can add any of the following.

• A drop-down list

• A multi-line text box, for users to enter additional comments

• Epic context information or EXIF data beyond what Photo Capture makes available

For more information on the JSON structure of the file and the available properties, refer to Appendix B: ppc.dictionary.settings. For more information on the existing Epic context information and EXIF data options, refer to Appendix A: Epic context and EXIF data fields.

To enable or create new fields, complete the following steps.

1. Navigate to [drive:]\<path>\Apache Software Foundation\Tomcat 7.0\webapps\ppcserver\WEB-INF\classes and open ppc.dictionary.settings with a text editor.

2. Remove the pound signs (#) to uncomment the first and last curly brackets and "fields":

3. Optional. To use the example Comments text box or Laterality list, remove the pound signs before each line of code.

4. Optional. To create a new field, complete the following substeps.

1. Create a copy of the object template and remove the comments.

2. Next to "name", type a name for the field inside the brackets. This name appears in the Photo Capture Client user interface, and you use it in the Photo Capture - Indexing application plan dictionary.

3. Set "type" to User Entry, Predefined List, EXIF, or Epic.

4. If the type is User Entry, set "display" to Multi-Line or Single-Line. For all other types, use a blank set.

5. If the type is User Entry or Predefined List, set "defaultValue" with a value to display by default. For all other types, use a blank set.

6. If the type is Predefined List, populate "listItems" with options for the drop-down list. Wrap each list item with quotation marks, and separate items with a comma.

5. To create additional fields, repeat the previous step.

6. Save and close ppc.dictionary.settings.

Perceptive Photo Capture Installation and Setup Guide Page 27 of 37

Page 28: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Example: ppc.dictionary.settings The following example demonstrates enabling the multi-line Comments text box and the Laterality list.

{ "fields": [ { "name": "Comments", "type": "User Entry", "display":"Multi-Line", "defaultValue": "Enter a comment for the photo.", "listItems": [] }, { "name": "Laterality", "type": "Predefined List", "defaultValue": "Bilateral", "listItems": [ "Left", "Right", "Bilateral" ] } ] }

Create custom propert ies In addition to the standard document properties of Field1-Field5, you can create custom properties for photo indexing. Custom properties offer users an extended 128-character limit, compared to the 40-character limit of Field1-Field5. The following list provides examples of data you may want to index with custom properties.

• Epic context information

• EXIF data

• The description field

• Custom fields, such as user-entry text boxes or drop-down lists

To create custom properties in ImageNow, complete the following steps.

1. In Management Console, in the left pane, click Custom Properties.

2. On the Custom Properties tab, click New > String.

3. In the New String Property dialog box, in the Name box, type a name for the custom property. You can use any name as there are no defaults or Photo Capture-imposed restrictions.

4. Optional. In the Default value box, type a default value for the custom property.

5. Click OK.

Perceptive Photo Capture Installation and Setup Guide Page 28 of 37

Page 29: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Create document types for Photo Capture indexing Photo Capture Client requires users select a document type during indexing. This is the only indexing field that Photo Capture requires. All other indexing fields are optional. We recommend using the document type to index the most important feature of the image. For example, if you work with clinical users who must index photos of wounds based on bodily location, you might create the document types “head,” “neck,” and “arm.”

To populate Photo Capture Client with document type options, Photo Capture uses the document type list Photo Capture - Type. You, or the Photo Capture migration package, previously created this list.

To create document types and add them to the list, complete the following steps.

1. In Management Console, create any document types your users will require. For a review of the steps to create document types, refer to the Create the Indexing and Session document types section.

2. In Management Console, in Document Types, on the Document Type Lists tab, double-click Photo Capture - Type.

3. On the List Members tab, select the document types and click Add.

Note Do not add the Photo Capture - Indexing or Photo Capture - Session document types to this list.

4. Optional. To reorder the document types in the list, in the Members box, select a document type and click Move Up or Move Down. For example, you can move the most commonly used types to the top of the list. The Photo Capture Client user interface displays the document types in this order.

5. Click OK. In the confirmation box, click Yes.

Complete the Indexing appl icat ion plan Photo Capture processes each captured photo as a unique document in ImageNow. In this section, you configure the fields that appear in Photo Capture Client and how they map to ImageNow properties. This section guides you to create a typical Photo Capture indexing application plan. You can modify this suggested application plan to suit your indexing requirements.

Note that to retain EXIF data correctly, you must map any wanted EXIF data, such as EXIF - Date/Time, in both the Staging and the Indexing application plans. To find the Epic context and EXIF data fields available for indexing, refer to Appendix A: Epic context and EXIF data fields. For more information on creating additional fields in Photo Capture Client, refer to the Create custom fields in Photo Capture section.

Build the Indexing application plan dictionary To build a typical indexing plan dictionary, in the Dictionary pane, complete the following steps. For more options on available dictionary values, refer to Appendix A.

1. Click the New Field button.

2. In the Dictionary Field dialog box, in the Name box, type Photo - Type and click OK.

Note All Dictionary Field values are case-sensitive and must match the provided values exactly.

Perceptive Photo Capture Installation and Setup Guide Page 29 of 37

Page 30: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

3. Optional. Repeat the previous steps to add any custom fields you enabled or created in ppc.dictionary.settings, such as Laterality.

4. Optional. Repeat the previous steps to add the following standard fields.

• Epic - Patient Name

• Epic - Visit Date(MM/DD/YYYY)

• EXIF - Date/Time

• Photo - Description

Note Photo Capture does not require these fields. These are commonly used fields provided as an example.

Map the Indexing application plan This section provides the steps to create a typical Photo Capture Indexing application plan map. Your actual Indexing plan map can vary to suit your indexing requirements. Mapping Photo - Type to the document type is the only Photo Capture requirement.

To create a standard mapping, complete the following steps.

1. To open Application Plan Designer, in Management Console, click Application Plans > External, then double-click Photo Capture - Indexing.

2. Each document name must be unique. One way to do this is to set the Document Name to a unique ID. Under Document - Default, double-click on Document Name and complete the following substeps.

1. In the Document Name Attributes dialog box, in the Source list, click Unique ID.

2. Select the Overwrite proposed value check box.

3. Click OK.

2. To set the document type, double-click Document Type and complete the following substeps.

1. In the Document Type Attributes dialog box, in the Source list, click Dictionary.

2. In the Value list, click Photo - Type.

3. Select the Overwrite proposed value check box.

4. Click OK.

Important You must map Document Type with this exact value. Photo Capture will not index photos correctly if you use any other value.

Perceptive Photo Capture Installation and Setup Guide Page 30 of 37

Page 31: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

3. To map the remaining fields, drag dictionary values document keys or custom properties. The following list provides a standard mapping setup as an example.

• Map Epic - Patient Name to Field2.

• Map Epic - Visit Date(MM/DD/YYYY) to Field3.

• Map EXIF - Date/Time to Field4.

• Map Photo - Description to Field5.

• Map any additional desired EXIF data to a field or custom property.

4. Save and exit Application Plan Designer.

Conf igure the informat ion banner Photo Capture Client offers an optional information banner. When enabled, the banner spans the top of the photo gallery and can display up to three pieces of data, such as Epic patient information.

The banner allows you to draw attention to information that is important to your users. For example, you may want to display the patient name, MRN, and visit date for easy accessibility. The banner does not affect photo indexing or replace the Properties pane.

Notes

• To populate the banner fields with Epic values, choose from the values listed in the Epic context information table. The Epic context values are case-sensitive.

• You can include a label for each banner item. If you do not specify a label, the banner only displays the value.

• Photo Capture displays the first label/key pair in 12pt bold font, and any subsequent label/key pairs in 10pt regular font.

To enable and configure the banner, complete the following steps to configure the ppc.banner.settings file.

1. Navigate to [drive:]\<path>\Apache Software Foundation\Tomcat 7.0\webapps\ppcserver\WEB-INF\classes and open ppc.banner.settings with a text editor.

1. Starting with the first curly bracket, remove the pound signs to uncomment the sample banner.

2. Optional. To configure the label, type any description. There are no format constraints on the label. For example,

"label": "MRN",

3. To configure the key, specify the context value, such as an Epic context value. For example,

"key": "Epic - RecordId"

4. Specify up to three context values, then save and close the file.

Perceptive Photo Capture Installation and Setup Guide Page 31 of 37

Page 32: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Example: ppc.banner.settings { "fields": [ { "label": "", "key": "Epic - Patient Name" }, { "label": "MRN", "key": "Epic - RecordId" }, { "label": "Epic - Visit Date", "key": "" } ] }

In tegrate an iScr ipt With this optional process, you can set Photo Capture to run an iScript after a user submits a batch of photos in Photo Capture Client. For example, you could have a custom script that makes HL7 calls to create Epic hyperlinks. Photo Capture invokes the iScript for each image.

This section reviews the basic script layout and the process to enable a script.

Photo Capture iScript layout The following code example shows the basic format Photo Capture requires to integrate an iScript. For more information on writing an iScript, refer to the “Using iScript” topics in ImageNow Help.

function main() { var docId = getInputParams()[0]; // Insert your custom iScript here, using the ImageNow doc ID. return 0; }

Enable the iScript To enable Photo Capture to use an iScript, complete the following steps.

1. Save the iScript to the ImageNow Server script directory. For example, [drive:]\inserver6\script.

2. Open ppc.server.settings with a text editor.

Note The default location is [drive:]\<path>\Apache Software Foundation\Tomcat 7.0\webapps\ppcserver\WEB-INF\classes\.

3. Under Post-Commit iScript, complete the following substeps.

• Set post.commit.iscript.enabled to TRUE.

• Set post.commit.iscript.name to the name of your iScript.

4. Save and close the file.

Perceptive Photo Capture Installation and Setup Guide Page 32 of 37

Page 33: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Append ix A : Ep ic contex t and EX IF da ta f ie lds These tables list the Epic context information and EXIF data fields available for indexing with Photo Capture.

Epic context informat ion

Epic context information

Epic - Contact Serial Number

Epic - Coverage

Epic - dept

Epic - DocNum

Epic - Document Types

Epic - Environment ID

Epic - Guarantor

Epic - Hospital Account

Epic - Local Machine Name

Epic - Order

Epic - Patient External ID

Epic - Patient First Name

Epic - Patient

Epic - Patient Last Name

Epic - Patient Name

Epic - Record Date(MM/DD/YYYY)

Epic - RecordDat

Epic - RecordId

Epic - Result Date

Epic - User ID

Epic - Visit Date(MM/DD/YYYY)

Epic - Visit Date

EXIF data

EXIF data Description

EXIF - Make The manufacturer of the USB device.

EXIF - Model The model of the USB device.

EXIF - Image Description The title of an image.

EXIF - Orientation The orientation of the image in terms of rows and columns.

EXIF - Date/Time The date and time the USB device recorded or last modified the image.

EXIF - Date/Time Original The date and time the USB device originally recorded the image.

EXIF - Date/Time Digitized The date and time the USB device stored the image as digital data.

Note Manufacturer adherence to EXIF specifications is optional, and the use of EXIF date and time options vary between devices.

Perceptive Photo Capture Installation and Setup Guide Page 33 of 37

Page 34: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

EXIF data Description

EXIF - Host Computer Information about the host computer used to generate the image.

EXIF - Version Year A TIFF-specific tag, used in the TIFF-FX standard, which describes the version of the standard.

EXIF - Mode Number A TIFF-specific tag, used in the TIFF-FX standard, which describes the mode of the standard.

EXIF - Rating The Windows rating tag.

EXIF - Copyright The copyright notice of the person or organization that claims rights to the image.

EXIF - User Comment A two-byte character code tag that describes the image.

EXIF - XP Comment A Windows-specific tag that allows users to add a comment to the image.

EXIF - XP Author A Windows-specific tag that allows users to add author information to the image.

EXIF - XP Keywords A Windows-specific tag that allows users to add keywords to the image.

EXIF - Owner Name The owner of the USB device.

EXIF - Serial Number The serial number of the USB device.

Perceptive Photo Capture Installation and Setup Guide Page 34 of 37

Page 35: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Append ix B : ppc.d ic t ionar y.se t t ings

ppc.dict ionary.sett ings Using a JSON structure, the ppc.dictionary.settings file provides the option to create custom user-entry, EXIF, or Epic fields for Photo Capture indexing. The file’s default location is [drive:]\<path>\Apache Software Foundation\Tomcat 7.0\webapps\ppcserver\WEB-INF\classes.

The following table provides definitions and sample data for ppc.dictionary.settings. For more information on creating custom options, refer to the Create custom fields in Photo Capture section.

Field Properties Options Description

fields The General group of settings specifies Interact for Epic Client settings.

name Any valid string A name for the custom option. You use this name to create a new dictionary field in Application Plan designer, and it appears as the field label in Photo Capture Client.

For example, Laterality.

type User Entry A text box.

Text boxes mapped to Field1 through Field5 have a 40-character limit.

Text boxes mapped to custom properties have a 128-character limit.

Define the appearance of the text box with the display property, described below.

Predefined List A drop-down list.

Populate the list options in the listItems property, described below.

Exif An additional EXIF field captured from the photo.

Epic An additional value returned from Epic.

display Multi-line

Single-line

Defines the appearance of a User Entry type box.

Tip If you map a User Entry value to Field1-Field5, use Single-line. If you map User Entry to a custom property, use Multi-line.

Perceptive Photo Capture Installation and Setup Guide Page 35 of 37

Page 36: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

Field Properties Options Description

defaultValue Any valid default The default for the User Entry or Predefined List types. For other Types, use a blank set for the default.

listItems A list including at least one string

The list options for the Predefined List type. For other Types, use a blank set for the default.

Append ix C : Conf igura t ion f i l es You can configure Photo Capture Server, Transfer, and Client with the following files. For more information on these files and their settings, refer to the comments within each file.

ppc.server.set t ings This file configures Photo Capture Server. The default location is [drive:]\<path>\Apache Software Foundation\Tomcat 7.0\webapps\ppcserver\WEB-INF\classes\.

The ppc.server.settings file includes these settings.

• The URL settings specify the location of Photo Capture Client and Integration Server.

• The General settings specify the general configuration of the Photo Capture Server.

• The User settings specify the ImageNow user name and password for the Photo Capture user account.

• The Heartbeat settings control the heartbeat resource. The heartbeat resource is a cache of valid transaction IDs and their associated computer names.

To authorize user access and provide patient security, Photo Capture assigns a unique transaction ID to each photo device based on the contents.

To view or index photos in Photo Capture Client, you must maintain a connection with the original photo location, whether a camera or directory. Photo Capture Client uses this connection for user authentication. To prevent unauthorized user access, Photo Capture Client blocks the image view if you disconnect the device or directory. Reconnecting the device or directory, without modifying the original contents, restores your session.

• Photo Capture Server uses two connection pools to communicate with ImageNow. The Connection Pool settings specify the number of connections to use for each pool.

• The Staging Area settings specify what actions to take on photos that live in the staging area.

The staging area is an ImageNow drawer that temporarily holds photos downloaded by Photo Capture Transfer pending indexing or deletion by a user in Photo Capture Client.

• The Grouping settings configure how Photo Capture groups and processes photos in Photo Capture Client when using Batch Mode.

Perceptive Photo Capture Installation and Setup Guide Page 36 of 37

Page 37: Perceptive Photo Capture - Kofax · Create the external application plans ... in the Photo Capture Client URL field, type the URL ... Perceptive Photo Capture Installation and Setup

• The Post-Commit iScript settings specify whether to run an iScript for each image a user submits from Photo Capture Client.

• The Logging settings specify how Photo Capture Transfer logs transactions and communications.

• The Statistics settings enable and configure Photo Capture Transfer to collect performance data to a log file.

TransferCl ient . in i This file configures Photo Capture Transfer. The file resides in the destination folder you selected during the Photo Capture Transfer installation process.

The TransferClient.ini file includes these settings.

• The Photo Capture settings specify basic directory, timing, and task-based settings for Transfer Client. The only setting that does not include a default is ppc.server.url.

• The Logging setting specifies the level Photo Capture uses to log errors for troubleshooting.

INEpicScan. in i This Interact for Epic Scan file includes two sections, [Scan Mode] and [Photo Capture], that pertain to Photo Capture. The file resides in the destination folder you selected during the Interact for Epic installation process.

• The Scan Mode settings specify which mode Epic Scan Capture uses.

• The Photo Capture settings specify the values that Epic Scan uses when using a Photo Capture scan mode.

Append ix D: Insta l l the Desk top Exper ience fea ture If you install Photo Capture Transfer on Windows Server 2008, you must install the Desktop Experience feature. Complete the following steps.

1. In Server Manager, in the left pane, click Features.

2. In the Features pane, click Add Features.

3. In the Add Features Wizard window, select the Desktop Experience check box and click Install.

4. For the changes to take effect, restart the computer.

Perceptive Photo Capture Installation and Setup Guide Page 37 of 37