XDS Connector. Installation and Setup Guide. Version: 1.0.x

Size: px

Start display at page:

Download "XDS Connector. Installation and Setup Guide. Version: 1.0.x"

Gyles Nichols
5 years ago
Views:

1 XDS Connector Installation and Setup Guide Version: 1.0.x Written by: Product Knowledge, R&D Date: November 2016

2 2016 Lexmark. All rights reserved. Lexmark is a trademark of Lexmark International Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Lexmark.

3 Table of Contents Overview... 4 Required components... 4 Software prerequisites... 4 Licenses... 4 Installation and setup... 5 Download XDS Connector... 5 Install XDS Connector... 5 Change Perceptive Connect port number... 5 Install XDS Interact Setup... 6 Configure XDS Connector... 7 Configure Acuo XDS Interaction REST Service... 7 Configure Perceptive XDS Connector... 9 Map ImageNow workflow queue ID with Perceptive Connect service... 9 Delete document or folder after successful XDS upload Uninstall XDS Connector Uninstall Perceptive Connect Windows service Uninstall XDS Interact Setup Troubleshoot XDS Connector How to verify that Integration Server is up and running before routing any document Appendix A: Glossary

4 Overview The XDS Connector is developed with the primary purpose of archiving medical images and documents containing text, images, and vocabulary-coded clinical information for a healthcare enterprise in a highly interoperable fashion. The XDS Connector allows you to initiate medical content capture through ImageNow's Capture capability using single or batch mode. The captured object is indexed and temporarily stored in ImageNow either as a document or as a folder containing multiple documents. The captured object is routed to the Perceptive Connect workflow queue. The Perceptive XDS Connector then invokes Acuo XDS Interaction REST Service, which in turn sends the object and index keys to Acuo XDS Registry-Repository that receives and stores the object and index keys in the VNA. Upon successful receipt of data, VNA sends an acknowledgement response to ImageNow, which in turn deletes the temporary folder or document at its end. This solution uses Acuo XDS Registry-Repository in order to receive documents from ImageNow. However, you may use any other XDS repository as per your choice. This document explains how to install and set up the XDS Connector. It also describes the procedure to configure the XDS Connector to suit user requirements. Required components Software prerequisites You must install the following software before you install and configure the XDS Connector. ImageNow Server, version 6.7 or 6.8 ImageNow Client, version 6.7 or 6.8 Note You must be a user with management privileges, a manager, or the owner. Perceptive Connect 0.12 Integration Server, version 6.7 or 6.8. Note The Integration Server version must be compatible with the ImageNow version. Microsoft.NET Framework 4 Acuo XDS Repository or any other XDS Repository Acuo XDS Registry or any other XDS Registry You need the following component as a prerequisite only if you capture documents using Interact for Epic. However, you may choose to capture documents using any other ImageNow Capture mechanism, provided that mechanism gives the desired metadata to ImageNow. Interact for Epic (optional) Licenses You are required to have the following ImageNow licenses: ImageNow Server Integration Server + unlimited transaction pack 4

5 Interact for Epic (optional) Acuo XDS Repository Acuo XDS Registry Perceptive Connect Installation and setup This section provides information on how to complete the following tasks. Download XDS Connector Install XDS Connector Configure XDS Connector Uninstall XDS Connector Download XDS Connector 1. Go to the Perceptive Software website at and log into the Customer Portal. 2. In the Product Downloads page, search for all downloadable items for the product and version you want to use. These files may include a product installer, product documentation, or set of supporting files. 3. Download the relevant files to a temporary directory on your computer. Install XDS Connector To install the XDS Interact Setup, you must have Perceptive Connect Windows service installed on your machine. For Perceptive Connect installation steps, refer to the Perceptive Connect Installation and Setup Guide, available on the Product Documentation tab in the Customer Portal on the Perceptive Software website. You must have administrative privileges to perform the procedure. To work with the supporting files, navigate to the local directory where you downloaded the supporting files following the instructions in Download XDS Connector section. Change Perceptive Connect port number By default, Perceptive Connect and Integration Server are deployed on port number 80. Before you install the XDS Interact Setup, you must ensure that Integration Server and Perceptive Connect installations are using different port numbers. Also, make sure that port number 80 is not used by any other service. To change the Perceptive Connect port number, perform the following procedure. 1. Navigate to the Perceptive Connect installation directory, and double-click perceptiveconnectw.exe monitor program to configure and start or stop the service. The default location of the file is [drive:]\<perceptive Connect install directory>\bin\perceptiveconnectw.exe. 2. To configure the external properties, in the Perceptive Connect Properties dialog box, you can perform the following actions. 5

