CaAERS v1.7

From CTMS_WIKI

Introduction

caAERS v1.7 is production point release that fixes priority bugs and issues in the previous version and includes the addition of new functionality. See caAERS1.7 Release Notes for further feature & fix documentation.

A fully functional demo system to use for testing purposes is available here. Username/password is: SYSTEM_ADMIN/system_admin

Please send all feedback from testing to: paul.baumgartner@semanticbits.com

Below is a "Quick Start" guide to installing the application. For full installation instructions, click here: Stand-alone Application

Installation components

Fresh caAERS Install

Prerequisites

You must first have JDK installed on your machine before you can install caAERS. caAERS also requires Apache Tomcat version 5.5.23 or higher. If you do not already have Apache Tomcat, you can select to have it auto-installed during the caAERS installation process. caAERS supports two databases, Oracle and PostgreSQL. You will need to create an empty database for caAERS to use.

After you have followed the instructions below to run the Graphical Installer, you will need follow the instructions listed after that to install the Apache Servicemix and upload XML files that contain preconfigured Report Definitions and Rules for caAERS.

Installing caAERS v1.7

Database Configuration

SUGGESTION: To best understand the installation procedures for the caAERS, it is recommended that you follow the proce­dures described in this section with minimal deviation.

Run the Graphic Installer

Step	Action
1	Verify that there is an empty database for caAERS to use.(We recommend you name it caaers).
2	Go to caAERSInstaller.jar and save the jar file to your machine. Once it has been saved, double-click the jar file to begin the installation process.
3	The caAERS Installer will begin extracting files need to complete the process. The following screen will be displayed as it is extracting.
4	Once the installer has finished extracting, this page will be displayed: Click the Next >> button to move forward in the process. The << Back and Install buttons will be grayed out.
5	Select the radio button next to "I Accept." And then click Next >>.
6	Select the database to be used with caAERS and then click Next >>.
7	To install caAERS successfully, you need to have the database's parameters, including name, host name, port address, and a valid user id and password. Enter the appropriate information in all of the fields and then click Next >>.
8	Create administrator for caAERS. Default user name is SYSTEM_ADMIN and Default password is system_admin. Please change accordingly and then click Next >>. |
9	Enter {a folder location} for the Rules Repository for caAERS to use. Either type in the location, or browse to it clicking Select Folder and navigating to it. After  entering the folder, click Next >>.(If the folder does not exist, the installer will prompt the user & create one) |
10	Select appropriate Authntication Mode and then click Next >>. |
11	If WebSSO was selected in the previous step the below screen will be presented. Additional information on what should be entered is included below. WebSSO server URL: Modified to define the server name/port that is hosting WebSSO The WebSSO server certificate_: This is the path/filename of the certificate that was created for WebSSO during the installation of the WebSSO software. Note: It may be necessary to make a local copy of this certificate on the caAERS server if file permissions prohibit reading this file directly from where it resides within the WebSSO server. The Host Certificate and Host Key: Enter the certificate and key files (normally ending in a .pem filename extension) created for caAERS using the GAARDS UI program on the Dorian Server. (Refer to the CCTS 1.0 Installation Guide for information on generating certificate and key files for each CCTS application component) Acegi URL: Update the server/port assignment to define the server name/port where caAERS will be running. The remainder of the path details, /caAERS/j_acegi_cas_security_check, should not be modified. Study Consumer URL: If using a standard configuration, this default path should be correct. You can update it directly in the config file at a later point if changes are required. Registration Consumer URL: If using a standard configuration, this default path should be correct. You can update it directly in the config file at a later point if changes are required. |
12	Verify the components that are to be installed, and then click Next >>. |
13	Click Install to start the installation process. This will initiate the installation and display the installation's status. The status screen will be displayed as shown for some time while the install continues.  It is not complete until you receive the *Finished* pop-up window as shown in step 13. Be patient and do not hit the Cancel button. |
14	When the process has completed, click OK and then click Exit. |

Install Apache Servicemix & Upload XML Files

1. Download apache-servicemix-3.1.2-windows-service.zip.
2. Unzip apache-servicemix-3.1.2-windows-service.zip to any location and create environment variable SERVICEMIX_HOME pointing to this location.
   1. Download caaers-adeers-sa-3.1.2-incubating.zip & save it in $SERVICEMIX_HOME/bin/deploy folder (*nix environments) OR save it in $SERVICEMIX_HOME/deploy (windows environment)
   2. Download ctms-caaers-sa-3.1.2-incubating.zip & save it in $SERVICEMIX_HOME/bin/deploy folder (*nix environments) OR save it in $SERVICEMIX_HOME/deploy (windows environment)
3. Right click on this link: caAERS-AdEERS, select save link as then save the file in the user home folder (the user which starts servicemix). For example: C:\Users\{username}
4. Start the Servicemix by going to the command line $SERVICEMIX_HOME/bin and run the command: servicemix.
5. Start Tomcat from $CATALINA_HOME/bin and run the command: startup.sh on unix/linux/mac or startup.bat on windows.
6. Log in to caAERS using the username/password which was provided during caAERS installation. Go to https://localhost:8443/caaers/. This will display the log in page if you are installing caAERS locally. The default Username is: SYSTEM_ADMIN. The default Password is: system_admin.
   Note: If you are installing caAERS remotely, replace localhost with the server name where caAERS has been installed.
