Skip Headers
Oracle® Clinical Installation Guide
Release 4.6.2

E18817-04
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 Oracle Clinical Front End

The Oracle Clinical Front End installation includes the Oracle Clinical Forms Server, which performs the form processing; communicates the display changes to the client; and calls forms to query, update, select, and delete data from the Database Server.

In addition, the Oracle Clinical Front End includes the Oracle Clinical Remote Data Capture application, the online help, and the creation of the OPA OC4J instance and the RDC OC4J instance.

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

This chapter includes the following topics:

6.1 Installing the Oracle Clinical Front End Components

To install the Oracle Clinical Front End components:

  1. Log in as a user with system administrator privileges.

  2. Insert the Oracle Clinical and Oracle Thesaurus Management System 4.6.2 disk.

  3. Locate and run the following file:

    oc\application_tier\install\setup.exe

    The Installer opens to the Welcome screen.

  4. Follow the instructions on the installation screens. For additional information about each screen, see Section 6.1.1, "Attend to the Oracle Clinical Front End Installation Screens."

6.1.1 Attend to the Oracle Clinical Front End Installation Screens

The Oracle Universal Installer guides you through the installation and configuration of the Oracle Clinical components.

Welcome

Click Next to continue the installation.

Select a Product to Install

Select Oracle Clinical Front End 4.6.2.0.XX (where XX is the build number).

The Oracle Clinical Front End components include the Oracle Clinical Forms Server, the Oracle Clinical Remote Data Capture application, and the online help.

Click Next.

Specify Home Details

Enter values for the Oracle Home location you created when you installed Oracle Application Server 10g Release 2. This installation guide refers to this location as ORACLE_AS10gR2_HOME.

  • Name: Select the name of the correct Oracle Home; for example, AS10gR2.

  • Path: Browse for the path to the correct Oracle Home; for example, D:\Oracle\AS10gR2.

Click Next.

Oracle Clinical Front End Choose the Oracle AS10gR3 Home Directory

Click Next.

Oracle Clinical Front End Choose OPA Home Directory

Specify the directory that is the root directory for installations of Oracle Health Sciences products. Typically, you respond with the path to the opapps46 directory.

The recommended installation directory for Release 4.6.x is:

drive:\opapps46

This installation guide refers to this location as OPA_HOME.

Click Next.

Oracle Clinical Front End Enter OC4J Admin Password

When you installed Oracle Application Server 10g Release 3, you created a password for the OC4J administrator. You must enter and confirm that password.

Oracle Clinical Front End Enter OPMN Port Number

Enter the port number that the Oracle Process Manager and Notification Server (OPMN Server) uses. The default port number is 6004.

If you modified the default installation, you can check the following configuration file for the OPMN port number:

\ORACLE_AS10gR3_HOME\opmn\conf\opmn.xml

Oracle Clinical Front End Select the PSUB File Access Mode

Select the file access mode that the system uses to transfer or access the files generated by batch jobs submitted by the PSUB process. You can select SFTP or UNC as the protocol for viewing files generated by PSUB.

For more information, see Chapter 9, "Implementing Secure FTP for File Viewing (UNIX Only)."

  • SFTP (Secure File Transfer Protocol) — Select SFTP for installations with UNIX on the database tier. The output files are transferred from the database tier to the application tier using SFTP, and then displayed to the user.

  • UNC (Microsft Windows Universal Naming Convention) — Select UNC for installations with Windows on the database tier. The output files are accessed on the database tier using UNC, and then displayed to the user.

Click Next.

Oracle Clinical Remote Data Capture Front End Debug Information

Click Next to continue.

OPA Front End Choose OPAConfig Password

Enter and confirm the password that you will use to secure access to the OPAAdmin application. The default user name for logging in to the OPAAdmin application is opaconfig.

Ensure that all your passwords are strong passwords. You can strengthen passwords by creating and using password policies for your organization.

For information about how to change this password after installation, see Section 6.4, "Changing the Password for the opaconfig User."

Click Next.

OPA Front End Enter NLS Language

Enter the NLS language setting that is appropriate for your database character set.

The default value is AMERICAN_AMERICA.UTF8.