6 3. Click OK. To modify the HTTP port for the web server, on the Java tab, under Java Options, modify the org.osgi.service.http.port property. To modify the log level for Perceptive Connect, on the Logging tab, in the Level list, set the property to any one of the following options: Error, Info, Warning, or Debug. To set the log path for Perceptive Connect, on the Logging tab, set the Log path property to the relative or absolute path where logs will be saved. Install XDS Interact Setup 1. Navigate to the folder where your local installation files are stored and select the appropriate installer, such as XDSInteractSetup_<version>.exe. In the XDSInteractSetup_<version>.exe file name, <version> stands for the version number. Ensure that you use the file with the latest version number. 2. Right-click the installer and select Run as administrator. 3. In the Welcome to the Installation Wizard for XDS Interact Setup page, click Next. 4. In the License Agreement page, read the License Agreement, scroll to the bottom of the agreement, select I accept the terms in the license agreement, and then click Next. 5. In the Setup Type page, under Select a setup type, you can select one or more of the following installation options. By default, all options are selected. Acuo XDS Interaction REST Service. This option installs the Acuo XDS Interaction REST Service. XDS ImageNow Components. This option creates a customized modifiable XDS interact ImageNow environment with Custom Properties, Doc Types, Workflow, etc. Perceptive XDS Connector. This option installs the Perceptive XDS Connector. 6. Click Next. 7. In the Acuo XDS Interaction REST Service page, browse to the directory path where you want to install the service and then click Next. This page appears only if you have chosen to install the Acuo XDS Interaction REST Service option. 8. In the Perceptive Connect Details page, complete the following substeps. This page appears if you have chosen to install either or both of XDS ImageNow Components and Perceptive XDS Connector options. 1. Under Machine Information, in the IP or Host name box, enter the IP address of the machine where you have installed Perceptive Connect. 2. Under Machine information, in the Port box, enter the port number of the machine where you have installed Perceptive Connect. 3. To verify the correctness of the entered data, click Test Connection. 4. Click Next. 9. In the Ready to Install the Program page, click Install. 10. In the Installation Wizard Completed page, click Finish. 6

7 Configure XDS Connector If you modify the configuration information, make sure to stop and start the Windows service again to implement the changes. Configure Acuo XDS Interaction REST Service Appsetting.config To see the configuration settings, browse to the installation folder and open the Appsetting.config file. Typically, the path is [drive:]\program Files (x86)\perceptive Software\Acuo Interact Service\AcuoXDSInteractService. You can change the information in the configuration file according to your solution requirements. The following example shows a sample XML data instance. For actual configuration information, refer to the configuration file in your installation folder. <appsettings> <add key="integrationserverip" value=""/> <add key="integrationserverport" value=""/> <add key="pcuser" value=""/> <add key="pcpassword" value="" /> <add key="logmessage" value="true"/> <add key="isproxy" value=""/> </appsettings> The following table provides definitions and setting options for the configuration file. Unless otherwise noted, the default setting is blank. XML Key Default Setting Description IntegrationServerIP IntegrationServerPort PCUser PCPassword The IP address of the Integration Server. This is the port number of the Integration Server. This is the Integration Server login user ID. This value must be set at the time of installation. This is the Integration Server login password. This value must be set at the time of installation. This value should be a base64 encoded string. You can use any authentic encoder to encode your password and use it in the Appsettings.config file. For example, to encode your password using a Windows command, save your password in a TXT file, such as 'password.txt'. Run the CertUtil command to encode the password as a base64 string in Windows 7. CertUtil [Options] -encode InFile OutFile Encode file to Base64 certutil -encode password.txt encodedpassword.txt This saves the encoded string in a TXT file named 'encodedpassword.txt.' 7

