Configure and Register Data Gateway for Visualization

After you've installed Data Gateway, you configure your on-premises environment and register one or more Data Gateway agents for remote connectivity from visualization projects.

To deploy multiple Data Gateway agents, repeat steps 4 to 9 for each agent.
  1. Log into Oracle Analytics Cloud as an administrator.
  2. Copy your Oracle Analytics Cloud URL:
    1. In a browser, navigate to Oracle Analytics Cloud.
    2. In the browser's address bar, copy the URL up to and including <domain> (not the text after that).
      The URL will be in the format https://hostname.domain:port. You'll use this URL in Step 3 when you set up Data Gateway in Agent Configuration.
  3. Enable Data Gateway in Console:
    1. From the Oracle Analytics Cloud Home page, click Console.
    2. Click Remote Data Connectivity.
    3. Enable the Enable Data Gateway option.
  4. For each deployment of Data Gateway, use Data Gateway Agent Configuration to generate an authorization key for that machine:
    If you're asked to log in, enter the same username and password that you specified in the Credentials page of the Data Gateway installer.
    1. Start the Data Gateway Configuration page.
      • In a server deployment, open a web browser and enter the URL: <Local hostname>:<port>/obiee/config.jsp. To obtain the URL used to start Data Gateway Agent Configuration, use the /<Data Gateway install folder>/domains/bin/status.sh command and refer to the URL output value displayed.
      • For a personal deployment on Windows, from your local installation folder, click datagateway.exe.
      • For a personal deployment on MacOS, from your local installation folder, click datagateway.
    2. In the URL field, enter the Oracle Analytics Cloud server URL that you copied in Step 1.
    3. Click Generate Key, then click Copy to Clipboard.
      Tip: Don't click Test, Save, or Enable yet.
      Leave the other fields blank.
  5. Switch to the browser session where you have the Console page Remote Data Connectivity displayed, and add a Date Gateway agent.
    1. Under Data Gateway, click Add.
    2. In Public Key, paste in the key that you copied using the Copy to Clipboard option in Step 4.c.
      When you paste in the key, the Name, ID, and Host fields are completed with the details of the on-premises machine where you've installed Data Gateway.
    3. Click OK to save the details.
  6. Switch to the Data Gateway Configuration page.
  7. (Optional) Use the Allowed Hosts field to restrict Data Gateway access to specific host machines. Leave the field blank to enable Data Gateway to access any host machine.
    For example, cxdb.example.com.
    By default the Data Gateway agent will attempt to connect to a data source on any host specified in a remote connection in Oracle Analytics Cloud. The Allowed Hosts field allows you to constrain the target hosts and IP addresses that Data Gateway can connect to. However, you must configure Data Gateway so that all agents can serve all remote queries.
  8. (Optional) Use the Allowed SQL Statements field to restrict Data Gateway to specific SQL or data manipulation language (DML) constructs. Leave the field blank to enable Data Gateway to execute any SQL statements or DML constructs on the data source.
    For example, specify SELECT to restrict Data Gateway to read-only access to the remote data source. Or specify SELECT; ALTER SESSION to restrict Data Gateway to using SELECT and ALTER SESSION operations.
  9. Click Test, Save, then Enable.
    To deploy multiple Data Gateway agents, repeat steps 4 to 9 for each agent.

If you also want to connect remotely from reporting dashboards and analyses, perform the additional configuration steps in Configure and Register Data Gateway for Reporting.

Then you're ready to test your deployment by connecting remotely to an on-premises database.