Salesforce

Building the JDBC URL

After installing the license, access the connection management page by executing the command "java -jar kingswaysoft.jdbc.jar". Enter the necessary details, and the program will automatically generate the JDBC connection URL. Users can click Test Connection to test the generated URL and Copy to Clipboard to copy the connection string for use within the application where the JDBC driver is being used.

NOTE: If a license is not installed, you can still use the connection manager to generate a JDBC URL, but the 'Test Connection' feature will be disabled.

General Page

The General page allows you to specify connection properties and login credentials for the Salesforce REST service:

connectionmanage

General Settings

Service Endpoint

The Service Endpoint option allows you to specify the API you want to connect to Salesforce with. There are two options available:

  • SOAP
  • REST
Instance Type

The Instance Type option allows you to specify what Salesforce instance you are connecting to. There are three options available:

  • Production
  • Sandbox
  • Other

For the first two options, the Service URL option below will be automatically populated. In the case the "Other" option is selected, you can specify an alternate Service URL which may not be a default one. This can be used for the case that you are connecting to a special Salesforce deployment including the situation that you use your own custom domain for Salesforce access.

Service URL

Using this option to provide an alternate URL that will be used to post transactions to your Salesforce instance. This field is only available when the Instance Type option above has been selected as "Other", for the other two options (Production and Sandbox), the Service URL is automatically populated using a default value.

Authentication Methods for Salesforce

SOAP

Enter User Name, Password, Security Token, and Server URL to establish a connection.

Authentication
User Name

The User Name option allows you to specify the user account used to connect to Salesforce.com for your integration purpose.

Password (SOAP Service Endpoint)

The Password option allows you to specify a password for the above user in order to be able to log in to the Salesforce service.

Security Token (SOAP Service Endpoint)

The Security Token option is used to specify the security token that you have requested in Salesforce.com. If you do not have a security token yet, you must request one by resetting your security token. To do so, login to Salesforce.com, click Your Name | My Settings | Personal | Reset Security Token, and then click the Reset My Security Token button. The new security token is sent via email to the email address on your Salesforce user record. Note that there is no way to retrieve your security token from Salesforce. In case you have lost it, you must request a new one by resetting it again. If you ever need to do so, make sure that you update the security token setting of any other applications that might be using the same authentication.

REST
Authentication Mode

This option allows you to specify the preferred type of authentication you want to use when connecting to Salesforce's REST API. There are three options available:

  • Authorization Code
  • Certificate
  • Password
Authorization Code

A pre-existing token can be used to establish a connection. If you wish to generate a new authentication token, click Generate Token File to go through the token generation process. You can use the generated token file to connect.

Authentication
Generate Token File

This button completes the OAuth authentication process in order to generate a new token.

  • Client Id: The Client Id option allows you to specify the unique ID which identifies the application making the request.
  • Client Secret: The Client Secret option allows you to specify the client secret belonging to your app.
  • Redirect Url: The Redirect Url option allows you to specify the Redirect Url to complete the authentication process.
  • Prevent Cross-Sit Request Forgery (CSRF) exploits: Cross-site request forgery(CSRF) is an attack that can cause the user to perform unwanted actions on web pages the user is authenticated on. The option is turned on by default and can be turned off if necessary.
  • PKCE (Proof Key for Code Extension): Ensures that the client that initiates the OAuth flow is the same client that completes flow. This option would need to be set in the Salesforce connected app or as an org-wide option.
Token Path

The path to the token file on the file system.

Token Password

The password to the token file.

Certificate

Users can choose to use a saved certificate file and certificate password to establish a connection. Alternatively, they can click "Generate New Certificate" to go through the certificate generation process, generate a keystore, save it locally, and use the set certificate password to connect. (Note: The certificate file only supports the PFX format. For newly generated certificates, the simultaneously generated PEM file needs to be configured in the portal.)

Authentication
Client Id

The Client Id option allows you to specify the unique ID which identifies the application making the request.

Certificate Path

The Certificate Path option is only available when the Certificate Authentication Mode has been chosen, it allows you to specify the path to the certificate you wish to use to authenticate.

Certificate Password

The Certificate Password option is only available when the Certificate Authentication Mode has been chosen, it allows you to specify the password of the certificate you have specified in Certificate Path

User Name

