Upgrading from an Earlier Release and Migrating The Metadata
This section is a guide for customers who are upgrading to TDV from a previous version and want to migrate metadata from that version to the new version.
Note: This process is different from many other software vendor upgrade procedures, which typically modify the existing instance.
The metadata upgrade process requires installing a new TDV instance in parallel with the existing TDV instance, exporting the metadata from the old instance, and importing the old instance’s backup CAR file into the new TDV instance.
TDV recommends that you keep the older TDV instance until you are sure the new installation is stable. However, be aware that:
• If you are running two versions of TDV simultaneously, their port numbers must be different.
• If you are using Active Cluster, all servers in the cluster must be running at the same version and patch level.
• New instances of TDV can use the repository database of older instances.
Make sure that you have administrator privileges and perform all of the steps below as that user. In addition, it is advised that the installation and the upgrade steps be performed by the same user to avoid any permission issues that may arise.
To upgrade and migrate your existing installation, follow the steps (in the given order) in these sections
Documenting the Existing TDV Instance
Before making a backup of the existing TDV instance, document the key features of the instance. These settings are later applied to the new TDV instance to ensure the consistency of results returned from published resources.
Note: If you cannot upgrade directly from the existing TDV instance to the new version, multiple versions of TDV and multiple export and import processes might be required, so that database schemas remain compatible.
Make note of the settings in the following table.
Setting | What to Record |
Ports | The port numbers for the existing instance, because after the installation of the new server is complete, the port numbers of the new instance might need to be changed. |
Authentication mechanism | The authentication mechanism. If LDAP or another dynamic authentication is used, the same settings need to be applied to the new server. This setting determines various authentication mechanisms enabled within Server. |
Users/groups | The groups created in Server and the users that belong to these groups. If LDAP authentication is used, note the LDAP groups that were imported into Server. |
Metadata repository | The full path of the repository location and the administrator user ID and password. |
Custom data sources | Custom data sources that were introspected and any custom drivers that were used to introspect these sources. |
External libraries | Any external libraries that were referenced from the instance. |
Customized settings, including Java flags, managed and unmanaged memory | Configuration parameter settings for the existing Server instance. From the Administration menu, select Configuration and check all relevant parameter settings. The new TDV instance’s settings should match the old instance settings if you want similar results and performance. |
Considerations for Upgrading to TDV 8.X
During the export you perform in
Exporting Metadata from the Existing TDV Instance all of the relevant information from your old repository is captured.
During the import you perform in
Importing Metadata into the New TDV Instance all of the relevant information from your old repository is transferred into the new TDV PostgreSQL repository database.
Exporting Metadata from the Existing TDV Instance
The first step for upgrade or migration is to export the existing metadata information from the repository. This process writes out a CAR file that includes six files containing metadata, scheduling, settings, and user information.
To run the export
1. Verify that you have administrator privileges.
2. Open a command prompt window.
3. Navigate to <TDV_install_dir>/bin.
4. Perform a full backup with the options that you need:
— Using Studio. See “Using Studio for a Full Server Backup” in the TDV User Guide.
— Using the TDV backup_export utility. For more information, see the TDV Administration Guide.
5. Locate and copy the resulting CAR file to a safe and easily accessible location for use later.
Installing the New Version of TDV
To install a new TDV when you are upgrading from an earlier release
1. Review the new features and bug fixes as documented in the TDV and Business Directory Release Notes.
3. Install the latest versions of all other TDV software that you use.
4. Set up any external libraries, including JDBC drivers, and then shut down and restart the server.
5. Deliver the upgraded drivers (the TDV ODBC driver and the TDV JDBC driver) to the dependent clients.
6. To ensure consistency in results and performance, make the configuration of the new server instance similar to the old instance.
Importing Metadata into the New TDV Instance
If your are upgrading your version of TDV from an earlier version and you have completed the instructions in
Exporting Metadata from the Existing TDV Instance, then follow the instructions in this section. If you are performing a new installation, you can skip these instructions.
After the new TDV instance is successfully installed, the metadata from old TDV instance needs to be imported into the new instance. After the import is successfully completed, settings such as Java configurations, managed memory setting and ports can be updated on the new instance.
To run the import
1. Verify that you have administrator privileges.
3. Perform a full backup import with the options that you need:
— Using the Studio Import dialog window. For more information, see the TDV User Guide.
— Using the TDV backup_import utility. For more information, see the TDV Administration Guide.
4. Validate that the TDV resources or other settings are as you expect in the new version of Studio.
Verifying a Successful Installation
To verify that your installation of the TDV software was successful, follow the steps in this section.
To verify a successful installation
1. Start Studio. Follow instructions in the TDV Getting Started Guide or in the TDV User Guide.
2. If you have just completed an upgrade from one version of TDV to a new one, then we suggest that you complete these instructions:
a. Determine a set of tests that will touch all published resources and all introspected data sources, and then apply the tests against:
— The existing instance of TDV, as a sanity check.
— The new instance of TDV, to ensure the same results are produced.
b. Configure and use the PubTest tool to test all your published resources.
The PubTest program can be configured to test all published resources using JDBC, ODBC, and Web services. Additional configuration might be required to test the ODBC and Web services. Starting with TDV 4.0, an end-to-end testing program referred to as PubTest (pubtest.java) is included with the TDV installation. This program is located in the <TDV_install_dir>\apps\jdbc directory. A PubTest.doc file in this directory provides additional documentation about using this tool.