ECM-VNA Convergence Connector

Size: px

Start display at page:

Download "ECM-VNA Convergence Connector"

Jesse Rice
5 years ago
Views:

1 ECM-VNA Convergence Connector Installation and Setup Guide Version: 1.0.x Written by: Product Knowledge, R&D Date: September 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... 5 Installation and setup... 5 Download ECM-VNA Convergence Connector... 5 Install ECM-VNA Convergence Connector... 5 Change Perceptive Connect port number... 5 Load ECM XDS Submission Plugin... 6 Install ECM-VNA Interact Setup... 7 Configure ECM-VNA Convergence Connector... 8 Configure ECM-VNA Plugin Service... 8 Configure Perceptive Connect for ECM-VNA Convergence Connector Configure application plan for output agent Configure workflow and add scripts on workflow action Delete document or folder after successful XDS upload Map Perceptive Content workflow queue ID with Perceptive Connect service Uninstall ECM-VNA Convergence Connector Uninstall Perceptive Connect Windows service Uninstall ECM-VNA Plugin Troubleshoot ECM-VNA Convergence Connector How to verify that Integration Server is up and running before routing any document How to ensure minimum requirements for sending a document to Acuo XDS Repository Appendix A: Glossary Index

4 Overview ECM-VNA Convergence Connector brings together features of Lexmark s ECM and VNA at both the viewer and the platform tiers to create value and leverage enhanced functionality. Using the ECM-VNA Convergence Connector, you can: Transfer clinical and medical images from ECM to VNA, thereby providing a single view of all unstructured content for the patient information in the context of the EMR/EPR. Store both ECM and VNA data to the new unified storage architecture. Configure the system so that patient-centric clinical content is published to XDS. Required components Software prerequisites You must install the following software before you install and configure the ECM-VNA Convergence Connector. Perceptive Content Server, version 7.0 Perceptive Content Client, version 7.0 Note You must be a user with management privileges, a manager, or the owner. Perceptive Connect Note The default user name and password must be set as admin. Output Agent Integration Server Note The Integration Server version must be compatible with the Perceptive Content version. Microsoft.NET Framework Java SE Development Kit (JDK) 1.7 or 1.8 Acuo XDS Repository with ECM XDS Submission Plugin capability, version or higher 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 Perceptive Content Capture mechanism, provided that mechanism gives the desired metadata to Perceptive Content. Interact for Epic (optional) 4

5 Licenses You may be required to have the following licenses. Perceptive Content Server Integration Server + unlimited transaction pack 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 ECM-VNA Convergence Connector Install ECM-VNA Convergence Connector Configure ECM-VNA Convergence Connector Uninstall ECM-VNA Convergence Connector Download ECM-VNA Convergence Connector 1. Go to the and log into the Enterprise Software Customer Portal. 2. Click Downloads, 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 ECM-VNA Convergence Connector To install the ECM-VNA 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 Lexmark Enterprise 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 ECM-VNA Convergence Connector section. Change Perceptive Connect port number By default, Perceptive Connect and Integration Server are deployed on port number 80. Before you install the ECM-VNA 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. 5

6 To change the Perceptive Connect port number, complete the following steps. 1. Navigate to the Perceptive Connect installation directory, and the 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. To modify the HTTP port for the web server, on the Java tab, under Java Options, modify the Dorg.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. 3. Click OK. Load ECM XDS Submission Plugin To load the ECM XDS Submission plugin, complete the following steps. 1. Open Acuo Console. 2. In Acuo Console, in the left pane, expand Acuo Repository Manager, and select PlugIns. 3. In the right pane, search for ECM XDS Submission Plugin. If the plugin is not available, complete the following substeps. 1. In the Actions pane, click Add Plugin. 2. In the Add Repository PlugIn dialog box, click Search Path. 3. In the Browse for Folder dialog box, browse to your local Acuo Repository installation folder, and click OK. Note Typically, the Acuo Repository installation folder path is [drive:]\program Files\Acuo Technologies\XDSRepository. Do not browse to the Acuo Repository installation folder for MMC which is typically at x86, that is, [drive:]\program Files (x86)\acuo Technologies\XDSRepository. In the Add Repository PlugIn dialog box, in the PlugIn list, you are now able to see the ECM XDS Submission Plugin option. 4. In the Add Repository PlugIn dialog box, in the PlugIn list, select the ECM XDS Submission Plugin option. 5. In the Add Repository PlugIn dialog box, under PlugIn Configuration, the pre-populated values for Name, Class, and Assembly display. If these values do not display, select the proper Acuo Repository Installer that supports ECM-VNA plugin. Note Typically, the pre-populated values are: Name: ECM XDS Submission Plugin, Class: Acuo.Repository.PlugIn.ECM.XDS.EcmXdsPlugIn, and Assembly: C:\Program Files\Acuo Technologies\XDSRepository\EcmXdsSubmissionPlugIn.dll; where Name is the plugin's display name in MMC, Class is the namespace name, and Assembly is the path of plugin dll (click Browse to change the path). 6. Click Add. 6

