BizTalk Adapter for Sybase

Build 21.0.8137

Connection Properties

Connection String Options  

The connection string properties describe the various options that can be used to establish a connection.

Adapter

CData.BizTalk.SybaseAdapter.dll

Remarks

The connection string can be set to a series of "option=value" pairs, separated by semicolons. If a connection string property value has special characters such as semicolons, single quotes, spaces, etc., then you must quote the value using either single or double quotes.

Connection options are case insensitive.

Connecting to Sybase

To connect to the Sybase, specify the following connection properties:

  • Server: Set this to the name or network address of the Sybase database instance.
  • Database: Set this to the name of the Sybase database running on the specified Server.

Optionally, you can also secure your connections with TLS/SSL by setting UseSSL to true.

Authenticating to Sybase

Sybase supports several methods for authentication including basic, Kerberos, and, LDAP.

Connect Using Basic Authentication

Set the AuthScheme to Basic and set the following connection properties to use Sybase authentication.

  • User: Set this to the username of the authenticating Sybase user.
  • Password: Set this to the username of the authenticating Sybase user.

Connect using LDAP Authentication

To connect with LDAP authentication, you will need to configure Sybase server-side to use the LDAP authentication mechanism.

After configuring Sybase for LDAP, you can connect using the same credentials as basic authentication.

Connect Using Kerberos Authentication

To leverage Kerberos authentication, begin by enabling it via the following connection property:

  • AuthScheme: Set to Kerberos will be used for authentication to Sybase.
See Using Kerberos information regarding the connection properties that need to be set for Kerberos authentication.

You can find an example connection string below:

Server=MyServer;Port=MyPort;User=SampleUser;Password=SamplePassword;Database=MyDB;Kerberos=true;KerberosKDC=MyKDC;KerberosRealm=MYREALM.COM;KerberosSPN=server-name

Connection String Options


The connection string options available in this provider are divided into the following categories. Click on the links for further details.

Authentication


PropertyDescription
AuthSchemeThe scheme used for authentication. Accepted entries are Password, Kerberos.
ServerThe name of the server running Sybase Database.
PortThe port of the Sybase database.
DatabaseThe name of the Sybase database.
UserThe Sybase user account used to authenticate.
PasswordThe password used to authenticate the user.
CharsetChaeset name to communicate with server.
UseSSLThis field sets whether SSL is enabled.
AlternateServersThis property allows you to specify multiple servers in addition to the one configured in Server and Port . Specify both a server name and port; separate servers with a comma.

Kerberos


PropertyDescription
KerberosKDCThe Kerberos Key Distribution Center (KDC) service used to authenticate the user.
KerberosRealmThe Kerberos Realm used to authenticate the user with.
KerberosSPNThe service principal name (SPN) for the Kerberos Domain Controller.
KerberosKeytabFileThe Keytab file containing your pairs of Kerberos principals and encrypted keys.
KerberosServiceRealmThe Kerberos realm of the service.
KerberosServiceKDCThe Kerberos KDC of the service.
KerberosTicketCacheThe full file path to an MIT Kerberos credential cache file.

SSL


PropertyDescription
SSLClientCertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertTypeThe type of key store containing the TLS/SSL client certificate.
SSLClientCertPasswordThe password for the TLS/SSL client certificate.
SSLClientCertSubjectThe subject of the TLS/SSL client certificate.
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Logging


PropertyDescription
LogfileA filepath which designates the name and location of the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous


PropertyDescription
EncryptPasswordThis field sets whether password encryption is enabled.
IgnoreGroupNumberWhether to return group number (like ';num') of procedure when list procedures.
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
MaxTDSPacketSizeThe protocol sending and receiving buffer size. For the lower version, it's from 512 to 512. For the newer version, it's from 512 to 2048.
OtherThese hidden properties are used only in specific use cases.
QueryPassthroughThis option passes the query to the Sybase server as is.
ReadonlyYou can use this property to enforce read-only access to Sybase from the provider.
RTKThe runtime key used for licensing.
SwitchModeThis property allows you to specify a switching mode to select a server from AlternateServers as the active server.
SwitchStrategyThis property allows you to specify a switching strategy to select a server from AlternateServers as the active server.
TimeoutA timeout for the provider.

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 21.0.8137