Skip Headers
Oracle® Clinical Installation Guide
Release 5.1

E53553-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

6 Installing the Oracle Clinical Front End

This chapter includes:

The Oracle Clinical and RDC Onsite Front End includes:

The Oracle Application Server technology stack must be installed before you install the Oracle Clinical Front End. See Chapter 5, "Installing and Configuring the Application Tier" for instructions.

6.1 Gather the Required Information

Have the following information ready to enter in the Installer screens:

  • Home Details: Select the Oracle Home that corresponds to the Oracle Forms and Reports home, similar to C:\oracle\middleware\Oracle_FRHome1.

    On the Installer screen there are two drop downs, Name and Path. Use the Path drop-down to do the selection. When you select the directory, the Name value changes automatically.

  • Your OPA Home directory; by default:

    C:\opapps51

  • Oracle HTTPS Server (OHS) SSL Listener Port number. You may have set this to 443 per the instructions in the previous chapter; see Section 5.6.1.4.1, "Add the New Wallet Location and Specify Port.".

  • Oracle HTTP Server (OHS) Non-SSL Listener Port number.

    Tip:

    To find these two port numbers:
    1. Open an MS DOS window.

    2. Go to oracle_instance/bin.

    3. Enter opmnctl status -l

      where the last character is a lowercase L.

    To check, go to the URL https://host:port with each port.

  • WebLogic username: The account created when you installed the WebLogic Server.

  • Passwords for:

    • WebLogic Server (Enter a new password or use the password you created when installing WebLogic Server)

    • OPA Proxy (bc4j_internal)—the password you created when installing Oracle Clinical database objects

    • RDC Proxy (rdc_midtier_proxy)—the password you created when installing Oracle Clinical database objects

  • Database details:

    • Server.Domain; for example:

      servername.your_company.com

    • Database service name

    • Port number

  • Wallet location: for the Wallet you created in Section 5.6, "Enable SSL Between a Browser and Oracle HTTP Server." (You can browse for it on screen.)

  • Online help URL: If you have customized the online help, the URL where the customized online help is located.

6.2 Restart Computer and Stop All Servers and Services

Restart the computer and then stop all servers and services:

  1. Restart the computer.

  2. In the Windows Services control panel, find Oracle WebLogic Node Manager service and stop it.

  3. From the Windows Start menu, go to All Programs, then Oracle Classic Instance_asinst_1, then:

    • Forms Services, then Stop WebLogic Server - WLS_FORMS

    • Reports Services, then Stop WebLogic Server - WLS_REPORTS

    • Stop the WebLogic FRDomain Admin Server via Stop Weblogic Admin Server

6.3 Install the Oracle Clinical Front End Components

To install the Oracle Clinical Front End components:

  1. Log in as the user you selected in Section 5.1.1, "Identify a Single Account to Perform All Application Tier Installation Tasks".

  2. In the staging area, locate the directory where you downloaded and extracted Oracle Clinical (see Section 1.5, "Downloading and Extracting the Software").

  3. Run the following file as an administrator:

    Disk1\install\setup.exe

    The Installer opens to the Welcome screen.

    Note:

    See "Using the Silent Installer" for instructions for running the Installer as a file with pre-entered parameter values.

    Note:

    Although there is a button for deinstalling products on the Welcome screen, Oracle does not support using the Installer to deinstall Oracle Clinical.
  4. In the Select a Product to Install page, select Oracle Clinical Front End 5.1.0.0.x.

  5. Follow the instructions on the installation screens, providing the information you assembled in Section 6.1, "Gather the Required Information".

  6. If the Installer detects that you have already installed Release 5.0 or above and created the OPADomain, the Installer asks if you want to overwrite OPADomain or not.

    Choose to overwrite it if your previous installation failed or only partially completed; for example, the RDC Onsite URL does not work. If you have created it successfully, and especially if you have done customizations such as setting up clusters or multiple databases, do not overwrite OPADomain.

  7. Summary: The Summary screen provides information about the global settings, languages, space requirements, and products for this installation.

    Review the installation details to verify that they are correct. To revisit earlier installation screens and make changes, click Back.

    When you are ready to continue, click Install.

  8. Install: The Installer copies the files onto the server, completes the setup and configuration tasks, and generates a log file of this installation.

    In addition, the Install screen displays the location of the log file that records the results of the installation activities for this session. Make a note of this information so you can view the log file after the installation.

  9. End of Installation: The End of Installation screen reports whether the installation was successful. In addition, this screen lists the URLs that you use to access the Oracle Clinical, RDC Onsite, and RDC Administration applications.

    The Installer saves the URL information in the following file:

    \opapps51\log\setup.txt

    When you have finished reviewing the installation information, click Exit.