7 Install ECM-VNA Interact Setup To install ECM-VNA setup, complete the following steps. 1. Navigate to the folder where your local installation files are stored and select the appropriate installer, such as Acuo_ECM_VNA_Interact_Setup_<version>.exe. 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 ECM-VNA 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. ECM-VNA Perceptive Content Components. This option creates a customized modifiable ECM VNA interact Perceptive Content environment with elements such as Custom Properties, Doc Types, and Workflow. Perceptive ECM VNA Connector. This option installs the ECM-VNA Convergence Connector. 6. Click Next. 7. In the Perceptive Connect Details page, complete the following substeps. 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. 8. In the Ready to Install the Program page, click Install. 9. In the Installation Wizard Completed page, click Finish. 7

8 Configure ECM-VNA Convergence Connector If you modify the configuration information, make sure to stop and start the Acuo Repository service again to implement the changes. To see the configuration settings, browse to your Acuo Repository installation folder, such as [drive:]\program Files\Acuo Technologies\XDSRepository, and open the configuration files. Configure ECM-VNA Plugin 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\Acuo Technologies\XDSRepository. 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="localhost"/> <add key="integrationserverport" value="8080"/> <add key="pcuser" value="administrator"/> <add key="pcpassword" value="ywjjzdeymzqhqcmk" /> <add key="logmessage" value="true"/> <add key="deletefolder" value="false"/> <add key="deletedocument" value="false"/> <add key="usedocumentlevel" value="true"/> <add key="timeout" value=" "/> <add key="isproxy" value=" "/> <add key="soapproxy" value=" "/> <add key="restproxy" value=" "/> <add key="useserviceforlog" value="false"/> <add key="sendauditlog" value="true"/> <add key ="acuostorexds" value="true"/> </appsettings> The following table provides definitions and setting options for the XML keys that are configurable. Unless otherwise noted, the default setting is blank. XML Key Default Setting Description IntegrationServerIP localhost The IP address of the Integration Server. IntegrationServerPort 8080 This is the port number of the Integration Server. PCUser administrator This is the Integration Server login user ID. This value must be set at the time of installation. 8

