TABLE OF CONTENTS


DbVisualizer Instructions

Introduction

 

DbVisualizer is a freely available tool that provides a UI for interfacing and interacting with SQL Databases. It is available for a range of Operating Systems, with this guide focusing on installing DbVisualizer on a Windows or macOS platform and configuring it to run against an Ocient Database. On windows platform the DbVisualizer tool can be used either as a stand-alone executable (no installation needed) or can be installed like other windows applications. Both the stand-alone and the installed versions of DbVisualizer require Java to be installed on the host. Both versions can be downloaded from the DbVisualizer download page. The "ZIP" file on the download page is the stand-alone executable and the "SETUP" file is the installer.


Instructions for Windows OS

Installing DbVisualizer

 

Download one of the below installers from DbVisualizer download page at https://www.dbvis.com/download/.


  • Launch the installer by double clicking on the downloaded setup file. Click on the "Next>" button.
  • Select the directory where you want to install the tool and then click on the "Next>" button.
  • Make the selections on the "Select Start Menu Folder" screen regarding creation of start menu folder and creating shortcuts on for all users and then click on the "Next >" button. It is okay to accept the defaults on this screen.
  • Provide credentials for the Administrator user on the host if prompted.
  • Make selection regarding what files to associate DbVisualizer with and then click on the "Next >" button. It is okay to accept the defaults on this screen.
  • Make selections on the "Select Additional Tasks" screen and then click on the "Next >" button. It is okay to accept the defaults on this screen.
  • Provide credentials for the Administrator user on the host if prompted.
  • The installation will start at this point. The following screen will be displayed after the installation completes. Keep the "Run DbVisualizer" box checked and click on the "Finish" button if you prefer to launch the tool after exiting the installer. Otherwise, uncheck the box and click on the "Finish" button.

Staging DbVisualizer stand-alone executable

Download and then unzip the below zip file from DbVisualizer download page at https://www.dbvis.com/download/


Launching DbVisualizer

  • If using the stand-alone executable, navigate to the directory the stand-alone executable was unzipped in and launch DbVisualizer by double clicking on dbvis.exe.
  • If using the installed version, launch DbVisualizer by double clicking on the shortcut present on the desktop (if available) or by clicking on "DbVisualizer <version_number>" icon in the application list accessible from the start menu.
  • An End User Licensing Agreement (EULA) will be displayed if you are launching DbVisualizer for the first time. Review and accept the agreement if you agree with it.
  • Make appropriate selections on the prompt for licensing and migrating settings if one is displayed.


Configuring the driver

  • Download the latest "with-dependencies" Ocient JDBC driver from https://mvnrepository.com/artifact/com.ocient/ocient-jdbc4. You can get the "with-dependencies driver" by:
    • Visit the maven url above.
    • Click on the driver version number.
    • Click on the "View All" hyperlink in the "Files" row.
    • Click on the file with the filename ending with "jar-with-dependencies.jar".
  • Launch the DbVisualizer if it is not already running. 
  • Click on the Tools menu and then select "Driver Manager"
  • Click on the "custom" hyperlink in the right hand side of the displayed window
  • In the displayed window, set
    • Name: as "Ocient JDBC Driver"
    • URL Format as "jdbc:ocient://${Database Host}:${Port||4050}/${databaseName}"
  • Click on the blue "+" sign and then on "Add Files". Navigate to the location of the jar file downloaded at beginning of this procedure and select the jar file.
  • The Driver manager window should show the configuration like below after you have executed the above steps. The "jar" file name may be different depending on the version downloaded.
  • Close the "Driver Manager" window.

Connecting to Ocient DB

  • Launch the DbVisualizer if it is not already running.
  • Click on the "Create a Connection" in the right hand pane and then double click on "Ocient JDBC Driver" from the displayed menu.
  • Populate the "Database Host", the "Database Port", the "databaseName", the "Database Userid", and the "Database Password" fields and click on the connect button at the bottom. The below screen capture shows sample values.


Connecting via SSO

  • One time database side setup is required to enable SSO.
  • Using this functionality requires use of driver version 3.3.1 or higher.
  • Execute steps from the "Connecting to Ocient DB" section except filling in the "Database Userid" and the "Database Password" fields. Leave those fields blank.
  • Leave the "Database Userid" and "Database Password" fields blank.
  • Click on the "Properties" tab and change the value for "handshake" parameter to "SSO".
  • Click on the "Connect" button in the "Connection" tab to connect to the database.