Prerequisites for Connectors

The following topics cover the prerequisites for connectors.

OAuth Connections

For the Flogo Connectors that support OAuth 2.0 connection type, set the Callback or redirect URL to https://vscode.dev/redirect.

Installing Driver from Visual Studio Code UI

Note:
  • On Windows, you need Admin privileges to run Install Prerequisites for Flogo Connectors. Uninstall the existing Chocolatey package manager.

  • On Linux and macOS, you need Admin privileges to install the packages that enable Install Prerequisites for Flogo Connectors.

To install the prerequisites for connectors, perform the following steps:

1. Go to the Flogo icon on the left side of the menu.

2. Click HELP AND FEEDBACK and select Install Prerequisites for Flogo Connectors.

3. Now, you can select the available connectors from the list for driver installation.

4. Install the driver for the selected connector.

Note: Installing Driver from Visual Studio Code UI Script includes installing ODBC Driver Manager and the selected Connector Driver.

Installing ODBC Driver Manager

Before creating a database server connection, you must install ODBC Driver Manager and Database drivers. Install ODBC Driver Manager by running one of the following platform-specific commands.

Platform Command
Windows The ODBC Driver Manager is prepackaged with Windows as ODBC Data Source Administrator.
macOS

To install the ODBC Driver Manager, run the following command:

brew install unixodbc

The above command creates the configuration file odbcinst.ini at the default location: /usr/local/etc/odbcinst.ini

If brew is not installed on your system, you can install it by running the following command:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Note: If the odbcinst.ini configuration file is not created automatically, then you must create it by running the following command:
touch $(brew --prefix)/etc/odbcinst.ini
Note: TIBCO Flogo® Connector for Snowflake requires an iODBC driver manager. You can download the iODBC from here. After downloading the iODBC driver manager, double-click the downloaded .dmg file. Double-click the installer file iODBC-SDK.pkg and follow the instructions.
Ubuntu

To install the unixODBC Driver Manager, run the following command:

apt install unixodbc

For TIBCO Data Virtualization Flogo Connector, run the following command:

apt-get install unixodbc unixodbc-dev

The above command creates the odbcinst.ini configuration file at the default location: /etc/odbcinst.in

Note: If the odbcinst.ini configuration file is not created automatically, then you must create it by running the following command:
touch /etc/odbcinst.ini

Installing Oracle Database ODBC Drivers

To install Oracle ODBC drivers on specific platforms:

On Windows

  1. Download and unzip the Instant Client Basic package from the Oracle website.

  2. Download the Instant Client ODBC package. Unzip it in the same directory as your basic package.

  3. Execute odbc_install.exe from the Instant Client directory as administrator.

  4. Result

    After installation, Oracle ODBC Driver in the ODBC Data Source Administrator (x64) program is now visible on the Drivers tab.

    For more information, see: https://www.oracle.com/in/database/technologies/releasenote-odbc-ic.html

