5 Installing Oracle Thesaurus Management System Application Components

The Oracle Thesaurus Management System Front End includes:

  • The Oracle Thesaurus Management System Forms Server, which is required for the primary Oracle Thesaurus Management System application

  • The TMS Lite Browser, the online help, and the OPAXDO service for reports generation

You must install the TMS Server code and database objects before you install the Front End.

If Oracle Clinical Front End or previous versions of TMS Front End (which are supported for Front End) was already installed on the application server, follow instructions in Section 6.8, "Upgrade the TMS Front End" as the needed components were already created by previous Oracle Clinical or TMS Front End installation.

Note:

Before installing TMS Front End, you must start the FRDomain services (AdminServer, WLS_FORMS, and WLS_REPORTS) so that all required components will be created. After the FRDomain services have started, stop all these as the TMS Front End installation require to have all the FRDomain services stopped.

This section includes:

5.1 Restart Computer and Stop All Servers

Restart the computer and then stop all servers:

  1. Restart the computer.

  2. Stop all servers. For instructions, see Section 5.10, "Stopping Servers".

5.2 Installing the TMS Front End

The TMS Report Server must be installed on the same machine as the TMS Front End and requires that the WebLogic FRDomain Admin Server be running during installation, whereas the TMS Front End and Server installation processes require that the Admin Server be stopped.

5.2.1 Gather Required Information

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

  • Home Details: Enter the following:

    • Name: OPA_HOME

    • Path: C:\opapps53 or any desired path

      Note:

      • OPA_HOME was created after you installed the TMS Database Server (see "Install the TMS Database Server").
      • If TMS 5.2.x or Oracle Clinical 5.2.x has already been installed on this application server, OPA_HOME may already be set to C:\opapps52 or similar path, and you must use this for TMS 5.3 too. Do not create a new OPA_HOME if this was already created. The TMS 5.3 components will be placed by the installer under this OPA_HOME at the specified location for the TMS 5.3 release.

  • Java home is the location where JDK 1.8.0_191 or higher was installed.

  • Oracle Fusion Middleware home directory; for example:

    C:\Oracle\Middleware\Oracle_Home

  • Oracle Fusion Middleware User Projects directory; for example:

    C:\Oracle\Middleware\Oracle_Home\user_projects

  • OPA home directory should be the same path as OPA_HOME; by default:

    C:\opapps53

  • OPADomain Administration Server configuration details:

    • Listen address

    • Listen port number

    • SSL listen port number

    • OPADomain WebLogic username

    • OPADomain WebLogic password

  • OPADomain Node Manager configuration details:

    • Listen address

    • Listen port number

    • WebLogic username

    • WebLogic Server password

  • OPADomain Default Coherence Cluster Listener Port: Installer default value is 7575. For FRDomain, the default value is 7574.

  • Database details (this will be used to create a data source under OPADomain):

    • Server.Domain; for example:

      servername.your_company.com

    • Port number

    • Database service name

    • TMS Proxy Password (tmsproxy)—the password you created when installing Oracle Thesaurus Management System database objects.

  • Oracle Fusion Middleware Repository Creation Utility (RCU) configuration details:

    • Database host

    • Database port

    • Service name

    • Schema prefix

    • Database administrator username and password

    • RCU schema password

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

  • Managed Server configuration details:

    • Number of Managed Servers

    • Listen port start index

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

5.2.2 Start the Installer

To install the TMS Front End:

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

  2. In the staging area, locate the directory where you downloaded and extracted Oracle Thesaurus Management System (see Section 1.6, "Download the Software").

  3. Run the following file as an administrator:

    Disk1\install\setup.exe

    The Installer opens to the Welcome screen.

    Note:

    See Section 1.7, "Use the Silent Installer (Optional)" 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 Thesaurus Management System.

5.2.3 Attend to the TMS Front End Installer Screens

The Oracle Universal Installer guides you through the installation and configuration of the TMS Front End.

  1. Select a Product to install: Oracle Thesaurus Management System Front End 5.3.0.0.x.

  2. Choose Install Type: Select Yes to install a Oracle Thesaurus Management Front End.

  3. Available Product Components: Select Oracle Thesaurus Management System Front End 5.3.0.0.x.

    Note:

    Although the Installer gives you the option install the TMS Server (database server code) at the same time, do not select this option. You must install the TMS Server first, then the database objects, and then the Front End.
  4. Follow the instructions on the installation screens, providing the information you assembled in Section 5.2.1, "Gather Required Information.".

  5. 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.

  6. 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.

  7. 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 TMS application and TMS Lite Browser.

    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.

