ImageNow Interact for Epic Installation and Setup Guide Version: 6.6.x Written by: Product Documentation, R&D Date: ImageNow and CaptureNow are registered trademarks of Perceptive Software, Inc. All other products produced by Perceptive Software, Inc., including WebNow, are Perceptive Software trademarks. All other brands and product names mentioned in this document are trademarks or registered trademarks of their respective owners. Copyright 2013 Perceptive Software. All rights reserved.
Table of Contents ImageNow Interact for Epic... 3 Install Interact for Epic Server and Client... 4 Download the Interact for Epic files... 4 Run the Interact for Epic attended installation... 5 Run the Interact for Epic unattended installation... 6 Install Interact for Epic ROI... 8 Download Interact for Epic ROI plug-in... 8 Run the Interact for Epic ROI attended installation... 8 Run the Interact for Epic ROI unattended installation... 9 Sharing web applications on Apache Tomcat... 11 About web application installation... 11 Configure Apache Tomcat to run multiple web applications... 11 Configure Interact for Epic... 12 Set up single sign-on (SSO) for Interact for Epic... 12 Configure the SSO settings... 12 Enable SSO for a specific user... 14 Enable SSO for all users... 14 Customize the Document Properties pane... 15 Create a basic view... 15 Set a view for Interact for Epic Viewer... 16 Optional: Create a view for a specific document type... 16 Configure basic settings... 18 Troubleshoot Interact for Epic... 19 Logging Interact for Epic Viewer, Interact for Epic CDV, or Interact for Epic Scan... 19 Logging Interact for Epic ROI... 19 Appendix A: INEpicViewer.ini... 20 Appendix B: INEpicCDV.ini... 27 Appendix C: INEpicScan.ini... 29 Appendix D: INEpicPainter.ini... 34 Appendix E: Epic.settings... 38 Index... 41 Page 2 of 41
ImageNow Interact for Epic ImageNow Interact for Epic provides embedded access to your ImageNow documents from within Epic s health information system. This tight integration allows you to scan and retrieve ImageNow documents based upon the currently viewed patient chart without leaving the Epic environment. When ImageNow receives new documents, it notifies Epic of the arrival of relevant medical information. From Epic, users can open the documents for viewing within the embedded ImageNow Interact for Epic Viewer. Enhanced chart printing functionality allows you to print entire patient charts, including both ImageNow documents and Epic chart information, from within Epic. This document explains how to install the ImageNow Interact for Epic Server, Interact for Epic Client, and Interact for Epic Release of Information (ROI) plug-in with both attended and unattended installation methods. The guide also explains how to configure Apache Tomcat. For product technical specifications and system requirements, refer to the Product Technical Specifications document for your version of ImageNow. Prerequisites You must install and have access to the following programs before installing ImageNow Interact for Epic. ImageNow Server and Client 6.6.x Notes For compatibility, the ImageNow Server build number must be equal to, or higher than, the Interact for Epic Server build. You must be a user with management privileges, a manager, or the owner. Apache Tomcat 6.x or higher One of the following supported versions of Epic Epic Spring 2008 Epic Summer 2009 (v77) Epic 2010 (v78) Epic 2012 (v79) Microsoft.NET Framework, version 2 Note Interact for Epic ROI, when used with Epic 2012, requires Microsoft.NET Framework, version 4. If you do not have this required Framework version, the Interact for Epic ROI installer installs it automatically. Page 3 of 41
Install Interact for Epic Server and Client This guide assumes you are installing ImageNow Interact for Epic for the first time, or that you have no earlier versions running on your computer. However, you can update Interact for Epic using the same steps. The installation wizard detects the update and installs the product accordingly. Refer to the ImageNow Readme 6.6.x for information about enhancements and changes that might apply to Interact for Epic. Find the ImageNow Readme 6.6.x and other important documents on the Perceptive Software website at www.perceptivesoftware.com. On the website, click Customer Portal, log in with your user name and password, and then select the Product Documentation tab. The installer for Interact for Epic installs the following components: ImageNow Interact for Epic Viewer, for document viewing. ImageNow Interact for Epic Clinical Deficiency Viewer (CDV) integration, for Epic deficiency synching. ImageNow Interact for Epic Scan integration, for Epic scan acquisition. The installer does not include the Interact for Epic Release of Information (ROI) reporting functionality. After installing Interact for Epic Server, install the Interact for Epic ROI plug-in separately as described in the Install the Interact for Epic ROI plug-in section. Download the Interact for Epic files You must install your web application server, such as Apache Tomcat, before installing Interact for Epic. 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 to a temporary directory on your computer: The latest 32- or 64-bit build of ImageNow Interact for Epic Server 6.6.x, as shown by the highest build number. The latest build of Interact for Epic Client 6.6.x, as shown by the highest build number. 3. Complete the installation on a computer that has the following: Internet access Network access to ImageNow Server Page 4 of 41
Run the Interact for Epic attended installation To run the Interact for Epic Server and Client installation wizards, complete the following steps. Prerequisite You must install Apache Tomcat before installing Interact for Epic. Install Interact for Epic Server To install Interact for Epic Server, complete the following steps. 1. Double-click the Interact for Epic Server file you downloaded. 2. In the Welcome to the Installation Wizard for ImageNow Interact for Epic page, click Next. 3. In the License Agreement page, read the License Agreement, select the I accept the terms in the license agreement box and click Next. 4. In the Destination Folder page, verify the location of, or click Change to select, your web application server and click Next. For example, [drive:]\program Files\Apache Software Foundation\Tomcat <version>\webapps\interactforepic\. 5. In the Interact for Epic Environment Configuration page, do the following steps. 1. In the ImageNow server name field, type the server name. 2. In the ImageNow server port number field, type the port number. The default is 6000. 3. In the Native application viewing list, select Enabled and click Next. 6. In the Ready to Install the Program page, click Install. 7. Stop the Apache Tomcat server. In the ImageNow Interact for Epic Server dialog box click OK. 8. When the installation is complete, click Finish and start the Apache Tomcat server. Install Interact for Epic Client To install Interact for Epic Client, complete the following steps. 1. Double-click the Interact for Epic Client file you previously downloaded. 2. In the Welcome to the Installation Wizard for ImageNow Interact for Epic Client page, complete the following substeps. 1. Read the terms of the license and select the Click to accept the terms of the license and proceed box 2. Optional. To select a destination folder, click Change. The default is [drive]:\program Files\ImageNow6\Epic\ 3. Click Install. 3. In the Installation Wizard Completed window, click Finish. Page 5 of 41
Run the Interact for Epic unattended installation Installing Interact for Epic Server and Client silently is an automatic way to run your installation. If you follow the procedures below, you will not install Interact for Epic using the installation wizard. Using this unattended installation method, you can do a custom installation or use a combination of default and customized settings. The following tables contain the arguments you can use when you install Interact for Epic unattended. If you do not manually set argument values, then the default values are used during the installation. For strings, use escaped quotation marks when setting the argument. Install Interact for Epic Server Argument Description Default Example L *V If you use this argument, setup does not create directories. The path for the log file generation must be a valid, existing path. This argument is typically used to diagnose installation errors. If the command line argument is removed, it defaults to %TEMP%. L *V \"C:\logs\Server_Unattende dinstall.txt\" INSTALLDIR The location of the Interact for Epic Server files. [drive:]\program Files\Apache Software Foundation\Tomcat\7.0 \webapps\interactfor epic INSTALLDIR= \"C:\Epic\ImageNow\ Server\" ES_PORT ImageNow Server port. 6000 ES_PORT_VAL=6000 ES_HOST ImageNow Server host. blank ES_HOST_VAL=jdoe XML_NATIVE.VIE WER Specifies whether to view documents in the native application. XML_NATIVE.VIEWER_VA L= Enter the following command using one of these methods: A command in the Command Prompt window A command line script you create for your deployment software, for example: ImageNow Interact for Epic Server 32-bit 6.6.0 <build>.exe /s /V"/qb <argument list>" The following example shows the command format using argument values: ImageNow Interact for Epic Server 32-bit 6.6.0 <build>.exe /s /V"/qb /L*V \"%LOGFILE%\" INSTALLDIR=\"%INSTALLDIR_VAL%\"ES_PORT=%ES_PORT_VAL% ES_HOST=%ES_HOST_VAL% XML_NATIVE.VIEWER=%XML_NATIVE.VIEWER_VAL%" Page 6 of 41
Install Interact for Epic Client Argument Description Default Example L *V If you use this argument, setup does not create directories. The path for the log file generation must be a valid, existing path. This argument is typically used to diagnose installation errors. If the command line argument is removed, it defaults to %TEMP%. L *V \"C:\logs\I4Eclient_Unatten dedinstall.txt\" INSTALLDIR The location of the Interact for Epic Client files. [drive:]\program Files\ImageNow6\Epic INSTALLDIR= \"C:\Epic\ImageNow\ Client\" Enter the following command using one of these methods: A command in a Command Prompt window A command line script you create for your deployment software, for example: ImageNow Interact for Epic Client 6.6.0 <build>.exe /s /V"/qb <argument list>" The following example shows the command format using argument values: ImageNow Interact for Epic Client 6.6.0 <build>.exe /s /V"/qb /L*V \"%LOGFILE%\" INSTALLDIR=\"%INSTALLDIR_VAL%\" Page 7 of 41
Install Interact for Epic ROI The ImageNow Interact for Epic Release of Information (ROI) plug-in allows a user to fulfill an ROI request from within the Epic HIM ROI module. The Interact for Epic plug-in sends existing ImageNow content for a specific patient to Epic's ROI module. When installing the ROI plug-in, you enter Workstation Settings which supply the value for the Epic resource. Epic passes the following criteria into ImageNow s XML structure: The ImageNow user name of the logged-in Epic user The ImageNow password of the logged-in Epic user The document IDs of any items included in the ROI report A print group for the ROI plug-in that utilizes documents from ImageNow The following example shows ImageNow s XML structure: {\*\EpicData xml <epicdata format="imagenow_doc"><userid>username</userid><password>userpassword</passwo rd><documentid>301yt7v_0001kfq23000003</documentid><imagesize Width='4' Height='8' /></epicdata>} To install the Interact for Epic Server prior to installing the ROI Plug-in, refer to the Install Interact for Epic Server section of this document. Download Interact for Epic ROI plug-in You must install your web application server, such as Apache Tomcat, before installing Interact for Epic. 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 to a temporary directory on your computer: The latest 32- or 64-bit build of ImageNow Interact for Epic Server. For Epic 2010 and previous: ImageNow Interact for Epic ROI 6.6.0 <build>.exe For Epic 2012: ImageNow Interact for Epic ROI Epic 2012 6.6.0 <build>.exe 3. Complete the installation on a computer that has the following: Internet access Network access to ImageNow Server Run the Interact for Epic ROI attended installation You must work with an Epic resource to complete the installation and configuration. To install the Interact for Epic ROI Plug-In, complete the following steps. 1. Double-click the Interact for Epic ROI file you previously downloaded. The installation wizard may prompt you to install required components, including Microsoft.NET Framework and Microsoft Visual C++ 2010 SP1 Redistributable Package (x86). Click Install. 2. In the Welcome to the Installation Wizard for Interact for Epic Release of Information Plug-In page, click Next. 3. In the License Agreement page, read the License Agreement, click the I accept the terms in the license agreement option, and then click Next. Page 8 of 41
4. In the Destination Folder page, verify the installation location for the ROI plug-in. To set a different installation location, click Change. After verifying or changing the location, click Next. An example default location is [drive:]\epic\bin\7.7.5\epic Print Service\Plugins\Painter\. 5. In the Interact for Epic Release of Information Plug-in Configuration page, complete the following substeps. Note To find information on enabling SSO and the single sign-on key value, refer to the Set up single sign-on (SSO) for Interact for Epic section. In the Server:Port field, type your server and port number. For example, 127.0.0.1:8080. Optional. To enable single sign-on capability, select the Enable SSO check box. In the SSO key field, type the single sign-on key value. Click Next 6. In the Ready to Install the Program page, click Install. 7. When the installation is complete, click Finish. 8. Perform the following substeps within Epic. For information on these procedures, refer to the Epic help. 1. In the FDI settings, enter imagenow_doc as the Image Plug-in Name. 2. On the EPS server, restart the EPS service. Run the Interact for Epic ROI unattended installation Installing Interact for Epic ROI silently is an automatic way to run your installation. If you follow the procedures below, you will not install Interact for Epic ROI using the installation wizard. Using this unattended, silent installation method, you can do a custom installation or use a combination of default and customized settings. The following tables contain the arguments you can use when you install Interact for Epic ROI unattended. If you do not manually set argument values, then the default values are used during the installation. For strings, use escaped quotation marks when setting the argument. Argument Description Default Example L *V If you use this argument, setup does not create directories. The path for the log file generation must be a valid, existing path. This argument is typically used to diagnose installation errors. If the command line argument is removed, it defaults to %TEMP%. L *V \"C:\logs\I4EROI_Unattend edinstall.txt\" INSTALLDIR The location of the Interact for Epic ROI files. [drive:]\ Epic\bin\7.7.5\Epi c Print Service\Plugins\P ainters. INSTALLDIR= \"C:\Epic\ImageNow\ROI\" ES_SERVERPORT The server name and port of the Interact for Epic Server, in server:port format. localhost:8080 ES_SERVERPORT=\"jdoe: 8080\" Page 9 of 41
Argument Description Default Example EP_SSO.ENABLED Boolean value specifying whether SSO is enabled. EP_SSO.ENABLED=FALS E EP_SSO.KEY If the SSO is enabled, sets the key. <blank> EP_SSO.KEY=123456 Enter the following command using one of these methods: A command in a Command Prompt window A command line script you create for your deployment software, for example: ImageNow Interact for Epic ROI 6.6.0 <build>.exe /s /V"/qb <argument list> The following example shows the command format using argument values: ImageNow Interact for Epic ROI 6.6.0 <build>.exe /s /V"/qb /L*V \"C:\logs\I4EROI_UnattendedInstall.txt\" INSTALLDIR=\"C:\Epic\ImageNow\ROI\" ES_SERVERPORT=\"jdoe:8080\" EP_SSO.ENABLED= EP_SSO.KEY=123456" Page 10 of 41
Sharing web applications on Apache Tomcat You can configure your Apache Tomcat server to run multiple web applications simultaneously. Any web application that authenticates with ImageNow Server must share the encryption.jar file to run an additional web application on the same web application server. For information on configuring a shared encryption.jar file, refer to the following procedure. About web application installation When you install multiple web applications on the same Apache Tomcat server, you store each web application in its own directory. The default file location can vary according to your customized installation. The following table shows sample locations. Web Application Server Apache Tomcat Apache Tomcat Sample Web Application WebNow Interact for Epic Default Installed Directory [drive:]\<path>\apache Software Foundation\Tomcat 7.0\webapps\webnow [drive:]\<path>\apache Software Foundation\Tomcat 7.0\webapps\interactforepic Configure Apache Tomcat to run multiple web applications To run multiple web applications simultaneously on Apache Tomcat, you must configure the server to share a single encryption.jar file between all of the web apps. Complete the following steps: 1. Stop the Apache Tomcat server and close all internet browsers. 2. Navigate to [drive:]\<path>\apache Software Foundation\Tomcat <version>\webapps, where the Apache Tomcat server stores web applications. Create a new directory called shared. 3. In the webapps directory, select a web application and open the \WEB-INF\lib directory. 4. Cut the encryption.jar file. 5. Navigate to [drive:]\<path>\apache Software Foundation\Tomcat <version>\webapps\shared and paste the encryption.jar file. 6. Delete the encryption.jar from the lib directory for each web application installed on the Apache Tomcat server. 7. Navigate to [drive:]\<path>\apache Software Foundation\Tomcat <version>\conf and open the catalina.properties with a text editor. 8. Set shared.loader to ${catalina.base}\shared\encryption.jar. Page 11 of 41
Configure Interact for Epic Use any of the following procedures as a guide to configure Interact for Epic s features. For a complete list of configuration files and information on setting options, refer to the appendixes located at the end of this document. Set up single sign-on (SSO) for Interact for Epic After you install ImageNow Interact for Epic, you can set up single sign-on (SSO). SSO allows your users to log on to Interact for Epic Viewer, CDV, Scan, the ROI plug-in and ImageNow Client using your SSO provider logon. To fully enable SSO, follow the procedures below to configure the SSO settings. Then, do one of the following procedures: Enable SSO for a specific user Enable SSO for all users Configure the SSO settings To set up SSO for ImageNow Interact for Epic, use the following procedures to configure the SSO settings in the Epic.settings, inow.ini, and INEpicViewer.ini files. If you use the Interact for Epic CDV Integration, Scan integration, or ROI plug-in, follow the optional procedures to configure the corresponding INI files. Configure the Epic.settings file Complete the following steps to configure SSO in the Epic.settings file. 1. On the Apache Tomcat server, navigate to the [drive:]\<path>\apache Software Foundation\Tomcat <version>\webapps\interactforepic\web-inf folder. 2. Using a text editor, open the Epic.settings file. 3. Under the Login settings section, set sso to. 4. Save and close the Epic.settings file. Configure the inow.ini file Complete the following steps to enable SSO between Interact for Epic and ImageNow. 1. On the ImageNow Server computer, navigate to the [drive:]\<path>\inserver6\etc folder. 2. Using a text editor, open the inow.ini file. 3. Under [Logon Control], add the following settings: Create the setting epic.sso and set to. Create the setting epic.sso.key and specify a value for the token sent from ImageNow. The value can be any valid string. Note Use this value for the sso.key setting in the INEpicViewer.ini, INEpicCDV.ini, and INEpicScan.ini files. 4. Save and close the inow.ini file. Page 12 of 41
Configure the INEpicViewer.ini file Complete the following steps to configure SSO for Interact for Epic Viewer. 1. On the ImageNow Interact for Epic Client computer, navigate to the [drive:]\<path>\imagenow6\epic folder. 2. Using a text editor, open the INEpicViewer.ini file. 3. Under [General], update the following settings: Set SSO.enabled to. Set SSO.key to the same value you specified for the epic.sso.key setting in the inow.ini file. 4. Save and close the INEpicViewer.ini file. Configure the INEpicCDV.ini file If using ImageNow Interact for Epic CDV integration, complete the following steps to configure the INEpicCDV.ini file: 1. On the ImageNow Interact for Epic Client computer, navigate to the [drive:]\<path>\imagenow6\epic folder. 2. Using a text editor, open the INEpicCDV.ini file. 3. Under [General], update the following settings: Set SSO.enabled to. Set SSO.key to the same value you specified for the epic.sso.key setting in the inow.ini file. 4. Save and close the INEpicCDV.ini file. Configure the INEpicScan.ini file If using ImageNow Epic Scan integration, complete the following steps to configure the INEpicScan.ini file: 1. On the ImageNow Interact for Epic Client computer, browse to the [drive:]\<path>\imagenow6\epic folder. 2. Using a text editor, open the INEpicScan.ini file. 3. Under [General], update the following settings: Set SSO.enabled to. Set SSO.key to the same value you specified for the epic.sso.key setting in the inow.ini file. 4. Save and close the INEpicScan.ini file. Page 13 of 41
Configure the INEpicPainter.ini file During installation, ROI installation wizard provides the option to enable SSO and type in the SSO key. If you are using ROI and did not configure SSO during installation, complete the following steps to configure the INEpicPainter.ini file: 1. On the ImageNow Interact for Epic Client computer, browse to the [drive:]\[path]\epic Print Service\Plugins\Painters folder. 2. Using a text editor, open the INEpicScan.ini file. 3. Under [General], update the following settings: Set sso.enabled to. Set sso.key to the same value you specified for the epic.sso.key setting in the inow.ini file. 4. Save and close the INEpicScan.ini file. Enable SSO for a specific user After you configure all necessary files as described in the previous section, you can enable SSO for a specific user. To enable a user to log in to ImageNow Interact for Epic through the Epic SSO, configure the user s ImageNow.ini file. Important For security purposes, the ImageNow owner account cannot use SSO or log in manually after you enable SSO. 1. On the ImageNow Client computer, browse to the [drive:]\users\<username>\appdata\roaming\imagenow folder. 2. Using a text editor, open the ImageNow.ini file. 3. Under [General], add the setting epic.sso and set to. 4. Save and close the ImageNow.ini file. Enable SSO for all users After you configure all necessary files as described in the previous section, you can enable SSO for all users. To enable SSO for all users, you need to push the epic.sso setting out to each user. Follow the procedures below to create an EpicSSO.ini file and configure the inserver.ini file on the ImageNow Server. Important For security purposes, the ImageNow owner account cannot use SSO or log in manually after you enable SSO. Create the EpicSSO.ini file Use the following procedure to create a new configuration file that inserver.ini uses to push the epic.sso setting out to each user. 1. Using a text editor, create a file named EpicSSO.ini. 2. In the EpicSSO.ini file, create the following group and setting: [General] epic.sso= 3. Save the EpicSSO.ini on the ImageNow Server computer. Page 14 of 41
Configure the inserver.ini file This configuration pushes the epic.sso setting in EpicSSO.ini out to each user. It also checks for updates each time the client logs in to the server. 1. On the ImageNow Server computer, browse to the [drive:]\inserver6\etc folder. 2. Using a text editor, open the inserver.ini file. 3. Under [ClientINI], update the following settings: Set client.ini.sync.mode to 1. Set client.ini.file.path to a valid path to the new EpicSSO.ini file you just created. 4. Save and close the inserver.ini file. 5. To apply your changes, restart ImageNow Server. Customize the Document Properties pane Using the Management Console, you can create custom document views. In the ImageNow Explorer, document views allow you to: Filter search results Select which document properties appear as columns Create custom document property labels. In Interact for Epic Viewer, your view s custom document property labels appear in the Document Properties pane. To configure Interact for Epic Viewer with a view to display and label specific document properties, use the following procedures in order: Create a basic view Set a view for Interact for Epic Viewer Optional. Create a view for a specific document type Create a basic view The following steps explain how to create a new document view in the Management Console and define the view components in View Designer. To perform this procedure, you must have document view management privileges. 1. In the Management Console, in the left pane, click Views. In the right pane, on the Document tab, click New. In the New View dialog box, complete the following steps: 1. In the Name box, type a name. For example, Epic. 2. In the Description box, type the description of the view that will appear in the ToolTip for the view. 3. Click OK. 2. Select the view and click Modify. Page 15 of 41
3. In the ImageNow View Designer window, in the Preview pane, click the Columns button, perform any of the following actions and then click OK: To display a column in the view, select the check box next to the document property. To create a custom label for a document key, click the document key row, type the new name, and press ENTER. Note You can only create custom labels for the following document properties: Drawer, Folder, Tab, Field3, Field4, Field5, and Type. To rearrange the order of the columns, select a document property and click the Move Up or Move Down button. 4. In ImageNow View Designer, click the Properties button and perform the following actions: 1. On the View Properties window, on the Security tab, under Users and Groups, click Add. 2. In the Select Users and Groups window, on the Groups tab, under Search results, click All Users, click the Add button and then click OK. Note Rather than adding the group All Users, you can create or add a specific group. For example, Epic Users. Any user not included in the group will not be able to access any document in Interact for Epic. 3. In the View Properties window, click OK. 5. Save and exit. 6. In the View Designer dialog box, perform one of the following actions: If you want the view to appear in ImageNow Explorer as an active view in addition to applying labels and restricting fields in Interact for Epic, click Yes to activate the new view. If you want to use the view only to apply labels to fields in Interact for Epic, click No. Set a view for Interact for Epic Viewer The following steps explain how to configure Interact for Epic to use a view. With a view set, Interact for Epic Viewer displays the specified document properties and labels in the Document Properties pane. 1. On the web application server, navigate to the [drive:][path]\interactforepic\web-inf folder. For example, [drive:]\program Files\Apache Software Foundation\Tomcat <version>\webapps\interactforepic\web-inf. 2. Using a text editor, open the Epic.settings file. 3. Under the Display settings section, set properties.view.name to the name of the view you created in Management Console. For example, properties.view.name=epic 4. Save and close the Epic.settings file. Optional: Create a view for a specific document type After you create and set a basic view for Interact for Epic Viewer, you can create additional views for individual document types. For example, if you had a document type Digital Photos, you could create a document type-specific view and label Field3 with Date & Time Photo Captured. By making a specific view for your Digital Photos documents, the label Date & Time Photo Captured only appears on your Digital Photos document types. Page 16 of 41
You do not need to create a separate view for every document type. Interact for Epic Viewer uses the basic view you set in properties.view.name, such as Epic, for any document type without its own, specific view. 1. In the Management Console, in the left pane, click Views. In the right pane, on the Document tab, click New. In the New View dialog box, complete the following steps: 1. In the Name box, type a name in the format <basic view name> - <document type>. For example, for a basic view named Epic and the document type of Digital Photos, name the view Epic Digital Photos. 2. In the Description box, type a description of the view that will appear in the ToolTip for the view. 3. Click OK. 2. Select the view and click Modify. 3. In the ImageNow View Designer window, in the Preview pane, click the Columns button, perform any of the following steps and then click OK: To display a column in the view, select the check box next to the document property. To create a custom label for a document property, click the document property row, type the new name, and press ENTER. Note You can only create custom labels for the following document properties: Drawer, Folder, Tab, Field3, Field4, Field5, and Type. To rearrange the order of the columns, select a document property and click the Move Up or Move Down button. 4. In ImageNow View Designer, click the Properties button and perform the following actions: 1. On the View Properties window, on the Security tab, under Users and Groups, click Add. 2. In the Select Users and Groups window, on the Groups tab, under Search results, click All Users, click the Add button and then click OK. Note Interact for Epic blocks any user not given permission to access this view from accessing the document. If you created a special user group in the Create a basic view procedure, such as Epic Users, you must give the group permission to access this view. 3. In the View Properties window, click OK. 5. Optional. If you want to the view to appear in ImageNow Explorer as an active view, you need to constrain the view to the document type. Otherwise, the view returns all document types in ImageNow. 1. On the View tab, click the Add button. In the Add Condition dialog box, perform the following steps: 2. In the Constrain By list, select Document key. 3. In the Type list, select Normal. 4. In the Field list, select Type. 5. Note If you applied a custom label to Type, the custom label appears instead of Type. 5. In the Operator list, select is equal to. 6. In the Value list, select the document type you specified in the view name, (for example, Digital Photos ). 7. Click OK. 6. In the ImageNow View Designer window, save and exit. Page 17 of 41
7. In the View Designer dialog box, perform one of the following actions: If you want the view to appear in ImageNow Explorer as an active view in addition to applying labels and restricting fields in Interact for Epic, click Yes to activate the new view. If you want to use the view only to apply labels and restrict fields in Interact for Epic, click No. Tip Keep properties.view.name in Epic.settings set to the name of the basic view, such as Epic. Interact for Epic Viewer automatically displays either the basic view, such as Epic, or a document type-specific view, such as Epic Digital Photos, based on the active document s type. Configure basic settings The Interact for Epic configuration file INEpicViewer.ini defines the basic functionality and appearance of Interact for Epic Viewer. For more detailed definitions of each setting, refer to Appendix A. Perform any of the following procedures in the INEpicViewer.ini file. Enable the Launch document in ImageNow Viewer button To enable the Launch document in ImageNow Viewer button on the Interact for Epic toolbar, under [General], set launch.imagenow.client. to. This allows users to open documents in ImageNow Viewer from Interact for Epic Viewer. Close Interact for Epic Viewer automatically To automatically close Interact for Epic Viewer when the ImageNow Viewer launches, under [General] set launch.imagenow.client.close.viewer to. Configure proxy server settings If you use a proxy server, configured in Internet Explorer s Internet Options window, under [General], set use.ie.proxy.settings to. Show or hide annotation types Perform any of the following steps under the [Documents] group. To show all annotation types on documents, set annotations.all to and annotations.none to. To hide all annotations, set annotations.all to and annotations.none to. To show or hide specific annotation types, perform all of the following actions: 1. Set annotations.all to. 2. Set annotations.none to. 3. Set each individual annotation setting, such as annotation.check, to to display or to hide. Note These settings only affect which annotations display or hide in Interact for Epic Viewer. If a user launches a document in the ImageNow Viewer, annotations appear according to the user s ImageNow privileges. Page 18 of 41
Troubleshoot Interact for Epic If a functional issue occurs, use the information in this section to create logs to aid with troubleshooting. Logging Interact for Epic Viewer, Interact for Epic CDV, or Interact for Epic Scan To increase the level of detail at which Interact for Epic logs errors for troubleshooting, follow the procedure below. 1. On the ImageNow Interact for Epic Client computer, browse to the [drive:]\program Files\ImageNow6\Epic folder. 2. Using a text editor, perform any of the following actions: In the INEpicViewer.ini file, under [Logging], set debug.level.file to a number between 1 and 6. Save and close the INEpicViewer.ini file. Open the INEpicCDV.ini file, under [Logging], set debug.level.file to a number between 1 and 6. Save and close the INEpicCDV.ini file. Open the INEpicScan.ini file, under [Logging], set debug.level.file to a number between 1 and 6. Save and close the INEpicScan.ini file. 3. To view a log, navigate to [drive:]\users\<username>\appdata\roaming\imagenow\log, then open the most recent log file in a text editor. Note The higher the number, the more detailed the logging. Reset to 0 after you finish debugging. Failure to do so can slow performance and consume hard disk space. Logging Interact for Epic ROI To increase the level of detail at which Interact for Epic logs errors for troubleshooting, follow the procedure below. 1. On the ImageNow Interact for Epic Client computer, browse to the [drive:]\[path]\epic Print Service\Plugins\Painters 2. Using a text editor, in the INEpicPainter.ini file, under [Logging], set debug.level.file to a number between 1 and 6. Save and close the INEpicPainter.ini file. 3. To view a log, navigate to [drive:]\users\<username>\appdata\roaming\imagenow\log, then open the most recent log file in a text editor. Note Interact for Epic ROI creates the error log in the <username> directory for the username Epic Print Service runs as, not to the directory for the user requesting the ROI. Page 19 of 41
Appendix A: INEpicViewer.ini The following table provides definitions and sample data for the settings in the INEpicViewer.ini configuration file. This table displays the INI settings under group headings in brackets, for example, [General], in the order the groups appear in the INI file. Each setting offers two or more options, which are defined and described in the table below. Use this table as a guide when customizing the file. The default Master INI file location is [drive:]\program Files\ImageNow6\Epic\INEpicViewer.ini. You can select a different destination folder during the Interact for Epic installation process. The default User INI file location is [drive:]\users\<username>\appdata\roaming\imagenow\inepicvieweruser.ini. Note The default Master INI file location is C:\Program Files (x86)\imagenow6\epic\inepicviewer.ini for 64-bit versions of Windows. Group Setting Options Description General The General group of settings specifies basic ImageNow Interact for Epic Client settings. url sso.enabled http://<server name>:<port number>/ interactforepic/ GetPage Specifies the path to the Interact for Epic Server for fetching pages of the document. The default is http://127.0.0.1:8080/interactforepic/ GetPage Specifies whether to enable single sign-on for Interact for Epic and ImageNow. Notes To enable single sign-on for Interact for Epic, you must also configure the single sign-on on the Server computer. When you enable single sign-on, your single sign-on provider supplies authentication information. Users cannot log in to Interact for Epic anonymously. Refer to the Set up single sign-on (SSO) for Interact for Epic section of this document for set up information. The default is. sso.key Any valid string Specifies the token used when you enable single sign-on for Interact for Epic and ImageNow. Note The string value must match the key provided on the ImageNow Server in the inow.ini. Page 20 of 41
Group Setting Options Description sso.use.epic.id launch.imagenow.client launch.imagenow.client.close. viewer use.ie.proxy.settings Specifies whether to use the EpicID or the external ID and password passed through the Epic API for logging into ImageNow. = The external ID and password from Epic are used. = The Epic ID is used. The default is. Note You must set sso.enabled to to enable this setting. Specifies whether to enable the Launch document in ImageNow Viewer button in the Interact for Epic Viewer. This button launches the current document in the ImageNow Viewer. The default is. Specifies whether to close the Interact for Epic Viewer when you click the Launch document in ImageNow Viewer button. The default is. Specifies whether to use the Internet Explorer (IE) proxy server setting. The IE default automatically detects proxy servers, causing an authentication delay in Interact for Epic. If you configure a proxy server in the Internet Options window of IE or your Control Panel, set to. The default is. Documents The settings in the Documents group enable you to specify the types of annotations that display. If you do not have sufficient privileges in ImageNow to hide an annotation, the annotation appears in the Interact for Epic Viewer even if the specific setting for that annotation is set to. annotations.all Specifies whether annotations are rendered on the document. This setting overrides all other annotation settings. The default is Page 21 of 41
Group Setting Options Description annotations.none annotations.arrow annotations.check annotations.highlight annotations.line annotations.rectangle annotations.oval Specifies whether annotations are rendered on the document. This setting overrides all individual annotation settings. It does not override the annotations.all configuration. = No annotations display, unless annotations.all is set to. = All annotations display, unless annotations.all is set to. Note If both annotations.all and annotations.none are set to, the individual settings for each annotation are used. The default is. Specifies whether arrow annotations are rendered on the document. The default is. Specifies whether check annotations are rendered on the document. The default is. Specifies whether highlight annotations are rendered on the document. The default is. Specifies whether line annotations are rendered on the document. The default is. Specifies whether rectangle annotations are rendered on the document. The default is. Specifies whether oval annotations are rendered on the document. The default is. Page 22 of 41
Group Setting Options Description annotations.pen annotations.stamp annotations.text annotations.url annotations.digitalsignature Specifies whether pen annotations are rendered on the document. The default is. Specifies whether stamp annotations are rendered on the document. The default is. Specifies whether text annotations are rendered on the document. The default is. Specifies whether URL annotations are rendered on the document. The default is. Specifies whether digital signature annotations are rendered on the document. The default is. Layout The Layout group of settings specifies how generated documents appear. default.fit.mode height width page zoom Specifies how the image appears when it first displays in the Interact for Epic Viewer. Notes Height = Fits the image to its height in the display area. Width = Fits the image to its width in the display area. Page = Fits the image to both its width and height in the display area. Zoom = Displays the image at a set zoom level. The default is page. default.zoom.percentage 0 through 100 Specifies the zoom level when default.fit.mode is set to zoom. The default is 100 Page 23 of 41
Group Setting Options Description download.path Any valid directory Overrides the temporary path where images downloaded from WebNow are stored. The default is \Documents and Settings\<username>\Application Data\ImageNow\temp. Logging Specifies the level that Interact for Epic uses to log errors for troubleshooting. debug.level.file 0 through 6 Specifies the level for which ImageNow logs errors for troubleshooting. Use minimal logging unless you are debugging an issue. If you increase the logging level, make sure that you set it back down after you finish debugging. Failure to do so can slow performance and consume hard disk space. 0 = Logging is off. 1 through 6 = Logging is on. The higher the number, the more verbose the logging. For example, 1 offers minimal logging, whereas 6 offers the most detailed log information. The default is 0. Lockdown Configuration The Lockdown Configuration group of settings prevents the user from changing configuration settings in the ImageNow Interact for Epic Viewer. lockdown.configuration.zoom lockdown.configuration.large. icons Prevents the user from changing the default fit mode. The default is. Prevents the user from changing the size of the icons. The default is. Default User Settings Specifies default user settings if the INEpicViewerUser.ini file is not present in the user s home directory. This setting is useful in environments where the user s application data is not retained from one session to the next. Settings in the INEpicViewerUser.ini file override the Default User Settings. default.show.properties.panel Specifies whether to show the document properties panel. The default is. Page 24 of 41
Group Setting Options Description Default User Settings (continued) default.show.staus.bar Specifies whether to show the status bar. The default is. default.show.tasks.panel Specifies whether to show the deficiency tasks panel. The default is. Note This setting does not apply to the HIMScanSig interface. default.show.thumbnails.pane Specifies whether to show the thumbnails pane. The default is. default.properties.panel.width default.properties.panel. height default.thumbnails.panel. height Any positive number Any positive number Any positive number greater than 165 Defines the width of the document properties panel in pixels. Note Interact for Epic calculates the default based on the screen resolution of the machine on which the client is running. Setting a value here affects all users and may cause unexpected results for users with different screen resolutions. Defines the height of the document properties panel in pixels. Note Interact for Epic calculates the default based on the screen resolution of the machine on which the client is running. Setting a value here affects all users and may cause unexpected results for users with different screen resolutions. Defines the height of the thumbnails panel in pixels. Note Interact for Epic calculates the default based on the screen resolution. Setting a value here affects all users and may cause unexpected results for users with different screen resolutions. Page 25 of 41
Group Setting Options Description default.window.position 0,0,0,0 Defines the position and size of the window. By default, Interact for Epic positions the window relative to the host application. The default window position and size are specified in pixels. The format for this setting is as follows: x-position, y-position, width, height. The default is 0,0,0,0 Page 26 of 41
Appendix B: INEpicCDV.ini The following table provides definitions and sample data for the settings in the INEpicCDV.ini configuration file. This table displays the INI settings under group headings in brackets, for example, [Scan Analysis], in the order the groups appear in the INI file. Each setting offers two or more options, which are defined in the table below along with a description of each setting and its options. Use this table as a guide when customizing the file. The INI file resides in the destination folder you selected during the installation process. Group Setting Options Description Scan Analysis The Scan Analysis group of settings specifies basic settings for the Epic CDV integration. project.type Default Specifies the project type to open. open.in.workflow Specifies whether the project opens in workflow mode if the project is in a workflow queue. General The General group of settings specifies basic settings for the Epic CDV integration. sso.enabled Specifies whether to enable single sign-on for ImageNow. Notes To enable single sign-on for ImageNow, you must also configure the single sign-on on the Server computer. When you enable single sign-on, your single sign-on provider supplies authentication information. Users cannot log in to ImageNow anonymously. Refer to the Set up single sign-on (SSO) for Interact for Epic section of this document for set up information. The default is. sso.key Any valid string Specifies the token used when you enable single sign-on for ImageNow. Note The string value must match the key provided on the ImageNow Server in the inow.ini. Page 27 of 41
Group Setting Options Description Logon Settings The settings in the Logon Settings group enable you to adjust logon parameters as needed. logon.use.epic.id Specifies whether to use the EpicID or the external ID and password passed through the Epic API for logging into ImageNow. = The external ID and password from Epic are used. = The Epic ID is used. The default is. logon.attempt.max 0 through 25 Specifies the number of attempts to login to the ImageNow client. The default is 10. The maximum is 25. logon.attempt.delay Number of milliseconds Specifies the amount of time in milliseconds to delay between each login attempt. The default is 500. Logging Specifies the level that Interact for Epic uses to log errors for troubleshooting. debug.level.file 0 through 6 Specifies the level for which ImageNow logs errors for troubleshooting. Use minimal logging unless you are debugging an issue. If you increase the logging level, make sure that you set it back down after you finish debugging. Failure to do so can slow performance and consume hard disk space. 0 = Logging is off. 1 through 6 = Logging is on. The higher the number, the more verbose the logging. For example, 1 offers minimal logging, whereas 6 offers the most detailed log information. The default is 0. Page 28 of 41
Appendix C: INEpicScan.ini The following table provides definitions and sample data for the settings in the INEpicScan.ini configuration file. This table displays the INI settings under group headings in brackets, for example, [Capture], in the order the groups appear in the INI file. The INI file resides in the destination folder you selected during the installation process. Group Setting Options Description Capture The Capture group of settings allows you to specify the name of the capture profile that runs when the scan starts. You can also set the source, mode and delimiter for the capture profile, when prompting for the capture profile. capture.profile.name capture.profile.prompt Any valid capture profile Specifies the capture profile used for scanning. Specifies whether to prompt the user for a capture profile to use for scanning. = The capture.profile.name value is used. The default is. capture.profile.source -1 through 2 When prompting for a capture profile, specifies the source for the capture profiles to choose from. -1 = All sources 0 = File 1 = Scanner 2 = ImageNow Printer The default is 1 capture.profile.mode -1 through 2 When prompting for a capture profile, specifies the mode for the capture profiles to choose from. -1 = All modes 0 = Single 1 = Batch 2 = Package The default is 0 Page 29 of 41
Group Setting Options Description capture.profile.delimiter Any character When prompting for a capture profile, specifies the delimiter to separate the capture profile list. The delimiter must be a character that does not occur in any of the capture profile names. The default is ^. Key Mapping The Key Mapping group of settings specifies how index keys are assigned to scans through the Epic Scan integration. Use these settings to specify an Epic context name. The corresponding value is passed into ImageNow as a capture COM value. You can use the values in ImageNow by selecting COM Value as the source on the index keys tab of a capture profile. drawer folder, tab, f3, f4, f5 <text> = A valid drawer <text> = A literal string of text up to 40 characters Example: folder = EpicScanTest <uniqueid> = A unique value in the form of a document ID by adding <<uniqueid>> Example: folder = <<uniqueid>> Specifies the index key used for the drawer. This field is required. If the drawer is not valid, then "Default" is used. Specifies the index key used for the folder, tab, and fields 3, 4, and 5. Note For information on <name> options, refer to the note that appears below this table. The defaults are: folder =Contact Serial Number tab =Patient Name f3 =Visit Date (MM/DD/YYYY) f4 =<blank> f5 =<blank> <name> = One of the names to use a value passed by Epic (see table below) Example: folder = Contact Serial Number Page 30 of 41