9 XML Key Default Setting Description PCPassword YWJjZDEyMzQhQCMk (base64 encoding for 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.' AcuoRepository.exe.config To see the configuration settings, browse to the installation folder and open the AcuoRepository.exe.config configuration file. Typically, the path is [drive:]\ Program Files\Acuo Technologies\XDSRepository. 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="xdsrepository_servicebehavior"> <host> <baseaddresses> <add baseaddress=" /> </baseaddresses> </host> <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\Acuo Technologies\XDSRepository. 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 9

10 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 ECM- VNA Convergence Connector receives frequently changed metadata from Perceptive Content custom properties associated with each captured document. If you use a Perceptive Content 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. Configure Perceptive Connect for ECM-VNA Convergence Connector To configure Perceptive Connect for the connector, complete the following steps. 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\Acuo Technologies\XDSRepository, open the AcuoRepository.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. 10

Configure application plan for output agent To configure an application plan for output agent, complete the following steps. 1. On the Perceptive Content toolbar, click Manage. 2.

11 Configure application plan for output agent To configure an application plan for output agent, complete the following steps. 1. On the Perceptive Content toolbar, click Manage. 2. In Management Console, in the left pane, click Application Plans, and click Agent. 3. In the right pane, click New. 4. In the Plan Settings dialog box, in the General tab, in the Name box, provide a name, click OK. 5. In the Agent Application Plan Designer dialog box, in the Elements tab, in the Method list, select Import Agent. 6. Click the Save icon. Configure workflow and add scripts on workflow action To configure the workflow and add scripts, complete the following steps. 1. In the Management Console, in the left pane, click Workflow. 2. In the right pane, on the Workflow tab, double-click AcuoEcmVnaIntegration. The following workflow diagram displays. 3. Double-click the ReadyToMerge queue. 4. In the Queue Properties dialog box, in the left pane, select Actions. 5. In the right pane, on the Inbound tab, in the iscript list, select SubmitToOutputAgent.js. 11

12 6. Click OK. 7. To add the iscripts one by one in the queues as mentioned below, complete the previous steps. ReadyToMerge (Actions-->Inbound-->SubmitToOutputAgent.js) Merged Successfully (Actions-->Inbound-->ImportToImageNow.js) Submitted to XDS (Actions-->Inbound-->DeleteMergedPage.js) Delete document or folder after successful XDS upload Upon successful receipt of data, the Acuo XDS Interaction REST Service sends an acknowledgement response to Perceptive Content, 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 Perceptive Content toolbar, click Manage. 2. In Management Console, in the left pane, click Workflow. 3. In the right pane, double-click the AcuoEcmVnaIntegration workflow. 4. In the Workflow Designer, right-click Submitted to XDS 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. Map Perceptive Content workflow queue ID with Perceptive Connect service The following steps must be performed only after installing the Perceptive Content Components. 1. On the Perceptive Content toolbar, click Manage. 2. In Management Console, in the left pane, click Workflow. Note If workflow is not appearing then run the following command: (C:\inserver\bin64\cmd.exe): inupgradeutil upgrade-privs --from In the right pane, double-click the AcuoEcmVnaIntegration workflow. 4. In the Workflow Designer, right-click Imported Successfully integration ASQ queue, click Properties. 5. In the Queue Properties dialog box, under Details, find the ID value, such as 321YX8V_0000C38KL00002V. Note the ID value for future use. Close the dialog box. 6. Open the Integration ASQ mapping web page using an URL address, such as 7. Under Select a trigger, in the list, select Integration ASQ Trigger. 8. Under Workflow Queue ID, provide the ID value, such as 321YX8V_0000C38KL00002V, that is created after installing Perceptive Content Components (as previously noted). 12

13 9. Click Next. 10. Under Select an action, in the list, select nondicomaction. 11. Click Next. 12. Click the Save Channel button. 13. Click OK. Uninstall ECM-VNA Convergence Connector Uninstall Perceptive Connect Windows service To uninstall Perceptive Connect Windows service, perform the following procedure. 1. Open a Command Prompt window and go to the Perceptive Connect installation directory. 2. Run the following command: java -jar connect-runtime-installer jar 3. In Choice, type uninstall and press ENTER. Uninstall ECM-VNA Plugin To uninstall the ECM-VNA plugin, complete the following steps. 1. Open Acuo Console. 2. In Acuo Console, in the left pane, expand Acuo Repository Manager, and select PlugIns. 3. In the right pane, select ECM XDS Submission Plugin. 4. In the Actions pane, click Delete. 5. Click OK. 13

14 Troubleshoot ECM-VNA Convergence Connector Use the information provided in this section to troubleshoot the ECM-VNA Convergence 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 Perceptive Content Server version number displays. Refer to the example provided below. <?xml version="1.0" encoding="utf-8" standalone="yes"?> <connectionstatus> <version> </version> </connectionstatus> How to ensure minimum requirements for sending a document to Acuo XDS Repository Following are the minimum requirements to generate a successful transaction log in Acuo XDS Repository. You must set the mentioned values in Perceptive Content. For more information, contact Enterprise Software Support. 1. Set the custom property documenttype of the document to xdsb. 2. Set the custom property patientid of the document to a valid patient ID format such as 53c369f7c31e4d9^^^& &ISO. 14

15 Appendix A: Glossary The following table defines terms specific to ECM-VNA Convergence Connector that you may need to know. Terms VNA XDS Description A vendor neutral archive (VNA) is a medical imaging technology in which images, 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. 15

16 Index installing and setting ECM-VNA Convergence Connector configuring... 8 downloading... 5 installing... 5 uninstalling troubleshooting ECM-VNA Convergence Connector

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

XDS Connector. Installation and Setup Guide. Version: 1.0.x XDS Connector Installation and Setup Guide Version: 1.0.x Written by: Product Knowledge, R&D Date: November 2016 2016 Lexmark. All rights reserved. Lexmark is a trademark of Lexmark International Inc.,