5.2.4 Find the Installation Log Files

During the installation of an Oracle Health Sciences component, the Oracle Universal Installer generates the following log file:

installActionstimestamp.log

On a Windows installation, the log files are located at:

\Oracle\Inventory\logs

For example:

C:\Program Files\Oracle\Inventory\logs

All generated log files have a timestamp appended to the name. For example:

installActions2013-04-30_11-22-52AM.log

If you encounter any error, contact Health Sciences Support.

5.2.5 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 Thesaurus Management System Reports Server.

5.2.6 Add WebLogic Data Sources If Using Multiple Databases

When you run the Oracle Thesaurus Management System Installer, it sets up a data source connection for TMS Lite Browser, 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 the TMS Lite Browser (or RDC) for each additional database. The same data source connection can be used for running TMS reports.

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

5.3 Make the Java Runtime Environment Available for Download

Oracle Thesaurus Management System requires that Java Standard Edition (SE) Runtime Environment (JRE) exist on the user's computer.

The Oracle Thesaurus Management System 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.6.5, "Download 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.

5.4 Installing the TMS Reports Server

This section describes installing and configuring a Reports Server. The TMS Reports Server runs on Oracle Forms and Reports 12c (12.2.1.3). It schedules batch jobs such as synchronization.

You must install the TMS Front End before installing the TMS Report Server.

Note:

If you have already installed the Oracle Clinical Reports Server on this machine, you do not need to install the TMS Reports Server.

The Installer prevents you from installing two Reports Servers with the same name.

5.4.1 Start the WebLogic FRDomain Admin Server

The WebLogic FRDomain Admin Server must be running when you install the Reports Server.

At the DOS command prompt, do the following:

  1. Go to ORACLE_HOME\user_projects\domains\FRDomain\bin and run the startWebLogic.cmd.

  2. Go to ORACLE_HOME\user_projects\domains\FRDomain\bin and run startNodeManager.cmd.

5.4.2 Gather Required Information

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

  • Home Details: Enter the following:

    • Name: OPA_HOME

    • Path: C:\opapps53 or the path defined for OPA_HOME

  • Oracle Fusion Middleware home directory; for example:

    C:\Oracle\Middleware\Oracle_Home

  • Oracle Fusion Middleware User Projects directory; for example:

    C:\Oracle\Middleware\Oracle_Home\user_projects

  • OPA home directory; for example:

    C:\opapps53

  • WebLogic username and password

  • Report Server name

  • Report Server output directory

5.4.3 Start the TMS Report Server Installer

To install the TMS Report Server:

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

  2. In the staging area, locate the directory where you downloaded and extracted Oracle Thesaurus Management System (see Section 1.6, "Download the Software").

  3. Run the following file as an administrator:

    Disk1\install\setup.exe

    The Installer opens to the Welcome screen.

    Note:

    See Section 1.7, "Use the Silent Installer (Optional)" 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 Thesaurus Management System.
  4. In the Select a Product to Install page, select Oracle Thesaurus Management System Report Server 5.3.0.0.x.

5.4.4 Attend to the TMS Reports Server Installation Screens

The Oracle Universal Installer guides you through the installation and configuration of the TMS Reports Server.

  1. Follow instructions on the installation screens, providing the information you gathered Section 5.4.2, "Gather Required Information".

  2. Choose Install Type: Select Yes to install a fresh instance of Oracle Thesaurus Management System Report Server.

  3. For the question "Do you want to create Report Server Component?", select Yes.

  4. Report Server name: Enter a unique name across your installation. If you try to create a second Reports Server with the same name as the first, the Installer detects it and prevents it.

  5. 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.

5.4.5 Review the Installation Log File

Review the generated installation log file, installActionstimestamp.log, for errors.

This is the name of the most current log file. Earlier files have a timestamp appended to the name.

Location: \Oracle\Inventory\logs

For example:

C:\Program Files\Oracle\Inventory\logs

If you encounter any error, contact Health Sciences Support.

5.4.6 Start the TMS Report Server

After you install the TMS Report Server, you must start it. Also, start the FRDomain WLS_FORMS and WLS_REPORTS services.

  1. Start the WLS_FORMS and WLS_REPORTS services in the WebLogic Forms console at http://host:7001/console.

  2. To start the report server, go to ORACLE_HOME\user_projects\domains\FRDomain\bin and run startComponent.cmd for report_server_name.

    Where, report_server_name is the name you had used when the Reports Server was installed.

