Getting Started

This page provides a guide to Establishing a Connection to Salesforce in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Salesforce

Establishing a Connection shows how to authenticate to Salesforce and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Salesforce through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to Salesforce by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Salesforce

By default, the Cloud connects to production environments.

To use a Salesforce sandbox account, set UseSandbox to true and be sure to specify a sandbox username in User.

Authenticating to Salesforce

Salesforce supports authentication via either user credentials, or the OAuth standard.

User Credentials

Authentication with user credentials generally requires the additional use of a security token. The security token can only be obtained from Salesforce. To request the security token:

Open the personal information page on Salesforce.com.
Click the link to reset your security token. The token will be emailed to you.
Specify the security token in the SecurityToken connection property or append it to the Password.

To eliminate the need for a security token:

Log in to Salesforce and enter Network Access in the Quick Find box in the setup section.
Add your IP address to the list of trusted IP addresses.

When you are ready to connect, set these parameters:

AuthScheme: Basic.
User: The user's login ID.
Password The user's password.
SecurityToken (optional): The security token you obtained from Salesforce.

If you want to connect without using a security token, you must disable the security token as follows:

Log in to Salesforce and enter Network Access in the Quick Find box in the setup section.
Add your IP address to the list of trusted IP addresses.

OAuth

Salesforce provides embedded OAuth credentials that simplify connection from a Desktop application . To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to Salesforce from the available OAuth flows. For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Salesforce, see Connection.

OAuth Password Grant

Follow these steps to set up the Password Grant option:

Set the AuthScheme to OAuthPassword to perform authentication with the password grant type.
Set all the properties specified in either the web or desktop authentication sections above.
Set the User and Password to your login credentials, as well as the SecurityToken if required.

Note: If you have enabled Session Settings > Lock sessions to the IP address from which they originated, make sure that your IP address does not change while using the Cloud. If the IP changes during the usage of the Cloud, an "INVALID_SESSION_ID" error is returned from Salesforce and the Cloud will no longer be able to retrieve data. If you receive this error, ask your Salesforce administrator to disable this configuration or make sure to configure a static IP for the instance where you are using the Cloud. Then, reset the connection to continue using the Cloud.

OAuthJWT Certificates

Set the AuthScheme to OAuthJWT.

OAuthJWT

To obtain the OAuthJWT consumer key:

Log in to Salesforce.com.
From Setup, enter Apps in the Quick Find box and then click the link to create an app. In the Connected Apps section of the resulting page, click New.
Enter a name to be displayed to users when they log in to grant permissions to your app, along with a contact Email address.
Click Enable OAuth Settings and enter a value in the Callback URL box. Set this value only to create the Connected App as it is required. It will not actually be needed for this type of authentication. The Callback URL is in the format:
```
http://localhost:8019/src/oauthCallback.rst
```
Enable Use digital signatures.
Upload your certificate.
Select the scope of permissions that your app should request from the user.
Click your app name to open a page with information about your app. The OAuth consumer key is displayed.

After creating your OAuth Application, set the following connection properties:

AuthScheme: OAuthJWT.
InitiateOAuth: GETANDREFRESH.
OAuthJWTCert: The JWT Certificate store.
OAuthJWTCertType: The type of the certificate store specified by OAuthJWTCert.
OAuthJWTCertPassword: The Password of the JWT Certificate store.
OAuthJWTIssuer: The OAuth Client ID.
OAuthJWTSubject: The username (email address) to the permitteed User Profile configured in the OAuth Connected App.

Note: This flow never issues a refresh token.

AzureAD

Set the AuthScheme to AzureAD. Use the following connection properties to connect to AzureAD:

SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.

Note that this configuration requires two AAD applications: the "Salesforce" application used for single sign-on, and a separate "connector" application with user_impersonation permission on the "Salesforce" application. You must also specify the OAuth connection properties:

OAuthClientId: The application Id of the connector application, listed in the Overview section of the app registration.
OAuthClientSecret: The client secret value of the connector application. Azure AD displays this when you create a new client secret.

Use the following SSOProperties to authenticate to AzureAD:

Resource: The application Id URI of the Salesforce application, listed in the Overview section of the app registration. In most cases this is the URL of your custom Salesforce domain.
AzureTenant: The Id of the Azure AD tenant where the applications are registered.

The following is an example connection string:

AuthScheme=AzureAD;InitiateOAuth=GETANDREFRESH;OAuthClientId=3ea1c786-d527-4399-8c3b-2e3696ae4b48;OauthClientSecret=xxx;SSOProperties='Resource=https://example.my.salesforce.com;AzureTenant=6ee709df-9de0-4cdf-10e6b7a51d95';

Okta

Set the AuthScheme to Okta. Use the following connection properties to connect to Okta:

User: The Okta user.
Password: The Okta user's password.
SSOLoginURL: The SSO provider's login URL.
SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.

In SSOProperties, when required, set these input parameters:

APIToken (optional): The API Token that the customer created from the Okta org. You should use this when authenticating a user via a trusted application or proxy that overrides OKTA client request context.
MFAType (optional): Only required if you have configured MFA flow. Currently we support only the following types: OktaVerify, Email, and SMS.
MFAPassCode (optional): Only required if you have configured MFA flow. If this is set to empty/invalid the driver initially issues a MFA challenge that triggers the platform to send you a one-time password on your device or email, based on the configured MFA type. You need to re-issue another connection where the retrieved one-time password value is passed to MFAPassCode connection property.

Example connection string:

AuthScheme=OKTA;User=OktaUserName;Password=OktaPassword;SSOLoginURL='https://subdomain.okta.com/app/salesforce/app/sso/saml';SSOExchangeURL='https://subdomain.my.salesforce.com/services/oauth2/token';

OneLogin

Set the AuthScheme to OneLogin. Use the following connection properties to connect to OneLogin:

User: The OneLogin user.
Password: The OneLogin user's password.
SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.

You need the following SSOProperties to authenticate to OneLogin:

OAuthClientId: The OAuthClientId. If you do not already have this, find it by navigating to Developers > API Credentials > Credential > ClientId.
OAuthClientSecret: The OAuthClientSecret. If you do not already have this, find it by navigating to Developers > API Credentials > Credential > ClientSecret.
Subdomain: The subdomain of the OneLogin user accessing the SSO app. For example, if your OneLogin URL is splinkly.onelogin.com, the subdomain value is splinkly.
AppId: The ID of the SSO app.
Region (optional): The region where your OneLogin account resides. The OneLogin API operates in multiple regions and this property is used to find the correct domain. Legal values are US (default) and EU.

Example connection string:

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;SSOProperties='OAuthClientID=3fc8394584f153ce3b7924d9cd4f686443a52b;OAuthClientSecret=ca9257fd5cc3277abb5818cea28c06fe9b3b285d73d06;Subdomain=OneLoginSubDomain;AppId=1433920';

PingFederate

Set the AuthScheme to PingFederate. The following connection properties need to be set:

User: The PingFederate user.
Password: The PingFederate user's password.
SSOLoginURL: The SSO provider's login URL.
SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.

Among SSOProperties to authenticate to PingFederate:

AuthScheme (optional): The authorization scheme to be used for the IdP endpoint. Legal values are None or Basic.

You can also use the following SSOProperties to configure mutual SSL authentication for SSOLoginURL, the WS-Trust STS endpoint:

SSLClientCert
SSLClientCertType
SSLClientCertSubject
SSLClientCertPassword

Example connection string:

AuthScheme=PingFederate;User=pingFederateUser;Password=pingFederatePassword;SSOLoginURL='https://<authority>/idp/sts.wst';SSOExchangeUrl='https://domain.my.salesforce.com/services/oauth2/token?so=00D3000006JDF';

ADFS

Set the AuthScheme to ADFS and set these properties:

User: The ADFS user.
Password: The ADFS user's password.
SSOLoginURL: The SSO provider's login URL.
SSOExchangeUrl: The Salesforce OAuth 2.0 token endpoint for the identity provider. This can be found in the Salesforce account settings by navigating to Administration Setup > Security Controls > SAML Single Sign-On Settings and then choosing the desired organization.

You need the following SSOProperties to authenticate to ADFS:

RelyingParty: The value of the Relying Party Identifier on the ADFS server for Salesforce.

Example connection string:

AuthScheme=ADFS;User=username;Password=password;SSOLoginURL='https://sts.company.com';SSOProperties='RelyingParty=https://saml.salesforce.com';

ADFS Integrated

The ADFS Integrated flow indicates you are connecting with the currently logged in Windows user credentials. To use the ADFS Integrated flow, do not specify the User and Password, but otherwise follow the same steps in the ADFS guide above.

OAuth Scopes and Endpoints

Required Scopes and Endpoint Domains for Salesforce

When integrating with Salesforce, your application needs specific permissions to interact with the API.

These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.

This topic provides information about the required access scopes and endpoint domains for the Salesforce Cloud.

Understanding Scopes

Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.

For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.

Required Scopes for Salesforce


Scope	Description
full	Allows access to all data accessible by the logged-in user, and encompasses all other scopes. Required for write access.
api	Allows access to the current, logged-in user’s account using APIs, such as REST API and Bulk API 2.0. This scope also includes chatter_api, which allows access to Connect REST API resources. Required for read access.
chatter_api	Allows access to Connect REST API resources on behalf of the user.
refresh_token	Allows a refresh token to be returned when the requesting client is eligible to receive one. With a refresh token, the app can interact with the user’s data while the user is offline. This token is synonymous with requesting offline_access. Required for read access.
id	Allows access to the identity URL service. You can request profile, email, address, or phone individually to get the same result as using id because they’re synonymous. Required for read access.
visualforce	Allows access to customer-created Visualforce pages only. This scope doesn’t allow access to standard Salesforce UIs.
web	Allows use of the access_token on the web. This scope also includes visualforce, allowing access to customer-created Visualforce pages. Required for read access.

Understanding Endpoint Domains

Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.

Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.

Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.

Required Endpoint Domains for Salesforce


Domain	Always Required	Description
test.salesforce.com	FALSE	The subdomain used to access sandbox instances of Salesforce.
<Site>.my.salesforce.com	TRUE	The domain of your Salesforce site.
<LoginURL>	FALSE	The login URL specified in LoginURL. The default value is login.salesforce.com.
<SSOLoginURL>	FALSE	The login URL of your SSO provider. Required when AuthScheme is set to OKTA, PingFederate, or ADFS.
<Subdomain>.onelogin.com	FALSE	The subdomain of onelogin.com specified in SSOProperties. Required if AuthScheme is set to OKTA.
<SSOExchangeURL>	FALSE	Your SSO Exchange URL. Required when AuthScheme is set to OKTA, PingFederate, ADFS, OneLogin, or AzureAD.
<Resource>	FALSE	The Azure AD resource URL specified in SSOProperties. Required when AuthScheme is set to AzureAD.
<RelyingParty>	FALSE	The URI of your ADFS relying party, specified in SSOProperties. Required when AuthScheme is set to ADFS.

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

You can use the Cloud to work with all of the tables in your account. The Cloud connects to Salesforce and gets the list of tables and the metadata for the tables by calling the appropriate web services. Any changes you make to your Salesforce account, such as adding a new table, adding new columns, or changing the data type of a column, are immediately reflected when you connect using the Cloud.

Tables

The Cloud models the Salesforce API as relational Tables. The table definitions are dynamically retrieved; here, we show the sample table definitions that are included in the Salesforce.com development environment.