If you are only installing Oracle Clinical and Remote Data Capture, Oracle recommends that you use the UTF8 character set. In addition, Oracle recommends UTF8 for new customers.

However, be sure to use the same character set on the database tier and the application tier. If your database is US7ASCII and you select UTF8 for the application tier, Oracle Clinical stores some special characters incorrectly in the database.

The NLS language setting (NLS_LANG) is stored in the following file:

ORACLE_AS10gR2_HOME\forms\server\opa46.env

Click Next.

OPA Front End Enter NLS Date Format

All Oracle Health Sciences applications require a date format with a four-digit year. For example, DD-MON-RRRR.

If the NLS_DATE_FORMAT entry in the system registry is configured, Oracle Universal Installer displays that value by default. Adjust or enter the date format.

The NLS date format setting (NLS_DATE_FORMAT) is stored in the following file:

ORACLE_AS10gR2_HOME\forms\server\opa46.env

Click Next.

OPA Front End Enter Report Queue Manager Machine

By default, Oracle Universal Installer displays either the IP address or the name of the computer that has the Report Queue Manager installed. Accept the default value. Click Next.

OPA Front End Enter URL for the Report Queue Manager

Accept the default value. Click Next.

OPA Xhelp Enter the URL location of your custom documentation

If you have a directory for custom help, enter the URL location. Use the following syntax:

http://computer.domain:port/opa46/xhelp

Summary Oracle Clinical Front End 4.6.2.0.XX

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.

Install

Oracle Universal 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.

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, OPAAdmin, RDC, and RDC Administration applications.

The Installer saves the URL information in the following file:

\OPA_HOME\log\setup.txt

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

6.1.2 Review the Installation Log File

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

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

6.1.3 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.1.4 Update the Mandatory System Registry Values for Oracle Clinical Front End

After you install Oracle Clinical Front End, you must update the Windows System Registry for Oracle Clinical to work properly.

To update the Windows System Registry:

  1. Open the Windows System Registry Editor.

  2. Navigate to the following key:

    \HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ORACLE\ORACLE_AS10gR2_HOME

  3. Update the OPA_XMLTEMP_HTTP value to include the port number for the Oracle Application Server 10g Release 3 HTTP Server. For example:

    http://myserver.us.oracle.com:7777/opa46/rdc/temp

  4. Update the OPA_LOCAL_MT_URL value to include the port number for the Oracle Application Server 10g Release 3 HTTP Server. For example:

    OPA_LOCAL_MT_URL=http://127.0.0.1:7777

6.2 Making the Java Runtime Environment Available for Download

The Oracle Clinical, RDC Classic, and RDC Administration applications require that the Java Runtime Environment (JRE) exists on the user's computer. These applications support Java SE 6 Update 24 (Standard Edition, Version 1.6.0.24) or later.

The Launch pages for these applications include a Downloads link, which opens the Downloads page. You can configure the Downloads page so your users can install the required JRE software if it does not exist on their computer.

To download the latest version of the JRE and then position the software so your users can install it directly from the Downloads page:

  1. Go to the following Oracle Web site:

    http://www.oracle.com/technetwork/java/javase/downloads/index.html

  2. Download the latest Java Runtime Environment installer (for example, JavaSetup6u21-rv.exe) to the following location:

    OPA_HOME\html

  3. Rename the download file to sunjpi.exe.

6.3 Downloading the Oracle Clinical PDF Plug-in

If your organization implements the DCI Forms graphic layout system for annotated CRFs, you must:

  • Download the Oracle Clinical PDF plug-in from My Oracle Support

  • Install the plug-in on each Forms Server computer

To download and install the Oracle Clinical PDF plug-in:

  1. Sign in to My Oracle Support at https://support.oracle.com.

  2. Click the Patches & Updates tab. The Patches & Updates page opens and displays the Patch Search region.

  3. In the Patch ID or Number is field, enter 8262425. The current plug-in patch number is 8262425. If this patch becomes obsolete, download its successor.

  4. Click Search to execute your query. The Patch Search Results page opens.

  5. Click the patch ID number. The system displays details about the patch. In addition, you can view the ReadMe file before downloading the patch.

  6. Click Download. Follow the instructions on the screen to download and save the patch zip file to this computer.

  7. Extract the file to a temporary directory.

  8. Follow the instructions in the ReadMe file to install the PDF plug-in on this Forms Server.

