This article provides a brief overview of the Salesforce cloud provider for UniDAC used to access Salesforce from Delphi and Lazarus. You will find the description of some useful features and how to get started quickly.
Main features of Salesforce cloud provider are:
The full list of Cloud provider features can be found on the UniDAC features page.
Both Professional and Standard Editions of UniDAC include the Salesforce cloud provider.
Salesforce provider supports Salesforce data types and API.
Applications that use the Salesforce cloud provider require Devart ODBC Driver for Salesforce to be installed on the client computer. The driver is sold and distributed separately from UniDAC.
When an application was built without runtime packages (Link with runtime packages set to False in Project Options), you do not need to deploy any BPL files with it. For more information, see Deployment.
Note that UniDAC Trial requires deployment of additional BPL files regardless of Link with runtime packages.
To connect to Salesforce using Devart ODBC Driver, you should configure the driver and set up a DSN. In the TUniConnection component, specify the following parameters:
If using OAuth2.0 authentication, you need to specify the Refresh Token. It is available when the OAuth 2.0 authentication type is selected.
For more information on how to obtain Salesforce SecurityToken, see the article.
In the TUniConnection component, specify the following parameters:
Though UniDAC is components that provide a unified interface to work with various cloud services, it also lets you tune behaviour for each cloud individually. For thin setup of a certain cloud, UniDAC provides specific options. These options can be applied to such components as TUniConnection, TUniQuery, TUniTable, TUniStoredProc, TUniSQL, TUniScript via their SpecificOptions property. SpecificOptions is a sting list.
Below you will find the description of allowed options grouped by components.
Option name | Description |
---|---|
Authentication |
The authentication type to use when connecting to Salesforce. Defaults to OAuth.
OAuth
The OAuth 2.0 authentication.
User ID and Password
The basic user/password authentication.
|
ConnectionTimeout | The time to wait for a connection to open before raising an exception. |
IncludeDeleted | If set to True, the result set of a query will contain deleted records that are visible in the recycle bin. The default value is False. |
RefreshToken | This option is available when the OAuth 2.0 authentication type is selected. |
SecurityToken | Enter the security token of your Salesforce account in this field. |
Server |
This option specifies the URL of the Salesforce server. Supported domains include:
|
UseUnicode | Enables or disables Unicode support. Affects character data fetched from the server. When set to True, all character data is stored as WideStrings, and TStringField is replaced by TWideStringFiled. |
UTCDates | Use the UTCDates option to return the datetime values from the data source as UTC values. |
Option name | Description |
---|---|
ProxyPassword | If Proxy User authorization is used, specify Proxy user password in this option. |
ProxyPort | Specify the Proxy port here. You can learn Proxy Port in the same way as described above for the host. |
ProxyServer |
If you are using Proxy for connection to your network, specify the Proxy server address in this option.
To learn your Proxy server address, open Control Panel->Internet Options->Connections->LAN settings. |
ProxyUser | If Proxy User authorization is used, specify Proxy user name (ID) in this option. |
Refresh Token | The Salesforce OAuth 2.0 token. Available when the OAuth 2.0 authentication type is selected. |
Option name | Description |
---|---|
CommandTimeout | The time to wait for a statement to be executed. |
Option name | Description |
---|---|
CommandTimeout | The time to wait for a statement to be executed. |
ExtendedFieldsInfo | If True, an additional query is performed to get information about the returned fields and tables they belong to. The default value is False. |
FetchAll |
If True, all records of a query are requested from database server when the dataset is being opened.
If False, records are retrieved when a data-aware component or a program requests it. The default value is False. |
FieldsAsString | If set to True, all non-BLOB fields are handled as strings. The default value is False. |
UnknownAsString | If set to True, all Salesforce data types that are fetched as text and don't have the size limit, are mapped to TStringField with the default size 8192 bytes. If False (default value), such types are mapped to TMemoField. The TEXT data type is always mapped to TMemoField regardless of the value of this option. |
The TUniDump component has no Salesforce-specific options.
The TUniLoader component has no Salesforce-specific options.
The TUniDump component has no Salesforce-specific options.