In addition to the tables, the Cloud also offers stored procedures and views, enabling you to work with other aspects of the Salesforce API, like bulk jobs, custom reports, and so on.

Stored Procedures

Stored Procedures are function-like interfaces to Salesforce. They can be used to search, update, and modify information in Salesforce.

Views

Views offer additional metadata information from Salesforce.

Working with Polymorphic Fields

Polymorphic Fields explains how to work with related objects as different types of objects.

Data Type Mapping

The Cloud maps types from the data source to the corresponding data type available in the schema. The following table documents these mappings.

Data Type Mapping


Salesforce UI	Salesforce API Type	CData Schema
Auto Number	string	string
Lookup Relationship	ID	string
Master-Detail Relationship	ID	string
External Lookup Relationship	ID	string
Checkbox	boolean	bool
Currency	double	float
Date	date	date
Date/Time	datetime	datetime
Email	string	string
Geolocation	Location*	string
Number	double	float
Percent	double	float
Phone	string	string
Picklist	string	string
Picklist (Multi-Select)	string	string
Text	string	string
Text Area	string	string
Text Area (Long)	string	string
Text Area (Rich)	string	string
Text (Encrypted)	string	string
Time	time	time
URL	string	string

Note: Entries marked with an asterisk "*" indicate a structured data type containing latitude and longitude.

Polymorphic Fields

Working with Polymorphic Fields

A polymorphic field is one where the related object might be one of several different types of objects. For example, the WhoID field of a Task can be a Contact or a Lead. To find out if a field is polymorphic, you can query the sys_tablecolumns and check the IsPolymorphic column. There are two pseudo columns related to each polymorphic field:

{PolymorphicField}Type Column
{PolymorphicField}ExternalID Column

The pseudo columns are used to efficiently work with polymorphic fields.

Polymorphic Field Types

{PolymorphicField}type can be used in the criteria to specify the type of object the polymorphic relates to. For example: To query only the tasks where the Owner relationship is of type User, the following query can be used:

SELECT * FROM Task WHERE OwnerIDType = 'User'

For INSERT/UPDATE/UPSERT statements, the polymorphic fields can be used directly, or instead of having to look up the ID of a specific object type, the {PolymorphicField}ExternalID can be used. For example, when trying to update the WhoID of a task, instead of having to find the ID which belongs to a specific Contact, a contact external ID field can be used as a reference. Let's say the contact has an external ID "ContactEmail__c". Instead of using:

SELECT ID FROM Contact WHERE ContactEmail__c = '[email protected]'
UPDATE Task SET WhoID = ID from first query

The following can be executed:

UPDATE Task SET WhoID='[email protected]', WhoIDType='Contact', WhoIDExternalID = 'ContactEmail__c'

This tells the service to set the WhoID value for this task to whichever contact ID has the external ID ContactEmail__c equals to [email protected]. The same applies to INSERT & UPSERT statements.

Salesforce Reports and Dashboards API

The Salesforce Cloud enables you to request and access tabular, summary, and matrix reports. The driver retrieves report data directly from Salesforce (server-side). You can further aggregate and filter report data client-side.

To access reports with the driver, set IncludeReports to true.

To get a list of the available reports, run:

SELECT * FROM sys_tables WHERE IsReport='true'

Tabular Reports

Tabular reports are reports that have no grouping fields.

Salesforce limits the number of rows allowed in a single report to no more than 2,000 rows. To ensure that all your data is retrieved properly, we recommend that you use filters to create reports that are narrowed down to a specific view. A limited report is more likely to fit within the row limit.

Summary and Matrix Reports

Summary or Matrix reports are reports that contain grouping fields.

For these report types, the driver does not currently support the Preview feature (Detailed rows = ON). However, the driver does expose a report summary with groupings, summary formulas, and record counts as a view. To get the detailed information, you can clone this report and remove the groupings. This turns the view into a tabular report.

Query examples

SELECT * FROM Report_Accounts_With_Contacts
SELECT Max(AnnualRevenue) FROM Report_Accounts_With_Contacts

Tables

The Cloud models the data in Salesforce as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Salesforce Tables


Name	Description
AcceptedEventRelation	This is a table representing the AcceptedEventRelation entities in Salesforce.
Account	This is a table representing the Account entities in Salesforce.
AccountContactRole	This is a table representing the AccountContactRole entities in Salesforce.
AccountFeed	This is a table representing the AccountFeed entities in Salesforce.
AccountHistory	This is a table representing the AccountHistory entities in Salesforce.
AccountPartner	This is a table representing the AccountPartner entities in Salesforce.
AccountShare	This is a table representing the AccountShare entities in Salesforce.
AdditionalNumber	This is a table representing the AdditionalNumber entities in Salesforce.
ApexClass	This is a table representing the ApexClass entities in Salesforce.
ApexComponent	This is a table representing the ApexComponent entities in Salesforce.
ApexLog	This is a table representing the ApexLog entities in Salesforce.
ApexPage	This is a table representing the ApexPage entities in Salesforce.
ApexTestQueueItem	This is a table representing the ApexTestQueueItem entities in Salesforce.
ApexTestResult	This is a table representing the ApexTestResult entities in Salesforce.
ApexTrigger	This is a table representing the ApexTrigger entities in Salesforce.
AppMenuItem	This is a table representing the AppMenuItem entities in Salesforce.
Approval	This is a table representing the Approval entities in Salesforce.
Asset	This is a table representing the Asset entities in Salesforce.
AssetFeed	This is a table representing the AssetFeed entities in Salesforce.
AssignmentRule	This is a table representing the AssignmentRule entities in Salesforce.
AsyncApexJob	This is a table representing the AsyncApexJob entities in Salesforce.
Attachment	This is a table representing the Attachment entities in Salesforce.
AuthProvider	This is a table representing the AuthProvider entities in Salesforce.
AuthSession	This is a table representing the AuthSession entities in Salesforce.
BrandTemplate	This is a table representing the BrandTemplate entities in Salesforce.
BusinessHours	This is a table representing the BusinessHours entities in Salesforce.
BusinessProcess	This is a table representing the BusinessProcess entities in Salesforce.
CallCenter	This is a table representing the CallCenter entities in Salesforce.
Campaign	This is a table representing the Campaign entities in Salesforce.
CampaignFeed	This is a table representing the CampaignFeed entities in Salesforce.
CampaignMember	This is a table representing the CampaignMember entities in Salesforce.
CampaignMemberStatus	This is a table representing the CampaignMemberStatus entities in Salesforce.
CampaignShare	This is a table representing the CampaignShare entities in Salesforce.
Case	This is a table representing the Case entities in Salesforce.
CaseComment	This is a table representing the CaseComment entities in Salesforce.
CaseContactRole	This is a table representing the CaseContactRole entities in Salesforce.
CaseFeed	This is a table representing the CaseFeed entities in Salesforce.
CaseHistory	This is a table representing the CaseHistory entities in Salesforce.
CaseShare	This is a table representing the CaseShare entities in Salesforce.
CaseSolution	This is a table representing the CaseSolution entities in Salesforce.
CaseStatus	This is a table representing the CaseStatus entities in Salesforce.
CaseTeamMember	This is a table representing the CaseTeamMember entities in Salesforce.
CaseTeamRole	This is a table representing the CaseTeamRole entities in Salesforce.
CaseTeamTemplate	This is a table representing the CaseTeamTemplate entities in Salesforce.
CaseTeamTemplateMember	This is a table representing the CaseTeamTemplateMember entities in Salesforce.
CaseTeamTemplateRecord	This is a table representing the CaseTeamTemplateRecord entities in Salesforce.
CategoryData	This is a table representing the CategoryData entities in Salesforce.
CategoryNode	This is a table representing the CategoryNode entities in Salesforce.
ChatterActivity	This is a table representing the ChatterActivity entities in Salesforce.
ClientBrowser	This is a table representing the ClientBrowser entities in Salesforce.
CollaborationGroup	This is a table representing the CollaborationGroup entities in Salesforce.
CollaborationGroupFeed	This is a table representing the CollaborationGroupFeed entities in Salesforce.
CollaborationGroupMember	This is a table representing the CollaborationGroupMember entities in Salesforce.
CollaborationGroupMemberRequest	This is a table representing the CollaborationGroupMemberRequest entities in Salesforce.
CollaborationInvitation	This is a table representing the CollaborationInvitation entities in Salesforce.
Community	This is a table representing the Community entities in Salesforce.
Contact	This is a table representing the Contact entities in Salesforce.
ContactFeed	This is a table representing the ContactFeed entities in Salesforce.
ContactHistory	This is a table representing the ContactHistory entities in Salesforce.
ContactShare	This is a table representing the ContactShare entities in Salesforce.
ContentDocument	This is a table representing the ContentDocument entities in Salesforce.
ContentDocumentFeed	This is a table representing the ContentDocumentFeed entities in Salesforce.
ContentDocumentHistory	This is a table representing the ContentDocumentHistory entities in Salesforce.
ContentDocumentLink	This is a table representing the ContentDocumentLink entities in Salesforce.
ContentVersion	This is a table representing the ContentVersion entities in Salesforce.
ContentVersionHistory	This is a table representing the ContentVersionHistory entities in Salesforce.
Contract	This is a table representing the Contract entities in Salesforce.
ContractContactRole	This is a table representing the ContractContactRole entities in Salesforce.
ContractFeed	This is a table representing the ContractFeed entities in Salesforce.
ContractHistory	This is a table representing the ContractHistory entities in Salesforce.
ContractStatus	This is a table representing the ContractStatus entities in Salesforce.
CronJobDetail	This is a table representing the CronJobDetail entities in Salesforce.
CronTrigger	This is a table representing the CronTrigger entities in Salesforce.
Dashboard	This is a table representing the Dashboard entities in Salesforce.
DashboardComponent	This is a table representing the DashboardComponent entities in Salesforce.
DashboardComponentFeed	This is a table representing the DashboardComponentFeed entities in Salesforce.
DashboardFeed	This is a table representing the DashboardFeed entities in Salesforce.
DeclinedEventRelation	This is a table representing the DeclinedEventRelation entities in Salesforce.
Document	This is a table representing the Document entities in Salesforce.
DocumentAttachmentMap	This is a table representing the DocumentAttachmentMap entities in Salesforce.
Domain	This is a table representing the Domain entities in Salesforce.
DomainSite	This is a table representing the DomainSite entities in Salesforce.
EmailServicesAddress	This is a table representing the EmailServicesAddress entities in Salesforce.
EmailServicesFunction	This is a table representing the EmailServicesFunction entities in Salesforce.
EmailTemplate	This is a table representing the EmailTemplate entities in Salesforce.
EntitySubscription	This is a table representing the EntitySubscription entities in Salesforce.
Event	This is a table representing the Event entities in Salesforce.
EventFeed	This is a table representing the EventFeed entities in Salesforce.
EventRelation	This is a table representing the EventRelation entities in Salesforce.
FeedComment	This is a table representing the FeedComment entities in Salesforce.
FeedItem	This is a table representing the FeedItem entities in Salesforce.
FeedPollChoice	This is a table representing the FeedPollChoice entities in Salesforce.
FeedPollVote	This is a table representing the FeedPollVote entities in Salesforce.
FieldPermissions	This is a table representing the FieldPermissions entities in Salesforce.
FiscalYearSettings	This is a table representing the FiscalYearSettings entities in Salesforce.
Folder	This is a table representing the Folder entities in Salesforce.
ForecastShare	This is a table representing the ForecastShare entities in Salesforce.
Group	This is a table representing the Group entities in Salesforce.
GroupMember	This is a table representing the GroupMember entities in Salesforce.
HashtagDefinition	This is a table representing the HashtagDefinition entities in Salesforce.
Holiday	This is a table representing the Holiday entities in Salesforce.
Lead	This is a table representing the Lead entities in Salesforce.
LeadFeed	This is a table representing the LeadFeed entities in Salesforce.
LeadHistory	This is a table representing the LeadHistory entities in Salesforce.
LeadShare	This is a table representing the LeadShare entities in Salesforce.
LeadStatus	This is a table representing the LeadStatus entities in Salesforce.
LoginHistory	This is a table representing the LoginHistory entities in Salesforce.
LoginIp	This is a table representing the LoginIp entities in Salesforce.
MailmergeTemplate	This is a table representing the MailmergeTemplate entities in Salesforce.
MobileDeviceRegistrar	This is a table representing the MobileDeviceRegistrar entities in Salesforce.
Note	This is a table representing the Note entities in Salesforce.
ObjectPermissions	This is a table representing the ObjectPermissions entities in Salesforce.
Opportunity	This is a table representing the Opportunity entities in Salesforce.
OpportunityCompetitor	This is a table representing the OpportunityCompetitor entities in Salesforce.
OpportunityContactRole	This is a table representing the OpportunityContactRole entities in Salesforce.
OpportunityFeed	This is a table representing the OpportunityFeed entities in Salesforce.
OpportunityFieldHistory	This is a table representing the OpportunityFieldHistory entities in Salesforce.
OpportunityHistory	This is a table representing the OpportunityHistory entities in Salesforce.
OpportunityLineItem	This is a table representing the OpportunityLineItem entities in Salesforce.
OpportunityPartner	This is a table representing the OpportunityPartner entities in Salesforce.
OpportunityShare	This is a table representing the OpportunityShare entities in Salesforce.
OpportunityStage	This is a table representing the OpportunityStage entities in Salesforce.
Organization	This is a table representing the Organization entities in Salesforce.
OrgWideEmailAddress	This is a table representing the OrgWideEmailAddress entities in Salesforce.
Partner	This is a table representing the Partner entities in Salesforce.
PartnerRole	This is a table representing the PartnerRole entities in Salesforce.
Period	This is a table representing the Period entities in Salesforce.
PermissionSet	This is a table representing the PermissionSet entities in Salesforce.
PermissionSetAssignment	This is a table representing the PermissionSetAssignment entities in Salesforce.
PermissionSetLicense	This is a table representing the PermissionSetLicense entities in Salesforce.
PermissionSetLicenseAssign	This is a table representing the PermissionSetLicenseAssign entities in Salesforce.
Pricebook2	This is a table representing the Pricebook2 entities in Salesforce.
Pricebook2History	This is a table representing the Pricebook2History entities in Salesforce.
PricebookEntry	This is a table representing the PricebookEntry entities in Salesforce.
ProcessDefinition	This is a table representing the ProcessDefinition entities in Salesforce.
ProcessInstance	This is a table representing the ProcessInstance entities in Salesforce.
ProcessInstanceStep	This is a table representing the ProcessInstanceStep entities in Salesforce.
ProcessInstanceWorkitem	This is a table representing the ProcessInstanceWorkitem entities in Salesforce.
ProcessNode	This is a table representing the ProcessNode entities in Salesforce.
Product2	This is a table representing the Product2 entities in Salesforce.
Product2Feed	This is a table representing the Product2Feed entities in Salesforce.
Profile	This is a table representing the Profile entities in Salesforce.
PushTopic	This is a table representing the PushTopic entities in Salesforce.
QueueSobject	This is a table representing the QueueSobject entities in Salesforce.
Quote	This is a table representing the Quote entities in Salesforce.
QuoteDocument	This is a table representing the QuoteDocument entities in Salesforce.
QuoteFeed	This is a table representing the QuoteFeed entities in Salesforce.
QuoteLineItem	This is a table representing the QuoteLineItem entities in Salesforce.
RecentlyViewed	This is a table representing the RecentlyViewed entities in Salesforce.
RecordType	This is a table representing the RecordType entities in Salesforce.
Report	This is a table representing the Report entities in Salesforce.
ReportFeed	This is a table representing the ReportFeed entities in Salesforce.
Scontrol	This is a table representing the Scontrol entities in Salesforce.
SelfServiceUser	This is a table representing the SelfServiceUser entities in Salesforce.
SetupEntityAccess	This is a table representing the SetupEntityAccess entities in Salesforce.
Site	This is a table representing the Site entities in Salesforce.
SiteFeed	This is a table representing the SiteFeed entities in Salesforce.
SiteHistory	This is a table representing the SiteHistory entities in Salesforce.
Solution	This is a table representing the Solution entities in Salesforce.
SolutionFeed	This is a table representing the SolutionFeed entities in Salesforce.
SolutionHistory	This is a table representing the SolutionHistory entities in Salesforce.
SolutionStatus	This is a table representing the SolutionStatus entities in Salesforce.
StaticResource	This is a table representing the StaticResource entities in Salesforce.
Task	This is a table representing the Task entities in Salesforce. To retrieve archived tasks, you must explicitly query for records with IsArchived set to True.
TaskFeed	This is a table representing the TaskFeed entities in Salesforce.
TaskPriority	This is a table representing the TaskPriority entities in Salesforce.
TaskStatus	This is a table representing the TaskStatus entities in Salesforce.
Topic	This is a table representing the Topic entities in Salesforce.
TopicAssignment	This is a table representing the TopicAssignment entities in Salesforce.
TopicFeed	This is a table representing the TopicFeed entities in Salesforce.
UndecidedEventRelation	This is a table representing the UndecidedEventRelation entities in Salesforce.
User	This is a table representing the User entities in Salesforce.
UserFeed	This is a table representing the UserFeed entities in Salesforce.
UserLicense	This is a table representing the UserLicense entities in Salesforce.
UserLogin	This is a table representing the UserLogin entities in Salesforce.
UserPreference	This is a table representing the UserPreference entities in Salesforce.
UserProfile	This is a table representing the UserProfile entities in Salesforce.
UserRecordAccess	This is a table representing the UserRecordAccess entities in Salesforce.
UserRole	This is a table representing the UserRole entities in Salesforce.
Vote	This is a table representing the Vote entities in Salesforce.
WebLink	This is a table representing the WebLink entities in Salesforce.

