The Oracle Database CPM plugin utilizes the 'Oracle in instantclient' ODBC driver to connect to remote Oracle databases. In order for the plugin to function, the driver must be installed on the CPM. At the time of this writing, the plugin supports the use of the following two drivers:
Note: any minor version of the drivers will work (e.g., 19.18, 19.23, 21.08, 21.14, etc.).
Steps
The complete installation of the driver involves installing two separate packages:
- Instant Client Basic Package
- Instant Client ODBC Package
Note: The plugin architecture is 32-bit, thus you must only use the 32-bit driver. 64-bit will not work.
Download the Packages
- Download each of these packages from the Oracle Instant Client Downloads page HERE.
- Locate the driver version you wish to install and click on the Plus (+) icon to expand the pane.
- Locate and download the zip files for the Basic Package and the ODBC Package.
- On the CPM, create the following new directory, replacing the pound (#) signs with the version number of the driver: C:\Oracle\instantclient_##_#
- Unzip both zip files into this new directory.
- Open Command Prompt as Administrator and navigate to the directory.
Windows will often automatically block files downloaded from the internet; the files are tagged as untrusted. To alleviate this issue, we need to remove any possible tags. To do so, in the Command Prompt window, run the following commands in order:
- PowerShell
- Get-ChildItem -Recurse | Unblock-File
- Exit
Install and Configure the Driver
- To install the Instant Client driver, using the existing Command Prompt window from above, run the following command: .\odbc_install.exe
- Once the installation is complete, we need to adjust the Environmental Variables on the CPM. To do so, go to Control Panel -> System -> Advanced system settings -> Environment Variables.
- Under System Variables, select New.
- Set the following entries: "Variable name: TNS_ADMIN" and "Variable path: C:\Oracle\instantclient_##_#\network\admin", as above, replace the pound (#) signs with the version number of the driver.
- Click OK.
- Select the Path variable under User Variables for (logged on user) and click Edit.
- In the Edit Environment Variable window, click New, followed by Browse.
- In the browser window, drill down to the Variable path: C:\Oracle\instantclient_##_#, replacing the pound (#) signs with the version number of the driver.
- Click OK on each window until you've closed out of the Environment Variables window. In order to commit the changes, you'll need to reboot the CPM.
Confirm Successful Installation
After the reboot, you can confirm the installation was successful by checking for the existence of the instantclient driver in the ODBC Data Sources (32-bit) app. To do so:
- Locate this app by going to Control Panel -> Administrative Tools -> ODBC Data Sources (32-bit).
- Select the Drivers tab and scroll down.
If you see Oracle in Instantclient_##_#, replacing the pound (#) signs with the version number of the driver, the driver has been successfully installed.