TIBCO Scribe® Online Connector For ODBC

ODBC Connections can provide the power and flexibility that you need to integrate data with systems for which TIBCO Scribe® Online does not have a Connector. However, TIBCO does not test all ODBC drivers and not all vendors implement their drivers in such a way that TIBCO Scribe® Online can work with them.

Note: ODBC Connections are only available with Integration and Migration Solutions and require an On-Premise Agent.

Important: Although TIBCO Scribe® Online supports data sources that follow ODBC and SQL standards, not all data sources follow these standards. Best practice is to thoroughly test your particular ODBC driver with TIBCO Scribe® Online. At minimum you should test the following: the ODBC Connection between TIBCO Scribe® Online and the database, creating a Map, reading data from the database, and writing data to the database.

Setup Considerations

For information about the available ODBC DSNs and parameters, see your System Administrator or the ODBC driver documentation provided by the OEM.

Tip: Before creating an ODBC Connection, read the Working With ODBC Connections KB article for information about the ODBC driver you want to use.

Selecting An Agent Type For ODBC

Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.

Connecting To ODBC

Note: Best practice is to create Connections with credentials that limit permissions in the target system, following the principle of least privilege. Using Administrator level credentials in a Connection provides Administrator level access to the target system for TIBCO Scribe® Online users. Depending on the entities supported, a TIBCO Scribe® Online user could alter user accounts in the target system.

  1. Select More > Connections from the menu.
  2. From the Connections page select Add to open the Add a New Connection dialog.
  3. Select the Connector from the drop-down list in the Connection Type field, and then enter the following information for this Connection:  
    • Name — This can be any meaningful name, up to 25 characters.
    • Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
    • DSN — The Data Source Name for this Connection. You can find or add an ODBC System DSN from the ODBC Data Source Administrator on the computer where the TIBCO Scribe® Online On-Premise Agent is installed. While the ODBC Data Source Administrator displays all available ODBC Data Sources; TIBCO cannot guarantee that a specific ODBC driver will work with TIBCO Scribe® Online.
    • Authentication — Select:
      • Application (default) — Select to use the login credentials for the ODBC application. If set to Application, the User name and Password are required.
      • Windows — Select if using a Windows user account to authenticate the database connection.

        Note: For information about which authentication mode to use, see your System Administrator.

    • User Name/Password — The user name and password to connect to this DSN.
    • Select Tables For Schema — Optionally, to process the data in tables associated with a single schema for this ODBC Connection, enter the schema name. If left blank, TIBCO Scribe® Online uses all schemas for this Connection.

      Tip: If you specify a schema, reset metadata for this Connection after you create or edit it. See Resetting Metadata.

  4. Select Test to ensure that the Agent can connect to your database. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
  5. Select OK to save the Connection.

Metadata Notes


Connection metadata must have unique entity, relationship, and field names. If your Connection metadata has duplicate names, review the source system to determine if the duplicates can be renamed.

TIBCO Scribe® Online API Considerations

To create Connections with the TIBCO Scribe® Online API, the ODBC Connector requires the following information:

Connector Name


Connector ID


TIBCO Scribe® Online Connection Properties

In addition, this Connector uses the Connection properties shown in the following table.

Note: Connection property names are case-sensitive.

Name Data Type Required Secured











Supported values:

  false = application

  true = windows
















License Agreement

The TIBCO Scribe® Online End User License Agreement for the ODBC Connector describes TIBCO and your legal obligations and requirements. TIBCO suggests that you read the End User License Agreement.

More Information

For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.