EMC Clinical Archiving

EMC Clinical Archiving Version 1.7 Installation Guide EMC Corporation Corporate Headquarters Hopkinton, MA 01748-9103 1-508-435-1000 www.emc.com

Legal Notice Copyright 2014-2015 EMC Corporation. All Rights Reserved. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDF Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks used herein are the property of their respective owners. Documentation Feedback Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we can make our documentation better or easier to use, please send us your feedback directly at IIGDocumentationFeedback@emc.com

Table of Contents Revision History... 5 Chapter 1 Before You Install... 7 Chapter 2 Security Configuration... 9 System Access Control Settings... 9 System Authentication... 9 Authentication Configuration... 9 User Actions Performed without Authentication... 9 Communication Security Settings... 10 Port Usage... 10 Network Encryption... 10 Data Security Settings... 10 Secure Deployment Settings... 11 Chapter 3 Installation... 13 Pre-Installation Tasks... 13 Preparing the Installation Environment... 14 Installing the Clinical Archiving Holding... 14 Installing Clinical Archiving... 15 Configuring the Environment Variable Settings... 15 Obtaining Third-party Library Dependencies... 16 Installing Third-party Library Dependencies... 17 Creating the HIP Configuration Directory... 18 Deploying the Properties File in the HIP Configuration Directory... 18 Deploying the Clinical Archiving WAR File... 19 Installing ArchiveVision... 19 Obtaining Third-party Library Dependencies... 19 Installing Third-party Library Dependencies... 21 Deploying the ArchiveVision War File... 21 Chapter 4 Post-Installation Configurations... 23 Configuring Clinical Archiving Repository... 23 Configuring Repository Related Properties... 23 Configuring EAS Service Related Properties... 24 Configuring EAS Service Context Related Properties... 25 Configuring HTTPS Related Properties... 25 Configuring ATNA Audit Related Properties... 26 Configuring Usage Report Properties... 27 Configuring ArchiveVision... 28 Chapter 5 Verify Your Installation... 29 Verifying the Installation of Clinical Archiving... 29 3

Table of Contents Verifying the Installation of ArchiveVision... 29 Chapter 6 Post-Installation Administrator Tasks... 31 Chapter 7 Upgrade... 33 Upgrading Clinical Archiving Jobs from 1.6 to 1.7... 33 Upgrading XDS Repository Connector from 1.6 to 1.7... 33 Chapter 8 Troubleshooting... 35 Log Settings... 35 Log Description... 35 Log Management and Retrieval... 35 Appendix A Sample Configuration Files... 37 ca-repository.properties... 37 4

Revision History Revision Date March 2015 Description Initial publication. 5

Preface 6

