Global Resource Property

Connection Settings

Global resource connection setting can be created or edited by ["Global Resource Settings"] in the Control Panel or in properties of each adapter.
In the global resource settings, the below mentioned version may be selected for the resource category selection.

API 7.0
API 14.0
API 18.0
API 23.0
API 26.0
API 29.0
API 34.0

Basic Settings

Item name	Required/Optional	Use of Variables	Description	Supplement
Name	Required	Not Available	Enter the destination setting name.

Required Settings

Item name	Required/Optional	Use of Variables	Description	Supplement
User ID	Required	Only environment variables are available	Enter the login user ID.	If the [Connect with OAuth] is not checked, this field becomes valid and an input required attribute.
Password	Required	Only environment variables are available	Enter the login password.	If the [Connect with OAuth] is not checked, this field becomes valid and an input required attribute.
Login Type	Required	Not Available	Choose login type. [login.salesforce.com]:(default) Login to a Production/Developer environment. [Sandbox]: Login to a SandBox environment. [Other]: Directly define the login URL.	If the [Connect with OAuth] is not checked, this field becomes valid.
Use SSL	Required	Not Available	Select whether or not to use SSL, for the communication with Salesforce. [Use]:(default) Uses SSL. [Not Use]: Does not use SSL.	If the [Connect with OAuth] is not checked, this field becomes valid.
Login URL	Optional	Only environment variables are available	Input the login URL.	If the [Login Type] is set to [Other] and the [Connect with OAuth] is not checked, this field becomes valid and an input required attribute.
Connect to OAuth	Optional	Not Available	Choose the type of destination. [login.salesforce.com]:(default) Connect to a Production/Developer environment. [SandBox]: Connect to a SandBox environment.	If the [Connect with OAuth] is checked, this field becomes valid.
Refresh Token	Optional	Only environment variables are available	Input the Refresh Token.	If the [Connect with OAuth] is checked, this field becomes valid and an input required attribute.
Timeout (sec)	Optional	Only environment variables are available	The timeout duration of the socket level connection to Salesforce is specified by seconds. Specifically, a request, for example a query, is sent to Salesforce, and the response waiting time is displayed.	The default value is "600."
Connection timeout (sec)	Optional	Only environment variables are available	The waiting time, when establishing a connection to Salesforce, is configured by the second. Specifically, depending on whether or not to make a connection from the DataSpiderServer to multiple Salesforces simultaneously, or depending on the load or overload of the network itself, the below mentioned exception occurrence timing is adjusted. org.apache.commons.httpclient.HttpException: Timeout waiting for connection	The default value is "60."
I/O bound Data Compression	Required	Not Available	Select whether or not to GZIP compression of the request messages and response messages from/to Salesforce. By compressing the transmission data the process effectivity increases. [Compress]:(default) Data is compressed. [Not Compress]: Data is not compressed.
Connect with OAuth	Optional	Not Available	Choose the method of connecting to Salesforce. [Checked]: Connect with OAuth2.0. [Not Checked]:(default) Connect by User ID/Password.	Available when the resource type is API 29.0 or later. For details, please refer to the About Connect with OAuth.

Property Action

Item name	Description	Supplement
Connection Test	Check the connection to the host.

Option Settings

Item name	Required/Optional	Use of Variables	Description	Supplement
Field value truncation	Required	Not Available	Select whether to truncate the update value's character string if, during an update, the update value's character string length is larger than the number of item length. [Truncate]:(default) Truncates the character string. [Do Not Truncate]: Available on API 18.0 or later. Does not truncate the character string. If larger than the item length, an error will occur.	Please refer to the "AllowFieldTruncationHeader" page of the API document "SOAP API Developer's Guide" for details.
Connection method at run-time	Required	Not Available	Set the connection method to Salesforce at script run-time. [Authentication by setting of global resource]:(default) Automatically create session to connect by [UserID] [Password] login authentication or by retrieving token with [Refresh Token]. [Take over the session from outside]: The existing session information (Server URL, Session ID) will be passed on when connected. Please run the operation [login (by SessionID)] to carry out the session.	An authentication by global resource setting will be conducted for sessions requiring designer manipulation even if the[Take over the session from outside] is selected.
Specify the Namespace	Optional	Not Available	Select whether or not to specify the "defaultNameSpace" in the session header's call options. [Checked]: Specifies the namespace. [Not Checked]:(default) Does not specify the namespace.
Namespace prefix	Optional	Available	Specify the character string which distinguishes the namespace prefix.	This becomes valid only when [Specify the Namespace] is checked. There is no need to add an underscore(_) at the end of the characters.
Make DST adjustments when updating Date Format Field	Optional	Not Available	Specify whether or not to make DST adjustments when updating date format field. [Checked]:(default) Apply the daylight savings time correction. [Not Checked]: Do not apply the daylight savings time correction. The same behavior as before this item is added will be retained.	For example, in Japan, the time zone in the daylight savings time run-in-period (the 24th hour of the first Saturday of May (April instead of May, only in 1949) to the 25th hour of the second Saturday of September, of every year, from May of 1948 to April of 1952) was "+1000." If not to apply the daylight savings time correction, because the GMT change is certainly performed based on the standard time ("+0900" in Japan), depending on the settings of this item, the update-type function's update results, to this period's date input data, will vary. Examples of cases [Checked] Input Data:1948-06-01 Result:1948-06-01 Input Data:1948-06-01H12:00:00 Result:1948-06-01 Examples of cases [Not Checked] Input Data:1948-06-01 Result:1948-05-31 Input Data:1948-06-01H12:00:00 Result:1948-06-01 For global resources created on the version before this item was added, the default will be [Not Checked]. For the date-time type (datetime), the daylight savings time correction will be performed regardless of this item's settings.

