Load Metadata from an Oracle Database

Version:
2020.2
Last modified: September 01, 2020

Use the Oracle Loader to upload metadata to Alteryx Connect for Oracle tables located in a specified TNS Service Name.

Review Loader Requirements

  • The Alteryx Connect Loaders must be installed on the machine where Alteryx Server is installed. To install the loaders:

    1. Download the loaders installer. For compatibility, the Loaders installer version must match the Alteryx Connect version.
    2. Run the installer as an administrator.
  • The Oracle user account requires at least "select" access to load objects and schemas. Alteryx recommends that the specified user is granted SELECT_CATALOG_ROLE permissions, which is the default for a system role. This will allow the loading of any and all schemas. For more information, see the Oracle documentation.
  • Install the appropriate Oracle database drivers:
    • To install the Oracle driver using Alteryx Designer, open Designer and go to Options > Advanced Options > Manage Data Connections > Add Connection > Oracle.
      • If an Oracle driver is already installed, the Oracle Database Connection window opens. You can optionally create a connection to test your database credentials and network connectivity.
      • If a driver is not installed, the Oracle Client Not Found message displays. Select a location with at least 2 GB of free space to install the Oracle Instant Client driver. Select Install.
    • To manually install the Oracle driver, see Instant Client Downloads.
    • For more information, see Manage Data Connections Window in the Alteryx Designer Help.
  • You will need the Oracle server name, port number, and service name.

Open the Loader

  1. Open Alteryx Designer.
  2. Select Help > Sample Workflows > Alteryx Connect Metadata Loaders > Oracle Loader > Oracle Loader.

Run the App

  1. Select Run as Analytic App Run as analytic app button.
  2. In the Oracle tab:
    • Type the TNS string or select Detailed connection parameters to manually specify a server IP address or hostname, port, and service name.

      The TNS string is your DB alias. This is your configured TNS name.

    • Type your Oracle database credentials.
    • In Schemas to load, optionally specify a comma-separated list of schemas. Leave blank to load all schemas.
    1. In the Alteryx Connect tab, type the URL for your Alteryx Connect instance and your credentials. 
      https://yourcompany.alteryxconnect.com

    2. Before running the app, select Save button and save the app configuration to the following directory: 
      C:\ProgramData\Alteryx\AlteryxConnect\Oracle_Loader\

      The .yxwv app values file is used for scheduling the loader to run in the Gallery. See Schedule Metadata Loaders.

  3. Select Finish to run the app.
    • If the run succeeds, "Success" appears in the App Results window.
    • If the run fails, a "There were Errors" message appears.

    Depending on how much metadata is being imported, the app can take a long time to run.

View the Metadata

  1. o to the Alteryx Connect URL and log in.
  2. From the main menu, select Data Sources > Databases.
  3. Select a folder to view its contents.
Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.