The Cloud can also expose custom entities on your Salesforce account that are not mentioned in the Tables. You can query against these custom entities as with any other table. Additionally, you can query against custom fields of standard entities.

There is a naming limitation that applies to the lists and to the custom fields. Empty spaces in list names are converted to underscores for the table names. Also, all custom fields and custom entities are identified by Salesforce with a __c appended to the end of the name.


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique identifier of the WebLink.
PageOrSobjectType	String	False		Label Page Or sObject Type Name corresponds to this field.
Name	String	False		Label Name corresponds to this field.
IsProtected	Boolean	False		Label Protected Component corresponds to this field.
Url	String	False		Label URL corresponds to this field.
EncodingKey	String	False		Label Link Encoding corresponds to this field.
LinkType	String	False		Label Content Source corresponds to this field.
OpenType	String	False		Label Behavior corresponds to this field.
Height	Int	False		Label Height (in pixels) corresponds to this field.
Width	Int	False		Label Width (in pixels) corresponds to this field.
ShowsLocation	Boolean	False		Label Show Address Bar corresponds to this field.
HasScrollbars	Boolean	False		Label Show Scrollbars corresponds to this field.
HasToolbar	Boolean	False		Label Show Toolbars corresponds to this field.
HasMenubar	Boolean	False		Label Show Menu Bar corresponds to this field.
ShowsStatus	Boolean	False		Label Show Status Bar corresponds to this field.
IsResizable	Boolean	False		Label Resizeable corresponds to this field.
Position	String	False		Label Window Position corresponds to this field.
ScontrolId	String	False		Label Custom S-Control ID corresponds to this field.
MasterLabel	String	False		Label Label corresponds to this field.
Description	String	False		Label Description corresponds to this field.
DisplayType	String	False		Label Display Type corresponds to this field.
RequireRowSelection	Boolean	False		Label Require Row Selection corresponds to this field.
NamespacePrefix	String	True		Label Namespace Prefix corresponds to this field.
CreatedDate	Datetime	True		Label Created Date corresponds to this field.
CreatedById	String	True	User.Id	Label Created By ID corresponds to this field.
LastModifiedDate	Datetime	True		Label Last Modified Date corresponds to this field.
LastModifiedById	String	True	User.Id	Label Last Modified By ID corresponds to this field.
SystemModstamp	Datetime	True		Label System Modstamp corresponds to this field.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Salesforce Views


Name	Description
Formulas	This table lists formulas for the specified TableName.
JobRecordResultsV2	Retrieves a list of records for a specific job.
PickListValues	This table lists picklist values for the specified TableName.
PolymorphicColumnsRelationships	Lists polymorphic columns relationships in the specified table name.
TableRelationships	Lists relationships in the specified table.

Formulas

This table lists formulas for the specified TableName.

Table-Specific Information

Select

The Cloud processes all filters client-side within the Cloud. The following queries are the only ones processed server side:

SELECT * FROM Formulas WHERE TableName = 'Account'

Note: Querying the table without a TableName filter specified will attempt to retrieve column metadata for all objects in your Salesforce account. Depending on the number of objects, this can take a while.

Columns


Name	Type	Description
TableName	String	The name of the table. This must be specified when retrieving data from Formulas.
ColumnName	String	The name of the column associated with the Formula.
Formula	String	The formula associated with this field.

JobRecordResultsV2

Retrieves a list of records for a specific job.

Table Specific Information

This view shows information about the records that have passed, failed, or are unprocessed after executing the CreateJobV2 stored procedure.

Select

To query this view you must specify the JobId, RecordState, and ColumnDelimiter columns in the WHERE clause. For example:

 SELECT * FROM JobRecordResultsV2 WHERE JobId = '133485445' AND ColumnDelimiter = 'COMMA' AND RecordState = 'Failed'

Columns


Name	Type	Description
ID [KEY]	String	ID of the record that was successfully processed.
Created	Boolean	The name of the table. This must be specified when retrieving data from PickListInformation.
RowFromOriginalCSV	String	Truncated row that was provided in the original job data upload request.
JobId	String	Specified the unique Id of the job.
RecordState	String	Specifies the type of the records that were processed by Salesforce. Valid values are 'Successful', 'Failed', 'Unprocessed'.
ColumnDelimiter	String	The column delimiter used for CSV job data. Valid values are 'BACKQUOTE','CARET','COMMA', 'PIPE', 'SEMICOLON', 'TAB'.

PickListValues

This table lists picklist values for the specified TableName.

Table-Specific Information

Select

TableName should be specified in the WHERE clause. RecordTypeId may also be specified along TableName to only retrieve data for a specific record type.

SELECT * FROM PickListValues WHERE TableName = 'Account'

SELECT * FROM PickListValues WHERE TableName = 'Account' AND RecordTypeId = '0121W000000cq9EDAL'

Columns


Name	Type	Description
ID [KEY]	String	The unique identifier of the picklist in the format ColumnName\|Picklist_Value.
TableName	String	The name of the table. This must be specified when retrieving data from PickListInformation.
ColumnName	String	The name of the column associated with the picklist entry. This may be optionally specified to only retrieve picklist information with regards to the specified column.
PickList_Value	String	The picklist value.
PickList_Label	String	The label for the picklist value.
PickList_IsActive	Boolean	A boolean indicating if the picklist value is active.
PickList_IsDefault	Boolean	A boolean indicating if this picklist value is the default value for the column it is associated with.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordTypeId	String	The Id of the record type. Specify this to return values only for picklist fields of a record type.

