Search

Retool

Retool

You can connect Retool to CData Connect Cloud via the OpenAPI specification or via the Virtual SQL Server API. Follow the prerequisites and steps for the method you want to use.

Prerequisites for Connecting via OpenAPI

Before you connect via OpenAPI, you must first do the following:

  • In CData Connect Cloud:
    • Connect a data source to your CData Connect Cloud account. See Connections for more information.
    • Add a workspace to Virtual Datasets.
    • Add assets to your workspace.
    • Generate a Personal Access Token (PAT) on the Settings page. Copy this down, as it acts as your password during authentication.
  • In Retool:
    • Go to Settings > API and click Create new to generate an access token. See the Retool documentation for more information.

Connecting to CData Connect Cloud via OpenAPI

To establish a connection from Retool to CData Connect Cloud via OpenAPI, follow these steps.

  1. In Virtual Datasets in CData Connect Cloud, select a workspace and copy the OpenAPI URL for the workspace. Keep the default options. See OpenAPI for more information.

  2. Log in to Retool.

  3. In the Resources tab, click Create new > Resource.

  4. In the Select a resource type search bar, enter OpenAPI.

  5. Click OpenAPI. The Configure OpenAPI screen appears.

  6. Enter the following information to configure the OpenAPI connector:

    • Name—the name to use to identify the connector.
    • Specification URL—the OpenAPI URL you copied in CData Connect Cloud. Paste the URL here.
    • Forward headers when fetching OpenAPI spec—must be selected.
    • Headers—Authorization is Basic. Then, Retool requires that you base64 encode your CData Connect Cloud username and PAT using the input format username:PAT. The PAT is the token you created in the prerequisites. You can use a tool such as the one here. Click Encode and copy the base64 encoded result into this field. For example, for test@cdata.com:12345, the base64 encoded value is dGVzdEBjZGF0YS5jb206MTIzNDU=.
    • Username—enter your CData Connect Cloud username. This is displayed in the top-right corner of the CData Connect Cloud interface. For example, test@cdata.com.
    • Password—enter the PAT you generated on the Settings page.

  7. Click Test connection to test your connection configuration.

  8. Once you have a successful connection, click Create resource.

  9. Create the app in Retool in which to integrate your data.

  10. Click Create resource query.

  11. Select the new resource you created, and view the endpoints that are available.

  12. You can now build your app with the data.

Prerequisites for Connecting via Virtual SQL Server API

Before you connect, you must first do the following:

  • Connect a data source to your CData Connect Cloud account. See Connections for more information.
  • Generate a Personal Access Token (PAT) on the Settings page. Copy this down, as it acts as your password during authentication.

Connecting to CData Connect Cloud via Virtual SQL Server API

To establish a connection from Retool to the CData Connect Cloud Virtual SQL Server API, follow these steps.

  1. Log in to Retool.

  2. Under Resources, click Connect a resource.

  3. Enter “Microsoft SQL” in the search bar and click the resulting option.

  4. Enter the connection settings.

    • Name—a name for the connection to CData Connect Cloud
    • Host—tds.cdata.com
    • Port—14333
    • Database name—enter the Connection Name of the CData Connect Cloud data source you want to connect to (for example, Salesforce1).
    • Database username—enter your CData Connect Cloud username. This is displayed in the top-right corner of the CData Connect Cloud interface. For example, test@cdata.com.
    • Database password—enter the PAT you generated on the Settings page.

  5. Click Test connection. If it succeeds, you can click Create resource. Your connection to CData Connect Cloud is ready to use.