This section provides you with an overview of the steps required to install, set-up, and begin accessing data using prebuilt model files developed by Progress. From the Autonomous REST Composer, you have access to a library of prebuilt Model files for publicly available data sources that fully define the required requests and pagination parameters. After downloading a Model, you only need to provide your authentication credentials to begin accessing data.

To begin accessing data with the driver:

  1. Install the driver:
    1. After downloading the product, unzip the installer files to a temporary directory.
    2. From the installer directory, run the appropriate installer file to start the installer. The installer file takes the following form:

      PROGRESS_DATADIRECT_ODBC_nn_WIN_xx_INSTALL.exe

    3. Follow the prompts to complete installation.
    Note:

    The installer program supports multiple installation methods, including command-line and silent installations. For detailed instructions, refer to the Progress DataDirect for ODBC Drivers Installation Guide.

  2. Before you can use your driver, you must set the PATH environment variable to include the path of the jvm.dll file of your Java™ Virtual Machine (JVM).
  3. Open the Autonomous REST Composer by using one of the following methods:
    • Select the Autonomous REST Composer (ODBC) icon from your desktop or the Windows Start menu.
    • From a command line, navigate to the directory containing the autorest.jar file and execute the following command: 
      java -jar autorest.jar --odbcdesign

      By default, the autorest.jar file is stored in the following directory: install_dir\Progress\DataDirect\ODBC\java\lib\.

    The Autonomous REST Composer opens in your default web browser.


    Hub window for the Autonomous REST Connector Autonomous REST Composer

  4. Select the Model for the data source to which you want to connect from the menu on the right.
    Note: If you do not see your data source on the menu, you can build your own by following the steps in Generating a Model file with the Autonomous REST Composer.
  5. The Connection tab of the Autonomous REST Composer opens.

    Hub window for the Autonomous REST Connector Autonomous REST Composer

    Optionally, you can provide values for the following fields if you want to connect and view your model in the composer:
    • Host Name: Set this property to specify the host name portion of the HTTP endpoint to which you send requests. For example, a Jira endpoint would take the following form: https://mycompany.atlassian.net.
      Note: This value will be provided by the Model for data sources that have static host names.
    • Port Number: Optionally, specify the TCP port of the server that is listening for REST API requests.
    • Authentication Method: Select the authentication method used to connect to your data source. The properties related to the selected method are exposed. Provide values for the exposed fields that apply to your connection. Note that some of the fields may not apply to your data source. Refer to the documentation for your REST service for details.
  6. Download your model file:
    1. Select the Configure Endpoints tab.
      Important: If you do not provide connection information to your service, you might receive an error message. However, this does not prevent you from downloading your Model file.
    2. Optionally, add, remove, or edit endpoints that are used to return data for use with SQL-based applications.
    3. Click Download to save your model file.
    Note: When configuring a data source or connection string, you will need to specify the fully qualified path to your Model file using the REST Config File (RESTConfigFile) option.
  7. Close the Autonomous REST Composer.
  8. Start the ODBC Administrator from the Progress DataDirect program group to configure the driver using the ODBC Administrator (GUI). The GUI dialog allows you to configure the data source definitions in the Windows Registry or generate connection strings.
    Note: The Windows driver also supports using connection strings to connect to your service. For more information, see "Using a connection string."
  9. Select either the User DSN, System DSN, or File DSN tab to display a list of data sources.
    • User DSN: If you installed a default DataDirect ODBC user data source as part of the installation, select the appropriate data source name and click Configure to display the driver Setup dialog box.

      If you are configuring a new user data source, click Add to display a list of installed drivers. Select your driver and click Finish to display the driver Setup dialog box.

    • System DSN: To configure a new system data source, click Add to display a list of installed drivers. Select your driver and click Finish to display the driver Setup dialog box.
  10. The Connection tab of the Configuration Manager opens.

    Hub window for the Configuration Manager of the Autonomous REST Connector

    Provide values for the following fields:
    • Data Source Name: Type a string that identifies this data source configuration, such as Projects.
    • Description: Type an optional long description of a data source name, such as My Development Projects.
    • Host Name: Optionally, set this property to specify the host name portion of the HTTP endpoint to which you send requests. For example, a Jira endpoint would take the following form: https://mycompany.atlassian.net.
      Note: This value will be provided by the Model for data sources that have static host names.
    • Port Number: Optionally, specify the TCP port of the server that is listening for REST API requests.
    • REST Config File: Enter the name and location of your Model file. For example, C:\path\to\myrest.rest.
  11. From the Authentication Method drop-down, select the authentication method used to connect to your data source. The properties related to the selected method are exposed. See Authentication for more information on supported methods.
  12. Provide values for the exposed authentication fields that apply to your connection. Note that some of the fields may not apply to your data source. Refer to the documentation for your REST service for details.
  13. Set the values for any optional properties that you want to configure. For additional information on optional features and functionality, see the following resources:
    • Connection URL examples provides connection string examples that can be used to configure common functionality and features. You can modify and combine these examples to create a string that best suites your environment.
    • Connection property descriptions provides a complete list of supported properties by functionality.
  14. To test your configuration:
    1. Click Test Connect.
    2. In the Test Query field, specify a query that you would like to test.
      Note: The default query returns only a list of the tables defined in the Model file. This list is generated by the driver's internal SQL Engine. To authenticate to the REST service, specify a simple SELECT statement using of the table from the results.
    3. Click Execute.
    If successful, the driver will return results from a test query.
  15. Click Save to save your data source.
    Note: As you provide values for properties, the Configuration Manager also generates an ODBC connection string for use by your application. To use your string, click the Copy button () and paste the string to a location that can be used by your application.
  16. Begin accessing data with your applications, BI tools, database tools, and more. To help you get started, the following resources guide you through accessing data with some common tools:
    • Example Application: The example application allows you to test connect and execute SQL statements right out of the box.
    • Power BI: Power BI is a business intelligence software program that allows you to generate analytics and visualized representations of your data.
    • Tableau: Tableau is a business intelligence software program that allows you to easily create reports and visualized representations of your data.
    • Microsoft Excel: Excel is a spreadsheet tool that allows you to connect, view tables, and execute SQL statements against your data.
    • Supported SQL statements and extensions: This section describes the syntax used for SQL statements supported by the driver. You can modify and use the provided examples for your application or tool.

This completes the deployment of the driver.