6.3.1 Review the Installation Log File

Review the generated installation log file for errors. See Section 1.7, "Reviewing the Installation Log Files" for details.

Work with Oracle Support, if necessary, to resolve any errors.

6.3.2 Restart the Computer

To ensure that all configuration changes are initialized, you must restart the computer before you continue with the next task in the installation process or before you install Oracle Clinical Reports Server.

6.3.3 Add WebLogic Data Sources If Using Multiple Databases

When you run the Oracle Clinical Installer, it sets up two data source connections, one for OPA and one for RDC Onsite, from the WebLogic Server (WLS) to the database you specify in the Installer screens.

If you plan to use more than one database, you must create a WLS data source for RDC for each additional database. If you also are using TMS on multiple databases, you need to create additional data sources for OPA and the TMS Browser. The OPA connection is used for running TMS reports.

Instructions are in the Oracle Clinical Remote Data Capture Onsite Administrator's Guide and the Oracle Thesaurus Management System User's Guide.

6.4 Make the Java Runtime Environment Available for Download

The Oracle Clinical and RDC Administration applications require that Java Standard Edition (SE) Runtime Environment (JRE) exist on the user's computer.

The Oracle Clinical Launch page is configured to prompt users to install JRE if it does not exist on their computer. To make this work, you need to download JRE into the OPA_HOME\html directory and rename it.

  1. If you have not already done so, download the software following instructions in Section 1.5.5, "Downloading the Java Runtime Environment."

    See that section if you are using the 64-bit version.

  2. Copy the downloaded file from the staging area to OPA_HOME\html.

  3. Rename the file to sunjpi.exe.

If your users need to have both JRE 6 and 7 installed to support different versions of Oracle Clinical, check My Oracle Support article 1570682.1 for guidance; see "Finding Information on My Oracle Support".

6.5 Make the Oracle Clinical PDF Plug-in Available to Users

Users who use the DCI Forms graphic layout system for annotated CRFs need the Oracle Clinical PDF Plug-in. There is a link to download this plug-in on the Oracle Clinical launch page. The link on the launch page resolves to: https://machine/opa51/rdc/opapdf.exe.

You should already have downloaded the plug-in, following instructions in Section 1.5, "Downloading and Extracting the Software."

To make the plug-in available from the launch page, follow the instructions in the readme file to install the PDF plug-in on the Forms server in the opa_home\html\rdc directory.

6.6 Share the RDC Directory for Image Access

As part of the Forms Server setup, you need to:

  • Share the directory that stores image files used by the Reports Server for the Patient Data Report and the Oracle Clinical Graphic Layout Editor for DCI Form generation and migration. Name the directory rdc. Its default location is opapps51\html\rdc. Make the directory readable by the account that is used to start up the OPADomain and FRDomain Servers.

  • Enable image browsing by setting values in the Windows system registry

6.6.1 Sharing the Directory Across Multiple Computers