PolymorphicColumnsRelationships

Lists polymorphic columns relationships in the specified table name.

Columns


Name	Type	Description
TableName	String	The name of the table to retrieve relationship information from.
ColumnName	String	The name of the polymorphic field.
SalesforceType	String	The salesforce type of the polymorphic field.
PrimaryKeyName	String	The name of the primary key.
RelationshipName	String	The salesforce name of the relationship.
ReferencedTableName	String	The name of the object the polymorphic fields relates to.
ReferencedColumnName	String	The name of the column the polymorphic fields relates to.
ForeignKeyName	String	The name of the foreign key.

TableRelationships

Lists relationships in the specified table.

Columns


Name	Type	Description
ChildsObject [KEY]	String	The child table that is related to the specified TableName in the input.
RelationshipName [KEY]	String	The name of the relationship.
Field	String	The field the relationship is associated on. Found in the ChildsObject.
ParentObject	String	The parent object in the relationship. This is the same as the input TableName.
DeprecatedAndHidden	Boolean	Boolean indicating if the relationship is deprecated and now hidden.
CascadeDelete	Boolean	Boolean stating if this entity is deleted, does the child object also get deleted.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
TableName	String	The name of the table to retrieve relationship information from.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Salesforce.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Salesforce, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Salesforce Stored Procedures


Name	Description
AbortJob	Aborts a Salesforce job.
CloseJob	Closes a Salesforce job.
CloseJobV2	Closes or aborts a Salesforce job.
ConvertLead	Converts a Lead into an Account, Contact, or (optionally) an Opportunity.
CreateBatch	Creates a Salesforce batch.
CreateCustomField	Adds a new custom field component to your organization.
CreateJob	Add a Salesforce object entry.
CreateJobV2	Creates a job, which represents a bulk operation (and associated data) that is sent to Salesforce for asynchronous processing. Provide job data via an Upload Job Data request, or as part of a multipart create job request.
DeleteJobV2	Deletes a job. To be deleted, a job must have a state of UploadComplete, JobComplete, Aborted, or Failed.
GetBatch	Gets information about a Salesforce batch.
GetBatchResults	Gets the results of a Salesforce batch.
GetDeleted	Retrieves the list of individual records that have been deleted within the given timespan for the specified object.
GetJob	Gets information about a Salesforce job.
GetJobBatchIds	Get batch id for all batches in a Job.
GetJobInfoV2	Gets information about a Salesforce job.
GetLimitInfo	Retrieves limit information for the organization. Use this stored procedure to monitor your SOAP API limits as you make calls against the organization.
GetUpdated	Retrieves the list of individual records that have been updated within the given timespan for the specified object.
GetUserInformation	Retrieves personal information for the user associated with the current session.
Merge	Combines up to 3 records of the same type into 1 record.
MetadataDeploy	Deploys file representations of components into an org by creating, updating or deleting the components they represent. To be used after executing MetadataRetrieve Stored Procedure.
MetadataDeployDetails	Used to retrieve additional details about MetadataDeploy job. Can be used after executing MetadataDeploy Stored Procedure.
MetadataRetrieve	Retrieve file representations of components in an organization.
QueryBatch	Gets data from Salesforce using query batch. Only batches created in CSV format are supported. Note that the outputs of this stored procedure are dynamic and depend on the Query input.
QueryResultsV2	Gets the results for a query job. The job must have the state JobComplete.
Undelete	Restores from Salesforce's RecycleBin a deleted record.

AbortJob

Aborts a Salesforce job.

Input


Name	Type	Description
JobId	String	Id of the job being aborted.

Result Set Columns


Name	Type	Description
ID	String	The Id of the job.
JobID	String	The Id of the job.
ObjectName	String	The name of the object to be used with the job.
Operation	String	The operation for the job. For example, delete, insert, query, upsert, update, or hardDelete.
ApiVersion	String	The API version of the job set in the URI when the job was created. The earliest supported version is 17.0.
ApexProcessingTime	String	The number of milliseconds taken to process triggers and other processes related to the job data. This is the sum of the equivalent times in all batches in the job. This does not include the time used for processing asynchronous and batch Apex operations. If there are no triggers, the value is 0. This field is available in API version 19.0 and later.
ApiActiveProcessingTime	String	The number of milliseconds taken to actively process the job. This value includes ApexProcessingTime, but not the time the job waited in the queue to be processed or the time required for serialization and deserialization. This is the sum of the equivalent times in all batches in the job. This field is available in API version 19.0 and later.
AssignmentRuleId	String	The Id of a specific assignment rule to run for a case or a lead. The assignment rule can be active or inactive.
ConcurrencyMode	String	The concurrency mode for the job. The valid values are: parallel and serial.
ContentType	String	The content type for the job. The valid values are: CSV, XML, ZIP_CSV, and ZIP_XML.
CreatedById	String	Id of the user who created the job.
CreatedDate	String	Date the job was created.
ExternalIdFieldName	String	The name of the external Id field for an upsert.
NumberBatchesCompleted	String	The number of batches that have been completed for this job.
NumberBatchesQueued	String	The number of batches queued for this job.
NumberBatchesFailed	String	The number of batches that have failed for this job.
NumberBatchesInProgress	String	The number of batches that are in progress for this job.
NumberBatchesTotal	String	The number of total batches currently in the job. This value increases as more batches are added to the job. When the jobstate is Closed or Failed, this number represents the final total. The job is complete when NumberBatchesTotal equals the sum of NumberBatchesCompleted and NumberBatchesFailed.
NumberRecordsFailed	String	The number of records that were not processed successfully in this job. This field is available in API version 19.0 and later.
NumberRecordsProcessed	String	The number of records already processed. This number increases as more batches are processed.
NumberRetries	String	The number of times that Salesforce attempted to save the results of an operation. The repeated attempts are due to a problem, such as a lock contention.
State	String	The state of the job. For example, Open, Closed, Aborted, or Failed.
SystemModStamp	String	Date and time in the UTC time zone when the job finished.
TotalProcessingTime	String	The number of milliseconds taken to process the job. This is the sum of the total processing times for all batches in the job. See also ApexProcessingTime and ApiActiveProcessingTime. This field is available in API version 19.0 and later.

CloseJob

Closes a Salesforce job.

Input


Name	Type	Description
JobId	String	Id of the job being closed.

Result Set Columns


Name	Type	Description
ID	String	The Id of the job.
JobID	String	The Id of the job.
ObjectName	String	The name of the object to be used with the job.
Operation	String	The operation for the job. For example, delete, insert, query, upsert, update, or hardDelete.
ApiVersion	String	The API version of the job set in the URI when the job was created. The earliest supported version is 17.0.
ApexProcessingTime	String	The number of milliseconds taken to process triggers and other processes related to the job data. This is the sum of the equivalent times in all batches in the job. This does not include the time used for processing asynchronous and batch Apex operations. If there are no triggers, the value is 0. This field is available in API version 19.0 and later.
ApiActiveProcessingTime	String	The number of milliseconds taken to actively process the job. This value includes ApexProcessingTime, but does not include the time the job waited in the queue to be processed or the time required for serialization and deserialization. This is the sum of the equivalent times in all batches in the job. This field is available in API version 19.0 and later.
AssignmentRuleId	String	The Id of a specific assignment rule to run for a case or a lead. The assignment rule can be active or inactive.
ConcurrencyMode	String	The concurrency mode for the job. The valid values are: parallel and serial.
ContentType	String	The content type for the job. The valid values are: CSV, XML, ZIP_CSV, and ZIP_XML.
CreatedById	String	Id of the user who created the job.
CreatedDate	String	Date the job was created.
ExternalIdFieldName	String	The name of the external Id field for an upsert.
NumberBatchesCompleted	String	The number of batches that have been completed for this job.
NumberBatchesQueued	String	The number of batches queued for this job.
NumberBatchesFailed	String	The number of batches that have failed for this job.
NumberBatchesInProgress	String	The number of batches that are in progress for this job.
NumberBatchesTotal	String	The number of total batches currently in the job. This value increases as more batches are added to the job. When the jobstate is Closed or Failed, this number represents the final total. The job is complete when NumberBatchesTotal equals the sum of NumberBatchesCompleted and NumberBatchesFailed.
NumberRecordsFailed	String	The number of records that were not processed successfully in this job. This field is available in API version 19.0 and later.
NumberRecordsProcessed	String	The number of records already processed. This number increases as more batches are processed.
NumberRetries	String	The number of times that Salesforce attempted to save the results of an operation. The repeated attempts are due to a problem, such as a lock contention.
State	String	The state of the job. For example, Open, Closed, Aborted, or Failed.
SystemModStamp	String	Date and time in the UTC time zone when the job finished.
TotalProcessingTime	String	The number of milliseconds taken to process the job. This is the sum of the total processing times for all batches in the job. See also ApexProcessingTime and ApiActiveProcessingTime. This field is available in API version 19.0 and later.

CloseJobV2

Closes or aborts a Salesforce job.

Input


Name	Type	Description
JobId	String	Id of the job being closed.
State	String	The state to update the job to. Use UploadComplete state to close a job. It is applicable only when the UploadJobDataV2 stored procedure is utilized or use Aborted state to abort a job. The allowed values are UploadComplete, Aborted.
JobType	String	Type of job to use in the job. Valid values are 'UNKNOWN', 'INGEST' or 'QUERY'. The allowed values are UNKNOWN, INGEST, QUERY. The default value is UNKNOWN.

Result Set Columns


Name	Type	Description
Closed	String	Whether the Job was closed or not.

ConvertLead

Converts a Lead into an Account, Contact, or (optionally) an Opportunity.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the table below, indexed parameters are denoted with a '#' character at the end of their names.

Input


Name	Type	Description
AccountId#	String	ID of the Account into which the lead will be merged. Required only when updating an existing account, including person accounts. If no accountID is specified, then the API creates a new account. To create a new account, the client application must be logged in with sufficient access rights. To merge a lead into an existing account, the client application must be logged in with read/write access to the specified account. The account name and other existing data are not overwritten.
ContactId#	String	ID of the Contact into which the lead will be merged (this contact must be associated with the specified accountId, and an accountId must be specified). Required only when updating an existing contact. If you are converting a lead into a person account, do not specify the contactId or an error will result. Specify only the accountId of the person account. If no contactID is specified, then the API creates a new contact that is implicitly associated with the Account. To create a new contact, the client application must be logged in with sufficient access rights. To merge a lead into an existing contact, the client application must be logged in with read/write access to the specified contact. The contact name and other existing data are not overwritten (unless overwriteLeadSource is set to true, in which case only the LeadSource field is overwritten).
ConvertedStatus#	String	Valid LeadStatus value for a converted lead. Required. To obtain the list of possible values, the client application queries the LeadStatus object. e.g: SELECT Id, MasterLabel FROM LeadStatus WHERE IsConverted=true
DoNotCreateOpportunity#	String	Specifies whether to create an Opportunity during lead conversion (false, the default) or not (true). Set this flag to true only if you do not want to create an opportunity from the lead. An opportunity is created by default.
LeadId#	String	ID of the Lead to convert. Required.
OpportunityName#	String	Name of the opportunity to create. If no name is specified, then this value defaults to the company name of the lead. The maximum length of this field is 80 characters. If doNotCreateOpportunity argument is true, then no Opportunity is created and this field must be left blank; otherwise, an error is returned.
OverwriteLeadSource#	String	Specifies whether to overwrite the LeadSource field on the target Contact object with the contents of the LeadSource field in the source Lead object (true), or not (false, the default). To set this field to true, the client application must specify a contactId for the target contact.
OwnerId#	String	Specifies the ID of the person to own any newly created account, contact, and opportunity. If the client application does not specify this value, then the owner of the new object will be the owner of the lead. Not applicable when merging with existing objects-if an ownerId is specified, the API does not overwrite the ownerId field in an existing account or contact.
SendNotificationEmail#	String	Specifies whether to send a notification email to the owner specified in the ownerId (true) or not (false, the default). The default value is FALSE.