5.5 Verifying the Application Tier Installation

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

Note:

Before accessing the URLs, make sure the OHS instance and all services are running. For information on how to start the required services, see Section 5.8, "How to Start Servers Manually".
  • Forms-based TMS—https://host/opa53/launch.htm

  • TMS HTML Browser—https://host/tmsadf/faces/Login

5.6 Verify and Fix Environment Variables

Check values and correct them if required.

5.6.1 Check Values

To check variable values:

  1. Open a DOS prompt window.

  2. Run:

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

    For example:

    C:\Oracle\Middleware\Oracle_Home\user_projects\domains\OPADomain\bin\setDomianEnv.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 3.4, "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 5.6.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 5.6.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 5.6.2, "Correct Values".

5.6.2 Correct Values

To correct any of the above problems:

  1. Navigate to ORACLE_HOME\oracle_common\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\jdk

  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 5.6.1, "Check Values".

5.7 Set 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 5.8, "How to Start Servers Manually".

5.7.1 Create boot.properties

Check if the boot.properties file exists in Oracle_Home\user_projects\domains\FRDomain\servers\AdminServer\security.

If not, create it as a plain text file with the following contents:

username = weblogic_user_name
password = weblogic_user_password

By default, the WebLogic user name is weblogic. This user name and password will get encrypted after all services are started.

5.7.2 Increase the Delay for Auto Start OPADomain and FRDomain

For OPADomain and FRDomain to start successfully, depending on the performance in your environment, you may want to increase the delay by which OPADomain and FRDomain start to allow time for Node Manager to start first.

  1. Go to OPA_HOME\config\opa_setup_scripts\ directory.

  2. Open the autostartfrdomain.cmd and autostartopadomain.cmd files.

  3. In each file, find the line PING 127.0.0.1 -n 30, and change the value from 30 to 60.

  4. Save and close the files.

5.7.3 Set Up Scripts to Execute Automatically at Machine Startup

Set up the Task Scheduler to start the FRDomain and OPADomain at startup:

  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 the following values:

    Name: Oracle FRDomainNM Autostart

    Trigger: When the computer starts

    Action: Start a program

    Select: opa_home\config\opa_setup_scripts\autostartfrdomainNM.cmd

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

  5. Find the task Oracle Domain Autostart under the Task Scheduler Library list. Right-click on the task you just created and select Properties.

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

  7. Click OK.

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

  9. Repeat the above steps for OPADomain Node Manager, OPADomain, and FRDomain, except for step 3 enter:

    • For OPADomain Node Manager:

      Name: Oracle OPADomainNM Autostart

      Select: opa_home\config\opa_setup_scripts\autostartopadomainNM.cmd

    • For OPADomain:

      Name: Oracle OPADomainMS Autostart

      Select: opa_home\config\opa_setup_scripts\autostartOPADomain.cmd

    • For FRDomain:

      Name: Oracle FRDomainMS Autostart

      Select: opa_home\config\opa_setup_scripts\autostartfrdomain.cmd

5.7.4 Test Autostart

To test:

  1. Restart the computer.

  2. Allow some time for the services to start.

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

    • TMS: https://host/opa53/launch.htm

    • TMS Lite Browser: https://host/tmsadf/faces/Login

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

    • autostartfrdomain2.log

    • autostartfrdomain2.err

    • autostartopadomain2.log

    • autostartopadomain2.cmd

5.8 How to Start 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, see Section 1.2, "Architecture" and Section 1.3, "Network Topology".

5.8.1 Start the FRDomain Node Manager

  1. Go to ORACLE_HOME\user_projects\domains\FRDomain\bin and run startNodeManager.cmd.

5.8.2 Start the FRDomain Admin Server

The Oracle FRDomain Admin Server is located on the WebLogic Server domain, and we recommend you to name it as FRDomain and use port number 7001. You must start the Admin Server before you can start either the Oracle Forms Server or the Oracle Reports Server.

At the DOS command prompt, do the following:

  • Go to ORACLE_HOME\user_projects\domains\FRDomain\bin and run the startWebLogic.cmd.

Note:

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

5.8.3 Start the Forms Server

The Oracle Forms Server is located on the WebLogic Server domain, and we recommend you to name it as FRDomain and use port number 7001. You must start the FRDomain Admin Server before the Forms Server.

To start the Forms Server (WLS_FORM), do one of the following:

  • Start the Forms Server in the Admin Console at http://host:7001/console.

    Note:

    The Admin Console is available only if the Admin Server is running.
  • Open a DOS prompt, and run the following:

    ORACLE_HOME\user_projects\domains\FRDomain\bin\startManagedWeblogic WLS_FORMS
    

