Skip to main content
ExLibris
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Installation and Configuration of ODBC for Voyager

    • Product: Voyager
    • Product Version: 7.2 and greater
    • Relevant for Installation Type: All

     

    Table of Contents

    Steps to configure and install ODBC drivers for Voyager's Prepackaged Reports. These installation instructions pertain to all currently supported versions of Voyager.

    Purpose

    Prepackaged Reports (PPR, Reports.mdb) allow sites to make a read-only connection to Voyager's database on the server via Microsoft Access on a workstation using an ODBC connection. PPR allow institutions to query the database for information that may not be available via batch jobs or other reporting functions in Voyager.

    Overview

    • These instructions cover installation of ODBC 10g  Full Client Drivers and linking tables for pre-packaged reports for all currently supported versions of Voyager.

    • Voyager Prepackaged Reports using MS Access require the installation of Oracle Client to function correctly.

    • Voyager currently only supports the use of the 32-bit Oracle 10g Full Client installation package. Later versions of Oracle client and 64-bit versions of the software are not supported for use with Voyager.

    • Voyager Support can provide you with a download link for the Oracle 10g Client installer for 32-bit MS Access package.  Please open a ticket to request the package. This file is 600MB.  It can take a while to download. Support recommends you archive the file locally for convenience, as it rarely changes.

    • Using Prepackaged Reports also requires that the Voyager Clients be installed on the workstation (see Overview of Voyager client installation process for detailed instructions on installing the Voyager clients).

    Requirements

    • MS Access 2013 or greater, 32-bit (See: Are there separate Voyager Oracle ODBC drivers for Access 32-bit and Access 64-bit?)
    • Voyager Version 7.2 or greater
    • Windows 10 Professional O.S. (not Windows "Home" version)
    • Administrator privileges on PC
    • Obtain the Oracle10g_ODBC_Win7-10.zip package.  NEW! If you don't have this file handy, you will need to open a ticket with Voyager Support to request a download link.
    • Create a folder in the root of your workstation's C:\ drive (for example: C:\orainst) to hold the installation package zip file, and unzip the package in that folder. Avoid using a deep file folder location, or placing the zip file in your Documents directory, or on the Desktop or on a shared drive.

    Download this client and not any other Oracle ODBC client package. Support will only troubleshoot the Ex Libris ODBC installation package.

    • 32-bit MS Access 2003 or greater (Not 64-bit). To determine your Access version:
      • Open MS Access > File > Account > click About Access
      • Box will pop up; note version at top of box.
    • tnsnames.ora template (See attached)
    • Hostname or IP address of your Voyager server; the Oracle read-only username and password (usually ro_xxxdb, where xxxdb is your Voyager instance name)

    Procedure

    Follow all of the steps below. Do not deviate from the instructions.  Install only the installation package specified in the previous section.

    BEFORE YOU BEGIN:  Restart your PC.

    1. Reboot the PC and then login with an account that has full administrative rights.
    2. Avoid opening any unnecessary programs.  Turn off anti-virus protection temporarily (if possible).  
    3. Completely remove any Oracle 10g Client which was installed previously. Any later versions of Oracle Client (e.g. Oracle 11g) should also be uninstalled if possible, to aid in preventing any complications. After any such uninstalls, reboot your PC again.
    4. From the unzipped Ex Libris ODBC installation package, run setup.exe
      1. Click "Next."
      2. Select "Administrator" as the installation type, and click "Next"
      3. In Specify Home Details verify directory names and paths do not have a "1" or an "_1" at the end of the Name or Path.  If they do, just remove it so that the Name ends in "home" and Path ends in "client".  Click Next.
      4. At Available Product Components, click "Next"
      5. At Product-Specific Prerequisite Checks", click the check box next to any errors and select "Yes" in any "Warning" dialogs.
      6. At "Summary select "Install", installation will run for a few minutes.
      7. At "Oracle Net Configuration Assistant" select "Perform Typical Configuration" and click "Next". And click Next on the following screen.
      8. Once the installation has completed Click "Finish" -> "Exit" -> "Yes"
    5. Open the attached tnsnames.ora template in a plain-text text editor (e.g. Notepad)
    6. In tnsnames.ora replace xxx.xxx.xxx.xxx with the IP or host name of the Voyager server.
    7. Copy the configured tnsnames.ora file to C:\oracle\product\10.2.0\client\network\ADMIN\
    8. Check permissions on tnsnames.ora to ensure "Full Control" is granted to "Authenticated Users"
    9. Locate and run the correct odbcad32.exe file for your Windows O.S. System Type (found in System > About > System Type) as Administrator (Right Click -> 'Run as Administrator'):
      1. For 64-bit Windows O.S. System Type: C:\Windows\SysWOW64\odbcad32.exe
      2. For 32-bit Windows O.S. System Type: C:\Windows\System32\obdcad32.exe
    10. Select the "System DSN" tab and select "Add."
    11. Select the driver "Microsoft ODBC for Oracle."
    12. Enter the following values:

    Data Source Name: VGER

    Description: Tables

    Username: ro_xxxdb (Replace 'xxxdb' with the db name of the voyager instance)

    Server: VGER

     

    DSN.png

     

    1. Click 'OK' to close odbcad32.exe
    2. Open Reports.mdb from C:\Voyager\Access Reports\ 
      (Make sure the Reports.MDB file that you are using is for the correct version of Voyager you are running)
    3. Select "External Data" from the MS-Access Ribbon, select "New Data Source", then select "From Other Sources"  and select "ODBC Database"

      access_ribbon.jpg

      new_data_source.jpg

      from_other.jpg

      odbc_database.jpg
       
    4. Select "Link to the data source by creating a linked table."

      Link_to_data.jpg
       
    5. Select the "Machine Data Source" tab.

    DataSource.png

    1. Select "VGER" and click "OK."
    2. Enter the following values and click "OK":

    User Name: ro_xxxdb (Replace 'xxxdb' with the db name of the voyager instance)

    Password: ro_xxxdb

    Server: VGER

     

    credentials.png

    1. Click "Deselect All" (this can take a minute or so), and then click "OK." You can also check the "Save password" box. 

    de-select-tables.png

    1. Locate the navigation pane on the left hand side of the screen in MS-Access. At the top of the navigation pane select the drop down menu, and change the selection to "Forms".

    Forms.png

    1. Open "Build Database Links to Voyager" form.
    2. Enter the following values and select "Connect"(Replace 'XXXDB' with the db name of the Voyager instance):

    ODBC Name: VGER

    Connect String: VGER

    DB User ID: ro_xxxdb

    Password: ro_xxxdb

    Tablespace: XXXDB  (typically you will want to use ALL CAPS for the Tablespace name)

    link-tables.png

    If you get errors, double-check your credentials are correct and enter ALL CAPS for the Tablespace name, then re-try this step.

    1. If successful, results indicating that links are being built successfully will appear as below. Be patient, this process can take 30 minutes or longer to complete successfully.  When successfully completed, the "Cancel" button will be grayed out (inactive), and the "Connect" and "Close" buttons will be active. Select "Close". You are done.
      Otherwise, if failures occur, double-check the configuration and permission of tnsnames.ora, and the configuration of the DSN. For further assistance open a support case with Voyager support.

    Success.png

    Troubleshooting

    In your query results if some fields are displaying as: "Error(12001)",  see:How to resolve Error 12001 when running query in Prepackaged Reports?

    If your installation fails, you can try completely removing the client and then try again.

    Make sure your computer meets the requirements specified in this Article, and follow the steps above exactly as they are written out.

    You can open a ticket with Voyager Support and we will assist you. In the information you provide in the ticket, please include any error messages you receive, and at which step in the process your installation has failed.

    For customers who must use a 64-bit version of Microsoft Access, see: PREPACKAGED REPORTS: Installing 64-bit ODBC Drivers


    • Article last edited: 18-Dec-2020
    • Was this article helpful?