ProductSupport

SQLConnect User Guide

Purpose:
Purpose of this user guide is to provide information on how to use the Oracle Cloud Tool’s SQL Connect software. If you are looking for the server-side administration of SQL Connect, please refer to our Administrator Manual.

Online Demo:  https://youtu.be/2X-dQdwzzxs

Installation: SQL Connect installer file will installed SQLConnect.exe on your computer. Once you receive your license information including username and password, install the exe on your computer. Read our FAQ for any issues during installation. Normally, it takes upto 24 hours to get your username and password activated after you purchase the software online for individual use. For enterprise license, contact your administrator.

CLICK HERE FOR INSTALLATION INSTRUCTIONS

STEP 1 – Download Software (Use one of the links for PROD or BETA version) and Install
STEP 2 – Download, and then Unarchive Catalog file to your Pod (Instructions below).
STEP 3 – Get your SQLConnect Username and Passwords. (Takes 24 hrs to activate)

How to Use

First Time Launch

After installation is complete, Go to Programs –> SQLConnect –> SQL Connect or Run the executable file SQLConnect.exe.

Application will execute, and you should be able to see the login prompt.

The login information you should have received from your license administrator. In case you are using a trial version, this user name and password will expire after 15 days. For production/live users, this is provided to the license administrator.

These are the login prompt you should have received from
your license administrator. In case you are using a trial version, this user name
and password will expire after 15 days. For production/live users, this is
provided to the license administrator.

Login

On the login screen, enter your username and
password. You should’ve received the username and password with your license.
If you do not have one, please contact the administrator for SQLConnect and obtain login
credentials. SQLConnect client can
be used by the user associated to the application on each machine.

  1. Enter User Name
  2. Enter Password
  3. Press the login button.

Note: Login button will be enabled after entering username and
password. If the Login button is greyed out, you must enter the Username and
Password.

  1. After logging in, Click on the Plus sign on the
    Connections options on left pane. If the left pane is not open, click the
    Yellow slider to open left pane.

Creating a new Connection

  1. Create Connection window will open. Enter following
    information in the connection fields.

  1. Oracle Connection Name: Enter the Oracle Connection Name. This is the name you want to save this connection as. In the screenshot above, you can see connections are saved with different names for quick reference.
  2. Oracle Cloud User Name: In the second field, enter your username for Oracle Cloud. This must be a valid user in cloud environment/pod that you want to connect to. Also, this user must have required role and data access in Oracle. If you are not sure about this, please contact your system administrator.
  3. Password: Enter your Oracle Cloud password. You can use the EYE icon to toggle visibility of password.
  4. URL: Enter the url for your Oracle pod. e.g. http://EEEE.us6.oraclecloud.oracle.com
  5. Once you enter all the fields, NEXT button should be enabled. Click NEXT To check connection. If the connection is successful, it will be saved under your connection and you will be connected to the database. If, for some reason connection is not successful, you’ll get an error. If the system is unable to establish connection it may spin forever – in which case cancel and close the application.
  6. While using the application, you can select “Connect To” and select the name of the pod form drop down list.

Opening new tab:

To create new Tab, simply click the + button. You can also open files from File menu to open file in new tab.

Working with Files

You can open one or more files at the same time, by using File –> Open menu option. Also the same menu provides options to SAVE and CLOSE files. You can also click the SAVE icon to save the file.

Running Query

Query can be executed by clicking the EXECUTE button, or pressing CTRL+Enter keys on your keyboard.

Editor functions

Following are some of the shortcuts used for editing purpose:

  • Ctrl-C – Copy
  • Ctrl-V – Paste
  • Ctrl-F – Find
  • Ctrl-Shift-F – Replace
  • F4 – Open DB Browser

User Interface features

The user interface of SQL connect is divided
into five sections.

  1. File Menu & Header
  2. View Menu
  3. SQL (Query) Editor
  4. Left Pane & Controls
  5. Main Menu
  6. Results Pane

In the File Menu, you have options to open,
close and exit from the file and application. You can add multiple tabs, Save
them with different names locally on your file system.

In main menu, you’ll find a button to Execute a
SQL – “Execute”. Options to export the results to “CSV” and “Excel”. You can
also manage the number of items you want to see in each page from the query
results. This defaults to 100. You can also swith connection between multiple
connection using the “Connected To” drop down menu.

View Menu:

View Menu provides you option to Hide/UnHide the Connections Tab, and Database Browser Tabs.

 

Sizing the panes:

Using the yellow control button, you can hide or
unhide the left pane.

Using your mouse controls, you can resize the
panes.

Here is a full video demo for SQL Connect user:

https://youtu.be/2X-dQdwzzxs
SQLConnect Demo

Architecture:

SQL Connect uses
following components to make the product work.

Component Purpose
SQL
Connect User Interface
(SQLConnect.exe)
The Graphical user interface, editor,
that is used by end user to launch and run queries against Oracle cloud. This
is the main user facing executable product for SQL connect.
Query Processing Engine This
is built within the executable to parse, syntax check, validate and convert
the user entered SQL in a format that can be processed by request processor
on Oracle cloud.
BIP
Web Service
A Web Service on Oracle Cloud Business
Intelligence application that is invoked from SQL Connect to establish
communication with Oracle Cloud.
Request
Processor
Key
logic component of SQL connects that interprets the request send by QPE and
processes that in Oracle Cloud to generate result set and send it back to the
BIP Web service
Results/Error
Processor
Component of SQL Connect which renders
results in a format the UI engine can process. It also processes any errors
produced by the request and converts that to user readable format to be
displayed on the UI.
UI
Engine
User
Interface (UI) Engine is the presentation component of SQL connect which
renders results for the user.