Result Set Columns


Name	Type	Description
AccountId	String	ID of the new Account (if a new account was specified) or the ID of the account specified when convertLead() was invoked.
ContactId	String	ID of the new Contact (if a new contact was specified) or the ID of the contact specified when convertLead() was invoked.
LeadId	String	ID of the converted Lead.
OpportunityId	String	ID of the new Opportunity, if one was created when convertLead() was invoked.
Success	String	Indicates whether the convertLead() call succeeded (true) or not (false) for this object.
Errors	String	If an error occurred during the create() call, an array of one or more Error objects providing the error code and description.

CreateBatch

Creates a Salesforce batch.

Table-Specific Information

To create a batch, specify the Id of the Job you are adding it to and the XML aggregate of the batch itself. For example, the XML aggregate may resemble the following:

<?xml version="1.0" encoding="UTF-8"?>
<sObjects xmlns="http://www.force.com/2009/06/asyncapi/dataload" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <sObject>
    <FirstName>Bill</FirstName>
    <LastName>White</LastName>
  </sObject>
  <sObject>
    <FirstName>Bob</FirstName>
    <LastName>Black</LastName>
  </sObject>
</sObjects>

Note: The objects contained in the XML aggregate must all correspond to the object associated with the Job being used.

Input


Name	Type	Description
JobId	String	Id of the job the batch is being added to.
Aggregate	String	The aggregate of objects being added. Specifies the query to use if performing a batch query.
ContentType	String	The content type for the job. The valid values are: CSV, XML, ZIP_CSV, and ZIP_XML. Set the value to CSV if performing a batch query The default value is XML.

Result Set Columns


Name	Type	Description
ID	String	The Id of the batch.
JobID	String	The Id of the job.
ApexProcessingTime	String	The number of milliseconds taken to process triggers and other processes related to the batch data. If there are no triggers, the value is 0. This does not include the time used for processing asynchronous and batch Apex operations. See also ApiActiveProcessingTime and TotalProcessingTime. This field is available in API version 19.0 and later.
ApiActiveProcessingTime	String	The number of milliseconds taken to actively process the batch. This value includes ApexProcessingTime, but not the time the batch waited in the queue to be processed or the time required for serialization and deserialization. See also TotalProcessingTime. This field is available in API version 19.0 and later.
CreatedDate	String	The date and time in the UTC time zone when the batch was created. This is not the time processing began, but the time the batch was added to the job.
NumberRecordsFailed	String	The unique, 18 character Id for the job associated with this batch.
NumberRecordsProcessed	String	The number of records processed in this batch at the time the request was sent. This number increases as more batches are processed.
State	String	The current state of processing for the batch. For instance, Queued, InProgress, Completed, Failed, or Not Processed.
StateMessage	String	Contains details about the state. For example, if the state value is Failed, this field contains the reasons for failure. If there are multiple failures, the message may be truncated. If so, fix the known errors and resubmit the batch: Even if the batch failed, some records could have been completed successfully.
SystemModstamp	String	The date and time in the UTC time zone that processing ended. This is only valid when the state is Completed.
TotalProcessingTime	String	The number of milliseconds taken to process the batch. This excludes the time the batch waited in the queue to be processed. See also ApexProcessingTime and ApiActiveProcessingTime. This field is available in API version 19.0 and later.

CreateCustomField

Adds a new custom field component to your organization.

Input


Name	Type	Description
Label	String	Label for the field.
ObjectName	String	Name for the parent object.
FieldName	String	Name for the new custom field.
Type	String	Type of the field. The allowed values are Checkbox, Currency, Date, DateTime, Time, Email, Location, Number, Percent, Phone, Picklist, MultiselectPicklist, Text, TextArea, LongTextArea, Url, EncryptedText.
Description	String	Description of the field.
Required	Boolean	Indicates whether the field requires a value on creation.
Unique	Boolean	Indicates whether the field is unique.
ExternalId	Boolean	Indicates whether the field is an external ID field.
DefaultValue	String	Represents the default value of the field.
Length	Integer	Length of the field.
Precision	Integer	The precision for number values. Precision is the number of digits in a number.
Scale	Integer	The scale for the field. Scale is the number of digits to the right of the decimal point in a number. For example, the number 256.99 has a scale of 2.
ValueSet	String	Represents the set of values that make up a picklist on a custom field.
VisibleLines	Integer	Indicates the number of lines displayed for the field.
MaskType	String	For encrypted text fields, specifies the format of the masked and unmasked characters in the field. The allowed values are all, creditCard, lastFour, nino, sin, ssn.
MaskChar	String	For encrypted fields, specifies the character to be used as a mask. The allowed values are asterisk, X.

Result Set Columns


Name	Type	Description
FullName	String	The FullName of the field.
Success	String	If the store procedure has succeeded or not.

CreateJob

Add a Salesforce object entry.

Input


Name	Type	Description
ObjectName	String	Name of the object to be used for the job (i.e., Account, Campaign, Event, etc.)
Action	String	Type of action to use in the job. For example, insert, update, upsert, delete or query.
ConcurrencyMode	String	The concurrency mode for the job. The valid values are Parallel or Serial. Parallel: Process batches in parallel mode. This is the default value. Serial: Process batches in serial mode. Processing in parallel can cause database contention. When this is severe, the job may fail. If you experience this issue, submit the job with serial concurrency mode. This guarantees that batches are processed one at a time. Note that using this option may significantly increase the processing time for a job. The allowed values are Parallel, Serial. The default value is Parallel.
ContentType	String	The content type for the job. The valid values are: CSV, XML, ZIP_CSV, and ZIP_XML. The default value is XML.
ExternalIdColumn	String	Specifies the external Id column to use if performing an upsert.
ChunkSize	String	Salesforce recommends that you enable chunking when querying tables with more than 10 million records or when a bulk query consistently times out. If chunksize is specified the query is split into multiple batches. Use this paramter only if action value is query.

Result Set Columns


Name	Type	Description
ID	String	The Id of the job created.
JobID	String	The Id of the job.
ObjectName	String	The name of the object to be used with the job.
Operation	String	The operation for the job. For example, delete, insert, query, upsert, update, or hardDelete.
ApiVersion	String	The API version of the job set in the URI when the job was created. The earliest supported version is 17.0.
ApexProcessingTime	String	The number of milliseconds taken to process triggers and other processes related to the job data. This is the sum of the equivalent times in all batches in the job. This does not include the time used for processing asynchronous and batch Apex operations. If there are no triggers, the value is 0. This field is available in API version 19.0 and later.
ApiActiveProcessingTime	String	The number of milliseconds taken to actively process the job. This value includes ApexProcessingTime but not the time the job waited in the queue to be processed or the time required for serialization and deserialization. This is the sum of the equivalent times in all batches in the job. This field is available in API version 19.0 and later.
AssignmentRuleId	String	The Id of a specific assignment rule to run for a case or a lead. The assignment rule can be active or inactive.
ConcurrencyMode	String	The concurrency mode for the job. The valid values are: parallel and serial.
ContentType	String	The content type for the job. The valid values are: CSV, XML, ZIP_CSV, and ZIP_XML.
CreatedById	String	Id of the user who created the job.
CreatedDate	String	Date the job was created.
ExternalIdFieldName	String	The name of the external Id field for an upsert.
NumberBatchesCompleted	String	The number of batches that have been completed for this job.
NumberBatchesQueued	String	The number of batches queued for this job.
NumberBatchesFailed	String	The number of batches that have failed for this job.
NumberBatchesInProgress	String	The number of batches that are in progress for this job.
NumberBatchesTotal	String	The number of total batches currently in the job. This value increases as more batches are added to the job. When the jobstate is Closed or Failed, this number represents the final total. The job is complete when NumberBatchesTotal equals the sum of NumberBatchesCompleted and NumberBatchesFailed.
NumberRecordsFailed	String	The number of records that were not processed successfully in this job. This field is available in API version 19.0 and later.
NumberRecordsProcessed	String	The number of records already processed. This number increases as more batches are processed.
NumberRetries	String	The number of times that Salesforce attempted to save the results of an operation. The repeated attempts are due to a problem, such as a lock contention.
State	String	The state of the job. For example, Open, Closed, Aborted, or Failed.
SystemModStamp	String	Date and time in the UTC time zone when the job finished.
TotalProcessingTime	String	The number of milliseconds taken to process the job. This is the sum of the total processing times for all batches in the job. See also ApexProcessingTime and ApiActiveProcessingTime. This field is available in API version 19.0 and later.

CreateJobV2

Creates a job, which represents a bulk operation (and associated data) that is sent to Salesforce for asynchronous processing. Provide job data via an Upload Job Data request, or as part of a multipart create job request.

Input


Name	Type	Description
ObjectName	String	Name of the object to be used for the job (i.e., Account, Campaign, Event, etc.)
Query	String	The query to be performed.
Action	String	Type of action to use in the job. Valid values are 'insert', 'delete', 'update', 'upsert' or 'query'.
ExternalIdColumn	String	The external ID field in the object being updated. Only needed for upsert operations. Field values must also exist in CSV job data.
ColumnDelimiter	String	The column delimiter used for CSV job data. The default value is COMMA. Valid values are 'BACKQUOTE','CARET','COMMA', 'PIPE', 'SEMICOLON', 'TAB'.
LineEnding	String	The line ending used for CSV job data, marking the end of a data row. The default is LF. Valid values are 'LF' and 'CRLF'.
MultiPartRequest	Boolean	Enable this feature only when the total size of the CSV data does not exceed 20,000 characters. You must also specify the path of your CSV file.
CSVFilePath	String	Specifies the path of your CSV File.

Result Set Columns


Name	Type	Description
ID	String	The Id of the job created.
State	String	The state of the job. For example, 'Open', 'Closed', 'Aborted', or 'Failed'.
JobType	String	The type of the job. Values include: 'BigObjectIngest', 'Classic', 'V2Ingest'.
ContentUrl	String	The URL to use for 'Upload Job Data' requests for this job. Only valid if the job is in Open state.
ContentType	String	The format of the data being processed. Only CSV is supported.
CreatedDate	String	The date and time in the UTC time zone when the job was created.
CreatedById	String	The ID of the user who created the job.
ConcurrencyMode	String	The concurrency mode for the job. The valid values are: parallel and serial.
SystemModStamp	String	Date and time in the UTC time zone when the job finished.

DeleteJobV2

Deletes a job. To be deleted, a job must have a state of UploadComplete, JobComplete, Aborted, or Failed.

Input


Name	Type	Description
JobId	String	Id of the job being deleted.

Result Set Columns


Name	Type	Description
Deleted	String	Whether the Job was successfully deleted or not.

GetBatch

Gets information about a Salesforce batch.

Input


