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 selecting 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.
      • Windows: PROGRESS_DATADIRECT_JDBC_INSTALL.exe
      • Non-Windows: PROGRESS_DATADIRECT_JDBC_INSTALL.jar
    3. Follow the prompts to complete installation.

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

  2. Open the Autonomous REST Composer by using one of the following methods:
    • Select the Autonomous REST Composer (JDBC) 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 --design

      By default, the autorest.jar file is stored in the following directory: C:\Program Files\Progress\DataDirect\JDBC\lib\60.


    Hub window for the Autonomous REST Connector Configuration Manager

  3. 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.
  4. The Connection tab opens.

    Hub window for the Autonomous REST Composer

    Provide values for the following fields:
    • Server 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.
  5. 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.
  6. 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.
  7. 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.
  8. To test your configuration:
    1. Click Test Connect or select the SQL Editor tab from the side menu.
    2. In the Editor pane, specify a query that you would like to test.
    3. Click Execute.
    If successful, the driver will return your results in the Results pane.
  9. Download your model file:
    1. Select the Configure Endpoints tab.
    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: For subsequent connections, you will need to specify the fully qualified path to your Model file using the Config connection property. The string generated by the Autonomous REST Composer does not automatically provide a location.
  10. As you provide values for properties, the Composer generates a JDBC connection string for use by your application. To use your string, on the Set Authentication tab, click the Copy button (). You can then paste the string to a location that can be used by your application.
  11. 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:
    • DataDirect Configuration Manager: The DataDirect Configuration Manager allows you to test connect and execute SQL statements right out of the box.
    • Tableau: Tableau is a business intelligence software program that allows you to easily create reports and visualized representations of your data.
    • DbVisualizer: DB Visualizer is a database tool that allows you to connect 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.