X

Best Practices from Oracle Development's A‑Team

Deploying Remote Data Gateway in Oracle Analytics Cloud for Data Visualization

Introduction

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 a step-by-step guide to installing gateway agents and creating Data Visualization connections using RDG. 

For tips on using RDG connections with the Oracle Developer Client Tool, visit Deploying Remote Data Gateway in Oracle Analytics Cloud for Metadata Repositories.

The official documentation is  Connect to On-premises Data Sources and Known Issues.

Updates

Published on July 9, 2019

Versions

  • Oracle Analytics Cloud version 105.3.x
  • MacBook Pro OS 10.13.6 
  • Windows Server R8 Compute Instance
  • Linux 7.2 Compute Instance

Topics

  • Before You Begin
  • Installing the Remote Data Gateway Agents
  • Enabling the Remote Data Gateway in OAC
  • Configuring the Remote Data Gateway Agents
  • Validating OAC Remote Data Access

 Before You Begin

Prerequisites

For this post, deploying RDG requires the following:

  • The IP address or host name of a Linux compute instance.
  • The SSH private key associated with the instance's public key. 
  • A SSH utility with X11 tunneling capability to access the Linux instance.
  • Administration privileges on a MAC-OS or Windows client.

Reviewing Supported Data Sources

Ensure your data source is supported by following the instructions in Supported Data Sources.

Downloading the Remote Data Gateway

Navigate to https://www.oracle.com/technetwork/middleware/oac/downloads/index.html, accept the license agreement, and choose the desired platform(s). This post used all three platforms (MAC, Linux, and Windows)

Note: If you are using a Linux instance that does not have a browser, you may download the Linux installer to your client machine and then upload it to your Linux instance. To upload to a Linux compute instance, SCP the installer using the following:

scp -i < private key path >  <path to installer file> opc@< IP address or host name >:/tmp

 Installing the Remote Data Gateway

The steps for all platforms are in Install Data Gateway.

Topics

  • Installing RDG on Windows

  • Installing RDG on MAC

  • Installing RDG on Linux

Installing RDG on Windows

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

Installing RDG on MAC-OS

Unpack the ZIP file contents to the /Application folder.

Installing RDG on Linux

Installing Remote Data Gateway on Linux requires a graphical user interface.  If necessary, refer to http://www.ateam-oracle.com/preparing-linux-for-oracle-remote-data-gateway for pointers. This post assumes that X11 is configured on a Linux instance and an X11 Server is installed on the client machine. This post uses MAC-OS and the XQuartz X11 Server.

Starting the X11 Server Application

Use Finder to open the Applications>Utilities folder and double-click XQuartz. An xterm window opens on the MAC.

Now this terminal session or another remote terminal session can be used to SSH into the Linux instance to run an X11 application. 

SSH into the Linux Server with an X11 Tunnel

Use the SSH utility with the -X option to set up an X11 tunnel session on the Linux instance. Connect as the opc user. This requires the IP address / host name of the instance and the private key.  The SSH syntax is:

​​ssh -X -i < private key path >  opc@< IP address or host name >

Unzipping the RDG Download

These steps assume the installer was downloaded or uploaded to the /tmp directory.

cd /tmp

unzip datagateway-linux64-105.3.zip

Making the RDG Installer Executable

chmod 777 datagateway-linux64-105.3.bin

Running the Installer

./datagateway-linux64-105.3.bin

Waiting For and Using the Installer GUI

It may take up to a minute before the installer screen appears.

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

If a Welcome dialog is displayed, click Next.

At the Installation Location dialog, accept the defaults and click Next.

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

Return to the SSH session and type the status command. Make a note of the HTTP Port and the URL for use in the next section.

/home/opc/Oracle/Middleware/Oracle_Home/domain/bin/status.sh

 Enabling the Remote Data Gateway in OAC

Log into OAC. From the home page, navigate to the DV Console:

Click the Hamburger icon.

Click Console.

Click Remote Data Connectivity

Click Enable Data Gateway

 Configuring the Remote Data Gateway Agents

Configuring a Remote Data Gateway Agent requires navigating between the OAC Remote Data Connectivity console and the Remote Data Gateway Agent console.

Starting the RDG Configuration Utility

MAC

Start the RDG i.e. Oracle Analytics Data Gateway.app from the Applications folder.

Windows

Start RDG i.e. datagateway.exe from the installation directory.

Linux

Starting the RDG Configuration Utility requires browser access to the RDG host and port noted above. If the client running the browser is in the same network as the RDG server this should not be an issue.

To test if access is available, use a browser and the following URL:

http://<Your RDG host name/IP>:<Your RDG HTTP port>/obiee/javads?status

If successful, an XML response is returned.

If you need to open the HTTP port, refer to http://www.ateam-oracle.com/opening-ports-in-linux-7-firewalls-for-oracle-analytics-cloud-access-to-databases-and-remote-data-connector for guidance.

Use the URL noted in the installation section above to start the RDG Configuration Utility.

http://<Your RDG host name/IP>:<Your RDG HTTP port>/obiee/config.jsp

Obtaining the OAC URL

Log into the OAC instance. Copy the URL up to the end of the host name

e.g. < instance >-<tenancy>.analytics.ocp.oraclecoud.com

Creating an RDG Agent 1 of 2

Once the various configuration utilities have been started, the GUI is the same for all.

  • Enter the OAC URL obtained above and click Generate Key

  • Copy the generated key to the clipboard

​​​Leave the configuration screen as is and switch over to OAC,

Registering the Data Gateway Agent in OAC

Go to the OAC Remote Data Connectivity page in OAC.

  • Click Add.

  • Optionally enter a Name or one is created for you.Paste the key generated from the Agent definition screen into the Public Key. Note that the ID and Host are populated from the key contents. Click OK.

  • The agent is registered.

Creating an RDG Agent 2 of 2

Return to the configuration utility.

  1. Click Test. A Successfully authenticated message appears.
  2. Click Save. A Successfully Submitted message appears
  3. Click Enable.
  4. Click Save again. A Successfully Submitted message appears

​​​Repeat the above steps to create additional agents on other platforms. Additional agents prevent a single point of failure. Deploying multiple agents may also improve performance.

 Validating OAC Remote Data Access

With the agent(s) configured and running, creating a new DV data connection validates that RDG is configured correctly.

  • Login or Go To the OAC home page
  • Click the Hamburger icon.

  • Click Data

  • Click Connections

  • Enter the required fields.
    • Check the Use Remote Data Connectivity/Connector box.
    • Click Save

You can now create DV Data Sets and projects using the remote data source.

 Summary

This post described installing and configuring Remote Data Gateway agents and creating Data Visualization data connections using remote data sources.

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