Name	Type	Description
JobId	String	Id of the job the batch is associated with.
BatchId	String	Id of the batch being retrieved.

Result Set Columns


Name	Type	Description
ID	String	The Id of the batch.
JobID	String	The Id of the job.
ApexProcessingTime	String	The number of milliseconds taken to process triggers and other processes related to the batch data. If there are no triggers, the value is 0. This does not include the time used for processing asynchronous and batch Apex operations. See also ApiActiveProcessingTime and TotalProcessingTime. This field is available in API version 19.0 and later.
ApiActiveProcessingTime	String	The number of milliseconds taken to actively process the batch. This value includes ApexProcessingTime but not the time the batch waited in the queue to be processed or the time required for serialization and deserialization. See also TotalProcessingTime. This field is available in API version 19.0 and later.
CreatedDate	String	The date and time in the UTC time zone when the batch was created. This is not the time processing began, but the time the batch was added to the job.
NumberRecordsFailed	String	The unique, 18-character Id for the job associated with this batch.
NumberRecordsProcessed	String	The number of records processed in this batch at the time the request was sent. This number increases as more batches are processed.
State	String	The current state of processing for the batch. For instance, Queued, InProgress, Completed, Failed, or Not Processed.
StateMessage	String	Contains details about the state. For example, if the state value is Failed, this field contains the reasons for failure. If there are multiple failures, the message may be truncated. If so, fix the known errors and resubmit the batch. Even if the batch failed, some records could have been completed successfully.
SystemModstamp	String	The date and time in the UTC time zone that processing ended. This is only valid when the state is Completed.
TotalProcessingTime	String	The number of milliseconds taken to process the batch. This excludes the time the batch waited in the queue to be processed. See also ApexProcessingTime and ApiActiveProcessingTime. This field is available in API version 19.0 and later.

GetBatchResults

Gets the results of a Salesforce batch.

Input


Name	Type	Description
JobId	String	Id of the job the batch is associated with.
BatchId	String	Id of the batch being retrieved.

Result Set Columns


Name	Type	Description
ID	String	The Id of the result.
Created	String	Boolean indicating whether or not the result was created.
Success	String	Boolean indicating whether or not the result was a success.
Errors_Fields	String	Fields that resulted in an error.
Errors_Message	String	Error message returned.
Errors_StatusCode	String	The status code for the error.

GetDeleted

Retrieves the list of individual records that have been deleted within the given timespan for the specified object.

Input


Name	Type	Description
ObjectType	String	Object type. The specified value must be a valid object for your organization.
StartDate	String	Starting date/time (Coordinated Universal Time (UTC)-not local- timezone) of the timespan for which to retrieve the data. The API ignores the seconds portion of the specified dateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).
EndDate	String	Ending date/time (Coordinated Universal Time (UTC)-not local- timezone) of the timespan for which to retrieve the data. The API ignores the seconds portion of the specified dateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC).

Result Set Columns


Name	Type	Description
Id	String	ID of the deleted records which satisfy the start and end dates specified in the getDeleted() call.
DeletedDate	String	Date of the deleted records which satisfy the start and end dates specified in the getDeleted() call.

GetJob

Gets information about a Salesforce job.

Input


Name	Type	Description
JobId	String	Id of the job being retrieved.

Result Set Columns


Name	Type	Description
ID	String	The Id of the job.
JobID	String	The Id of the job.
ObjectName	String	The name of the object to be used with the job.
Operation	String	The operation for the job. For example, delete, insert, query, upsert, update, or hardDelete.
ApiVersion	String	The API version of the job set in the URI when the job was created. The earliest supported version is 17.0.
ApexProcessingTime	String	The number of milliseconds taken to process triggers and other processes related to the job data. This is the sum of the equivalent times in all batches in the job. This does not include the time used for processing asynchronous and batch Apex operations. If there are no triggers, the value is 0. This field is available in API version 19.0 and later.
ApiActiveProcessingTime	String	The number of milliseconds taken to actively process the job. This value includes ApexProcessingTime but not the time the job waited in the queue to be processed or the time required for serialization and deserialization. This is the sum of the equivalent times in all batches in the job. This field is available in API version 19.0 and later.
AssignmentRuleId	String	The Id of a specific assignment rule to run for a case or a lead. The assignment rule can be active or inactive.
ConcurrencyMode	String	The concurrency mode for the job. The valid values are: parallel and serial.
ContentType	String	The content type for the job. The valid values are: CSV, XML, ZIP_CSV, and ZIP_XML.
CreatedById	String	Id of the user who created the job.
CreatedDate	String	Date the job was created.
ExternalIdFieldName	String	The name of the external Id field for an upsert.
NumberBatchesCompleted	String	The number of batches that have been completed for this job.
NumberBatchesQueued	String	The number of batches queued for this job.
NumberBatchesFailed	String	The number of batches that have failed for this job.
NumberBatchesInProgress	String	The number of batches that are in progress for this job.
NumberBatchesTotal	String	The number of total batches currently in the job. This value increases as more batches are added to the job. When the jobstate is Closed or Failed, this number represents the final total. The job is complete when NumberBatchesTotal equals the sum of NumberBatchesCompleted and NumberBatchesFailed.
NumberRecordsFailed	String	The number of records that were not processed successfully in this job. This field is available in API version 19.0 and later.
NumberRecordsProcessed	String	The number of records already processed. This number increases as more batches are processed.
NumberRetries	String	The number of times that Salesforce attempted to save the results of an operation. The repeated attempts are due to a problem, such as a lock contention.
State	String	The state of the job. For example, Open, Closed, Aborted, or Failed.
SystemModStamp	String	Date and time in the UTC time zone when the job finished.
TotalProcessingTime	String	The number of milliseconds taken to process the job. This is the sum of the total processing times for all batches in the job. See also ApexProcessingTime and ApiActiveProcessingTime. This field is available in API version 19.0 and later.

GetJobBatchIds

Get batch id for all batches in a Job.

Input


Name	Type	Description
JobId	String	Id of the job.

Result Set Columns


Name	Type	Description
ID	String	The Id of the batch.
State	String	The state of the batch.

GetJobInfoV2

Gets information about a Salesforce job.

Input


Name	Type	Description
JobId	String	Id of the job being retrieved.
JobType	String	Type of job to use in the job. Valid values are 'UNKNOWN', 'INGEST' or 'QUERY'. The allowed values are UNKNOWN, INGEST, QUERY. The default value is UNKNOWN.

Result Set Columns


Name	Type	Description
ObjectName	String	The name of the object to be used with the job.
Operation	String	The operation for the job. For example, delete, insert, query, upsert, update, or hardDelete.
ApiVersion	String	The API version of the job set in the URI when the job was created. The earliest supported version is 17.0.
ConcurrencyMode	String	The concurrency mode for the job. The valid values are: parallel and serial.
ContentType	String	The content type for the job. The valid values are: CSV, XML, ZIP_CSV, and ZIP_XML.
CreatedById	String	Id of the user who created the job.
CreatedDate	String	Date the job was created.
NumberRecordsProcessed	String	The number of records already processed. This number increases as more batches are processed.
NumberRetries	String	The number of times that Salesforce attempted to save the results of an operation. The repeated attempts are due to a problem, such as a lock contention.
State	String	The state of the job. For example, Open, Closed, Aborted, or Failed.
SystemModStamp	String	Date and time in the UTC time zone when the job finished.
TotalProcessingTime	String	The number of milliseconds taken to process the job. This is the sum of the total processing times for all batches in the job. See also ApexProcessingTime and ApiActiveProcessingTime. This field is available in API version 19.0 and later.
IsPkChunkingSupported	String	Whether PK chunking is supported for the queried object .
ErrorMessage	String	The error message if the job has failed.

GetLimitInfo

Retrieves limit information for the organization. Use this stored procedure to monitor your SOAP API limits as you make calls against the organization.

Result Set Columns


Name	Type	Description
Current	Integer	The number of calls for the specified limit type that have already been used in the organization.
Limit	Integer	The organization's limit for the specified limit type.
Type	String	The type of limit information specified in the header. API REQUESTS-the daily API usage for the organization against which the call was made.

GetUpdated

Retrieves the list of individual records that have been updated within the given timespan for the specified object.

Input


Name	Type	Description
ObjectType	String	Object type. The specified value must be a valid object for your organization.
StartDate	String	Starting date/time (Coordinated Universal Time (UTC)-not local- timezone) of the timespan for which to retrieve the data. The API ignores the seconds portion of the specified dateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).
EndDate	String	Ending date/time (Coordinated Universal Time (UTC)-not local- timezone) of the timespan for which to retrieve the data. The API ignores the seconds portion of the specified dateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC).

Result Set Columns


Name	Type	Description
Id	String	ID of the updated records which satisfy the start and end dates specified in the getUpdated() call.

GetUserInformation

Retrieves personal information for the user associated with the current session.

Input


Name	Type	Description
BasicInfoOnly	String	Default is false. If this input is set to true, the procedure will only return basic information like the ServerURL, SessionID, Sandbox, OrganizationId and OrganizationName.

Result Set Columns


Name	Type	Description
AccessibilityMode	String	Available in API version 7.0 and later. Indicates whether user interface modifications for the visually impaired are on (true) or off (false). The modifications facilitate the use of screen readers, such as JAWS.
CurrencySymbol	String	Currency symbol to use for displaying currency values. Applicable only when OrganizationMultiCurrency is false.
OrganizationId	String	Id of the organization. Allows third-party tools to uniquely identify individual organizations in Salesforce, which is useful for retrieving billing or organization-wide setup information.
OrganizationMultiCurrency	String	Indicates whether the user's organization uses multiple currencies (true) or not (false).
OrganizationName	String	Name of the user's organization or company.
OrgDefaultCurrencyIsoCode	String	Default currency ISO code. Applicable only when OrganizationMultiCurrency is false. When the logged-in user creates any objects that have a currency ISO code, the API uses this currency ISO code if it is not explicitly specified in the create() call.
ProfileID	String	Id of the profile associated with the role currently assigned to the user.
RoleID	String	Role Id of the role currently assigned to the user.
Sandbox	String	Whether the current organization is a sandbox. Either 'true' or 'false' for Basic authorization, and NULL otherwise.
ServerURL	String	The server URL of the Salesforce instance.
SessionID	String	The currently active section used by the API connection.
SessionSecondsValid	String	Number of seconds remaining until the user's session expires.
UserDefaultCurrencyIsoCode	String	Default currency ISO code. Applicable only when OrganizationMultiCurrency is true. When the logged-in user creates any objects that have a currency ISO code, the API uses this currency ISO code if it is not explicitly specified in the create() call.
UserEmail	String	The user's email address.
UserFullName	String	The user's full name.
UserID	String	The user's Id.
UserLanguage	String	User's language, which controls the language for labels displayed in an application. String is 2-5 characters long. The first two characters are always an ISO language code. For example, fr or en. If the value is further qualified by country, then the string also has an underscore (_) and another ISO country code, for example US or UK. For example, the string for the United States is en_US, and the string for French Canadian is fr_CA.
UserLocale	String	User's locale, which controls the formatting of dates and choice of symbols for currency. The first two characters are always an ISO language code; for example, fr or en. If the value is further qualified by country, then the string also has an underscore (_) and another ISO country code; for example, US or UK. For example, the string for the United States is en_US, and the string for French Canadian is fr_CA.
UserName	String	User's login name.
UserTimeZone	String	User's time zone.
UserType	String	Type of user license assigned to the Profile associated with the user.
UserUISkin	String	Available in API version 7.0 and later. Returns the value Theme2 if the user is using the newer user interface theme of the online application, labeled Salesforce. Returns Theme1 if the user is using the older user interface theme, labeled Salesforce Classic. In the online application, this look and feel setting is configurable from Setup by clicking Customize \| User Interface.