The User Name option allows you to specify the user account used to connect to Salesforce.com for your integration purpose.

Password

Use your User Name, Password, Client ID, Client Secret and Security Token to connect when using the Password Authentication Mode

Authentication
Client Id

The Client Id option allows you to specify the unique ID which identifies the application making the request.

Client Secret

The Client Secret option allows you to specify the client secret belonging to your app.

User Name

The User Name option allows you to specify the user account used to connect to Salesforce.com for your integration purpose.

Password

The Password option allows you to specify a password for the above user in order to be able to log in to the Salesforce service.

Security Token

The Security Token option is used to specify the security token that you have requested in Salesforce.com. If you do not have a security token yet, you must request one by resetting your security token. To do so, login to Salesforce.com, click Your Name | My Settings | Personal | Reset Security Token, and then click the Reset My Security Token button. The new security token is sent via email to the email address on your Salesforce user record. Note that there is no way to retrieve your security token from Salesforce. In case you have lost it, you must request a new one by resetting it again. If you ever need to do so, make sure that you update the security token setting of any other applications that might be using the same authentication.

Test Connection

After all the connection information has been provided, click the "Test Connection" button to test if the user credentials entered can successfully connect to the selected service.

Advanced Settings Page

The Advanced Settings page allows you to specify advanced settings for the connection.

connectionmanage

Proxy Server Settings
Proxy Mode

The Proxy Mode option allows you to specify how you want to configure the proxy server setting. There are three options available.

  • No Proxy
  • Auto-detect (Using system-configured proxy)
  • Manual
Proxy Server

Using the Proxy Server option allows you to specify the name of the proxy server for the connection.

Port

The Port option allows you to specify the port number of the proxy server for the connection.

Username (Proxy Server Authentication)

The Username option (under Proxy Server Authentication) allows you to specify the proxy user account.

Password (Proxy Server Authentication)

The Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Miscellaneous Settings
Timeout (secs)

The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds. Specify 0 for infinite timeout.

Retry on Intermittent Errors

The retry on intermittent errors determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.

Ignore Certificate Errors

This option can be used to ignore those SSL certificate errors when connecting to the target server.

Warning: Enabling the "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instances. Unless there is a strong reason to believe the connection is secure - such as the network communication is only happening in an internal infrastructure, this option should be unchecked for best security.

Note: When this option is enabled, it applies to all HTTP-based SSL connections in the same job process.

Optional Headers
Allow Save on Duplicate

When this option is enabled, the service calls made to Salesforce will contain a header option that indicates that duplicates are allowed.

Allow Field Truncation

When this option is enabled, the service calls made to Salesforce will contain a header option that indicates that field truncation is allowed.

Assignment Rule

Using this option, you can specify the assignment rule to be fired when a lead or case is created using the Salesforce destination component. The input of this field should be the ID of the assignment rule in Salesforce. You can get an assignment rule's ID by navigating to the assignment rule record in Salesforce, the ID should be the last part of the URL, which generally consists of 18 characters.

Use Default Assignment Rule

This option allows you to use the default (active) assignment rule for a Case/Lead or apply all territory assignment rules to the Account.

Include Deleted

This option allows you to receive deleted objects from the API response.

Using the JDBC Driver

Explore detailed examples in this section that demonstrate the application of JDBC classes such as Connection, Statement, and ResultSet to effectively manage interactions with Salesforce data. This section covers the use of regular statements and prepared statements for executing complex or frequently executed queries.

Executing Statements

Once you've connected from your code (see Connecting with DriverManager and Connecting with Data Sources), you can execute SQL statements using the Statement class. Refer to "Executing Prepared Statements" to execute parameterized statements.

SELECT

Use the Statement class's generic execute method or the executeQuery method to execute SQL statements that return data. To retrieve the results of a query, you would then call the getResultSet method of the Statement.

Statement statement = connection.createStatement();	

String query = "SELECT * FROM Account";
		
ResultSet resultSet = statement.executeQuery(query);

while (resultSet.next()) {
    for (int i = 1; i <= resultSet.getMetaData().getColumnCount(); i++) {
        LOGGER.info(resultSet.getMetaData().getColumnLabel(i) + "=" + resultSet.getString(i));
    }
}

Note: Currently, SELECT queries only support SOQL.