PROXY setting

Item name	Required/Optional	Use of Variables	Description	Supplement
Proxy setting	Required	Not Available	Select whether or not to use the proxy server. [Use]: Use the proxy server. [Not Use]:(defualt) Not use the proxy server.
Proxy host	Optional	Only environment variables are available	Enter the proxy server's host address. This becomes valid and required when [USE] is selected for the [Proxy setting].
Proxy port	Optional	Only environment variables are available	Enter the proxy server's port number. This becomes valid and required when [USE] is selected for the [Proxy setting].
Proxy user	Optional	Only environment variables are available	Enter the proxy server's authentication User. This becomes valid when [USE] is selected for the [Proxy setting].	Only the basic authentication is available.
Proxy password	Optional	Only environment variables are available	Enter the proxy server's authentication password. This becomes valid when [USE] is selected for the [Proxy setting].

SOAP Header Setting

Item name	Required/Optional	Use of Variables	Description	Supplement
AllOrNone Header (allOrNone)	Optional	Not Available	Specifies the allOrNone field of the AllOrNone header. [Checked]: A rollback will occur if, in an update-related call, all of the records in 1 batch do not succeed. [Not Checked]:(default) A rollback in update-related calls is disabled.	Available when the resource type is API 23.0 or later. In an update-related call, the input data is subdivied and executed in the unit of the batch size. Therefore, if [Checked] is selected, the rollbacks occur by each batch. For example, in a case where the batch size is set as 200, and if an error data existed as the 500th of the 1,000 overall input data, The first 1-400 will succeed, the 401-600th will be rollbacked, and the 601-1,000th will succeed. Therefore, the function would be considered effective when the input data is smaller than the batch size (maximum 200). For details, please refer to the "AllOrNoneHeader" page of the API document "SOAP API Developer's Guide."
Email Header (triggerAutoResponseEmail)	Optional	Not Available	Specify the triggerAutoResponseEmail field, in the Email header. [Checked]: For read and case, the automatic response rule's trigger becomes enabled. [Not Checked]:(default) The trigger is disabled.	Available when the resource type is API 14.0 or later. For details, please refer to the "EmailHeader" page of the API document "SOAP API Developer's Guide."
Email Header (triggerOtherEmail)	Optional	Not Available	Specify the triggerOtherEmail field, in the Email header. [Checked]: The trigger of the emails outside the organization becomes enabled. [Not Checked]:(default) The trigger is disabled.	Available when the resource type is API 14.0 or later. For details, please refer to the "EmailHeader" page of the API document "SOAP API Developer's Guide."
Email Header (triggerUserEmail)	Optional	Not Available	Specify the triggerUserEmail field, in the Email header. [Checked]: The trigger of the emails, which will be sent to users within the organisation, becomes enabled. [Not Checked]:(default) The trigger is disabled.	Available when the resource type is API 14.0 or later. For details, please refer to the "EmailHeader" page of the API document "SOAP API Developer's Guide."
Mru Header (updateMru)	Optional	Not Available	Specify the updateMru field, in the Mru header. [Checked]: Updates the list of recently used items. [Not Checked]:(default) Do not update the list of recently used items.	For details, please refer to the "MruHeader" page of the API document "SOAP API Developer's Guide."
AssignmentRule Header (useDefaultRule)	Optional	Not Available	Specify the useDefaultRule field, in the AssignmentRule header. [Checked]: The default assignment rules are applied for read and case. [Not Checked]:(default) The assignment rules will not be applied.	For details, please refer to the "AssignmentRuleHeader" page of the API document "SOAP API Developer's Guide."
AssignmentRule Header (assignmentRuleId)	Optional	Not Available	Specify the assignmentRuleId field, in the AssignmentRule header. Specify the read/case assignment rule ID. ID can be obtained by inquiring at the AssignmentRule object.	This will be invalid, due to API specifications, if [Checked] is selected for the AssignmentRule Header (useDefaultRule). If the value is not in an appropriate ID form (15 characters or 18 characters Salesforce.com ID), the call will fail and a MALFORMED_ID exception will be returned. For details, please refer to the "AssignmentRuleHeader" page of the API document "SOAP API Developer's Guide."
DisableFeedTracking Header (disableFeedTracking)	Optional	Not Available	Specify the disableFeedTracking field, in the DisableFeedTracking header. [Checked]: The feed tracking will become disabled, for the executed change. [Not Checked]:(default) The feed tracking will not become disabled.	Available when the resource type is API 23.0 or later. For details, please refer to the "DisableFeedTrackingHeader" page of the API document "SOAP API Developer's Guide."