Before You Install Chapter 1 Before beginning installation, ensure that your system meets the requirements. The EMC Clinical Archiving Release Notes provides information on the system requirements supported for this release. The documentation is available at EMC Online Support (https://support.emc.com). 7

Before You Install 8

Chapter 2 Security Configuration This chapter contains the following topics: System Access Control Settings, page 9 Communication Security Settings, page 10 Data Security Settings, page 10 Secure Deployment Settings, page 11 System Access Control Settings The system access control settings enable the protection of resources against unauthorized access. System Authentication The system authentication settings control the process of verifying an identity claimed by a system for accessing the product. Authentication Configuration The XDS Repository Connector Server supports Trusted Node Authentication using TLS certificates. User Actions Performed without Authentication The XDS Repository Connector Server SOAP requests can be accessed through HTTP (non-secure), which allows these requests to be sent to the HIP XDS Repository Server without any authentication. This configuration is optional. 9

Security Configuration Communication Security Settings The communication security settings enable the establishment of secure communication channels among the product components, and between product components and external systems or components. These settings are applicable only for XDS Repository Connector. Port Usage The XDS Repository Connector Server endpoint URLs are configured for each request type, which includes the optional port. No default port is provided. The ATNA audit server port default is 514 for ATNA SOAP requests. The following table shows the ATNA port details: Component Service Protocol Port Description ATNA AuditServer ITI-20 AuditEvent SOAP 514 ATNA auditserver Network Encryption The Repository Connector uses the HTTPS protocol for HIP Server endpoints to achieve network encryption. Data Security Settings All sensitive healthcare data is stored in EMC InfoArchive and XDS Registry. EMC InfoArchive and XDS Registry are responsible for securing this data internally. 10

Security Configuration Secure Deployment Settings These settings are applicable only for the Repository Connector. You must follow the instructions given below to securely deploy the product: Use HTTPS for all network communications with the HIP XDS Repository Connector Server SOAP requests. Configure TLS keystore and truststore credentials in the appropriate ca-repository.properties file to secure outgoing requests from repository connector to EMC InfoArchive. Configure TLS keystore and truststore credentials in the appropriate application server to secure incoming requests. 11

Security Configuration 12

Chapter 3 Installation This chapter contains the following topics: Pre-Installation Tasks, page 13 Preparing the Installation Environment, page 14 Installing the Clinical Archiving Holding, page 14 Installing Clinical Archiving, page 15 Installing ArchiveVision, page 19 Pre-Installation Tasks Before installing Clinical Archiving and ArchiveVision, ensure that you have prepared the installation environment with the following components: Component Clinical Archiving Installation Files ArchiveVision Installation Files Clinical Archiving Holding Files Task Download the following files from EMC Download Center: ca-repository-1.7.0.zip ca-jobs-1.7.0.zip Download the following file from EMC Download Center: ca-archivevision-1.7.0.zip Download one of the following files from EMC Download Center, depending on the version of EIA that you use: For EIA 3.0: ca-holding-for_eia_3.0-1.7.0.zip Registry xdb xhive Installation Files Install xdb version 10.5.8. Info Archive Install InfoArchive 3.1. For EIA 3.1: ca-holding-for_eia_3.1-1.7.0.zip Install a working XDS Registry (compliant with IHE XDS Revision 10). Apache Tomcat Install Apache Tomcat 7 7.0.42. 13

Installation Component Task Apache Ant Install Apache Ant 1.9.3. JDK Install JDK 1.7.x. Preparing the Installation Environment Configured the following variables as described in the following table: Environment Variable Description JAVA_HOME 1. Create a new system variable JAVA_HOME and set the value of the variable to the directory where JDK 1.7.0_45 is installed. C:\Program Files\Java\jdk1.7.0_45 2. Append the following path to the PATH system variable: %JAVA_HOME%\bin ANT_HOME 1. Create a new system variable ANT_HOME and set the value of the variable to the directory where Apache Ant 1.9.3 is installed. C:\Program Files\apache-ant-1.9.3 2. Append the following path to the PATH system variable: %ANT_HOME%\bin Installing the Clinical Archiving Holding To install clinical archiving holding: 1. Download the clinical archiving holding file from EMC Download Center. If you are using EIA 3.0, download ca-holding-for_eia_3.0-1.7.0.zip. If you are using EIA 3.1, download ca-holding-for_eia_3.1-1.7.0.zip. 2. Extract the zip to a local folder. C:\archiveholding\ca-holding\ 3. Go to the extracted folder and open the build.properties file in a text editor. 14

Installation 4. Modify the values for the following parameters (and any other parameters required for installation): DCTM_REPOSITORY= DCTM_USER= DCTM_USER_PWD= DC_PATH= DC_PATH indicates the path where the confirmations must be stored. 5. Go to the command prompt. 6. Go to the folder where you extracted the clinical archiving holding. C:\archiveholding\ca-holding\ 7. Run build.xml using the following command: ant -f build.xml 8. Type yes and press Enter when you are prompted to install the holding. The command window shows "BUILD SUCCESSFUL" if the archive holding installation is successful. The log information is saved in the logs sub-folder, which provides detail information about the installation process. Installing Clinical Archiving This section contains the following topics: Configuring the Environment Variable Settings, page 15 Obtaining Third-party Library Dependencies, page 16 Installing Third-party Library Dependencies, page 17 Creating the HIP Configuration Directory, page 18 Deploying the Properties File in the HIP Configuration Directory, page 18 Deploying the Clinical Archiving WAR File, page 19 Configuring the Environment Variable Settings If you are using Linux, ensure that you have executable permissions to run the shell scripts. 1. Download the ca-jobs-1.7.0.zip file from EMC Download Center. 2. Extract the ca-jobs-1.7.0.zip file to a folder. C:\clinical_archiving\ca-jobs-1.7 3. Go to C:\clinical_archiving\ca-jobs-1.7\bin. 4. Open the set-env.bat file in Edit mode. 15

Installation If you are on a Linux machine, open the set-env.sh file. 5. Set the value of SET JAVA_HOME to point to the Java home directory. SET JAVA_HOME=C:\Program Files\Java\jdk1.7.0_45 6. Set the value of CLINICAL_ARCHIVE_HOME to point to the folder where the ca-jobs-1.7.0.zip file has been extracted. SET CLINICAL_ARCHIVE_HOME=C:\clinical_archiving\ca-jobs-1.7 The above settings are mandatory to run the encoder/decoder utility described in the Appendix of EMC Clinical Archiving Administration Guide. EMC Clinical Archiving Administration Guide describes the steps to run the Clinical Archiving jobs. Obtaining Third-party Library Dependencies You must install the following third-party library dependencies for successful deployment of the Clinical Archiving WAR file: Camel IHE To obtain the Camel jar files: 1. Go to www.archive.apache.org. 2. Download the apache-camel-2.12.1.zip file. 3. Extract the zip file to a local folder. C:\jarfiles\apache-camel-2.12.1 To obtain the IHE jar files: 1. Create a folder in the local path. C:\jarfiles\oht_jars\ 2. Go to www.projects.openhealthtools.org. 3. Download the org.openhealthtools.ihe_2.0.0.zip file. 4. Extract the zip to a local path. C:\jarfiles\openhealthtools\ 16

Installation 5. Copy the following jar files from C:\jarfiles\openhealthtools\ to C:\jarfiles\oht _jars. org.openhealthtools.ihe.atna.context_2.0.0.jar org.openhealthtools.ihe.atna.nodeauth_2.0.0.jar org.openhealthtools.ihe.utils_2.0.0.jar 6. Go to www.repo.openehealth.org. 7. Download the org.openhealthtools.ihe.atna.auditor-2.0.0-p1.jar file. 8. Copy org.openhealthtools.ihe.atna.auditor-2.0.0-p1.jar to C:\jarfiles\oht _jars. To verify the jar files: 1. Check if the checksum values of the downloaded jar files match with the checksum values mentioned in the following table for corresponding files: Filename apache-camel-2.12.1.zip org.openhealthtools.ihe_2.0.0.zip org.openhealthtools.ihe.atna.auditor-2.0.0-p1.jar Checksum Value 8aae88dec9558606cfd1b4bd6aaa2438 ac7bee0ac7d0db9becf71d29690d45d3 33c0fbc631ab539d70dd0bb6fd343fee Installing Third-party Library Dependencies 1. Download the ca-repository-1.7.0.zip file from EMC Download Center. 2. Extract the ca-repository-1.7.0.zip file to a folder. C:\clinical_archiving\ca-repository-1.7 You can find the build.xml file in the ca-repository-1.7 folder. 3. Go to the command prompt and navigate to the directory where build.xml file is located. C:\clinical_archiving\ca-repository-1.7 4. Run build.xml using the following command: ant -f build.xml 5. Type the complete path of Camel home directory when the script prompts you to enter the Camel home directory. C:\jarfiles\apache-camel-2.12.1 6. Type the complete path of the OHT home directory when the script prompts you to enter the OHT home directory name. C:\jarfiles\oht_jars\ 17

Installation 7. Press Enter. After you run the ant -f build.xml command, you get the following folder: C:\clinical_archiving\ca-repository-1.7\install You can find the ca-repository-1.7.0.war file in the install folder. Creating the HIP Configuration Directory The HIP servers maintain configuration information in a directory called HIP configuration directory, which is located outside the folder containing the WAR file. This design enables users to easily upgrade to newer versions of the software by replacing the server WAR file. By default, HIP uses the following directory: <user.home>/.hip where <user.home> is the home directory of the user who installs the Clinical Archiving. C:\Users\username\ If this directory does not already exist, create a folder named.hip in your user.home directory by typing.hip. Ensure that you place a dot at the end of the name. Windows will remove the trailing dot. The resulting folder must be as follows: C:\Users\username\.hip The com.emc.healthcare.com Java system property defines the location of the configuration directory. You must configure the com.emc.healthcare.com system property in the application server s start up script to create the log file in the correct location. This property should point to a valid path. Use the following syntax: -Dcom.emc.Healthcare.home=<hip_config_directory> Deploying the Properties File in the HIP Configuration Directory After creating the HIP configuration directory, deploy the properties files in the HIP configuration directory. To deploy the properties file: 1. Go to the install folder obtained after running the build command described in Step 4. C:\clinical_archiving\ca-repository-1.7\install 2. Extract the ca-repository-1.7.0.war file. The extracted clinical archiving repository connector WAR file contains a sample properties file in the following location: 18

Installation <tomcat_install_dir>/webapps/ca-repository-1.7/config/ca-repository 3. Copy the ca-repository folder containing the ca-repository.properties file from <tomcat_install_dir>/webapps/ca-repository-1.7/config/ to C:\Users\username\.hip\. Creating the HIP Configuration Directory, page 18 provides details about creating HIP configuration directory. <hip_config_dir>/ca-repository/ca-repository.properties Deploying the Clinical Archiving WAR File 1. Stop the J2EE Web Application container. 2. Go to the install folder obtained after running the build command as described in Step 4. C:\clinical_archiving\ca-repository-1.7\install 3. Copy the ca-repository-1.7.0.war file to the following directory: <tomcat_install_dir>/webapps/ 4. Start the J2EE web application container to expand the WAR file. Note: The examples in this guide are provided with the assumption that the WAR file is deployed in the following location: <tomcat_install_dir>/webapps/ Installing ArchiveVision This section contains the following topics: Obtaining Third-party Library Dependencies, page 19 Installing Third-party Library Dependencies, page 21 Deploying the ArchiveVision War File, page 21 Obtaining Third-party Library Dependencies You must install the following third-party library dependencies for successful deployment of the ArchiveVision WAR file: xdb (mandatory) InfoArchive (mandatory) IHE (optional) 19

Installation The IHE jar files are required only if you require EMPI integration. To obtain the xdb jar files: 1. Create a folder in the local path to copy the xdb jar files. C:\jarfiles\xdb 2. Go to <xdb_install_dir>/lib. 3. Copy the xhive.jar file to the C:\jarfiles\xdb folder. 4. Go to <xdb_install_dir>/lib/core. 5. Copy all the jar files except the slf4j jar to the C:\jarfiles\xdb folder: To obtain the InfoArchive jar files: 1. Create a folder in the local path to copy the InfoArchive jar files. C:\jarfiles\infoarchive 2. Go to <eas-services war>\web-inf\lib\. It is assumed that you have successfully installed EMC InfoArchive prior to installing ArchiveVision. 3. Copy the eas-service-datamodel.jar to C:\jarfiles\infoarchive. To obtain the IHE jar files: 1. Create a folder in the local path to copy the IHE jar files. C:\jarfiles\oht_jars\ 2. Go to www.projects.openhealthtools.org. 3. Download the following file: org.openhealthtools.ihe_2.0.0.zip 4. Extract org.openhealthtools.ihe_2.0.0.zip. 5. Copy the following jar files to the C:\jarfiles\oht_jars\ folder: org.openhealthtools.ihe.common.hl7v2.client-2.0.0.jar org.openhealthtools.ihe.common.mllp-2.0.0.jar org.openhealthtools.ihe.pdq.consumer-2.0.0.jar org.eclipse.ohf.hl7v2.core_0.2.0.200812311053.jar org.eclipse.ohf.utilities_0.2.0.200812311053.jar org.openhealthtools.ihe.atna.context_2.0.0.jar org.openhealthtools.ihe.atna.nodeauth_2.0.0.jar org.openhealthtools.ihe.utils_2.0.0.jar 6. Go to www.repo.openehealth.org. 20

Installation 7. Download the following jar file: org.openhealthtools.ihe.atna.auditor-2.0.0-p1.jar 8. Copy the above jar files to C:\jarfiles\oht_jars. Installing Third-party Library Dependencies 1. Download ca-archivevision-1.7.0.zip from EMC Download Center. 2. Extract ca-archivevision-1.7.0.zip. C:\archivevision-1.7 You can find the build.xml file in the C:\archivevision-1.7\web\ folder. 3. Go to the command prompt and navigate to the directory where build.xml is located. C:\archivevision-1.7\web 4. Run build.xml using the following command: ant -f build.xml 5. Type the complete path of xdb home directory and press Enter when the script prompts you to enter the xdb home directory. C:\jarfiles\xdb 6. Type the complete path of InfoArchive home directory and press Enter when the script prompts you to enter the InfoArchive home directory. C:\jarfiles\infoarchive 7. Type the complete path of OHT home directory and press Enter when the script prompts you to enter the OHT home directory. C:\jarfiles\oht_jars After you run the ant -f build.xml command, you get the install folder as follows: C:\archivevision-1.7\web\install You can find the ca-archivevision-1.7.0.war file in the install folder. Deploying the ArchiveVision War File 1. Stop the J2EE Web Application container. 2. Go to the install folder obtained after running the build command as described in Step 4. C:\archivevision-1.7\web\install 21

Installation 3. Copy the ca-archivevision-1.7.0.war file to the following directory: <tomcat_install_dir>/webapps/ 4. Rename the WAR file to archivevision.war. 5. Start the J2EE Web Application container to expand the WAR file. 22

Post-Installation Configurations Chapter 4 This chapter contains the following topics: Configuring Clinical Archiving Repository, page 23 Configuring ArchiveVision, page 28 Configuring Clinical Archiving Repository To configure ca-repository.properties file, open <hip_config_dir>/ca-repository/ca -repository.properties and set the properties as described in the following topics: Configuring Repository Related Properties, page 23 Configuring EAS Service Related Properties, page 24 Configuring EAS Service Context Related Properties, page 25 Configuring HTTPS Related Properties, page 25 Configuring ATNA Audit Related Properties, page 26 Configuring Usage Report Properties, page 27 ca-repository.properties, page 37 shows a sample content of ca-repository.properties file. Configuring Repository Related Properties The following table provides information about the configuration of ca-repository related properties: Property description Description This property specifies a description for the Repository server. The description is used only for display purposes. This property has no default value. description=eas Repository Server 23

Post-Installation Configurations Property repository.uniqueid Description This mandatory property specifies the unique ID assigned to the XDS Repository. This has no default value. repository.uniqueid=1.3.6.1.4.1.21367.13.40.1 Configuring EAS Service Related Properties The following table provides information about the configuration of eas-service related properties: Property repository.eas.repositoryid Description This mandatory property specifies the Content Server Repository ID used by EAS. repository.eas.repositoryid=000001 repository.eas.serviceaddress The repository ID can be configured either as a decimal value or as a hexadecimal value. If you are using a hexadecimal value, you must enclose the value within single quotes. This mandatory property specifies the address where the EAS Web Services are installed. repository.eas.contentservicepath repository.eas.serviceaddress=http:/ /eashost/eas-services This optional property specifies the path to the WSDL of the ContentService relative to the serviceaddress. repository.eas.contentservicepath =services/contentservice?wsdl 24

Post-Installation Configurations Configuring EAS Service Context Related Properties The following table provides information about the configuration of eas-service context related properties: Property repository.eas.context.serviceaccount.consumerapplication Description This property specifies the InfoArchive consumer application. repository.eas.context.serviceaccount.languagecode repository.eas.context.serviceaccount.consumerapplication=eas_gui This property specifies the InfoArchive language code. repository.eas.context.serviceaccount.username eas.context.serviceaccount.languagecode=en_us This property specifies the InfoArchive username used for auditing purposes inside InfoArchive only. repository.eas.context.serviceaccount.roles repository.eas.context.serviceaccount.username=dmadmin This property specifies the InfoArchive roles. repository.eas.context.serviceaccount.roles=phonecalls_role Configuring HTTPS Related Properties The HTTPS properties enable the XDS Repository Server to use secure HTTPS communication. The following table provides information about the configuration of HTTPS related properties: Property https.keystore Description This property specifies the location of the keystore on the system where the private SSL certificates for the machine are stored. https.keystore=${com.emc.healthcare.home}/ca-repository/keystore.jks 25

Post-Installation Configurations Property https.keystorepassword Description This optional property specifies the password to access the keystore. This property has no default value. https.truststore https.keystorepassword=xxxxxx This property specifies the location of the truststore on the system where you keep the SSL certificates of machines trusted in TSL connections. This is where you keep the certificates of Document Consumers and XDS Repositories. https.truststorepassword https.truststore=${com.emc.healthcare.home}/ca-repository/truststore.jks This property specifies the password to access the truststore. https.ciphersuites https.truststorepassword=xxxxxx This property specifies the Cipher Suite used to encrypt the session. https.ciphersuites=tls_rsa_with_aes _128_CBC_SHA Configuring ATNA Audit Related Properties The following table provides information about the configuration of ATNA related properties: Property audit.host Description This property specifies the name of the machine that hosts the ATNA audit repository. The default value is localhost. audit.host=localhost 26

Post-Installation Configurations Property audit.port Description This property specifies the port number of the ATNA audit repository. The default value is 514. audit.transport audit.port=514 This property specifies the transport type for the ATNA audit repository, for example, BSD, TLS, or UDP. The default value is UDP. audit.sourceid audit.transport=udp This property specifies the source ID for ATNA audit messages. This property has no default value. audit.sourceid=${description} Configuring Usage Report Properties The following table shows the configuration of usage report properties: Property usagereport.username Description This property specifies the user name to login to the Usage Reporting web application. usagereport.password usagereport.username=administrator This property specifies the password you need to type to login to the Usage Reporting web application. usagereport.password=password 27

Post-Installation Configurations Configuring ArchiveVision EMC Clinical Archiving ArchiveVision Configuration Guide provides detail information about configuring ArchiveVision. 28

Chapter 5 Verify Your Installation This chapter contains the following topics: Verifying the Installation of Clinical Archiving, page 29 Verifying the Installation of ArchiveVision, page 29 Verifying the Installation of Clinical Archiving 1. Ensure that the library dependencies are installed. Installing Third-party Library Dependencies, page 17 provides details about installing the library dependencies. 2. Verify if the.hip folder is available in C:\Users\<username> folder. 3. Start the XDS Repository Connector using the normal start procedure for the J2EE web application container. For example, start the server on Tomcat using the following command: [root]# service Tomcat start 4. Check the log file for errors. /usr/share/apache-tomcat-7.0.42/logs/catalina.out 5. Open a web browser and type the following URL: http://<host:port>/ca-repository-1.7.0/services The WSDL page appears, indicating that the server deployment is successful. Verifying the Installation of ArchiveVision 1. Ensure that the library dependencies are installed. Installing Third-party Library Dependencies, page 17 provides details about installing the library dependencies. 2. Verify if the Java system properties hip.ca.viewer.config.file and hip.ca.viewer.settings.file are defined. 29

Verify Your Installation 3. Start the xdb Server and ensure that the InfoArchiveDB database is operational. 4. Start ArchiveVision using the normal start procedure for the J2EE web application container. For example, start the server on Tomcat using the following command: [root]# service Tomcat start 5. Check the log file for errors. /usr/share/apache-tomcat-7.0.42/logs/catalina.out If the log file does not contain any error, you can conclude that the installation is successful. 30

Chapter 6 Post-Installation Administrator Tasks The EMC Clinical Archiving Administration Guide provides information about the administrator tasks that must be performed after installation of Clinical Archiving. 31

Post-Installation Administrator Tasks 32

Chapter 7 Upgrade This chapter contains the following topics: Upgrading Clinical Archiving Jobs from 1.6 to 1.7, page 33 Upgrading XDS Repository Connector from 1.6 to 1.7, page 33 You must upgrade Clinical Archiving 1.6 to Clinical Archiving 1.7 when using with HIP 1.7 and InfoArchive 3.1. ArchiveVision 1.7 is the first release and therefore does not require an upgrade. Upgrading Clinical Archiving Jobs from 1.6 to 1.7 1. Stop the xdb instance currently used by the Clinical Archiving jobs. 2. Save the previous version of Registration and Deregistration configuration files. 3. Save the folder containing the Clinical Archiving jobs for 1.6 release for future reference. 4. Start the xdb instance currently used by the Clinical Archiving jobs. 5. Install the Clinical Archiving 1.7 jobs in a new location pointing to the old xdb location. Configuring the Environment Variable Settings, page 15 provides steps to configure the environment for running Clinical Archiving 1.7 jobs. You can use the Registration and Deregistration configuration files of 1.6 version, if required. EMC Clinical Archiving Administration Guide provides instructions to run the Clinical Archiving jobs. Upgrading XDS Repository Connector from 1.6 to 1.7 XDS Repository Connector does not require an upgrade from 1.6 to 1.7. You must download the ca-repository-1.7.0.war file and install it. 33

Upgrade Installing Clinical Archiving, page 15 provides detail steps to install the WAR file. 34

Troubleshooting Chapter 8 This chapter contains the log information for troubleshooting issues. Log Settings A log is a chronological record of system activities that is sufficient to enable the reconstruction and examination of the sequence of environments and activities surrounding or leading to an operation, procedure, or event in a security-relevant transaction from inception to final results. Log Description For XDS Repository Connector: The log file for the XDS Repository server is located in <hip_config_directory>\logs\ca-repository.log. For Clinical Archiving Jobs: The logfile can be configured through the -logfile command line argument. Log Management and Retrieval For Repository Connector: The XDS Repository Connector Server uses the Simple Logging Facade for Java (SLF4J) combined with a logback logging provider implementation. The default log level setting is INFO. You can increase the trace messages by setting the log level to DEBUG in <tomcat installation directory>\webapps\ca-repository-1.7\web-inf\classes \logback.xml file as follows: <--!Set to DEBUG to see detailed HIP message information --> <logger name="com.emc.healthcare"> <level value="debug"/> </logger> For Clinical Archiving Jobs: The log file can be configured through the -logfile command line argument. 35

Troubleshooting You can configure the log level using command line log options (verbose/quiet/debug). 36

Sample Configuration Files Appendix A This appendix contains a sample content of the ca-repository.properties file. ca-repository.properties # User settable properties are listed in this file. The order of # property evaluation is as follows: # 1: ${com.emc.healthcare.home}/ca-repository/ca-repository.properties # is consulted first # 2: System.properties is consulted second. # # Property values are set in the order they are encountered. If the same # property is defined in multiple locations, the final setter takes precedence # # All settable properties for this server are enumerated in this file. If a # property defined and commented out this documents its default value. # # ------------------- Repository Related Properties ---------------------------- # # # The description property is used to contain a description of this server # instance for display purposes # NO DEFAULT description=eas Repository Server # The repository unique ID. # Example: repository.uniqueid=1.3.6.1.4.1.2205.2154.3.1.2 # REQUIRED, NO DEFAULT repository.uniqueid=1.3.6.1.4.1.21367.13.40.1 # ----------------------- EAS Service Related Properties ----------------------- # # # The Content Server Repository ID used by EAS. # Example: repository.eas.repositoryid=000451 # REQUIRED, NO DEFAULT repository.eas.repositoryid=000001 # The EAS Webservice address. # The address to where the EAS Web Services have been installed. # Example: repository.eas.serviceaddress=http://eashost/eas-services # REQUIRED, NO DEFAULT repository.eas.serviceaddress=http://localhost/eas-services 37

Sample Configuration Files # The EAS content service path. # Example: repository.eas.contentservicepath=services/contentservice?wsdl # OPTIONAL, DEFAULT = services/contentservice?wsdl repository.eas.contentservicepath=services/contentservice?wsdl # ------------------------- EAS Service Context -------------------------- # # The properties below are used given that the EASServiceAccountContextProvider # is used. # The EAS consumer application. # repository.eas.context.serviceaccount.consumerapplication # Example:repository.eas.context.serviceAccount.consumerApplication=xds_repository # REQUIRED, NO DEFAULT repository.eas.context.serviceaccount.consumerapplication=eas_gui # The EAS language code. # Example: eas.context.serviceaccount.languagecode=xds_repository # REQUIRED, NO DEFAULT repository.eas.context.serviceaccount.languagecode=en_us # The EAS username. # Example: repository.eas.context.serviceaccount.username=xds_repository_user # REQUIRED, NO DEFAULT repository.eas.context.serviceaccount.username=dmadmin # The EAS Roles. # REQUIRED, NO DEFAULT # Example: repository.eas.context.serviceaccount.roles=xds_repository_role repository.eas.context.serviceaccount.roles=phonecalls_role # ---------------------------- HTTPS Related Properties ------------------------ # # # The following properites must be configured for secure communication # These are used for keystore and truststore configuration. # # The final property in this section, https.ciphersuites is used to # configure the suite used, a suitable value for # this parameter is: TLS_RSA_WITH_AES_128_CBC_SHA # # The properties in this section have NO DEFAULTS # https.keystore # https.keystorepassword # https.truststore # https.truststorepassword # https.ciphersuites https.keystore=${com.emc.healthcare.home}/ca-repository/keystore.jks https.keystorepassword=changeit https.truststore=${com.emc.healthcare.home}/ca-repository/truststore.jks https.truststorepassword=changeit https.ciphersuites=tls_rsa_with_aes_128_cbc_sha # ------------------------- ATNA Audit Related Parameters -------------------- # # # Host name for the ATNA audit repository # DEFAULT=localhost # audit.host=localhost # Port number for the ATNA audit repository. # DEFAULT=514 # audit.port=514 38

Sample Configuration Files # Transport type for the ATNA audit repository (BSD, TLS, UDP) # DEFAULT=UDP # audit.transport=udp # An optional source identifier for ATNA audit messages. # NO DEFAULT audit.sourceid=${description} 39

Sample Configuration Files 40

Index A access control settings, 9 ATNA properties, 26 authentication configuration, 9 C ca-repository.properties, 23 communication security settings port usage, 10 configuring ca-repository.properties file, 23 configuring the set-env.bat file, 15 creating hip directory, 18 D data security settings, 10 deploying archivevision war file, 21 deploying clinical archiving war file using tomcat, 19 deploying property files, 18 E eas service context properties, 25 eas service properties, 24 H https properties, 25 I installing archivevision, 19 installing ArchiveVision library dependencies, 21 installing clinical archiving, 15 installing clinical archiving holding, 14 installing the jar files, 17 L log description, 35 log management and retrieval, 35 log settings, 35 N network encryption, 10 O obtaining ArchiveVision library dependencies, 19 obtaining library dependencies, 16 P port usage, 10 post-installation configuration, 23 pre-installation tasks, 13 preparing the environment, 14 S sample files, 37 secure deployment settings, 11 security configuration, 9 U usage report properties, 27 user authentication, 9 V verifying installation, 29 verifying installation of ArchiveVision, 29 verifying installation of clinical archiving, 29 verifying the jar files, 17 41