8 LogMessage ISProxy TRUE This is the Boolean value that determines whether to generate a log file. If you set this value to TRUE, a detailed log is generated for each Acuo XDS Interaction REST Service operation. The default location of the file is [drive:]\<xds Connector install directory>\logfiles\service.log. This is the Proxy Server IP address used for Integration Server calls. If you are using proxy server during connecting to Integration Server, use the proxy address here. AcuoXDSWindowsServiceInstall.exe.config To see the configuration settings, browse to the installation folder and open the AcuoXDSWindowsServiceInstall.exe.config configuration file. Typically, the path is [drive:]\program Files (x86)\perceptive Software\Acuo Interact Service\AcuoXDSInteractService. To change the port number of the REST Service, modify the address value under [<services>] tag. The following example shows a sample XML data instance. For actual configuration information, refer to the configuration file in the installation folder. <services> <service name="acuoxdsinteractionrestservice.acuoxdsinteractionrestservice" behaviorconfiguration="largeuploadbehavior"> <endpoint behaviorconfiguration="restbehavior" address=" contract="acuoxdsinteractionrestservice.iacuoxdsinteractionrestservice" binding="webhttpbinding" bindingconfiguration="streamwebhttpbinding" /> </service> </services> XDSbDocSourceConfig.xml To see the configuration settings, browse to the installation folder and open the XDSbDocSourceConfig.xml configuration file. Typically, the path is [drive:]\program Files (x86)\perceptive Software\Acuo Interact Service\AcuoXDSInteractService. To change the endpoint of the XDS repository, modify the serviceendpointaddress value in [<serviceendpointaddress>] tag and set to a desired value. All other tags in this configuration file are set with default values. You can change the information in the configuration file according to your solution requirements and your XDS affinity domain requirements. The following example shows a sample xml data instance. For actual configuration information, refer to the configuration file in your installation folder. <?xml version="1.0" encoding="utf-8"?> <XDSbDocSourceConfig xmlns:xsi=" xmlns:xsd=" <serviceendpointname>documentrepository_port_soap12_http</serviceendpointname> <serviceendpointaddress> <sourceid> </sourceid> Note The XDSbDocSourceConfig.xml file contains metadata that are less likely to change. The XDS Connector receives frequently changed metadata from ImageNow custom properties associated with each captured document. If you use an ImageNow Capture mechanism that is not able to provide certain metadata as custom properties then you should add those additional metadata to the XDSbDocSourceConfig.xml file. 8

9 Configure Perceptive XDS Connector 1. In a browser, type Perceptive Connect Web Console address in the format Connect host name>:<port>/connect/bundles. 2. In Perceptive Connect Web Console, click Perceptive Connect > View Configuration. 3. In Perceptive Connect Web Console, in the View Configuration page, complete the following steps. 1. In the Name column, under Perceptive Content Connector, click the Connection Manager row. 2. In the Connection Provider Target list, set the appropriate Integration Server version, such as Integration Server In the User name box, type the user name. 4. In the Password box, type the corresponding password. 5. Click Save. 6. In the Name column, under nondicomconnector, click the nondicomaction configuration row. 7. In the Acuo XDS Interaction REST Service Endpoint box, set the endpoint address value (for endpoint address value, follow the direction as mentioned in the Note section provided below), click Save. Note Browse to your local installation directory, such as [drive:]\program Files (x86)\perceptivesoftware\acuo Interact Service\AcuoXDSInteractService, open the AcuoXDSWindowsServiceInstall.exe.config file, under <services> tag, search the AcuoXDSInteractionRestService.AcuoXDSInteractionRestService service name, copy the address field value, such as and paste in the Acuo XDS Interaction REST Service Endpoint box. 8. In the Name column, under Perceptive Content Connector, click the appropriate Integration Server version row, such as Integration Server 6.8 Connection row. 9. In the Integration Server URL box, set the Integration Server URL address, such as Click Save. Note To see log information about each connector operation, in Perceptive Connect Web Console, click Perceptive Connect > View Logs. Map ImageNow workflow queue ID with Perceptive Connect service The following steps must be performed only after installing the ImageNow Components. 1. On the ImageNow toolbar, click Manage. 2. In Management Console, in the left pane, click Workflow. 3. In the right pane, double-click the AcuoIntegration workflow. 4. In the Workflow Designer, right-click XDS Upload To Acuo integration ASQ queue, click Properties. 5. In the Queue Properties dialog box, under Details, find the ID value, such as 321YX8V_0000C38KL00002V. Note down this ID value. Close the dialog box. 9