5.8.4 Start the Reports Server

The Oracle Reports Server is located on the WebLogic Server domain, and we recommend you to name it as FRDomain and use port number 7001. You must start the FRDomain Admin Server before the Reports Server.

To start the Reports Server (WLS_REPORTS), do one of the following:

  • Start the Reports Server in the Admin Console at http://host:7001/console.

    Note:

    The Admin Console is available only if the Admin Server is running.
  • Open a DOS prompt, and run the following:

    ORACLE_HOME\user_projects\domains\FRDomain\bin\startManagedWeblogic WLS_REPORTS
    

5.8.5 Start the OPADomain Node Manager

  1. Go to ORACLE_HOME\user_projects\domains\OPADomain\bin and run startNodeManager.cmd.

5.8.6 Start the OPADomain Admin Server

The Oracle OPADomain Admin Server is located on the WebLogic Server domain, and we recommend you to name it as OPADomain, and use port number 7101. You must start the Admin Server before you can start the Managed Server of OPADomain.

To start the OPADomain Admin Server:

  1. Go to ORACLE_HOME\user_projects\domains\OPADomain\bin and run startWebLogic.cmd.

Note:

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

5.8.7 Start the Managed Server of OPADomain

The Managed Server of OPADomain is located on the WebLogic Server domain, and we recommend you to name it as OPADomain and use port number 7101. The Managed Server of OPADomain 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 Managed Server of OPADomain.

To start the Managed Server of OPADomain, use the Admin Console at either:

  • http://host:7101/console

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

5.8.8 Start the OHS Server

  1. Go to ORACLE_HOME\user_projects\domains\FRDomain\bin and run the startComponent.cmd for ohs1.

5.8.9 Start the TMS Reports Server

To start the TMS Reports Server:

  1. Go to ORACLE_HOME\user_projects\domains\FRDomain\bin and run the startComponent.cmd for report_server_name.

    Where, report_server_name is the name you had used when the Reports Server was installed.

5.9 Verify the Application Tier Installation

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

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

  • https://host/tmsadf/faces/Login

5.10 Stopping Servers

You can stop each server either in the appropriate WLS Admin Console or from DOS prompt with specific commands. These instructions are provided for your information; you do not need to do them now.

5.10.1 Stopping the Forms Server

The Oracle Forms Server is located on the WebLogic Server domain, and we recommend you to name it as FRDomain and use port number 7001.

To stop the Forms Server, do either:

  • Stop WLS_FORMS by running ORACLE_HOME\user_projects\domains\FRDomain\bin>stopManagedWebLogic.cmd WLS_FORMS from a command prompt started as an administrator.

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

    Note:

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

5.10.2 Stopping the Reports Server

The Oracle Reports Server is located on the WebLogic Server domain, and we recommend you to name it as FRDomain and use port number 7001.

To stop the Reports Server, do either:

  • Stop WLS_REPORTS by running ORACLE_HOME\user_projects\domains\FRDomain\bin>stopManagedWebLogic.cmd WLS_REPORTS from a command prompt started as an administrator.

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

    Note:

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

5.10.3 Stopping the FRDomain Admin Server

The Oracle FRDomain Admin Server is located on the WebLogic Server domain, and we recommend you to name it as FRDomain and use port number 7001.

To stop the Admin Server, do either:

  • Go to ORACLE_HOME\user_projects\domains\FRDomain\bin and run stopWebLogic.cmd.

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

5.10.4 Stopping the OPADomain Admin Server

The Oracle OPADomain Admin Server is located on the WebLogic Server domain, and we recommend you to name it as OPADomain and use port number 7101.

To stop the Admin Server, do the following:

  • Go to ORACLE_HOME\user_projects\domains\OPADomain\bin and run the stopWebLogic.cmd.

5.10.5 Stopping the Managed Server of OPADomain

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

To stop the managed server of OPADomain, 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.

5.10.6 Stop the OHS Server

To stop the OHS Server, go to ORACLE_HOME\user_projects\domains\FRDomain\bin and run stopComponent.cmd ohs1.

5.10.7 Stop the TMS Reports Server

To stop the TMS Reports Server, go to ORACLE_HOME\user_projects\domains\FRDomain\bin and run stopComponent.cmd for <report_server_name>.

Where, <report_server_name> is the name you used while installing the TMS Reports Server (see "Installing the TMS Reports Server").