Prerequisites for Connectors
This section covers the prerequisites for connectors. It includes the following topics:
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
-
On Windows, you can run Install Prerequisites for Flogo Connectors without Admin privileges.
-
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:
- Procedure
-
Go to the Flogo icon on the left side of the menu.
-
Click HELP AND FEEDBACK and select Install Prerequisites for Flogo Connectors.
-
Now, you can select the available connectors from the list for driver installation.
Note: In prerequisites, you can also install Go and the Flogo Golang dependencies. -
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.
-
On Windows, the prerequisite installation scripts that use the MSI installer might not display the correct success message when performing driver removal, modification, or repair actions.
-
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 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 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
-
Download and unzip the Instant Client Basic package from the Oracle website.
-
Download the Instant Client ODBC package. Unzip it in the same directory as your basic package.
-
Execute
odbc_install.exefrom the Instant Client directory as administrator.
After installation, the 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
-
To install Oracle ODBC driver, run the following commands,
brew tap InstantClientTap/instantclientbrew install instantclient-basicbrew install instantclient-odbcThe driver is installed at the default location.
For example:
/usr/local/Cellar/instantclient-odbc/<driver-version>dbru/lib/libsqora.dylib.<version> -
Edit the
odbcinst.inifile with the following text with driver file path and name as per your system.[Oracle ODBC DriverDescription=Oracle 19 ODBC driverDriver=<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
- Download and unzip the Instant Client Basic package from the Oracle website.
-
Download the Instant Client ODBC package. Unzip it in the same directory as your basic package.
-
Execute
odbc_update_ini.shfrom the Instant Client directory.
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
-
From TIBCO eDelivery, download the TIBCO Data Virtualization ODBC Driver package.
-
Extract the contents of the package to a local directory.
-
Run the installer file.
-
Confirm that the installation of the driver is successful.
-
Click Start > All apps > Windows Tools > ODBC Data Sources (64-bit).
-
Go to the Drivers tab, and verify an entry for TIBCO Data Virtualization ODBC Driver.
-
On Ubuntu:
- Procedure
-
From TIBCO eDelivery, download the TIBCO Data Virtualization ODBC Driver package.
-
Extract the contents of the package to a local directory.
-
Set the environment variables
ODBCINIandODBCINSTINIto locations ofodbc.iniandodbcinst.inifiles, respectively. -
From the local directory, run the
/bin/driverConfigutility. When the utility prompts for the driver path, provide the driver path from thelib/libcomposite.sofile. -
Confirm that the installation of the driver is successful. In the
odbcinst.inifile, 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
-
Download the MSI installer from the Oracle MySQL website.
-
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
-
Download the Debian installer file from the Oracle MySQL website.
-
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:
-
Download and extract the driver compressed
.tarfile from the MySQL website to the required location. -
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
-
Download the Microsoft SQL Server ODBC Driver MSI installer file from the Microsoft website.
-
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
-
Download the PostgreSQL ODBC Driver MSI Installer file from https://odbc.postgresql.org/.
-
Run the executable installer.
ResultAfter installation, the PostgreSQL ODBC Driver in the ODBC Data Source Administrator (x64) program is now visible on the Drivers tab.
On macOS
-
Run the following command:
brew install psqlodbcThe driver is installed at the default location.
For example:
/usr/local/Cellar/psqlodbc/16.00.0000/lib/psqlodbcw.soor/opt/homebrew/Cellar/psqlodbc/16.00.0000/lib/psqlodbcw.so -
Edit the
odbcinst.inifile 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
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
-
Download the Amazon Redshift ODBC Driver MSI installer file from the Amazon Redshift website.
-
Run the executable installer.
After installation, the Amazon Redshift ODBC driver in the ODBC Data Source Administrator (x64) program is now visible on the Drivers tab.
On macOS
-
Download the Redshift ODBC Driver installer from the Amazon Redshift website.
-
Extract and install the package.
The driver is installed at the default location.
For example:
/opt/amazon/redshift/lib/libamazonredshiftodbc.dylib -
Edit the
odbcinst.inifile 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
-
Download the driver file provided by Amazon.
-
Run the executable installer.
After installation, the Amazon Redshift ODBC driver in odbcinst.ini file is now visible with the driver path.
For more information, see Amazon Redshift Documentation.
Installing Snowflake ODBC Drivers
To install the Snowflake ODBC drivers on specific platforms:
On Windows
-
Download and install the
MSI Installerfile from the Snowflake ODBC installation page. -
Configure the ODBC Driver. Ensure that you see an entry for
SnowflakeDSIIDriverin the ODBC Data Source Administrator(x64) program under the Drivers tab.-
Open the Windows Data Source Administration tool.
-
Verify if the Snowflake ODBC driver is installed.
-
Create a new data source name (DSN).
-
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
-
Download the Snowflake ODBC driver installer from the Snowflake website.
-
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.
iodbctest command-line utility provided with iODBC to test the DSNs you create.On Ubuntu
-
Download and extract the
TGZfile. Install and set up 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.inifile. -
Adds the Snowflake driver information to your system-level
/etc/odbcinst.inifile. -
Adds the certificate authority (CA) certificates required by the Snowflake ODBC driver to your system-level
simba.snowflake.inifile. -
By running the
unixodbc_setup.shcommand, you do not need to set any environment variables.
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
-
Due to dependency on the OS-specific EMS client library, app executable for apps using EMS connector cannot be built for Windows and macOS with TIBCO Cloud™ Integration runtime and TIBCO Control Plane runtime. With local runtime, building a cross-platform executable, such as a Linux executable on Windows, is not supported when using the EMS connector.
-
TIBCO Enterprise Message Service™ (EMS) Client 10.3.0 or above is required.
-
For Windows
-
Download the TIBCO Enterprise Message Service™ (EMS) Client package from TIBCO eDelivery and extract to
TIB_ems_<version>_win_x86_64/TIB_ems_<version>. -
Set the
EMS_HOMEenvironment variable. -
Set the
EMS_HOME=<EMS installation path>. -
For running the binary, add the following to the system path:
<EMS installation path>\<version>\bin -
Install PowerShell on Windows and then run
Get-ExecutionPolicy. -
If it returns the status as "restricted", then run
Set-ExecutionPolicyAllSigned. -
From HELP AND FEEDBACK, select Install Prerequisites for Flogo Connectors.
-
Install the Tibco EMS/FTL/ActiveSpaces prerequisite option to set up
gcc. -
Install the Tibco EMS/FTL/ActiveSpaces prerequisite option to set up
pkg-config.
-
-
For macOS
-
Download the TIBCO Enterprise Message Service™ (EMS) Client package from TIBCO eDelivery and extract to
TIB_ems_<version>_macosx_x86_64/TIB_ems_<version>. -
Set the
EMS_HOMEenvironment variable.export EMS_HOME=<EMS installation path> -
Install Xcode IDE.
Xcode-select –install -
To run the binary, export DYLD_LIBRARY_PATH.
export DYLD_LIBRARY_PATH=<EMS installation path>/lib
-
-
For Linux
-
Download the TIBCO Enterprise Message Service™ (EMS) Client package from TIBCO eDelivery and extract to
TIB_ems_<version>_linux_x86_64/TIB_ems_<version>. -
Run the following commands:
-
sudo su -
for f in tar/*; do tar -C / -xvf $f;
-
-
Set the following variables in the
./bashrcdirectory:-
Export LD_LIBRARY_PATH=<EMS installation path>/<version>/lib -
Export EMS_HOME=<EMS installation path>/<version>
-
-
From HELP AND FEEDBACK, select Install Prerequisites for Flogo Connectors.
-
Install the Tibco EMS/FTL/ActiveSpaces prerequisite option to set up
pkg-config.
Note: EMS installation for ARM-based machines is not supported. Therefore, EMS binary generation, Docker image generation, and unit testing is not supported in ARM-based machines. -
Setting up SAP Solutions
Prerequisites
Ensure that the following requirements are met before proceeding:
Platform Limitations
Due to an OS-specific dependency on the NW RFC SDK, application executables using the Flogo® Connector for SAP Solutions cannot be built for Windows and macOS with the TIBCO Control Plane runtime.
When using a local runtime, building a cross-platform executable (such as a Linux executable on a Windows machine) is not supported.
Required Software
-
SAP NWRFC SDK 7.50 PL17 or later must be downloaded and installed locally.
-
The
gcctool must be installed on your machine. -
For Windows: The Visual C++ Redistributable Package for Visual Studio 2013 or later is required.
Configuring Flogo Connector for SAP Solutions in VS Code
To configure Flogo Connector for SAP Solutions, perform the following steps:
- Procedure
-
Download the SAP NWRFC SDK for your operating system.
-
Extract the SDK to a local directory (for example,
C:\nwrfcsdk), ensuring thatlibandincludesubdirectories are present. -
In Visual Studio Code where the Flogo extension is installed, navigate to Settings.
-
Use the search bar to find Flogo.
-
Locate the setting labeled Flogo > Extensions: SAPNWRFC Home.
-
Enter the full path to your extracted SDK directory in the corresponding text box (for example,
C:\nwrfcsdk).
Setting up the Runtime Environment
To run a built application containing the SAP Solutions connector, you must update the environment variables for your operating system.
-
For Windows
Add the following script to the system
PATHenvironment variable:<SAP NWRFC SDK installation path>\lib
-
For Linux
Set the following variable:
export LD_LIBRARY_PATH=<SAP NWRFC SDK installation path>/lib
-
For macOS
Set the following variable:
export DYLD_LIBRARY_PATH=<SAP NWRFC SDK installation path>/lib
Setting up FTL for Local Runtime
For Windows
-
From TIBCO eDelivery, download the Windows TIBCO FTL package.
-
Extract the contents of the downloaded package to a local directory.
-
Run the installer file and complete the installation.
-
Confirm that the installation is successful.
-
If
gccis not already installed, from HELP AND FEEDBACK, select Install Prerequisites for Flogo Connectors and install the Tibco EMS/FTL/ActiveSpaces prerequisite option. -
Set the TIBFTL_ROOT environment variable.
TIBFTL_ROOT=<ftl_installation_path>\ftl\<x.x>For example,
TIBFTL_ROOT=C:\tibco\ftl\7.1 -
Add the following path to the PATH environment variable:
<ftl_installation_path>\ftl\<x.x>\binFor example,
C:\tibco\ftl\7.1\binAfter updating the environment variables, restart or reload the Visual Studio Code window.
For Linux
-
From TIBCO eDelivery, download the Linux TIBCO FTL package.
-
Extract the downloaded package.
-
Run the following commands to install the package:
-
sudo su -
for f in tar/*; do tar -C / -xvf $f;
-
-
Confirm that the installation of the driver is successful.
-
Set the required environment variables:
export TIBFTL_ROOT=<ftl_installation_path>\ftl\<x.x>export LD_LIBRARY_PATH=<FTL installation path>/<version>/libFor example,
export TIBFTL_ROOT=/opt/tibco/ftl/7.1export LD_LIBRARY_PATH=/opt/tibco/ftl/7.1/lib:$LD_LIBRARY_PATH -
Add the FTL bin directory to the PATH variable:
export PATH=$PATH:<ftl_installation_path>/ftl/<version>/binFor example, export
PATH=$PATH:/opt/tibco/ftl/7.1/binAfter updating the environment variables, restart or reload the Visual Studio Code window.
Setting up ActiveSpaces for Local Runtime
Prior to using this connection, Flogo Connector for ActiveSpaces DataGrid needs to be installed and setup. Ensure that the following steps are completed before using this connector.
-
Set environment variable,
TIBDG_ROOTto<activespace_installation_path>\as\<x.x>. -
Set environment variable,
TIBFTL_ROOTto<ftl_installation_path>\ftl\<x.x>. -
Add the below paths in the
PATHvariable:-
<activespace_installation_path>\as\<x.x>\bin -
<ftl_installation_path>\ftl\<x.x>\bin
-
-
If
gccis not already installed, from HELP AND FEEDBACK, select Install Prerequisites for Flogo Connectors and install the Tibco EMS/FTL/ActiveSpaces prerequisite option.
After adding the environment variables, restart or reload the VS Code window.