Connection Retry Settings

Item name	Required/Optional	Use of Variables	Description	Supplement
Type of API call for retry target	Optional	Not Available	Set the type of the retry process target API calls in the case that a specific error occurs during connecting to Salesforce. [Unspecified (do not retry)]: All API calls, used during the execution of the operation, will be excluded from retry targets. [Until describe and auth related calls]: Out of the API calls used for the operation, the Auth, Describe calls will be the targets of the retry process. [Until read-related calls]:(default) Out of the API calls used for the operation, Auth, Describe, as well as read-related API calls will be targeted for the retry process. [Until certain update-related calls]: Out of the API calls used for the operation, Auth, Describe, read-related API calls, as well as some of update-related API calls will be targeted for the retry process. [All calls]: All API calls used during the operation will be targets of the retry process.	For details, please refer to "Connection Retry Process."
Number of connection retries	Optional	Only environment variables are available	Set the number of retries to be performed in the case that a specific error occurs when connecting to Salesforce.	The default value is "5."
Waiting time (sec) during a connection retry	Optional	Only environment variables are available	Set the the waiting time, in seconds, until the retry process in the case that a specific error occurs while connecting to Salesforce.	The default value is "1."

Connection Retry Details Settings

Item name

Required/Optional

Use of Variables

Description

Supplement

All Exception are handled as the connection retry target

Optional

Not Available

Specify whether or not all exceptions which occur during connection to Salesforce will be retry targets.

[Checked]:
All Exceptions will be retry targets.
[Not Checked]:(default)
The retry target exceptions are specified individually.

This becomes valid if [Unspecified (do not retry)] is not selected in the [Type of API call for retry target].

Specify Exception class and message for the connection retry target

Optional

Specify the connection retry target exception class and the message as a one combination.
Multiple combinations can be specified.
Rows of each combination can be manipulated with the below mentioned buttons.

[Add]:
Add a row.
[Move Up]:
Move the selected row upward by one row.
[Move Down]:
Move the selected row downward by one row
[Remove]:
Delete the row.

This becomes valid when an item other than [Unspecified (do not retry)] has been selected in the [Type of API call for retry target], and additionally, [Not Checked] has been selected for [All Exception are handled as the connection retry target].

As a default, the following condition will be specified.

API 23.0 or earlier:

The Conditions of the Connection Retry Exceptions
Error Message contains "connection reset"
Error Message contains "error in parsing the status line from the response: unable to find line starting with "http""

API 26.0 or later:

The Conditions of the Connection Retry Exceptions

Error Message contains "connection reset"

Specify Exception class and message for the connection retry target/Exception class name

Optional

Only environment variables are available

Specify the exception class name.
If not specified, only the [Error Message] will be the condition.

Rows in which both [Exception class name] and [ErrorMessage] are unspecified will be ignored.
Configuration Examples:
- java.net.SocketException
- org.apache.commons.httpclient.HttpException

Specify Exception class and message for the connection retry target/ErrorMessage

Optional

Only environment variables are available

Specify the error message.
Whether or not the specified character string is included in the message of the occurred exception is determined. Capitalised and non capitalised letters will not be differentiated.
If not specified, only the [Exception class name] will be used as the condition.

Rows in which both [Exception class name] and [Error Message] are unspecified will be ignored.

Specify API ExceptionCode for the connection retry target

Optional

Specify tte the exception code which targets the connection retry, in the case where the API returns an error.
Multiple ExceptionCodes can be specified.
Each row can be manipulated by the below mentioned buttons.

[Add]:
Add a row.
[Move Up]:
Move the selected row upward by one row.
[Move Down]:
Move the selected row downward by one row
[Remove]:
Delete the row.