To share the image directory across multiple machines:

  1. Log in to the Forms Server computer as a user with system administrator privileges.

  2. Select a directory to store the images. The default location is <OPA_HOME>\html\rdc\dcif_images (for example C:\opapps51\html\rdc\dcif_images) but you can select a different location.

  3. Select a directory in that path that you will share. The default directory is <OPA_HOME>\html\rdc (opapps51\html\rdc).

  4. Share that directory. The default share name is rdc.

  5. Make the directory readable by the account that is used to start up the OPADomain and FRDomain Admin Servers that use the Graphic Layout Editor.

  6. Set the related Windows registry settings under \HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\KEY_OHnumber:

    Note:

    There are two Oracle keys with randomly generated numbers. Only one of them contains these settings.
    • RDC_DCIF_IMAGES: Enter the UNC for the images directory. If you used the above defaults, the value would be:

      \\forms_server_machine_name\rdc\dcif_images.

    • RDC_DCIF_IMAGES_URL: Enter the URL for the same location; for example:

      https://server_name.domain/opa51/rdc/dcif_images

    • RDC_DCIF_IMAGES_BROWSE: Set to Y.

    • RDC_DCIF_IMAGES_VALIDATE: Set to Y to enable image browsing or N to disable image browsing.

  7. Put the images that should be available for the Patient Data Report and graphic layouts in the image directory; by default, dcif_images.

6.6.2 Setting Up the Image Directory on a Single Computer

If you have a single Forms server, do the setup in Section 6.6.1 except skip sharing the directory (Step 4 above) and set the RDC_DCIF_IMAGES registry entry to the full path; for example, C:\opapps51\html\rdc\dcif_images.

6.7 Install and Configure JSpell Spell Checker SDK (Optional)