10 6. Open the Integration ASQ mapping web page using an URL address, such as <port_number>/asq. 7. Under Enter queue ID, provide the Integration ASQ ID, such as 321YX8V_0000C38KL00002V, that is created after installing ImageNow Components (see step 5). 8. Click Next. 9. Under Select an operation, in the list, select nondicomaction. 10. Under Create a name for the action, type a name. 11. Click Next. 12. Under Mapping for operation instance, in the <enabled>false</enabled> tag, set the value to true. 13. Click the Save button. Delete document or folder after successful XDS upload Upon successful receipt of data, the Acuo XDS Interaction REST Service sends an acknowledgement response to ImageNow, which in turn deletes the temporary folder or document at its end and generates a log file. You must perform the following steps after receiving the acknowledgement response from Acuo XDS Interaction REST Service. 1. On the ImageNow toolbar, click Manage. 2. In Management Console, in the left pane, click Workflow. 3. In the right pane, double-click the AcuoIntegration workflow. 4. In the Workflow Designer, right-click UploadSucceeded queue, and click Properties. 5. In the Queue Properties dialog box, in the left pane, select Removal. 6. In the Queue Properties dialog box, in the right pane, under Select a removal method below, select the Delete from system option. 7. Under Selected removal method will be applied for items older than, type a number or click an arrow to set the value. 8. Click OK. Uninstall XDS Connector Uninstall Perceptive Connect Windows service To uninstall Perceptive Connect Windows service, perform the following procedure. 1. Browse to the Perceptive Connect installation directory. 2. Double-click the uninstall.bat file to remove the Perceptive Connect service. The uninstall script does not delete the installation directory. Uninstall XDS Interact Setup You can uninstall your existing XDSInteractSetup installation using Control Panel. The following procedure is applicable only if you have installed the Acuo XDS Interaction REST Service. In such a scenario, performing the following procedure uninstalls the Acuo XDS Interaction REST Service, whereas 10

11 other installed components such as XDS ImageNow Components and Perceptive XDS Connector remain unchanged. 1. Click Start, and click Control Panel > Programs > Programs and Features. 2. Select XDSInteractSetup and then click Uninstall. Troubleshoot XDS Connector Use the information provided in this section to troubleshoot the XDS Connector if a functional issue occurs. Troubleshooting information consists of sections that describe a situation that could happen, along with the procedures to resolve the issue. How to verify that Integration Server is up and running before routing any document 1. Download and install the Chrome Web Store REST Console. 2. Open the REST Console. 3. Under Target, under Request URI, provide the Integration Server connection URL, such as 4. Under Target, under Request Method list, select GET. 5. Under Authorization, under Authorization Header, select the Basic YWRtaW5pc3RyYXRvcjpsZXhtYXJrMTIz check box and click the Basic Auth button. 6. In the Basic Authorization dialog box, under Username, type the Integration Server user name. 7. In the Basic Authorization dialog box, under Password, type the Integration Server password. 8. Click the Set Header button. 9. Click the Send button. If the Integration Server is up and running, under Response Body, the ImageNow Server version number displays. Refer to the example provided below. <?xml version="1.0" encoding="utf-8" standalone="yes"?> <connectionstatus> <version> </version> </connectionstatus> 11

12 Appendix A: Glossary The following table defines terms specific to XDS Connector that you may need to know. Terms VNA XDS Description A vendor neutral archive (VNA) is a medical imaging technology in which images and documents and potentially any file of clinical relevance are stored or archived in a standard format with a standard interface, such that they can be accessed in a vendor-neutral manner by other systems. Cross-Enterprise Document Sharing (XDS) is a standards-based specification for managing the sharing of documents between healthcare enterprises. Data is managed through federated document repositories and a document registry to create a longitudinal record of information about a patient within a given clinical affinity domain. XDS is document content neutral, therefore, any type of clinical information without regard to content and representation is supported. The Acuo Integration Solution deals with non-dicom data objects utilizing XDS. 12

ECM-VNA Convergence Connector

ECM-VNA Convergence Connector Installation and Setup Guide Version: 1.0.x Written by: Product Knowledge, R&D Date: September 2016 2016 Lexmark. All rights reserved. Lexmark is a trademark of Lexmark International