This becomes valid when an item other than [Unspecified (do not retry)] has been selected in the [Type of API call for retry target], and additionally, [Not Checked] has been selected for [All Exception are handled as the connection retry target].
As a default, the following ExceptionCode will be specified.

ExceptionCode

SERVER_UNAVAILABLE

Specify API ExceptionCode for the connection retry target/ExceptionCode

Required

Only environment variables are available

Specify the ExceptionCode.

Unspecified rows will be ignored.
For the ExceptionCode, please refer to the "Exception Code" page in the API Document "SOAP API Developer's Guide."

Component Pool Settings

Component pool is not supported.

Security

Security can only be set from "Global Resource Settings" from Control Panel.

Main exceptions

Exception Name	Reason	Resolution
java.net.UnknownHostException	This exception occurs when the PROXY server specified in the global resource cannot be found.	Verify the condition of the PROXY server. Or verify [Proxy host] of the global resource specified in the [Connection].
API 23.0 or earlier org.apache.commons.httpclient.HttpConnection$ConnectionTimeoutException API 26.0 or later java.net.SocketTimeoutException connect timed out	A time-out has occurred while connecting to Salesforce.	Verify the network condition and Salesforce server condition. Or check [Connection timeout(sec)] of the global resource specified in the [Connection].
API 23.0 or earlier org.apache.commons.httpclient.HttpRecoverableException java.net.SocketTimeoutException: Read timed out API 26.0 or later java.net.SocketTimeoutException Read timed out	A time-out has occurred while waiting for a responce from the server after connecting to Salesforce.	Verify the network condition and Salesforce server condition. Or check [Timeout(sec)] of the global resource specified in the [Connection].
jp.co.headsol.salesforce.adapter.exception.SalesforceAdapterIllegalArgumentException	Invalid value is set for the property of Salesforce adapter.	Check the error message, and verify the settings.
com.sforce.soap.partner.fault.LoginFault	Login to Salesforce has failed.	Check the ExceptionCode or error message, and refer to the information about this type of error in Salesforce-related documents etc.
com.sforce.soap.partner.fault.UnexpectedErrorFault	An unexpected error has occured while processing to Salesforce.	Check the ExceptionCode or error message, and refer to the information about this type of error in Salesforce-related documents etc.

About connection retry

An exception will occur when connection with Salesforce fails at API call. For example, in cases of a temporary poor network, it is likely to succeed at a retry.
Connection retry process is a feature to automatically retry the API call when an API network error occurs.

Connection retry will run when an exception specified under [Type of API call for retry target] occur and also the condition matches with the detail in [detail settings for connection retry]
Connection retry will run per failed request. The [Number of connection retry] count will reset every time the request is successful.
Requests may be sent twice when running a connection retry. For example, if an API call to add a record is requested twice, it may create duplicate records. Please consider about the degree of allowing double transmission and the limit of API calls.

Type of API calls for retry target

Please specify the type of API call for retry target in [Type of API call for retry target]
Please refer to the list below for detail.

Type of API call for retry target	auth	describe	Read Related			Update Related
Type of API call for retry target	login new access token	describeGlobal describeSObjects	query queryAll queryMore	retrieve	getUpdated getDeleted	create	upsert	update	delete	setPassword	resetPassword	emptyRecycleBin	undelete	sendEmail
[Unspecified (do not retry)]	No	No	No	No	No	No	No	No	No	No	No	No	No	No
[Until describe and auth related calls]	Yes	Yes	No	No	No	No	No	No	No	No	No	No	No	No
[Until read-related calls]	Yes	Yes	Yes	Yes	Yes	No	No	No	No	No	No	No	No	No
[Until certain update-related calls]	Yes	Yes	Yes	Yes	Yes	No	Yes	Yes	No	Yes	Yes	No	No	No
[All calls]	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes	Yes

Please refer to help for details on the type of API call used in each operation.
Auth related calls will occur when [Authentication at global resource setting] is selected in [connection type at run-time], and either when the adapter conducts an initial transmission or when the session time expires during run-time.

Detail settings for connection retry

[Detail settings for connection retry] specifies the type of retry target when an exception occur.
When [Retry unconditionally] is [checked off], [Specify exceptional class and message for connection retry] and [Specify API ExceptionCode for connection retry] can be configured.
If so, anything that matches the exceptions will be targeted for the retry.

[Specify exceptional class and message for connection retry]
- Set the exceptional condition at transmission failure.
- When [Exceptional Class name] and [Error Message] is input, both must match as a condition.
- If either [Exceptional Class name] or [Error message] is left blank, it will become unconditional.
[Specify API ExceptionCode for connection retry]
- Specify the ExceptionCode when API fault exception is returned from Salesforce.