JSpell Spell Checker SDK is a third-party product from Page Scholar Inc (http://www.jspell.com/). You can use it to check the spelling of text objects in Oracle Clinical DCM and DCI graphic layouts. You must purchase the product separately.

6.7.1 Install JSpell on Oracle Application Server

To install the JSpell on Oracle Application Server:

  1. If you have not already done so, download and extract JSpell, following instructions in Section 1.5.7, "Downloading JSpell (Optional)."

  2. Identify the following files in the download directory:

    • jspellsdks.jar

    • jspellsdkn.jar

    • jspellsdk.war

  3. Copy the two .jar files to the following location on the Oracle Application Server: middleware_home \ Oracle_FRHome1\forms\java; for example: C:\app\oracle\middleware\Oracle_FRHome1\forms\java.

6.7.2 Install the JSpell WAR File on the WebLogic Server

To install the JSpell .war file on the WebLogic server:

  1. Copy the jspellsdk.war file to any location on the WebLogic server:

  2. Extract the contents of jspellsdk.war to a folder named jspellsdk:

    Description of jspell_war_path.gif follows
    Description of the illustration jspell_war_path.gif

  3. Copy the jspellsdk folder to default Admin Server upload location: middleware_home\user_projects\domains\OPADomain\servers\AdminServer\upload.

  4. Also copy the jspellsdk folder to the Target Server stage location. (middleware_home\user_projects\domains\OPADomain\servers\OpaServer1\stage)

    Note:

    If the stage directory does not already exist, create it.
  5. Log in to the OPADomain Admin Server console at: http://server_namedomain:7101/console

  6. Click the Deployments tab.

  7. Click the Install button.

  8. Check the Current Location. If it does not show the upload directory under AdminServer shown in Step 3 above, navigate to that location.

  9. Select jspellsdk (open directory) and click Next.

  10. Select Install this deployment as an application and click Next.

  11. Select the Target Server OpaServer1 and click Next.

  12. Under General, What do you want to name this deployment? enter jspellsdk in the Name: field.

  13. Click Finish. In a moment the summary screen appears.

  14. Restart the OpaServer1 process; see Section 6.10.5, "Starting the OpaServer1 Server."

  15. In the Summary of Deployments page in the OPADomain Admin Server console, check that jspellsdk is listed as Active and its Health value is OK.

6.7.3 Update the mod_wl_ohs.conf File for JSpell

By default JSpell uses port 7221. To make this work with either HTTP port 8888 or HTTPS port 443, edit mod_wl_ohs.conf and restart OHS.

To update the mod_wl_ohs.conf file:

  1. Navigate to the following directory:

    middleware_home\asinst_1\config\OHS\ohs1

  2. Open the fmod_wl_ohs.conf file.

  3. Add the following entry:

    <Location /jspellsdk>
    setHandler weblogic-handler
    webLogicHost localhost
    weLogicPort 7221
    </Location>
    

6.7.4 Restart Oracle HTTP Server (OHS)

To restart OHS:

  1. Open a DOS prompt.

  2. Enter:

    opmnctl restartproc process-type=OHS

6.7.5 Test the JSpell Servlet

To test the JSpell Servlet:

  1. Open an internet browser.

  2. Enter the following URL:

    https://server_namedomain:7221/jspellsdk/servlet/JSpellServlet? operation=status

If the status page opens without error, JSpell is installed properly.

6.7.6 Update the formsweb.cfg File for JSpell

To update the formsweb.cfg file:

  1. Navigate to the following directory:

    middleware_home\user_projects\domains\FRDomain\config\fmwconfig\servers\WLS_FORMS\applications\formsapp_11.1.2\config

  2. Open the formsweb.cfg file.

  3. Find the [opa51] text section.

  4. Append the following text string to the end of the archive parameter value:

    jspellsdks.jar,jspellsdkn.jar

6.7.7 Update the Windows System Registry for JSpell

Update the Windows System Registry:

  1. Open the Windows System Registry Editor.

  2. Navigate to the following key:

    \HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\KEYnumber where the Oracle Clinical and OPA registry settings are.

  3. Add the following keys to the registry:

    • OPA_SPELL_ENABLED=Y

    • OPA_SPELL_LANGUAGE=English (US)

    • OPA_SPELL_URL= http://server_name/jspellsdk/servlet/JSpellServlet

      Note:

      In the above registry value, use either HTTP or HTTPS, depending on how your system is configured.

6.7.8 Test JSpell in the Graphic Layout Editor

If you already have a study set up that uses the Graphic Layout Editor:

  1. In Oracle Clinical, navigate to a study DCM.

  2. From the Special menu, select Graphic Layout, then Edit. The Graphic Layout Editor opens.

  3. From the Edit menu, select Spell Check Current.

  4. If you receive a warning that the application is unsigned, click Run. The system displays the first misspelled word it finds and suggests alternative spellings.

  5. To find another misspelled work, select Find Next Misspelling from the Edit menu.

If you do not already have such a study set up, see Oracle Clinical Creating a Study.

6.8 Verify and Fix Environment Variables

Check values and correct them if required.

6.8.1 Check Values

To check variable values:

  1. Open a DOS prompt window.

  2. Run:

    middleware_home\user_projects\domains\OPADomain\bin\setDomainEnv.cmd  
    

    For example:

    c:\oracle\middleware\user_projects\domains\OPADomain\bin\setDomainEnv.cmd
    

    The script should run with no errors.

  3. Inspect the value of JAVA_HOME:

    1. At the DOS command prompt, type: set JAVA_HOME. You should see the location where you installed JDK following instructions in Section 5.3, "Install Oracle Java Development Kit."

    2. Enter: dir %java_home%. You should see the directory specified as your JAVA_HOME containing a file called src.zip and four subdirectories: jre, lib, bin, and include.

      If you do not see these things, you will need to add them as directed in Section 6.8.2, "Correct Values".

      If JAVA_HOME contains any spaces or if any of the directories in its path are greater than 8 characters, you will need to correct them as directed in Section 6.8.2, "Correct Values".

  4. Inspect the value of JAVA_VM. At the command prompt, enter: set JAVA_VM. You should see something like JAVA_VM=-server. If not, correct as directed in Section 6.8.2, "Correct Values".

6.8.2 Correct Values

To correct any of the above problems:

  1. Navigate to middleware_home\wlsserver_10.3\common\bin

  2. Back up commEnv.cmd.

  3. Open commEnv.cmd in a text editor.

  4. The first set command in the file, before any other set command, must identify the JAVA_HOME value. For example:

    set JAVA_HOME=c:\app\java\jdk16065

  5. Find:

    set JAVA_VM=-client

    change it to:

    set JAVA_VM=-server

  6. Close the DOS window and open a new one, then repeat the steps in Section 6.8.1, "Check Values".

6.9 Setting Up Automatic Startup

It is possible to configure any Windows service to restart itself upon failure. These are standard options available when configuring a Windows service in the context of Windows Services Manager.

However, it is important to understand that Windows Services Manager only monitors the service's JVM process. If the JVM process fails (shuts down), then Windows Services Manager will attempt to restart it. But there are some scenarios where the WebLogic Admin Server or Managed Server may go into an unhealthy or failed state while the JVM is still running. The Windows Service Manager will not know to restart the process in these cases, whereas if the Admin Server and Managed Server had been started using the WebLogic Node Manager, Node Manager would recognize such a state and restart the process.

Oracle recommends starting the Admin and Managed Servers through the Node Manager using python scripts and then configuring the Windows server to execute the python scripts at startup.

To start servers manually, see Section 6.10, "Starting Servers Manually."

6.9.1 Set Up Script to Execute Automatically at Machine Startup

Create a task and set up the Task Scheduler to run the job on bootup:

  1. From Start, then Control Panel, then Administrative Tools, open Task Scheduler.

  2. Select Create Basic Task on the right side of the Task Scheduler.

  3. Enter following values:

    Name: Oracle FRDomain Autostart

    Trigger: When the computer starts

    Action: Start a program

    Select: opa_home\config\autostartFRDomain.cmd

  4. Click Next and then Finish to complete creation of the scheduled task.

  5. Find the task Oracle Domain Autostart under the Active Tasks list (center pane) and double-click to select it. Right-click on the task you just created and select Properties.

  6. Click OK.

  7. When prompted, enter the user name and password.

  8. On the General tab, select Run whether user is logged on or not.

  9. Repeat these steps for OPADomain, with two differences. In Step 3, enter:

    Name: Oracle OPADomain Autostart

    Select:opa_home\config\autostartOPADomain.cmd

6.9.2 Verify Autostart Scripts

  1. From a DOS window, enter command:

    opa_home\config\autostartfrdomain2.cmd

    to start the FRDomain server. This command will print a lot of messages and will take some time. While this is executing, proceed to next step.

  2. From a different DOS window, enter command:

    opa_home\config\autostartopadomain2.cmd

    to start the OPADomain server.

  3. When both windows are complete, you will see messages like below, followed by the DOS prompt which will indicate script is complete:

    Starting server WLS_FORMS .................................... 
    Server with name WLS_FORMS started successfully 
    Starting server WLS_REPORTS ............................ 
    Server with name WLS_REPORTS started successfully 
     
    Successfully Connected to Node Manager. 
    Starting server AdminServer ... 
    Successfully started server AdminServer ... 
    Starting server OpaServer1 ... 
    Successfully started server OpaServer1 ... 
    
  4. Verify that these URLs work and you can log into application:

    • Oracle Clinical: https://server.domain/opa51/launch.htm

    • RDC Onsite: https://server.domain/rdcadfsrnd/faces/Login

6.9.3 Test Autostart

To test:

  1. Restart the computer.

  2. Allow some time for the services to start.

  3. Try the URLs in Section 6.9.2, "Verify Autostart Scripts."

    If the URLs do not work after several minutes, check files in opa_home\log:

    • autostartfrdomain2.log

    • autostartfrdomain2.err

    • autostartopadomain2.log

    • autostartopadomain2.cmd

6.10 Starting Servers Manually

If you have not set up automatic startup, you can start the required servers manually using the instructions in this section.

For information about these servers and the server architecture, see Figure 1-2, "Oracle Clinical Network Topology".

6.10.1 Starting the FRDomain Admin Server

The Oracle FRDomain Admin Server is located on the WebLogic Server domain that must be named FRDomain and must use port number 7001. You must start the Admin Server before you can start either the Oracle Forms Server or the Oracle Reports Server.

Do one of the following.

  • Go to the Start menu, then All Programs, then Oracle Classic asinst_1, then Start Admin Server.

  • Go to the Start menu, then All Programs, then Oracle WebLogic, then User Projects, then FRDomain, then Start Admin Server WebLogic Server Domain.

Note:

You cannot start it from the Admin Console because if the server is not running, the FRDomain Admin Console is not available.

6.10.2 Starting the Forms Server

The Oracle Forms Server is located on the WebLogic Server domain that must be named FRDomain and must use port number 7001. You must start the FRDomain Admin Server before the Reports Server.

To start the Forms Server, go to Start, then All Programs, then Oracle Classic asinst_1, then Forms, then Start WLS_FORMS.

6.10.3 Starting the Reports Server

The Oracle Reports Server is located on the WebLogic Server domain that must be named FRDomain and must use port number 7001. You must start the FRDomain Admin Server before the Reports Server.

To start the Reports Server, go to Start, then All Programs, then Oracle Classic asinst_1, then Reports, then Start WLS_REPORTS.

6.10.4 Starting the OPADomain Admin Server

The Oracle OPADomain Admin Server is located on the WebLogic Server domain that the Installer names OPADomain, and which must use port number 7101. You must start the Admin Server before you can start the OpaServer1.

To start the OPADomain Admin Server, go to the Start menu, then All Programs, then Oracle WebLogic Server, then User Projects, then OPADomain, then Start Admin Server.

Note:

You cannot start from the Admin Console because if the server is not running, the OPADomain Admin Console is not available.

6.10.5 Starting the OpaServer1 Server

The OpaServer1 Server is located on the WebLogic Server domain named OPADomain, which must use port number 7101. The OpaServer1 Server runs on Oracle ADF and supports RDC Onsite, the TMS Browser, and TMS reports. It also contains the database connections.

You must start the OPADomain Admin Server before the OpaServer1 Server.

To start the OpaServer1 Server, use the Admin Console at either:

  • http://host:7101/console

  • https://host/opaconsole (if configured)

6.11 Verify the Application Tier Installation

Verify that these URLs work and you can log into application:

  • https://host/opa51/launch.htm

  • https://host/rdcadfsrnd/faces/Login

6.12 Stopping Servers

You can stop each server either in the appropriate WLS Admin Console or from the Windows Start menu. These instructions are provided for your information; you do not need to do them now.

6.12.1 Stopping the Forms Server

The Oracle Forms Server is located on the WebLogic Server domain that must be named FRDomain and must use port number 7001.

To stop the Forms Server, do either:

  • Start, then All Programs, then Oracle Classic asinst_1, then Forms, then Stop WLS_FORMS.

  • Use the Admin Console at https://host:7001/console.

    Note:

    The Admin Console is available only if the Admin Server is running.

6.12.2 Stopping the Reports Server

The Oracle Reports Server is located on the WebLogic Server domain that must be named FRDomain and must use port number 7001.

To stop the Reports Server, do either:

  • Start, then All Programs, then Oracle Classic asinst_1, then Reports, then Stop WLS_REPORTS.

  • Use the Admin Console at https://host:7001/console.

    Note:

    The Admin Console is available only if the Admin Server is running.

6.12.3 Stopping the FRDomain Admin Server

The Oracle FRDomain Admin Server is located on the WebLogic Server domain that must be named FRDomain and must use port number 7001.

To stop the Admin Server, do either:

  • Start, then All Programs, then Oracle Classic asinst_1, then Stop Admin Server.

  • Use the Admin Console at https://host:7001/console.

6.12.4 Stopping the OPADomain Admin Server

The Oracle OPADomain Admin Server is located on the WebLogic Server domain that the Installer names OPADomain, and which must use port number 7101.

To stop the Admin Server, do either:

  • Start, then All Programs, then Oracle WebLogic Server, then User Projects, then OPADomain, then Stop Admin Server.

  • Use the OPADomain Admin Console at https://host/opaconsole or

    https://host:7101/opaconsole

6.12.5 Stopping the OpaServer1 Server

The OpaServer1 Server is located on the WebLogic Server domain named OPADomain, which must use port number 7101.

To stop the OpaServer1 Server, use the Admin Console at either:

  • http://host:7101/console

  • https://host/opaconsole (if configured)

    Note:

    The Admin Console is available only if the Admin Server is running.