Merge

Combines up to 3 records of the same type into 1 record.

Input


Name	Type	Description
ObjectType	String	Object type. The specified value must be a valid object for your organization.
MasterRecordId	String	Must provide the ID of the object that other records will be merged into.
RecordToMergeIds	String	Minimum of one, maximum of two. The other record or records to be merged into the master record.

Result Set Columns


Name	Type	Description
Id	String	ID of the master record, the record into which the other records were merged.
Success	String	Indicates whether the merge was successful (true) or not (false).
Errors_statusCode	String	If an error occurred during the merge() call, an array of one or more Error objects providing the error code and description.
Errors_message	String	If an error occurred during the merge() call, an array of one or more Error objects providing the error code and description.
MergedRecordIds	String	ID of the records that were merged into the master record. If successful, the values match mergeRequest.recordToMergeIds.
UpdatedRelatedIds	String	ID of all related records that were moved (reparented) as a result of the merge, and that are viewable by the user sending the merge call.

MetadataDeploy

Deploys file representations of components into an org by creating, updating or deleting the components they represent. To be used after executing MetadataRetrieve Stored Procedure.

Input


Name	Type	Description
FullPath	String	The full path to the zip file to upload/deploy. For instance: C:/Users/admin/Documents/deployment.zip.
AllowMissingFiles	String	Defaults to false. Specifies whether a deployment can still succeed if files that are specified in package.xml are not in the .zip file.
AutoUpdatePackage	String	Defaults to false. If a file is in the .zip file but not specified in package.xml, specifies whether the file is automatically added to the package. A MetadataRetrieve() is issued with the updated package.xml that includes the .zip file.
IgnoreWarnings	String	Defaults to false. Indicates whether deployments with warnings complete successfully or not. NOTE: Do not set this argument to true for deployments to production organizations.
RollbackOnError	String	Defaults to false. Indicates whether any failure causes a complete rollback or not.
RunAllTests	String	Defaults to false. Set to true to run all Apex tests after deployment, including tests that originate from installed managed packages.
RunTests	String	A list of Apex tests to run during deployment. Specify the class name, one name per instance. The class name can also specify a namespace with a dot notation. NOTE: To use this option, set testLevel to RunSpecifiedTests.
SinglePackage	String	Defaults to false. Indicates whether the specified .zip file points to a directory structure with a single package (true) or a set of packages.
TestLevel	String	Specifies which tests are run as part of a deployment. The test level is enforced regardless of the types of components that are present in the deployment package. Available values are 'NoTestRun', 'RunSpecifiedTests', 'RunLocalTests' and 'RunAllTestsInOrg'.

Result Set Columns


Name	Type	Description
JobId	String	The JobId for Deploy operation.
Success	String	Whether the deploy was successful or not.
Status	String	The Status of the deployment.
IgnoreWarnings	String	Specifies whether a deployment should continue even if the deployment generates warnings.
NumberComponentErrors	String	The number of components that generated errors during this deployment.
NumberComponentsDeployed	String	The number of components deployed in the deployment process.
NumberComponentsTotal	String	The total number of components in the deployment.
NumberTestErrors	String	The number of Apex tests that have generated errors during this deployment.
NumberTestsCompleted	String	The number of completed Apex tests for this deployment.
NumberTestsTotal	String	The total number of Apex tests for this deployment.

MetadataDeployDetails

Used to retrieve additional details about MetadataDeploy job. Can be used after executing MetadataDeploy Stored Procedure.

Input


Name	Type	Description
JobId	String	The JobId for Deploy operation.

Result Set Columns


Name	Type	Description
ComponentFailures_changed	String	If true, the component was changed as a result of this deployment. If false, the deployed component was the same as the corresponding component already in the organization.
ComponentFailures_componentType	String	The metadata type of the component in this deployment.
ComponentFailures_created	String	If true, the component was created as a result of this deployment. If false, the component was either deleted or modified as a result of the deployment.
ComponentFailures_createdDate	String	The date and time when the component was created as a result of this deployment.
ComponentFailures_deleted	String	If true, the component was deleted as a result of this deployment. If false, the component was either new or modified as result of the deployment.
ComponentFailures_fileName	String	The name of the file in the .zip file used to deploy this component.
ComponentFailures_fullName	String	The full name of the component.
ComponentFailures_problem	String	Description of the problem that caused the compile to fail.
ComponentFailures_problemType	String	Indicates the problem type. Valid values are 'Warning' and 'Error'.
ComponentFailures_success	String	Indicates whether the component was successfully deployed (true) or not (false).
ComponentSuccesses_changed	String	If true, the component was changed as a result of this deployment. If false, the deployed component was the same as the corresponding component already in the organization.
ComponentSuccesses_componentType	String	The metadata type of the component in this deployment.
ComponentSuccesses_created	String	If true, the component was created as a result of this deployment. If false, the component was either deleted or modified as a result of the deployment.
ComponentSuccesses_createdDate	String	The date and time when the component was created as a result of this deployment.
ComponentSuccesses_deleted	String	If true, the component was deleted as a result of this deployment. If false, the component was either new or modified as result of the deployment.
ComponentSuccesses_fileName	String	The name of the file in the .zip file used to deploy this component.
ComponentSuccesses_fullName	String	The full name of the component.
ComponentSuccesses_id	String	ID of the component being deployed.
ComponentSuccesses_success	String	Indicates whether the component was successfully deployed (true) or not (false).
NumTestsRun	String	The number of unit tests that were run.
NumFailures	String	The number of failures for the unit tests.
TotalTime	String	The total cumulative time spent running tests, in milliseconds.

MetadataRetrieve

Retrieve file representations of components in an organization.

Input


Name	Type	Description
PackageNames	String	A list of package names to be retrieved. If you are retrieving only unpackaged components, do not specify a name here. You can retrieve packaged and unpackaged components in the same retrieve.
SinglePackage	String	Defaults to false. Specifies whether only a single package is being retrieved or not. If false, then more than one package is being retrieved.
SpecificFiles	String	A list of file names to be retrieved. If a value is specified for this property, packageNames must be set to null and singlePackage must be set to true.
ManifestLocation	String	Specifies which metadata components to retrieve as part of a Retrieve call. It should point to a .xml file. Sample package.xml files can be found here: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/manifest_samples.htm. If not specified, it defaults to retrieve all custom objects.
DownloadLocation	String	The local path to save the zip file to. If not specified, the current execution path is used.

Result Set Columns


Name	Type	Description
Success	String	Whether the retrieve was successful or not.
FullPath	String	The full path (including name) of the downloaded file.

QueryBatch

Gets data from Salesforce using query batch. Only batches created in CSV format are supported. Note that the outputs of this stored procedure are dynamic and depend on the Query input.

Input


Name	Type	Description
Query	String	The query to be executed using the BULK API. It can either be a SQL query or SOQL query depending on the QueryMode input. Query parameter is required if job id and batch id are not specified.
QueryMode	String	Indicates the nature of the query to be executed. If it is a SQL query, it will be processed client-side in case of unsupported elements. In case of SOQL query it will directly be sent to Salesforce as is. Note that SOQL query does not support the following: COUNT, ROLLUP, SUM, GROUP BY CUBE, OFFSET, Nested SOQL queries, Relationship fields. Also, Bulk API cannot access or query compound address or compound geolocation fields. Columns name should be used instead of wildcard () in SOQL mode because it is not supported. The allowed values are SQL, SOQL. The default value is SOQL*.
JobId	String	The id of the job. If this parameter is specified, batch id should be specified too.
BatchId	String	The id of the batch. If this parameter is specified, job id should be specified too.
ChunkSize	String	Salesforce recommends that you enable chunking when querying tables with more than 10 million records or when a bulk query consistently times out. If chunksize is specified the query, result will be splited into multiple batches. Set the value equal to 0 to disable spliting the result into chunks. The maximum size of the chunk cannot be more than 250000 The default value is 30000.
ConcurrencyMode	String	The concurrency mode for the job. The valid values are Parallel or Serial. Parallel: Process batches in parallel mode which is the default value. Serial: Process batches in serial mode. Processing in parallel can cause database contention. When this is severe, the job may fail. If you experience this issue, submit the job with serial concurrency mode. This guarantees that batches are processed one at a time. Note that using this option may significantly increase the processing time for a job. The allowed values are Parallel, Serial. The default value is Parallel.
SkipErrors	String	This boolean parameter indicates if the provider should skip failed batches and get results for completed batches. The allowed values are true, false. The default value is false.
Rows@Next	String	This is used to page through multiple pages of results and should not be set manually.

Result Set Columns


Name	Type	Description
QueryJobId	String	The Id of the job.
QueryBatchId	String	The Id of the batch.

QueryResultsV2

Gets the results for a query job. The job must have the state JobComplete.

Input


Name	Type	Description
JobId	String	Id of the job being retrieved.
Locator	String	A string that identifies a specific set of query results. Providing a value for this parameter returns only that set of results.
MaxRecords	String	The maximum number of records to retrieve per set of results for the query.
FileName	String	The file name to use when local path is specified.
LocalPath	String	The local path to save the files to. If no path is specified, the file is kept in memory in the FileData output.
Encoding	String	The encoding of the data that will be output to FileData. The allowed values are NONE, BASE64. The default value is BASE64.

Result Set Columns


Name	Type	Description
Success	String	The status of the download for a specific file.
Locator	String	A string that identifies a specific set of query results.
FullPath	String	The full path (including name) of the downloaded file.
FileData	String	The file data output, if the LocalPath input is empty.

Undelete

Restores from Salesforce's RecycleBin a deleted record.

Procedure-Specific Information

To restore an object from Salesforce's recycle bin you need to use one of the following examples:

1. By specifying the Id of the deleted record.

EXECUTE Undelete Id = '1'

2. By specifying a list of deleted record Ids.

INSERT INTO Account#TEMP (ID) VALUES (1)
INSERT INTO Account#TEMP (ID) VALUES (2)
INSERT INTO Account#TEMP (ID) VALUES (3)

EXECUTE Undelete Id = 'Account#TEMP'

3. By specifying a list of Ids that are XML formatted.

EXECUTE Undelete XML = '<undelete xmlns="urn:enterprise.soap.sforce.com"> <ids>1</ids> <ids>2</ids> <ids>3</ids> </undelete>'

Input


Name	Type	Description
ID	String	The Id of the object that has been deleted. This or XML input are required.
XML	String	List of ids formatted in XML. This or ID input are required.

Result Set Columns


Name	Type	Description
Success	String	Returns true if the object is restored successfully.
ID	String	The Id of the restored object/s, if the operation is successful.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Salesforce:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations::

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Account table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Account'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the CreateJob stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateJob' AND Direction=1 OR Direction=2

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Account table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Account'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
AuthScheme	The type of authentication to use when connecting to Salesforce.
User	Specifies the user ID of the authenticating Salesforce user account.
Password	Specifies the password of the authenticating user account.
SecurityToken	The security token used to authenticate access to the Salesforce account.
UseSandbox	A boolean determining if the connection should be made to a Salesforce sandbox account.

Connection

Property	Description
APIVersion	The version of the Salesforce API used.
LoginURL	URL to the Salesforce server used for logging in.

SSO

