ODBC Connector and Data Gateway

Use ODBC Connector to retrieve data from an external system and send it to a callback URL. Install the Gateway Service App (GSA) on the external server to retrieve and execute commands from Flowize. You can send the results to a webhook to enrich a data record or to a URL that starts a flow.

Deprecated functionality

ODBC Connector is deprecated as of September 26, 2023 and unavailable in new projects. Support for this feature will cease. Existing projects using ODBC Connector can continue to operate. Contact the support team for alternatives and transition guidance. This guide applies to existing projects where the feature remains available.

Before you start

ODBC Connector must be available in your project. Its visibility and the actions you can use also depend on your role's access settings.

ODBC commands can run only in your own Environment. In the hosted designer, the connector configuration shows a notice instead of an API URL. Use the API URL displayed in your Environment for the external integration.

Open ODBC Connector

1. Open the project.
2. Go to Triggers > ODBC Connector.

The overview shows each connector's Name, API Key, command counts, Created date, and Last Access. Command counts include In Queue, Processing, Done, Errors, and Paused.

The connector's actions menu can include Open, New Command, Commands Queue, Connection Log, and Delete, according to your access settings.

Create a connector

When New ODBC Connector is available:

1. Select New ODBC Connector.
2. Enter a unique Name for the connector within the project. Use lowercase letters, numbers, and underscores, such as customer_updates.
3. Optionally enter a Description.
4. Select Save.

The name is required. Flowize rejects names containing other characters and names already used by another connector in the project. After saving, the form displays the name as read-only.

Saving a new connector generates an API Key. Open the saved connector to view Webservices Information, which contains the key and, in your Environment, the API URL. Use these values to access the connector API from your external integration.

Install and configure the Gateway Service App

The GSA runs on your external Windows server and communicates with Flowize through the connector's API. The published installation packages are:

• FlowizeGatewayService_Setup_x86.
• FlowizeGatewayService_Setup_x64.

Install the service

1. Download the installation package for your Windows server.
2. Run the installer and select the installation folder. The default location is Program Files.
3. Choose whether to create a desktop shortcut.
4. Select Install.
5. Open Flowize Gateway Service Configuration.

Configure the service

Use the API URL and key from the connector in your Environment.

Setting	What to enter
Flowize Url	The connector's API URL.
API Key	The key for the same connector.
Refresh rate (Seconds)	The interval to wait between requests when no commands remain in the queue.
Select Database Connection	Opens the database connection configuration used to execute commands.

In the database connection configuration, choose Use Data Link File or Use Connection String. The Data Link Properties dialog lets you select a provider and configure its connection details.

Select Save, then Start to begin receiving and executing commands. The configuration app also provides Stop and Restart controls.

How the GSA processes commands

While the service is running, it requests commands from Flowize. Each request retrieves one eligible Ready command and changes its status to Processing. The GSA executes the command against the configured database, reports the result to Flowize, and sends the retrieved data to the command's Callback URL.

The GSA continues requesting commands while work remains in the queue. When no commands remain, it waits for the configured refresh interval before checking again. This refresh interval controls polling; the command's schedule controls when that command becomes eligible for retrieval.

Static commands return to Ready with a new scheduled time after successful completion. Dynamic commands run once and are archived after completion. Errors appear in the command overview.

Callback data

The callback receives the command's output as JSON containing an array of objects. Each object represents a returned record. For example:

[
  { "customer_id": 101, "name": "Customer A" },
  { "customer_id": 102, "name": "Customer B" }
]

Create a scheduled command

1. In the connector's actions menu, select New Command.
2. Enter the required Command to execute. This is the command to execute on your server.
3. Enter the required Callback URL to call after the command has been processed. If the form lists existing URLs, you can select one to fill this field.
4. If you track the last retrieved value, configure Last Field name and Current Last Value as described below.
5. Set Date to start.
6. Configure Interval using the weekday, hour, minute, day, month, and year selectors.
7. Review Next execution time when the preview appears.
8. Select Save.

Commands created from this page have the Static type and start with the Ready status. The schedule determines when a ready command becomes eligible for retrieval by the external integration. Saving a command does not execute it on your server.

The preview updates when you change the start date or interval. After saving, the command page shows Wait till, and the queue shows Next execution on.

When the external integration reports a static command as Done, Flowize records the result in the archive, calculates the next scheduled time, and returns the command to Ready for another run.

Track the last retrieved value

Use Last Field name for the column that identifies the last value retrieved from your system. For example, enter customer_id when that column identifies the last customer retrieved.

The GSA sends Flowize the last value of the column specified in Last Field name. Flowize stores that value and supplies it with the next command so the GSA can use it for @last_value@.

Current Last Value displays the stored value. Select Modify Last Value to edit it, then select Save to store the change.

For example, if Last Field name is date_paid, use the recorded payment date to retrieve recently paid invoices:

SELECT * FROM invoices
WHERE date_paid IS NOT NULL
  AND date_paid >= '@last_value@'

If the GSA reports 2019-06-01 as the last value, the next run uses that date in place of @last_value@ and retrieves invoices paid on or after that date.

Inspect and manage the command queue

In the connector's actions menu, select Commands Queue. The table shows the command and callback URL, Type, Status, Last value, Created, Last Access, and Next execution on. Select Refresh to reload the table when that action is available.

Status	Meaning
Ready	The command can be retrieved when its scheduled time is due.
Processing	The external integration has retrieved the command for processing.
Done	The integration has reported completion.
Error	The integration has reported an error.
Paused	The command is not eligible for retrieval from the queue.

Available row actions depend on the command's status and your access settings:

Action	Available for	Result
Open	Ready, Error, or Paused	Opens the command. Command to execute, Callback URL, and Last Field name are editable for Ready and Error commands; these fields display as read-only for Paused commands.
Pause	Ready	Changes the status to Paused.
Set to Ready	Processing, Error, or Paused	Returns the command to Ready, recalculates its next run time, and clears its previous status message.
Delete	Ready, Error, or Paused	Deletes the command after confirmation.

important

Set to Ready makes a processing command eligible for retrieval again when its scheduled time is due. Check the external integration's progress before using this action.

When the queue has archived commands, select Do you want to see the archived commands? to open Archived Commands. This view shows archived commands, callback URLs, types, statuses, the reporting IP address, and Run on dates. When available, Delete all removes the connector's archived commands after confirmation.

Inspect connection logs

1. Open the connector's actions menu.
2. Select Connection Log.

The log shows Created and IP for recorded connections. Retrieving the next command through the connector API records a connection attempt and updates the connector's Last Access, including when no command is ready to retrieve.

These entries record access to the connector. Review the command queue and archive for command status.

If Delete all is available in the log view, select it and confirm to clear the connector's connection log.

Delete a connector

Select Delete in the connector's actions menu and confirm the deletion. Deleting the connector also removes its connection logs and associated commands from the active queue.

Transition from ODBC Connector

Flowize recommends moving existing integrations to an alternative solution to maintain compatibility and support. Contact the support team for guidance on selecting an alternative and planning the transition. The published guide does not name a replacement or provide a support end date.