Installing Oracle Analytics Cloud Remote Data Gateway

October 18, 2019 | 5 minute read
Text Size 100%:


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

Validated January 20, 2021 for OAC 5.9


This post is a step-by-step guide describing the common installation tasks for Oracle Analytics Cloud (OAC) Remote Data Gateway (RDG).

For Linux, it details the steps for using the installer with a GUI. 

Note: Refer here for a post on installing RDG silently on Linux without a GUI.

This post is used by the scenarios noted in the companion blog Deploying Remote Data Gateway in Oracle Analytics Cloud for Data Visualization


January 20, 2021 for OAC 5.9

October 22, 2020 with RDG 5.8

July 22, 2020 with RDG 5.7

February 13, 2020 with OAC 5.5 and RDG 5.5

October 15, 2019 with OAC 5.4 and RDG 5.4


Before You Begin

Installing Remote Data Gateway

 Before You Begin

Reviewing Supported Operating Systems

Ensure your operating system is supported by viewing the list at OAC Downloads.


Installing RDG requires the following common items:

All Platforms

Credentials and Privileges to install software on the RDG host.

Linux and Windows Servers

The IP address or host name where RDG is to be installed.


A Graphical User Interface or alternatives such as VNC and X11 for a standard installation.

Linux and Windows SSH

Follow the steps in Preparing SSH Tunneling for Oracle Analytics Cloud Remote Data Gateway in a Private Subnet to setup your SSH configuration file for access to the RDG Host. This post assumes the SSH client configuration file has an entry named RDG-Host.


The Microsoft Remote Desktop (RDP) utility if accessing remote Windows servers.

Copy the Installer to the RDG host

Linux or Windows SSH

scp <Path to Installer Zip File>  RDG-Host:/home/opc or

scp <Path to Installer Zip File>  RDG-Host:"c:\users\opc"

Windows RDP

Copy or use a shared folder for the installer.

 Installing Remote Data Gateway


Installing RDG on Windows

Installing RDG on MAC

Installing RDG on Linux

Installing Additional RDG Agents on Linux

Installing RDG on Windows

There is not a standalone installer. Extract the contents of the downloaded ZIP file to a desired directory.

If using RDP, connect and unzip the installer

If using SSH,

ssh RDG-Host Expand-Archive

Installing RDG on MAC-OS

Unpack the ZIP file contents to the /Application folder.

Installing RDG on Linux

Remote Data Gateway may be installed on Linux with or without a GUI. This post focuses on the GUI and uses X11. If the host does not have one, consider installing the X11 system. Pointers can be found in Preparing Linux for Oracle Remote Data Gateway. 

Start the X11 Server on the Client

Start the X11 server on your client machine e.g. XQuartz on Mac or XMing on Windows

Unzip the RDG Download

ssh RDG-HOST unzip < Path to Installer Zip File >

Make the RDG Installer Executable

If necessary,

ssh RDG-HOST chmod 774 <name of bin file>.bin

Run the Installer using X11Forwarding

ssh -Y RDG-HOST ./<name of bin file>.bin

Waiting for and Using the Installer GUI

Accept the defaults for the Installation Inventory Setup and click OK.

If a Welcome dialog is displayed, click Next.

At the Installation Location dialog, choose an unused location and click NextNote: The installer creates the directory if it does not exist.

At the Select Remote Data Version dialog, select Remote Data Gateway and click Next.

At the Agent Configuration Credentials dialog, specify a username and password to use for logging into the Data Gateway Agent Configuration page and click Next.

At the Installation Summary dialog, click Install.

After the Installation Progress screen completes, click Next.

At the Installation Complete dialog, click Start Jetty and then click Finish.

Validating the Linux Installation and Obtaining the Port and the URL

Use the status command and make a note of the HTTP Port and the URL for use in configuring RDG

ssh RDG-Host <Install Directory>/domain/bin/

Installing Additional RDG Agents

Additional RDG installations in different availability domains are recommended for High-Availability (HA) requirements. 

Per the recent 5.8 documentation:

"You can deploy multiple Data Gateway agents so that there's no single point of failure. Deploying multiple Data Gateway agents might also improve performance if an agent is short of resources. When you register an agent using the Data Gateway Agent Configuration dialog, note the following:

You should configure each agent in the same way.

Each agent is capable of serving all remote queries. You can't target specific queries at specific agents.

If you leave the Allowed Hosts field blank, the agent tries to reach a data source on any host based on the connection information it retrieves from a connection in Oracle Analytics Cloud. If you specify hosts in the Allowed Hosts field, the agent can only address those hosts specified.



This post described the common installation tasks for Oracle Analytics Cloud (OAC) Remote Data Gateway (RDG).

RDG is now ready for configuration. Refer here for details.

For other posts relating to analytics and data integration visit


Dayne Carley

Previous Post

Automatic Certificate Renewal in OCI Load Balancer

Amit Chakraborty | 6 min read

Next Post

Completing the Deployment of Remote Data Gateway for Oracle Analytics Cloud

Dayne Carley | 6 min read