Property	Description
SSOLoginURL	The identity provider's login URL.
SSOProperties	Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
SSOExchangeUrl	The URL used for consuming the SAML response and exchanging it for service specific credentials.

BulkAPI

Property	Description
UseBulkAPI	Whether to use the synchronous SOAP API or the asynchronous Bulk API.
BulkAPIConcurrencyMode	The concurrency mode for processing bulk rows with BULK API v1.
BulkUploadLimit	The max file size in MB allowed to be ingested by the Bulk API V2.
BulkPollingInterval	The time interval in milliseconds between requests that check the availability of the bulk query response. The default value is 500 ms.
BulkQueryTimeout	The timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes.
WaitForBulkResults	Whether to wait for bulk results when using the asynchronous API. Only active when UseBulkAPI is true.
BulkAPIVersion	The version of the bulk API to use for processing queries.

ToolingAPI

Property	Description
UseToolingAPI	Whether to use the Salesforce Tooling API.

OAuth

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
OAuthGrantType	Specifies the grant type for the chosen OAuth flow. This value should be the same as the grant_type that was set during OAuth custom application creation.

JWT OAuth

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

Property	Description
AllOrNone	A boolean indicating if you would like all inserts, updates, or deletes to fail in a request if even a single record fails.
ArchiveMode	Boolean indicating whether to include deleted and archived records with a standard SELECT query.
ContinueOnAlterException	Whether you want to continue after a ALTER statement has failed.
ExposeConceptualEntities	Boolean determining if the Salesforce record types / conceptual entities should be exposed as tables.
FilterScope	Optional scope to limit the records returned from queries.
IncludeMetadataDescription	Set this property to a value other than NONE if you want to retrieve the descriptions for columns, tables or both of them from the Metadata API.
IncludeReports	Whether to expose Salesforce Reports as views.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
QueryPassthrough	Whether to accept SOQL queries.
RemoveBOMCharacter	Specifies whether to remove the BOM character (char)0xfeff from the content.
RemovePrivateChar	Specifies whether to replace private use characters with a '?'.
ReplaceInvalidUTF8Chars	Specifies whether to replace invalid UTF8 characters with a '?'.
ReportExactPicklistLength	Whether to report the exact Salesforce length of picklist fields or report them with a length of 255.
ServerSideAggregation	A boolean determining if server side aggregation should be used.
SessionTimeout	The time in minutes for which a Salesforce login session is reused.
SkipFormulaFields	Set to true if formula fields should be skipped when listing columns.
SkipPickListTranslation	A comma seperated list of columns to skip translation on. Example: Table1.Col1, Col3, ... ;.
SortColumns	Set to true to sort table columns instead of reporting them in the Salesforce order.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
TranslatePickListFields	Whether to translate PickList fields into the language of the user.
UseDisplayNames	Boolean determining if the display names for the columns should be used instead of the API names.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
AuthScheme	The type of authentication to use when connecting to Salesforce.
User	Specifies the user ID of the authenticating Salesforce user account.
Password	Specifies the password of the authenticating user account.
SecurityToken	The security token used to authenticate access to the Salesforce account.
UseSandbox	A boolean determining if the connection should be made to a Salesforce sandbox account.

Remarks

To connect to a Salesforce sandbox account, set UseSandbox = true and append the sandbox name to the end of the user name. For example, if your user name is "user", and sandbox name in Salesforce is "sandbox", the specified User should appear as "user.sandbox".

Connection

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

Property	Description
APIVersion	The version of the Salesforce API used.
LoginURL	URL to the Salesforce server used for logging in.

APIVersion

The version of the Salesforce API used.

Data Type

string

Default Value

"62.0"

Remarks

The Salesforce API version used by default is 62.0.

LoginURL

URL to the Salesforce server used for logging in.

Data Type

string

Default Value

""

Remarks

URL to the Salesforce server used for logging in. Defaults to https://login.salesforce.com/services/Soap/c/62.0. This should only be changed if your organization uses a custom login endpoint.

SSO

This section provides a complete list of the SSO properties you can configure in the connection string for this provider.

Property	Description
SSOLoginURL	The identity provider's login URL.
SSOProperties	Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
SSOExchangeUrl	The URL used for consuming the SAML response and exchanging it for service specific credentials.

SSOLoginURL

The identity provider's login URL.

Data Type

string

Default Value

""

Remarks

The identity provider's login URL.

SSOProperties

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.

Data Type

string

Default Value

""

Remarks

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. This is used with the SSOLoginURL.

SSO configuration is discussed further in .

SSOExchangeUrl

The URL used for consuming the SAML response and exchanging it for service specific credentials.

Data Type

string

Default Value

""

Remarks

The CData Cloud will use the URL specified here to consume a SAML response and exchange it for service specific credentials. The retrieved credentials are the final piece during the SSO connection that are used to communicate with Salesforce.

BulkAPI

This section provides a complete list of the BulkAPI properties you can configure in the connection string for this provider.

Property	Description
UseBulkAPI	Whether to use the synchronous SOAP API or the asynchronous Bulk API.
BulkAPIConcurrencyMode	The concurrency mode for processing bulk rows with BULK API v1.
BulkUploadLimit	The max file size in MB allowed to be ingested by the Bulk API V2.
BulkPollingInterval	The time interval in milliseconds between requests that check the availability of the bulk query response. The default value is 500 ms.
BulkQueryTimeout	The timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes.
WaitForBulkResults	Whether to wait for bulk results when using the asynchronous API. Only active when UseBulkAPI is true.
BulkAPIVersion	The version of the bulk API to use for processing queries.

UseBulkAPI

Whether to use the synchronous SOAP API or the asynchronous Bulk API.

Data Type

bool

Default Value

false

Remarks

This property determines whether or not the asynchronous Bulk API is used for reads and writes to Salesforce. For reads, the driver will automatically create bulk query jobs and start returning results as they are available. Note that queries using a JOIN or aggregation are not supported in the Bulk API and therefore the driver will fall back to using the SOAP API for these queries. Jobs are closed automatically once they are complete or if there is a failure.

For writes back to Salesforce, up to 10000 records can be sent per batch. These requests will be processed asynchronously meaning the driver will not wait for Salesforce to process the results fully. You can query the following table to get information about the jobs and batches that were created:

SELECT * FROM [Info#TEMP]

Default Value

"25"

Remarks

The timeout in minutes for which the Cloud will wait for a bulk query response. The default value is 25 minutes. When UseBulkAPI is set, the Cloud starts an asynchronous job in Salesforce when running a SELECT query. It then waits for the response to be ready by periodically polling the server to check status. This property controls the total time the Cloud will wait for a response.

Note that this property is very different from Timeout. The Timeout is an inactivity timeout that controls the time to wait for any response. This property controls the total length of time to wait for a bulk query to execute. ;

WaitForBulkResults

Whether to wait for bulk results when using the asynchronous API. Only active when UseBulkAPI is true.

Data Type

bool

Default Value

false

Remarks

This property determines whether the Cloud will wait for bulk requests to report their status. By default this property is false and any INSERT, UPDATE or DELETE queries will complete as soon as they are submitted to Salesforce. When this property is true, the Cloud will wait for INSERT, UPDATE and DETETE queries to finish.

When this property is false, data modification queries will be faster but less detailed status information will be available. The LastResultInfo#TEMP table will list the creates batches and not the status of individual rows. Information about individual rows will only be availble if you execute the GetBatchResults stored procedure for each batch.

When this property is true, data modification queries will be slower but more status information will be available. The LastResultInfo#TEMP table will list the ID of each updated row, its status and any associated error messages.

BulkAPIVersion

Remarks

In most cases, the default grant type should not be modified. For information about the most common OAuth grant types and the trade-offs between them, see https://oauth.net/2/grant-types/.

JWT OAuth

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

OAuthJWTCert

The JWT Certificate store.

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

OAuthJWTCertType

The type of key store containing the JWT Certificate.

Possible Values

PFXBLOB, JKSBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, XMLBLOB, BCFKSBLOB

Data Type

string

Default Value

"PEMKEY_BLOB"

Remarks

This property can take one of the following values:


USER	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.
BCFKSFILE	The certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOB	The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.

OAuthJWTCertPassword

""

Remarks

The user subject for which the application is requesting delegated access. Set this to the username (email address) of the user who is permitted to use the OAuth App.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
AllOrNone	A boolean indicating if you would like all inserts, updates, or deletes to fail in a request if even a single record fails.
ArchiveMode	Boolean indicating whether to include deleted and archived records with a standard SELECT query.
ContinueOnAlterException	Whether you want to continue after a ALTER statement has failed.
ExposeConceptualEntities	Boolean determining if the Salesforce record types / conceptual entities should be exposed as tables.
FilterScope	Optional scope to limit the records returned from queries.
IncludeMetadataDescription	Set this property to a value other than NONE if you want to retrieve the descriptions for columns, tables or both of them from the Metadata API.
IncludeReports	Whether to expose Salesforce Reports as views.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
QueryPassthrough	Whether to accept SOQL queries.
RemoveBOMCharacter	Specifies whether to remove the BOM character (char)0xfeff from the content.
RemovePrivateChar	Specifies whether to replace private use characters with a '?'.
ReplaceInvalidUTF8Chars	Specifies whether to replace invalid UTF8 characters with a '?'.
ReportExactPicklistLength	Whether to report the exact Salesforce length of picklist fields or report them with a length of 255.
ServerSideAggregation	A boolean determining if server side aggregation should be used.
SessionTimeout	The time in minutes for which a Salesforce login session is reused.
SkipFormulaFields	Set to true if formula fields should be skipped when listing columns.
SkipPickListTranslation	A comma seperated list of columns to skip translation on. Example: Table1.Col1, Col3, ... ;.
SortColumns	Set to true to sort table columns instead of reporting them in the Salesforce order.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
TranslatePickListFields	Whether to translate PickList fields into the language of the user.
UseDisplayNames	Boolean determining if the display names for the columns should be used instead of the API names.

Default Value

"None"

Remarks

false

Remarks

Boolean determining if the display names for the columns should be used instead of the API names.

Cloud

Salesforce - CData Cloud

Overview

Key Features

Getting Started

Connecting to Salesforce

Accessing Data from CData Cloud Services

Establishing a Connection

Connecting to Salesforce

Authenticating to Salesforce

User Credentials

OAuth

OAuth Password Grant

OAuthJWT Certificates

OAuthJWT

AzureAD

Okta

OneLogin

PingFederate

ADFS

ADFS Integrated

OAuth Scopes and Endpoints

Required Scopes and Endpoint Domains for Salesforce

Understanding Scopes

Required Scopes for Salesforce

Understanding Endpoint Domains

Required Endpoint Domains for Salesforce

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Tables

Stored Procedures

Views

Working with Polymorphic Fields

Data Type Mapping

Data Type Mapping

Polymorphic Fields

Working with Polymorphic Fields

Polymorphic Field Types

Salesforce Reports and Dashboards API

Salesforce Reports and Dashboards API

Tabular Reports

Summary and Matrix Reports

Query examples

Tables

CData Cloud - Salesforce Tables

AcceptedEventRelation

Columns

Account

Columns

AccountContactRole

Columns

AccountFeed

Columns

AccountHistory

Columns

AccountPartner

Columns

AccountShare

Columns

AdditionalNumber

Columns

ApexClass

Columns

ApexComponent

Columns

ApexLog

Columns

ApexPage

Columns

ApexTestQueueItem

Columns

ApexTestResult

Columns

ApexTrigger

Columns