Upgrade a TMS Database

Follow the instructions in this section to upgrade each TMS database as mentioned below:

Back Up Database Objects

Back up the following packages if you have customized them:

  • tms_ud_activation_rules

  • tms_sup_srchobj

Prevent Access to Oracle Thesaurus Management System Databases

You must ensure that no data entry is performed, and no jobs that update data (such as batch validation) run during the upgrade process.

To prevent users from accessing the data, place the database in restricted mode. Provide restricted session access to the following accounts:

  • SYSTEM

  • SYS

  • OPA

  • RXC

  • TMS

  • CTXSYS

  • OPS$TMSBROWSER

  • TDX

After you complete the upgrade, remove the restricted access from the databases and user accounts.

Note:

The OPS$TMSBROWSER account is replaced by the account TMSPROXY from TMS 5.2.1.You do not need to remove restricted access for the TMSPROXY account.

Gather Required Information to Upgrade TMS Database

Before you start the Installer, be sure you have the information it prompts for:

  1. Home Details: The full path to the OPA_HOME or similar application home name on your application server; by default:

    c:\opa_home

    Note:

    If TMS 5.2.x, 5.3.x, or 5.4.0 or Oracle Clinical 5.2.x/5.4.1 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.4.1 too. Do not create a new OPA_HOME if this was already created. The TMS 5.4.1 components will be placed by the installer under this OPA_HOME at the specified location for the TMS 5.4.1 release.

  2. Oracle Database Client Home: Full path to ORACLE_HOME. For example, C:\Oracle\Middleware\Oracle_Home.

    If you upgraded the technology stack from version 12.2.1.3 to 12.2.1.4, use the new 12.2.1.4_ORACLE_HOME you created.

    Note:

    Make sure the tnsnames.ora from your ORACLE_HOME\network\admin has an entry for your database.

  3. TMS Server Code Home Directory: The system detects the location and enters the value for you. By default, it is <OPA_HOME>\tms.
  4. Database Details: Enter the database server name, database port number and database service name. It must be a valid TNS entry in your tnsnames.ora file.
  5. NLS Settings: Enter the NLS settings for the database; see Choose a Character Set. Oracle strongly recommends that you use UTF8. The default values are:
    • American_America.UTF8

    • DD-MON-RRRR

  6. Directory for data tablespace data files: Enter the path to the directory on the database server where the data tablespace datafiles for the application should be created during the installation. The Installer does not validate the value and you must use the following syntax, including a trailing slash, depending on your operating system; for example:
    • UNIX: /u01/oradata/dbname/

    • Windows: drive:\oradata\dbname\

  7. Enter and confirm passwords for the following accounts:
    • SYS

    • SYSTEM

    • RXC

    • OPA

    • TMS

    • CTXSYS

    • TMSPROXY

Stop PSUB Process (If Integrated with Oracle Clinical)

If your TMS installation is integrated with Oracle Clinical, you must stop the PSUB process before upgrading the database. See the Oracle Clinical Administrator's Guide for instructions.

Start the Installer

To upgrade a TMS database:

  1. Log in to the application server 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 Download the Software).
  3. Run the following file as an administrator:

    Disk1\install\setup.exe

    The Installer opens to the Welcome screen.

    Note:

    See 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 TMS Database Upgrade 5.4.1.0.x.

Attend to the TMS Database Upgrade Installer Screens

The Oracle Universal Installer guides you through the database upgrade. Provide the information you assembled in Gather Required Information to Upgrade TMS Database.

Ignore tablespace creation errors:

  • Select Yes if the database already has the TMS tablespaces created.

  • Select No if the TMS tablespaces do not exist.

The Installer gives you information that you should make a note of.

Set Initialization Parameters

After the upgrade completes, set the init.ora parameters according to the instructions in Install and Configure Oracle Database.

You must stop and then start the database to activate the changed init.ora parameters.

Note:

Do NOT SET the DB_DOMAIN parameter. In Release 5.1 and above this causes problems.

If you set up the EVENT parameter in the init.ora file to trace unique key constraints before upgrading, you should set the event parameter back to its required value.

Check Installation Log for Errors

When you upgrade, the installation log file may report the following error:

".....
Connected.
BEGIN tms_dsi_xml_schema.InstallSchemas; END  

*
ERROR at line 1:
ORA-02303: cannot drop or replace a type with type or table dependents 
ORA-06512: at "XDB.DBMS_XMLSCHEMA_INT", line 3
ORA-06512: at "XDB.DBMS_XMLSCHEMA", line 14 
ORA-06512: at "TMS.TMS_DSI_XML_SCHEMA", line 35 
ORA-06512: at line 1
 
finished TMSUPG 
TMS will now attempt to validate any invalidate objects... 
...."

This error occurs because the tmsupg.sql upgrade script executes tms_dsi_xml_schema.InstallSchemas before attempting to validate any invalid objects. Execution of tms_dsi_xml_schema.InstallSchemas fails if the database has invalid objects.

If this error occurs, you need to:

  1. Run compile invalid until all database objects have been made valid.
  2. Run tms_dsi_xml_schema.InstallSchemas manually. See Configure DSI Import for details.

Configure DSI Import

If you plan to use disconnected system integration (DSI), enter following commands:

set LOCAL=databasename
sqlplus tms/password
exec tms_dsi_xml_schema.InstallSchemas;
 

Load Dictionaries

You can load dictionaries at any time. See the Oracle Thesaurus Management System User's Guide for information about loading dictionaries.

Integration with Oracle Clinical

When a TMS database is cloned and TMS is integrated with Oracle Clinical, force rederivation must be executed for all Oracle Clinical studies.