6.4 Changing the Password for the opaconfig User

The Users page in Oracle Enterprise Manager 10g Application Server Control provides the options that let you change user passwords, add users, and delete users for the OPAAdmin application.

To change the password for the opaconfig user:

  1. Open a Web browser and enter your URL to the Oracle Application Server Forms and Reports Services Welcome page:

    computer-name.company-name.com

  2. Click the Log on to Oracle Enterprise Manager 10g Application Server Control link to open the Application Server Home page.

  3. Log in as user ias_admin with the password you set when you installed the Application Server.

  4. Select the appropriate instance.

  5. Click the opa OC4J instance.

  6. Click the Applications tab.

  7. Click the opaadmin link.

  8. Click the Administration tab.

  9. Expand the Security administration task, and then select the Go to Task icon for Security Provider.

  10. Click the Realms tab.

  11. Locate the jazn.com realm, and then click the number in its Users column.

  12. Click the opaconfig user name.

    1. Enter the old password, enter the new password, and then confirm your new password.

    2. Click Apply. Note that the user name remains opaconfig.

  13. Restart the opa OC4J instance.

6.5 Sharing the RDC Directory and Setting Image Browsing

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

  • Share the RDC directory so that it is available to both the Reports Server and the Oracle Clinical Graphic Layout Editor

  • Enable (or disable) image browsing by setting values in the Windows system registry

To share the RDC directory and to configure image browsing:

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

  2. Share the \opapps46\html\rdc\ directory. Give the directory the name RDC. Make it readable by any user account that uses the Graphic Layout Editor.

  3. Open the Windows System Registry Editor.

  4. Navigate to the following key:

    \HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ORACLE\ORACLE_AS10gR2_HOME

  5. Find and verify that the following values are set:

    • RDC_DCIF_IMAGES_BROWSE = Y

    • RDC_DCIF_IMAGES = \\forms_server_name\rdc\dcif_images

      The forms_server_name is the network name of the computer. You must use the reference syntax for the value. Entering the exact path does not work.

    • RDC_DCIF_IMAGES_URL = https://web_server_name.domain_name/opa46/rdc/dcif_images

      The domain_name is the fully qualified domain name. For example, my.company.com.

    • RDC_DCIF_IMAGES_VALIDATE = Y (to enable image browsing)

      or

      RDC_DCIF_IMAGES_VALIDATE = N (to disable image browsing)

Note:

The value for RDC_DCIF_IMAGES and RDC_DCIF_IMAGES_URL must be the same location.

6.6 Installing and Configuring the JSpell Spell Checker SDK

The 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 graphic layouts.

The Graphic Layout Editor in Oracle Clinical supports the JSpell Spell Checker SDK for Java J2EE. However, Oracle does not maintain the product itself. You must purchase the product separately.

6.6.1 Download and Install JSpell

To download the JSpell SDK files and install the JSpell libraries:

  1. Download the JSpell SDK files from the following location:

    http://www.jspell.com/java-spell-checker.html

  2. Extract the JSpell files from the downloaded ZIP file.

  3. Locate the following two JAR files:

    • jspellsdks.jar

    • jspellsdkn.jar

  4. Copy the JAR files into the following Application Server 10gR2 location:

    ORACLE_HOME/as10gr2/forms/java

  5. Create the jspell directory in the root of the Application Server 10gR2.

    For example, if you installed Application Server 10gR2 in the D:\oracle directory then you should create the D:\jspell directory.

  6. Open the lexicons folder that you extracted from the JSpell ZIP file.

  7. Copy the lex_enUS.jdx file into the jspell directory that you created in Step 5.

6.6.2 Install the JSpell WAR File on Application Server 10gR3