INSERT

Use either the generic execute method or the executeUpdate method of the Statement class to execute an INSERT operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the inserted data's ID, exceptions raised during execution, and details of the affected data.

try {	
    Statement statement = connection.createStatement();	
    String query = "INSERT INTO Account (Name,type) VALUES ('test', 'test type')";		
    statement.executeUpdate(query);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	
id,errorcode,errormessage,processdata,haserrors
0016T00003BuPrPQAV,null,null,{"attributes":{"type":"Account"},"Type":"test type","Name":"test"},false

UPDATE

Use either the generic execute method or the executeUpdate method of the Statement class to execute an UPDATE operation.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the updated data's ID, exceptions raised during execution, and details of the affected data.

try {	
    Statement statement = connection.createStatement();	
    String query = "UPDATE Account SET AccountNumber = '12345' WHERE type IN ('test type');";		
    statement.executeUpdate(query);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	
id,errorcode,errormessage,processdata,haserrors
0016T00003BuPrPQAV,null,null,{"attributes":{"type":"Account"},"Id":"0016T00003BuPrPQAV","AccountNumber":"12345"},false

DELETE

Use either the generic execute method or the executeUpdate method of the Statement class to execute a DELETE operation. Deleted records aren't deleted permanently from Salesforce, but they are placed in the Recycle Bin for 15 days from where they can be restored. The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the deleted data's ID, exceptions raised during execution, and details of the affected data.

try {
    Statement statement = connection.createStatement();	
    String query = "DELETE FROM Account WHERE Name = 'test1'";			
    statement.executeUpdate(query);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	
id,errorcode,errormessage,processdata,haserrors
0016T00003BvAZZQA3,null,null,null,false

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call. To determine whether a record already exists, the UPSERT statement or Database method uses the record's ID as the key to match records, a custom external ID field, or a standard field with the idLookup attribute set to true. If the key isn't matched, then a new object record is created.

  • If the key is matched once, the existing object record is updated.
  • If the key is matched multiple times, an error is generated and the object record is not inserted or updated.

In the Upsert SQL statement, it needs to end with 'ON DUPLICATE KEY UPDATE UPSERTFIELDS = key', where 'key' refers to the field specified by the user as the upsert key.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the ID of upserted data, exceptions raised during execution, and the data affected by the upserting.

String query = "UPSERT INTO Account (Name, AccountNumber, type, id) "
    + "VALUES ('test1', '123456', 'test type', null), "
    + "('test2', '123456', 'test type', '0016T00003Bv8vjQAB') "
    + "ON DUPLICATE KEY UPDATE UPSERTFIELDS = id";

try {	
    Statement statement = connection.createStatement();			
    statement.executeUpdate(query);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	
id,errorcode,errormessage,processdata,haserrors,isNew
0016T00003BvAZZQA3,null,null,SOAP Object=[Type=test type;Id=null;Name=test1;AccountNumber=123456;],false,true
0016T00003Bv8vjQAB,null,null,SOAP Object=[Type=test type;Id=0016T00003Bv8vjQAB;Name=test2;AccountNumber=123456;],false,false

Executing Prepared Statements

Using a PreparedStatement can improve performance when you need to execute a SQL statement multiple times with different parameters. Unlike a Statement object, a PreparedStatement object is provided with a SQL statement when it is created, which can then be executed with different values each time. This special type of statement is derived from the more general class, Statement.

Below are the steps outlining how to execute a prepared statement:

  1. Create a PreparedStatement: Use the prepareStatement method of the Connection class to instantiate a PreparedStatement. Refer to Connecting with DriverManager or Connecting with DataSource for information related to establishing connections.
  2. Set Parameters: Declare parameters by calling the corresponding setter method of the PreparedStatement. Note: The parameter indices start at 1.
  3. Execute the Statement: Use the generic execute or executeUpdate method of the PreparedStatement.
  4. Retrieve Results: Call the getResultSet method of the Prepared Statement to obtain the query results, which will be returned as a ResultSet.
  5. Iterate Over the Result Set: Use the next method of the ResultSet to iterate through the results. To obtain column information, utilize the ResultSetMetaData class. Instantiate a ResultSetMetaData object by calling the getMetaData method of the ResultSet.

SELECT

Use the Statement class's generic execute method or the executeQuery method to execute SQL statements that return data.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the retrieved data.

String query = "SELECT Accountnumber, Name, CreatedByid, CreatedDate FROM Account WHERE name = ?";
try {	
    PreparedStatement ps = connection.prepareStatement(query);
    ps.setString(1, "test1");
    ps.execute(query);
    while (ps.getResultSet().next()) {
        for (int i = 1; i <= ps.getResultSet().getMetaData().getColumnCount(); i++) {
            LOGGER.info(ps.getResultSet().getMetaData().getColumnLabel(i) + "=" + ps.getResultSet().getString(i));
        }
    }
} catch (SQLException e) {
    LOGGER.error(e);
}	

Note: Currently, SELECT queries only support SOQL.

INSERT

Use either the generic execute method or the executeUpdate method of the Statement class to execute an INSERT operation.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of inserted data, exceptions raised during execution, and the data affected by the insertion.

String query = "INSERT INTO Account (Name, AccountNumber, type) VALUES (?, ?, ?)";

try {
    PreparedStatement ps = connection.prepareStatement(query);			
    ps.setString(1, "test2");
    ps.setString(2, "123456");
    ps.setString(3, "test type");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	
id,errorcode,errormessage,processdata,haserrors
0016T00003BvS9uQAF,null,null,SOAP Object=[Type=test type;Name=test2;AccountNumber=123456;],false

UPDATE

Use either the generic execute method or the executeUpdate method of the Statement class to execute an UPDATE operation.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of updated data, exceptions raised during execution, and the data affected by the update.

String query = "UPDATE Account SET AccountNumber = ? WHERE type IN (?)";

try {	
    PreparedStatement ps = connection.prepareStatement(query);
    ps.setString(1, "654321");
    ps.setString(2, "test type");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	
id,errorcode,errormessage,processdata,haserrors
0016T00003BvSJpQAN,null,null,SOAP Object=[AccountNumber=654321;],false

DELETE

Use either the generic execute method or the executeUpdate method of the Statement class to execute a DELETE operation. Deleted records aren't deleted permanently from Salesforce, but they are placed in the Recycle Bin for 15 days from where they can be restored. The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the deleted data's ID, exceptions raised during execution, and details of the affected data.

String query = "DELETE FROM Account WHERE Name = ?";

try {	
    PreparedStatement ps = connection.prepareStatement(query);
    ps.setString(1, "test1");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	
id,errorcode,errormessage,processdata,haserrors
0016T00003BvSMFQA3,null,null,null,false

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call. To determine whether a record already exists, the UPSERT statement or Database method uses the record's ID as the key to match records, a custom external ID field, or a standard field with the idLookup attribute set to true. If the key isn't matched, then a new object record is created.

  • If the key is matched once, the existing object record is updated.
  • If the key is matched multiple times, an error is generated and the object record is not inserted or updated.

In the Upsert SQL statement, it needs to end with 'ON DUPLICATE KEY UPDATE UPSERTFIELDS = key', where 'key' refers to the field specified by the user as the upsert key.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the ID of upserted data, exceptions raised during execution, and the data affected by the upserting.

String query = "UPSERT INTO Account (Name, AccountNumber, type, id) "
    + "VALUES (?, ?, ?, ?)"
    + "ON DUPLICATE KEY UPDATE UPSERTFIELDS = id";

try {	
    PreparedStatement ps = connection.prepareStatement(query);
    ps.setString(1, "test3");
    ps.setString(2, "654321");
    ps.setString(3, "test type");			
    ps.setNull(4, Types.VARCHAR);
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	
id,errorcode,errormessage,processdata,haserrors,isNew
null,null,SOAP Errors:[[StatusCode=DUPLICATES_DETECTED;Message=Use one of these records?];],SOAP Object=[Type="test type";Id="0016T000033urGHQAY";Name="test3";AccountNumber="654321";],false,false

Metadata Discovery

This section provides examples on how to retrieve table and column metadata using the getTables, getColumns, and getPrimaryKeys methods from the DatabaseMetaData interface. These are essential for discovering database structures.

Tables

The getTables method from the DatabaseMetaData interface can be used to retrieve a list of tables.

Class.forName("com.kingswaysoft.jdbc.Drivers");

Properties connectionProps = new Properties();
connectionProps.put("user", "username");
connectionProps.put("password", "password");
connectionProps.put("securityToken", "token");

Connection connection = DriverManager.getConnection("jdbc:kingswaysoft:url=https://login.salesforce.com/services/Soap/u/58.0;serviceEndpoint=SOAP;", connectionProps);

ResultSet resultSet = connection.getMetaData().getTables(null, null, null, null);
LOGGER.info(resultSet.toString());
TABLE_CAT,TABLE_SCHEM,TABLE_NAME,TABLE_TYPE,REMARKS
null,null,AcceptedEventRelation,Table,
null,null,Account,Table,
null,null,AccountContactRole,Table,
null,null,AccountFeed,Table,

The getTables method returns the following metadata columns:

Column Name Data Type Description
TABLE_CAT String The catalog that contains the table.
TABLE_SCHEM String The schema of the table.
TABLE_NAME String The name of the table name.
TABLE_TYPE String The type of the table (e.g., TABLE or VIEW).
REMARKS String An optional description of the table.

Columns

Use the getColumns method of the DatabaseMetaData interface to retrieve detailed information about the columns in the database. To narrow your search to a specific table, specify the table name as a parameter.

Class.forName("com.kingswaysoft.jdbc.Drivers");

Properties connectionProps = new Properties();
connectionProps.put("user", "username");
connectionProps.put("password", "password");
connectionProps.put("securityToken", "token");

Connection connection = DriverManager.getConnection("jdbc:kingswaysoft:url=https://login.salesforce.com/services/Soap/u/58.0;serviceEndpoint=SOAP;", connectionProps);

ResultSet resultSet = connection.getMetaData().getColumns(null, null, "Contact", null);
LOGGER.info(resultSet.toString());
TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,DATA_TYPE,TYPE_NAME,COLUMN_SIZE,BUFFER_LENGTH,DECIMAL_DIGITS,NUM_PREC_RADIX,NULLABLE,COLUMN_DEF,SQL_DATA_TYPE,SQL_DATETIME_SUB,CHAR_OCTET_LENGTH,ORDINAL_POSITION,IS_NULLABLE,IS_AUTOINCREMENT,IS_GENERATEDCOLUMN,SALES_FORCE_TYPE
null,null,Contact,AccountId,1,java.lang.Character,18,null,0,0,null,null,null,1,null,null,null,null,null,null,reference
null,null,Contact,AssistantName,12,java.lang.String,40,null,0,0,null,null,null,12,null,null,null,null,null,null,stringnull,null,Contact,AssistantPhone,12,java.lang.String,40,null,0,0,null,null,null,12,null,null,null,null,null,null,phone

The getColumns method returns the following columns:

Column Name Data Type Description
TABLE_CAT String The database name.
TABLE_SCHEM String The table schema.
TABLE_NAME String The table name.
COLUMN_NAME String The column name.
DATA_TYPE Integer The data type represented by a constant value from java.sql.Types.
TYPE_NAME String The data type name used by the driver.
COLUMN_SIZE Integer The length in characters of the column or the numeric precision.
BUFFER_LENGTH Integer The buffer length.
DECIMAL_DIGITS Integer The column scale or number of digits to the right of the decimal point.
NUM_PREC_RADIX Integer The radix, or base.
NULLABLE Integer Whether the column can contain null as defined by the following JDBC DatabaseMetaData constants: columnNoNulls (0) or columnNullable (1).
REMARKS String The comment or note associated with the object.
COLUMN_DEF String The default value for the column.
SQL_DATA_TYPE Integer Reserved by the specification.
SQL_DATETIME_SUB Integer Reserved by the specification.
CHAR_OCTET_LENGTH Integer The maximum length of binary and character-based columns.
ORDINAL_POSITION Integer The position of the column in the table, starting at 1.
IS_NULLABLE String Whether a null value is allowed: YES or NO.
IS_AUTOINCREMENT String Whether the column value is assigned by Salesforce in fixed increments.
IS_GENERATEDCOLUMN String Whether the column is generated: YES or NO.
SALES_FORCE_TYPE String Salesforce attribute type.

Primary Keys

The getPrimaryKeys method in the DatabaseMetaData interface is used to retrieve metadata about primary keys for a given table in Salesforce.

Class.forName("com.kingswaysoft.jdbc.Drivers");

Properties connectionProps = new Properties();
connectionProps.put("user", "username");
connectionProps.put("password", "password");
connectionProps.put("securityToken", "token");

Connection connection = DriverManager.getConnection("jdbc:kingswaysoft:url=https://login.salesforce.com/services/Soap/u/58.0;serviceEndpoint=SOAP;", connectionProps);

ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "Account");
LOGGER.info(resultSet.toString());
TABLE_NAME,PRIMARY_COLUMN_NAME
Account,Id

The getPrimaryKeys method returns the following columns:

Column Name Data Type Description
TABLE_NAME String The name of the table that contains the primary key.
PRIMARY_COLUMN_NAME String The name of the column that serves as the primary key for the table.

Connection Settings

Connection Setting Type Default Value Description
AllowFieldTruncation Boolean false Specify the AllowFieldTruncation for Salesforce.
AllowSaveOnDuplicates Boolean false Specify the AllowSaveOnDuplicates for Salesforce.
AssignmentRule String "" Specify the AssignmentRule for Salesforce.
AuthenticationType String "" The AuthenticationType specifies the method used to authenticate when connecting to Salesforce RESTful API.
CacheExpirationTime Integer 30 Defines the expiration time for cache. A value of 0 disables caching.
CertificatePassword String "" The Certificate Password used to access the keystore file.
ClientId String "" The ClientId used to access Salesforce.
ClientSecret String "" The ClientSecret used to access Salesforce.
ConnectionTimeout Integer 30 ConnectionTimeout is the maximum amount of time the program will wait to set up a connection to the Salesforce API.
IncludeDeleted Boolean false Specify the IncludeDeleted for Salesforce.
IgnoreCertificateErrors Boolean false Specifies whether to verify the certificate when connecting to Salesforce. If certificate verification is not required, you can set this value to 'true'.
IgnoreError Boolean true Determines if the program continues executing SQL statements after encountering an error.
InstanceType String "" The InstanceType for Salesforce, which includes Production, Sandbox, and Other.
LogFileSize String "10485760" A string specifying the maximum size in bytes for a log file.
LogLevel String "INFO" The logging level for the JDBC driver.
LogPath String "./jdbcLogs" The directory where log files are stored.
OemKey String "" The OEM License key.
Password String "" The password used to authenticate the user.
PathToCertificate String "" PathToCertificate specifies the file path where the keystore file for connecting to Salesforce RESTful API is located.
ProxyPassword String "" The password to be used to authenticate to the proxy.
ProxyServer String "" The host of the proxy server.
ProxyServerPort Integer 0 The port of the proxy server.
ProxyUserName String "" The user name to be used to authenticate to the proxy.
ReadBatchSize Integer 1000 ReadBatchSize is used to set how many records can be read from Salesforce in a single call.
RedirectUri String "" The redirect URI used to obtain the Salesforce authentication URL.
ResultPath String "" The path where the execution result files are saved.
RetryOnIntermittentErrors Boolean true The RetryOnIntermittentErrors parameter indicates whether to retry the connection when it might occasionally fail due to temporary issues.
SaveResult Boolean false SaveResult indicates whether to save the execution results to a file.
SecurityToken String "" The security token used to authenticate access to the Salesforce account.
ServerUrl String "" ServerUrl is used to set the URL of the server used for connecting to Salesforce.
ServiceEndpoint String "" ServiceEndpoint specifies the method used to connect to Salesforce, including SOAP and RESTful APIs.
ServiceTimeout Integer 120 The ServiceTimeout is the timeout to receive the full response from Salesforce API.
Ssl Boolean false SSL indicates whether the connection is SSL-enabled or supports SSL encryption.
TokenPassword String "" The password used to read the token file.
TokenPath String "" TokenPath specifies the file path where the token for connecting to the Salesforce RESTful API is located.
TotalThreads Integer 0 The number of threads for executing operations in parallel. A value of 0 will disable multi threading.
TrustServerCertificate Boolean false TrustServerCertificate specifies whether to verify the certificate when connecting to Salesforce. This configuration applies only to RESTful calls.
UserName String "" The User Name used to authenticate.
WriteBatchSize Integer 200 WriteBatchSize is used to set how many records can be written to Salesforce in a single call.