On macOS

  1. To install Oracle ODBC driver, run the following commands,

    brew tap InstantClientTap/instantclient

    brew install instantclient-basic

    brew install instantclient-odbc

    The driver is installed at the default location.

    For example: /usr/local/Cellar/instantclient-odbc/<driver-version>dbru/lib/libsqora.dylib.<version>

  2. Edit the odbcinst.ini file with the following text with driver file path and name as per your system.

    [Oracle ODBC Driver

    Description=Oracle 19 ODBC driver

    Driver=<default driver location>

On Ubuntu

Oracle ODBC driver requires the libaio package to be installed as a prerequisite, run the following command to install the package:

apt install libaio1
  1. Download and unzip the Instant Client Basic package from the Oracle website.
  2. Download the Instant Client ODBC package. Unzip it in the same directory as your basic package.

  3. Execute odbc_update_ini.sh from the Instant Client directory.

  4. Result

    After installation, the Oracle ODBC Driver in the odbcinst.ini file is now visible with the driver path.

    To know more about installation steps, see: https://www.oracle.com/in/database/technologies/releasenote-odbc-ic.html

Installing TIBCO Data Virtualization ODBC Driver

On Windows:

    Procedure
  1. From TIBCO eDelivery, download the TIBCO Data Virtualization ODBC Driver package.

  2. Extract the contents of the package to a local directory.

  3. Run the installer file.

  4. Confirm that the installation of the driver is successful.

    1. Click Start > All apps > Windows Tools > ODBC Data Sources (64-bit).

    2. Go to the Drivers tab, and verify an entry for TIBCO Data Virtualization ODBC Driver.

On Ubuntu:

    Procedure
  1. From TIBCO eDelivery, download the TIBCO Data Virtualization ODBC Driver package.

  2. Extract the contents of the package to a local directory.

  3. Set the environment variables ODBCINI and ODBCINSTINI to locations of odbc.ini and odbcinst.ini files, respectively.

  4. From the local directory, run the /bin/driverConfig utility. When the utility prompts for the driver path, provide the driver path from the lib/libcomposite.so file.

  5. Confirm that the installation of the driver is successful. In the odbcinst.ini file, verify an entry for the TIBCO Data Virtualization ODBC Driver with the driver path.

Installing Oracle MySQL ODBC Driver

To install the database driver:

On Windows

  1. Download the MSI installer from the Oracle MySQL website.

  2. Run the executable installer.

Oracle MySQL ODBC Driver in the ODBC Data Source Administrator (x64) program is now visible on the Drivers tab.

On Ubuntu

  1. Download the debian installer file from the Oracle MySQL website.

  2. Run the executable installer.

Oracle MySQL ODBC Driver is now visible in the odbcinst.ini file with the driver path.

For prior versions of Ubuntu 22.04:

  1. Download and extract the driver compressed .tar file from the MySQL website to the required location.

  2. Use the installer utility from the bin folder of the extracted driver folder, run the following command:

    ./myodbc-installer -d -a -n "MySQL ODBC Unicode Driver" -t “DRIVER=/path/to/driver/libmyodbc8w.so;"

Installing Microsoft SQL Server ODBC Driver

To install the database driver:

On Windows

  1. Download the Microsoft SQL Server ODBC Driver MSI installer file from the Microsoft website.

  2. Run the executable installer.

Microsoft SQL Server ODBC Driver in the ODBC Data Source Administrator (x64) program is now visible on the Drivers tab.

On macOS and Ubuntu

To install the Microsoft ODBC Driver for SQL Server:

Microsoft SQL Server ODBC Driver is now visible in the odbcinst.ini file with the driver path.

Installing PostgreSQL and Greenplum ODBC Drivers

To install the PostgreSQL and Greenplum ODBC drivers on specific platforms:

On Windows

  1. Download the PostgreSQL ODBC Driver MSI Installer file from https://odbc.postgresql.org/.

  2. Run the executable installer.

    Result

    After installation, the PostgreSQL ODBC Driver in the ODBC Data Source Administrator (x64) program is now visible on the Drivers tab.

On macOS

  1. Run the following command:

    brew install psqlodbc

    The driver is installed at the default location.

    For example: /usr/local/Cellar/psqlodbc/16.00.0000/lib/psqlodbcw.so or /opt/homebrew/Cellar/psqlodbc/16.00.0000/lib/psqlodbcw.so

  2. Edit the odbcinst.ini file with the following text with driver file path and name as per your system.

    [PostgreSQL]
    Description=PostgreSQL ODBC Driver
    Driver=<default driver location>

On Ubuntu

  • Run the following command:

apt install odbc-postgresql
Result

After installation, the PostgreSQL ODBC driver in the odbcinst.ini file is now visible with the driver path.

Installing Amazon Redshift Database Drivers

To install the Amazon Redshift database drivers on specific platforms:

On Windows

  1. Download the Amazon Redshift ODBC Driver MSI installer file from the Amazon Redshift website.

  2. Run the executable installer.

Result

After Installation, the Amazon Redshift ODBC driver in the ODBC Data Source Administrator (x64) program is now visible on the Drivers tab.

On macOS

  1. Download the Redshift ODBC Driver installer from the Amazon Redshift website.

  2. Extract and install the package.

    The driver is installed at the default location.

    For example: /opt/amazon/redshift/lib/libamazonredshiftodbc.dylib

  3. Edit the odbcinst.ini file with the following text with driver file path and name as per your system.

    [Amazon Redshift]
    Description=Amazon Redshift ODBC Driver
    Driver=<default driver location>

On Ubuntu

  1. Download the driver file provided by Amazon.

  2. Run the executable installer.

Result

After installation, the Amazon Redshift ODBC driver in odbcinst.ini file is now visible with the driver path.

For more information, see, https://docs.aws.amazon.com/redshift/latest/mgmt/odbc20-install-config-linux.html

Installing Snowflake ODBC Drivers

To install the Snowflake ODBC drivers on specific platforms:

On Windows

  1. Download and install the MSI Installer file from the Snowflake ODBC installation page.

  2. Configure the ODBC Driver. Ensure that you see an entry for SnowflakeDSIIDriver in the ODBC Data Source Administrator(x64) program under the Drivers tab.

    1. Launch the Windows Data Source Administration tool.

    2. Verify if the Snowflake ODBC driver is installed.

    3. Create a new data source name (DSN).

ResultAfter installation, the SnowflakeDSIIDriver in the ODBC Data Source Administrator(x64) program is now visible on the Drivers tab. For more information, see Snowflake Developer Guide.

On macOS

  1. Download the Snowflake ODBC driver installer from the Snowflake website.

  2. Mount and install the package as mentioned here.

If you choose the default directory when prompted, the installer installs the ODBC driver files in the /opt/snowflake/snowflakeodbc/Library/ODBC directory.

To create a DSN, edit the appropriate odbc.ini file.

ResultYou can use the iodbctest command line utility provided with iODBC to test the DSNs you create.

On Ubuntu

  • Download and extract the TGZ file. Install and setup the ODBC driver as described in the Snowflake documentation.

  • Configure the environment with unixODBC.

In a terminal window, change to the snowflake_odbc directory, and run the ./unixodbc_setup.sh command to install the Snowflake ODBC.

This script completes the following:

  • Adds a Snowflake connection to your system-level /etc/odbc.ini file.

  • Adds the Snowflake driver information to your system-level /etc/odbcinst.ini file.

  • Adds all the certificate authority (CA) certificates required by the Snowflake ODBC driver to your system-level simba.snowflake.ini file.

  • By running the unixodbc_setup.sh command, you don't need to set any environment variables.

ResultTest the DSNs you created using the isql command line utility provided with unixODBC. On the command line, specify the DSN name, user login name and password.

Setting up EMS for Local Runtime

Note: Due to dependency on platform specific EMS client library, app executable for apps using EMS connector cannot be build for Windows and MacOS platforms on TIBCO Cloud Integration and TIBCO Control Plane.
  • For Windows

    1. Download the TIBCO Enterprise Message Service™ (EMS) Client package from TIBCO eDelivery and extract to TIB_ems_<version>_win_x86_64/TIB_ems_<version>.

    2. Set the EMS_HOME environment variable.

    3. Set the EMS_HOME=<EMS installation path>.

    4. For running the binary, add the following to the system path:

      <EMS installation path>\<version>\bin

    5. Install PowerShell on Windows and then run Get-ExecutionPolicy.

    6. If it returns the status as "restricted", then run Set-ExecutionPolicy AllSigned.

    7. If it is not restricted, then directly run the following command in PowerShell:

      Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
    8. Run the following command:

      choco install mingw -y

    9. Run the following command:

      choco install pkgconfiglite

  • For macOS

    1. Download the TIBCO Enterprise Message Service™ (EMS) Client package from TIBCO eDelivery and extract to TIB_ems_<version>_macosx_x86_64/TIB_ems_<version>.

    2. Set the EMS_HOME environment variable.

      export EMS_HOME=<EMS installation path>

    3. Install Xcode IDE.

      Xcode-select –install

    4. To run the binary, export DYLD_LIBRARY_PATH.

      export DYLD_LIBRARY_PATH=<EMS installation path>/lib

  • For linux

    1. Download the TIBCO Enterprise Message Service™ (EMS) Client package from TIBCO eDelivery and extract to TIB_ems_<version>_linux_x86_64/TIB_ems_<version>.

    2. Run the following commands:

      • sudo su

      • for f in tar/*; do tar -C / -xvf $f;

    3. Set the following variables in the ./bashrc directory:

      • Export LD_LIBRARY_PATH=<EMS installation path>/<version>/lib

      • Export EMS_HOME=<EMS installation path>/<version>