To install the JSpell WAR file on Application Server 10gR3:

  1. Log in to the Enterprise Manager Application Server Control by entering the URL in the following format:

    http://server_name/em/console

    where:

    server_name is the name of the server onto which you installed Application Server 10gR2 and Application Server 10gR3.

  2. Select the Application Server 10gR3 instance.

  3. Deploy the JSpell WAR file:

    1. Click the opa OC4J system component.

    2. Click the Applications tab.

    3. Click Deploy WAR File.

    4. Complete the following fields:

      Web Application: Enter the path to the jspellsdk.war file. You can click Browse to navigate to the location of this file.

      Application Name: jspellsdk

      Map to URL: /jspellsdk

    5. Click Deploy to start the installation. The system displays a message when the installation is done.

  4. Click OK. Note that you can now see the JSpell application listed along with the other applications already installed.

6.6.3 Test the JSpell Servlet

To test the JSpell Servlet:

  1. Open an internet browser.

  2. Enter the following URL:

    https://server_name/jspellsdk/servlet/JSpellServlet? operation=status

    where:

    server_name is the name of the server onto which you installed Application Server 10gR2 and Application Server 10gR3.

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

6.6.4 Change the Lexicons Directory

When you installed the JSpell SDK, the instructions recommended that you create the jspell directory in the same root (parent) directory as the Application Server. For example, if the Application Server is installed in D:\oracle, then you create the D:\jspell directory.

If the JSpell and Application Server directories are not at the same root directory, you must map JSpell's lexicons directory:

  1. Navigate to the following directory:

    ORACLE_AS10gR3_HOME\j2ee\opa\applications\jspellsdk \jspellsdk\WEB-INF

  2. Open the web.xml file.

  3. Find the following lines in the web.xml file:

    <init-param>
    <param-name>indexDirectory</param-name> 
    <param-value>/jspell/</param-value> 
    </init-param> 
      
    
  4. Change the /jspell/ text string to the location of the lex_enUS.jdx file on the Application Server 10gR3.

6.6.5 Update the formsweb.cfg File for JSpell

To update the formsweb.cfg file:

  1. Navigate to the following directory:

    ORACLE_AS10gR2_HOME\forms\server

  2. Open the formsweb.cfg file.

  3. Search for the [opa46] text section.

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

    jspellsdks.jar,jspellsdkn.jar

6.6.6 Update the Windows System Registry for JSpell

After you install the JSpell SDK, you need to add several keys to the Microsoft System Resigtry to support the JSpell application.

To add the required keys to the Windows System Registry:

  1. Open the Windows System Registry Editor.

  2. Navigate to the following key:

    \HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ORACLE\ORACLE_AS10gR2_HOME

  3. Add the following keys to the registry:

    • OPA_SPELL_ENABLED=Y

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

    • OPA_SPELL_LANGUAGE=English (US)

6.7 Applying Forms Server Customizations

If you are upgrading from an earlier release of Oracle Clinical, you must create new Forms Servers because the technology stack is different for Oracle Clinical 4.6.2 Forms Servers. If you modified any files in a previous Oracle Clinical installation, preserve your customizations.

6.7.1 Upgrade the User Menu

Oracle Clinical no longer includes the rxclbgen.pll file.

The rxcuser.pll file is located on the Forms Server in the OPA_HOME\oc\admin directory. If you customized rxcuser, upgrade the following files located in the Forms Server's Admin directory:

  • Recompile rxcuser.fmb with Forms Builder 10g.

  • Recompile rxcuser.mmb with Forms Builder 10g.

  • Detach rxclbgen.pll from rxcuser.fmb, and attach rxcuser.pll.

Replace your recompiled rxcuser.fmb and rxcuser.mmb files on each Forms Server in your network.

See the Oracle Clinical Administrator's Guide for more information about these customizations.

6.7.2 Upgrade rxclbcli.pll

If you have customized rxclbcli.pll, recompile it with Forms Builder 10g. See the Oracle Clinical Application Programming Interface Guide for more information.

Replace your recompiled rxclbcli.pll file on each Forms Server in your network.

6.7.3 Change DE_GRIDWIDTH and DE_GRIDHEIGHT Parameters

If you modified the DE_GRIDWIDTH and DE_GRIDHEIGHT parameters, change them to their original values so your Data Entry screens have the correct appearance.