7. Once you are logged in, click the Rules tab and click Import Report Definitions. The next step is to import the report definition XML files.
   Note: You must import the report definition XML files prior to importing the rules XML files. For more information about caAERS Report Definitions and how to configure them click here.
8. Download the Report Definition XML files from caAERS1.7 Report Definitions. To save the Report Definition XML files to your machine, right click on the links of the XML files and select Save link as.
9. From the Rules tab, click Browse and the select the folder where the report definition XML files are saved. Select the 10_day_report_submission_to_adeers.xml file and click Import. You will see a confirmation message stating that the file was imported successfully.
10. Repeat step 11 for the other Report Definition XML files:
    48_hour_sae_report_to_nci_medical_monitor_and_ccsa.xml
    ctep_10_calendar_day_sae_report.xml
    ctep_24_hour_sae_notification.xml
    ctep_5_calendar_day_sae_report.xml.
11. The next step is to download the Rules XML files from caAERS1.7 rules. To save the Rules XML to your machine, right click on the links of the XML files and select Save link as.
12. From the Rules tab, click Import Rules.
13. Click Browse to navigate to the folder where Rules XML files were downloaded. Select the gov.nih.nci.cabig.caaers.rules.sponsor.cancer_therapy_evaluation_program.mandatory_sections_rules.xml file and click Import. You will see a confirmation message stating that the file was imported successfully.
14. Repeat step 15 for the other CTEP Rules XML file:
    gov.nih.nci.cabig.caaers.rules.sponsor.cancer_therapy_evaluation_program.sae_reporting_rules.xml.
15. Repeat step 15, this time for the 2 DCP rules files:
    gov.nih.nci.cabig.caaers.rules.sponsor.division_of_cancer_prevention.mandatory_sections_rules.xml
    gov.nih.nci.cabig.caaers.rules.sponsor.division_of_cancer_prevention.sae_reporting_rules.xml
    Note: For more information about Rules and how to configure imported rules, click here.

Upgrade from caAERS v1.6 to caAERS v1.7

1. We recommenced making backup copies of all the important artifacts listed below BEFORE starting the upgrade procedure. 
   1. Make a backup of current caAERS database.
   2. Export & SAVE Report definitions.
   3. Export & SAVE Rules. DELETE the existing Rule's set.
2. caAERS Service Assemblies Upgrade.
   1. Stop Servicemix
   2. Delete $SERVICEMIX_HOME/bin/deploy/*.* (*nix environments) OR $SERVICEMIX_HOME/deploy/*.* (windows environment)
   3. Download caaers-adeers-sa-3.1.2-incubating.zip & save it in $SERVICEMIX_HOME/bin/deploy folder (*nix environments) OR save it in $SERVICEMIX_HOME/deploy (windows environment)
   4. Download ctms-caaers-sa-3.1.2-incubating.zip & save it in $SERVICEMIX_HOME/bin/deploy folder (*nix environments) OR save it in $SERVICEMIX_HOME/deploy (windows environment)
   5. Start Servicemix
3. Drop Rules related tables
   1. drop table rep_binval;
   2. drop table rep_fsentry;
   3. drop table rep_node;
   4. drop table rep_prop;
   5. drop table rep_refs;
   6. drop table rep_ver_binval;
   7. drop table rep_ver_fsentry;
   8. drop table rep_ver_node;
   9. drop table rep_ver_prop;
   10. drop table rep_ver_refs;
4. caAERS Web Archive Upgrade.
   1. Stop Tomcat
   2. Delete $CATALINA_HOME/work/Catalina/localhost/caaers
   3. Delete $CATALINA_HOME/webapps/caaers
   4. Delete $CATALINA_HOME/webapps/caaers.war
   5. Download caAERS Web Archiveto $CATALINA_HOME/webapps/
   6. Start Tomcat
5. Import Saved or New Rules.
   1. Download the rules xml files from caAERS1.7 rules.
   2. Launch caAERS and Login as an Administrator.
   3. Navigate to Rules tab in caAERS and then onto the Import Rules sub-section.
   4. Using the browse button navigate to the folder where rules xmls were downloaded & select
      gov.nih.nci.cabig.caaers.rules.sponsor.cancer_therapy_evaluation_program.mandatory_sections_rules.xml file and click on import.
   5. Repeat the above step for the 3 rules files namely
      gov.nih.nci.cabig.caaers.rules.sponsor.cancer_therapy_evaluation_program.sae_reporting_rules.xml
      gov.nih.nci.cabig.caaers.rules.sponsor.division_of_cancer_prevention.mandatory_sections_rules.xml
      gov.nih.nci.cabig.caaers.rules.sponsor.division_of_cancer_prevention.sae_reporting_rules.xml.