Best Practices from Oracle Development's A‑Team

Deploying Remote Data Gateway in Oracle Analytics Cloud for Metadata Repositories


Note: Private Access Channel is now available in Oracle Analytics and is recommended by Oracle for new connections to private data sources. For more information on the feature and the data sources it supports refer to:
    Connect to Private Data Sources Through a Private Access Channel
    Supported Data Sources
    A-Team Chronicles Private Access Channel Series

Last validated October 19, 2020 with OAC 5.8


The latest releases of Oracle Analytics Cloud (OAC) now include the new Remote Data Gateway (RDG) for accessing databases that are not otherwise accessible by OAC.

This post is one of the RDG RPD scenarios contained in Deploying Remote Data Gateway in Oracle Analytics Cloud for Data Visualization. Refer there for posts on connecting an RPD to ADW.

It is a step-by-step guide to creating RDG connections using the Developer Client Tool for OAC.


 October 19, 2020 with OAC 5.8

August 19, 2020 with OAC 5.7

May 19, 2020 with OAC 5.6

March 12, 2020 with version 5.5

July 23, 2019 with versions 105.3 and 105.4


Before You Begin

Loading Java Data Sources

Configuring an RDG Database Connection

 Before You Begin


An OAC Repository Data Model (RPD). This can either be accessed In the Cloud or Offline.

The latest Developer Client Tool for OAC downloaded and installed on a Windows server or client.

A supported RDG data source for data models. And the connections details for a JDBC thin driver for that source.

The hostname / Public IP address of an RDG or RDC host

For a Linux host:

Execute the command <DataGatewayInstallFolder>/domain/bin/status.sh and note the machine name, IP address and HTTP Port values.

For a Windows host:

Find the file named ports.properties for the installation you are using: It may be under %localappdata%\Temp\2\DataGateway and note the port number.

Find the IP address. Open a browser search window and type What is my IP address. (If RDG is on the same Windows Client as the Developer Client Tool use localhost.

For MAC: Mac OS was not tested as it needs to allow ingress from a Windows host. 

RDG must be is a running state and connected to the OAC containing the RPD.

Administration privileges on a Windows server or client.

Downloading the Developer Client Tool

Navigate to Developer Client Tool for OAC.

Accept the License Agreement

Click the latest version

Choose a download location if requested

Installing the Developer Client Tool

Go to the folder where the tool was downloaded.

Unzip the downloaded file

Click on the installer file e.g. setup_bi_client-5.x-win64.exe

Choose an installation folder

 Loading the Java Data Sources

Start the Developer Client Tool Using the Start Menu or via a Command Line:

<Your Installation Directory>\BI\BITOOLS\BIN\ADMINTOOL.CMD​

Note: Do not open an RPD yet.

Click Load Java Data Sources from the File drop-down

Enter the Hostname or IP address of the RDG host

Enter the RDG Port found above

Use any name for User e.g. admin, dummy, etc.

Leave Password blank

Leave SSL unchecked

Click OK on the confirmation screen.

 Configuring the RDG Database Connection

In this section an existing database connection is duplicated to preserve the original settings. It is then configured for RDG. 

Open the RPD either in In the Cloud or Offline mode.

Duplicating the Database Connection

Right-Click on the Database Connection Name and click Duplicate.

Configuring the Original Database Connection for RDG

Note: In the OAC Known Issues is the following:

Based on the above, if your database type is not Oracle, double-click on it and change the type to Oracle.

Double-Click on the Connection Pool to open it.

On the General tab

Change the Call Interface to JDBC (Direct Driver)

Change the Connection String to use the JDBC format for the database type used and click OK.

The format for Oracle databases is:

jdbc:oracle:thin:@//<hostname or IP address>:<port>/<service name>


jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=<hostname or IP address>)(PORT=<port>))(CONNECT_DATA=(<service-name>)))

​​​Change to the Miscellaneous tab.

For Required Cartridge Version enter 12.1

Ensure Javads Server URL is Blank

Enter the Driver Class for the database type you use. For Oracle it is oracle.jdbc.driver.OracleDriver

For Use SQL over HTTP use true

For RDC Version use 2

Click OK

Based on the note above, if your database type is not Oracle, double-click on it and return the type to its original value.

Saving the Repository

From the File menu click Save.

If the repository is opened in the cloud, then Publish it from the File>Cloud menu.

If opened offline, then upload it to OAC.

You can now create Analyses in OAC using the remote data source.


This post described creating RDG connections to remote data sources using the Developer Client Tool for OAC.

For other posts relating to analytics and data integration visit http://www.ateam-oracle.com/dayne-carley



Be the first to comment

Comments ( 0 )
Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.Captcha