Vertica Integration with Workato: Connection Guide

About Vertica Connection Guides

Vertica connection guides provide basic instructions for connecting a third-party partner product to Vertica. Connection guides are based on our testing with specific versions of Vertica and the partner product.

Vertica and Workato: Latest Versions Tested

This document is based on our testing using the following versions:

Software Version
Workato On-premise Agent 2.8.1
Desktop Platform

Windows Server 2016

Vertica Client

Vertica JDBC 10.1.1

Vertica Server

Vertica 10.1.1

Workato Overview

Workato is an automation platform that enables business and IT teams to integrate their applications and automate business work flows. Workato automates with recipes (work flows) to integrate applications for specific tasks. Each recipe has three components, apps, triggers, and actions.

Installing Workato

You need to install the Vertica On-prem Agent to create and use Workato recipes with the Vertica database. The On-prem Group enables you to create multiple on-prem connections. For more information about this grouping and the advantages, refer to On-prem Group.

For instructions on setting up and running the agent, see Setting up On-prem Agent.

Installing the Vertica Client Driver

Workato uses the Vertica JDBC driver to connect to Vertica. To install the client driver

  1. Navigate to the Vertica Client Drivers page.
  2. Download the JDBC driver package for your version of Vertica.

    Note For more information about client and server compatibility, see Client Driver and Server Version Compatibility in the Vertica documentation.

  3. Place the Vertica JDBC driver in the Agent/lib folder.
  4. You need to provide the path to the JDBC driver in the config.yml file. The file is located in the Agent/conf directory.

    1. In the server section, provide the classpath.
    2. In the database section provide the Vertica database details such as the connection profile name, URL, driver class, adapter, username and password.

  5. Note We provided sql as the connection profile name in the following example. This name will be used to create a connection to Workato.

  6. After you configure, the config.yml file looks as follows:

  7. Restart the Workato Agent.

Connecting Vertica to Workato

  1. Open in a browser and login with your Workato credentials.
  2. In the Assets tab, click the Create Recipe drop-down and then click Create connection.

  3. Select JDBC from the available connections.
  4. Enter the connection name, select the folder, on-prem connection profile (from the config.yml file), schema name, and the on-prem agent name.

    Note In the Is this app in a private network? drop-down, you need to enter the name of the on-prem agent that you set up during the agent installation.

  5. Click Connect. If the connection is successful, the following message is displayed:

Creating a Recipe Using the Vertica Connection

In this example, we will be creating a recipe that reads data from Vertica and processes the data into a CSV file.

Note Before you create a recipe, ensure that you follow the instructions here to connect to on-prem files on Workato.

  1. To process data to a CSV file, in the config.yml file, you need to provide a staging directory and a directory where the CSV file will be stored.

    1. In the server section, provide the staging directory.
    2. In the files section, provide the directory where you want to save the CSV file.

  2. Restart the Agent.
  3. Open and login with your credentials.
  4. In the Assets tab, click Create Recipe.
  5. Enter the name, select the folder, pick the starting point, and click Start building.

  6. In the Recipe work flow, click Trigger on a specified schedule.
  7. On the right pane, select

    • App: Scheduler by Workato
    • Trigger: New recurring event
  8. Now create another trigger to connect to the on-prem files. In the Recipe work flow, click the + sign.
  9. On the right pane, select

    • App: On-prem files
    • Action: ALL ACTIONS > Generate on-prem file URL
    • Connection: Select the on-prem file connection that you created.
    • Setup: Folder - Select the folder and enter File name for the CSV file.

  10. Create another trigger to create a connection to the Vertica database. In the Recipe work flow, click the + sign.

  11. On the right pane, select

    • App: JDBC
    • Action: Export query result
    • Connection: Select the JDBC on-prem connection that you created or you can create a new connection.
    • Setup

      • SQL: Provide the SQL Query.
      • Column delimiter: Select the required delimiter.
      • Upload URL: In the Recipe data pop-up, click File URL.

  12. Click Save and then click Test.

Known Limitations

  • DATE, TIME, and TIMETZ data types are not supported.

  • BINARY, VARBINARY, and LONG VARBINARY data types are not supported.

For More Information