グローバルリソースのプロパティ

接続設定

グローバルリソースの接続設定は、各アダプタのプロパティ設定ダイアログ、コントロールパネルの「グローバルリソースの設定」から行うことができます。
グローバルリソースの設定では、リソースの種類の選択にて以下のバージョンを選択することができます。

API 53.0
API 50.0
API 43.0
API 40.0
API 34.0

以下は非推奨またはサポート終了APIバージョンとなります。

非推奨APIバージョン
- API 29.0
- API 26.0
- API 23.0
詳細については、「非推奨APIバージョンについて」を参照してください。
サポート終了APIバージョン
- API 18.0
詳細については、「サポート終了APIバージョンについて」を参照してください。

基本設定

項目名	必須/省略可	変数の使用	説明	備考
名前	必須	使用不可	接続先の設定の名前を入力します。

必須設定

項目名	必須/省略可	変数の使用	説明	備考
ユーザID	省略可	環境変数のみ使用可	ログインユーザIDを入力します。	[OAuthを使用して接続する]にチェックを入れない場合のみ、有効かつ必須入力となります。
パスワード	省略可	環境変数のみ使用可	ログインパスワードを入力します。	[OAuthを使用して接続する]にチェックを入れない場合のみ、有効かつ必須入力となります。
ログイン先	省略可	使用不可	ログイン先種類を選択します。 [login.salesforce.com]:(デフォルト) Product/Developer にログインします。 [SandBox]: SandBox にログインします。 [その他（直接指定）]: ログイン先のURLを直接指定します。	[OAuthを使用して接続する]にチェックを入れない場合のみ、有効となります。
SSL使用	省略可	使用不可	Salesforceとの通信にSSLを使用するかを選択します。 [使用する]:(デフォルト) SSLを使用します。 [使用しない]: SSLを使用しません。	[OAuthを使用して接続する]にチェックを入れない場合のみ、有効となります。
ログインURL	省略可	環境変数のみ使用可	ログイン先のURLを入力します。	[OAuthを使用して接続する]にチェックを入れないかつ、[ログイン先]に[その他（直接指定）]を選択した場合、有効かつ必須入力となります。
OAuth接続先	省略可	使用不可	OAuth接続先種類を選択します。 [login.salesforce.com]:(デフォルト) Product/Developer に接続します。 [SandBox]: SandBox に接続します。	[OAuthを使用して接続する]にチェックを入れた場合のみ、有効となります。
Refresh Token	省略可	環境変数のみ使用可	Refresh Tokenを入力します。	[OAuthを使用して接続する]にチェックを入れた場合のみ、有効かつ必須入力となります。
タイムアウト(秒)	省略可	環境変数のみ使用可	Salesforceとのソケットレベルでの通信タイムアウト時間を秒単位で指定します。具体的には、Salesforceに対してクエリなどのリクエストを送信し、それに対する応答待ち時間を示します。	デフォルト値は「600」です。
Connectionタイムアウト(秒)	省略可	環境変数のみ使用可	SalesforceとのConnection確立の待ち時間を秒単位で設定します。具体的には、DataSpiderServerから同時に複数のSalesforceとの接続を行う、あるいは、ネットワーク自体の負荷が高い場合などにより、以下の例外発生のタイミングを調整します。 org.apache.commons.httpclient.HttpException: Timeout waiting for connection	デフォルト値は「60」です。
送受信時データ圧縮	必須	使用不可	Salesforceに対する要求メッセージおよび応答メッセージをGZIP圧縮するか選択します。送受信データを圧縮することにより、処理効率が向上します。 [圧縮する]:(デフォルト) データ圧縮をします。ただし、[OAuthを使用して接続する]にチェックを入れた場合、新しいアクセストークン取得のための要求メッセージは圧縮しません。 [圧縮しない]: データ圧縮をしません。
OAuthを使用して接続する	省略可	使用不可	Salesforceへの接続方法を選択します。 [チェックあり]: OAuth2.0で接続します。 [チェックなし]:(デフォルト) ユーザID/パスワードで接続します。	リソースの種類がAPI 29.0以降の場合に指定できます。詳細については、「OAuthによる接続とは」を参照してください。

プロパティアクション

項目名	説明	備考
接続テスト	ホストへの接続確認を行います。

オプション設定

項目名	必須/省略可	変数の使用	説明	備考
実行時の接続方式	必須	使用不可	スクリプト実行時のSalesforceへの接続方式を設定します。 [グローバルリソースの設定による認証]:(デフォルト) [ユーザID][パスワード]によるログイン認証、または[Refresh Token]によるトークン取得にて、自動的にセッションを作成して接続します。 [外部からセッションを引き継ぐ]: 既に確立されているセッション情報(サーバURL、セッションID)を引き継いで接続します。セッションを引き継ぐには、オペレーション[ログイン(セッションIDによる)]を実行してください。	[外部からセッションを引き継ぐ]を選択した場合においても、デザイナの操作時に必要となる接続ではグローバルリソースの設定による認証が行われます。
API種別	必須	使用不可	スクリプト実行時に使用するAPIの種別を選択します。 [Bulk API]:(デフォルト) Bulk APIを使用してスクリプトを実行します。 [Bulk API 2.0]: Bulk API 2.0を使用してスクリプトを実行します。	リソースの種類がAPI 50.0以降の場合に指定できます。 [Bulk API 2.0]を選択する場合、いくつかの制限があります。詳細については、「Bulk API 2.0」を参照してください。
名前空間を指定する	省略可	使用不可	セッションヘッダー、およびリクエストヘッダーのコールオプションに「defaultNameSpace」(名前空間)を設定するかどうかを選択します。 [チェックあり]: 名前空間を指定します。 [チェックなし]:(デフォルト) 名前空間を指定しません。	[API種別]に[Bulk API 2.0]を選択した場合のみ、有効になります。
名前空間プレフィックス	省略可	使用可	名前空間プレフィックスを識別する文字列を設定します。	[名前空間を指定する]にチェックを入れた場合のみ、有効かつ必須入力となります。末尾にアンダースコア(__)を入力する必要はありません。

PROXY設定

項目名	必須/省略可	変数の使用	説明	備考
Proxyサーバ設定	必須	使用不可	Proxyサーバを使用するか選択します。 [使用する]: Proxyサーバを使用します。 [使用しない]:(デフォルト) Proxyサーバを使用しません。
Proxyホスト	省略可	環境変数のみ使用可	Proxyサーバのホストアドレスを入力します。	[Proxyサーバ設定]に[使用する]を選択した場合、有効になります。
Proxyポート	省略可	環境変数のみ使用可	Proxyサーバのポート番号を入力します。	[Proxyサーバ設定]に[使用する]を選択した場合、有効になります。
Proxyユーザ	省略可	環境変数のみ使用可	Proxyサーバの認証ユーザを入力します。	[Proxyサーバ設定]に[使用する]を選択した場合、有効になります。認証はBasic認証のみ対応しています。
Proxyパスワード	省略可	環境変数のみ使用可	Proxyサーバの認証パスワードを入力します。	[Proxyサーバ設定]に[使用する]を選択した場合、有効になります。

接続リトライ設定

項目名	必須/省略可	変数の使用	説明	備考
対象とするAPIコールの種類	省略可	使用不可	Salesforceへの接続にて特定のエラーが発生した際、リトライ処理の対象となるAPIコールの種類を設定します。 [未指定(リトライしない)]: オペレーション実行時に使用されるすべてのAPIコールがリトライ処理対象外となります。 [認証、Describe系コールまで]: オペレーション実行時に使用されるAPIコールの内、認証、Describe系コールがリトライ処理の対象となります。 [読み取り系コールまで]:(デフォルト) オペレーション実行時に使用されるAPIコールの内、認証、Describe系および読み取り系のAPIコールがリトライ処理の対象となります。 [全てのコール]: オペレーション実行時に使用されるすべてのAPIコールがリトライ処理の対象となります。	詳細については、「接続リトライ処理について」を参照してください。
接続リトライ回数	省略可	環境変数のみ使用可	Salesforceへの接続にて特定のエラーが発生した際、リトライ処理を行う回数を設定します。	デフォルト値は「5」です。
接続リトライ時の待機時間(秒)	省略可	環境変数のみ使用可	Salesforceへの接続にて特定のエラーが発生した際、リトライ処理までの待機時間を秒単位で設定します。	デフォルト値は「1」です。

接続リトライ詳細設定

項目名

必須/省略可

変数の使用

説明

備考

無条件にすべての例外を接続リトライ対象とする

省略可

使用不可

Salesforceへの接続時に発生するすべての例外を接続リトライ対象とするかどうかを指定します。

[チェックあり]:
すべての例外をリトライ対象とします。
[チェックなし]:(デフォルト)
リトライ対象とする例外を個別に指定します。

[対象とするAPIコールの種類]に[未指定(リトライしない)]以外を選択している場合、有効となります。

接続リトライ対象とする例外クラスとメッセージの指定

省略可

接続リトライ対象とする例外クラスとメッセージを1つの組み合わせとして指定します。
この組み合わせは複数指定することができます。
各組み合わせの行は以下のボタンで操作することができます。

[追加]:
行を追加します。
[上へ]:
選択している行の順序を一つ上に上げます。
[下へ]:
選択している行の順序を一つ下に下げます。
[削除]:
行を削除します。

[対象とするAPIコールの種類]に[未指定(リトライしない)]以外を選択しているかつ、[無条件にすべての例外を接続リトライ対象とする]が[チェックなし]の場合、有効となります。
デフォルトでは次の条件が指定されます。

接続リトライ対象とする例外の条件

エラーメッセージに「connection reset」が含まれる

接続リトライ対象とする例外クラスとメッセージの指定/例外クラス名

省略可

環境変数のみ使用可

例外クラス名を設定します。
指定しない場合、[エラーメッセージ]のみを条件とします。

[例外クラス名][エラーメッセージ]ともに指定されていない行は無視されます。
設定例:
- java.net.SocketException
- org.apache.commons.httpclient.HttpException

接続リトライ対象とする例外クラスとメッセージの指定/エラーメッセージ

省略可

環境変数のみ使用可

エラーメッセージを設定します。
指定した文字列が、発生した例外のメッセージに含まれるかどうかを判定します。大文字小文字は区別されません。
指定しない場合、[例外クラス名]のみを条件とします。

[例外クラス名][エラーメッセージ]ともに指定されていない行は無視されます。

接続リトライ対象とするAPI ExceptionCodeの指定

省略可

APIがエラーを返した場合、接続リトライ対象とするExceptionCodeを指定します。
ExceptionCodeは複数指定することができます。
各行は以下のボタンで操作することができます。

[追加]:
行を追加します。
[上へ]:
選択している行の順序を一つ上に上げます。
[下へ]:
選択している行の順序を一つ下に下げます。
[削除]:
行を削除します。

[対象とするAPIコールの種類]に[未指定(リトライしない)]以外を選択しているかつ、[無条件にすべての例外を接続リトライ対象とする]が[チェックなし]の場合、有効となります。
デフォルトでは次のExceptionCodeが指定されます。

ExceptionCode

SERVER_UNAVAILABLE

接続リトライ対象とするAPI ExceptionCodeの指定/ ExceptionCode

必須

環境変数のみ使用可

ExceptionCodeを設定します。

指定されていない行は無視されます。
ExceptionCodeについてはAPIドキュメント「SOAP API Developer's Guide」の「ExceptionCode」ページおよび、「Bulk API 2.0 and Bulk API Developer Guide」の「Errors」ページを参照してください。

コンポーネントプールの設定

コンポーネントプールはサポートしていません。

セキュリティ

セキュリティの設定は、コントロールパネルの「グローバルリソースの設定」から行うことができます。

主な例外

例外名	原因	対策
java.net.UnknownHostException	グローバルリソースで指定したPROXYサーバが見つからない例外です。	PROXYサーバの状態を確認して下さい。または、[接続先]で指定したグローバルリソースの[Proxyホスト]を確認してください。
java.net.SocketTimeoutException connect timed out	Salesforceに接続中にタイムアウトが発生しました。	ネットワークの状態、Salesforceのサーバの状態を確認してください。または、[接続先]で指定したグローバルリソースの[Connectionタイムアウト(秒)]を確認してください。
java.net.SocketTimeoutException Read timed out	Salesforceに接続後、サーバからの応答までにタイムアウトが発生しました。	ネットワークの状態、Salesforceのサーバの状態を確認してください。または、[接続先]で指定したグローバルリソースの[タイムアウト(秒)]を確認してください。
jp.co.headsol.salesforce.adapter.exception.SalesforceAdapterIllegalArgumentException	Salesforce Bulkアダプタのプロパティの設定値が不正です。	エラーメッセージを確認し、設定内容をご確認ください。
com.sforce.soap.partner.fault.LoginFault	Salesforceへのログインに失敗しました。	ExceptionCodeまたは、エラーメッセージを確認し、Salesforceの関連ドキュメントなどに対象のエラーに関する情報がないか確認してください。

接続リトライ処理について

APIコールにてSalesforceとの通信に失敗すると例外が発生します。例えば、ネットワークが不安定となっていたなどの一時的な状態が原因であった場合、再度実行することで成功する可能性があります。接続リトライ処理とは、APIコールの通信時に発生した例外が特定の条件に一致する場合に、自動的にAPIコールをリトライして処理の続行を試みる機能です。

接続リトライは、[対象とするAPIコールの種類]に指定した種類のAPIコールにて例外が発生し、かつ発生した例外の内容が[接続リトライ詳細設定]に指定した条件に一致する場合に実行されます。
接続リトライは失敗した1リクエストごとに実行され、[接続リトライ回数]のカウントはリクエストが成功する度にリセットされます。
接続リトライを実行することによりリクエストを二重送信する可能性があります。例えば、レコードを追加するAPIコールを二重送信すると、重複レコードを作成してしまうなどの影響が考えられます。対象とするAPIコールの限定や、二重送信を許容する設計を検討してください。

対象とするAPIコールの種類

[対象とするAPIコールの種類]では、リトライ対象のAPIコールの種類を指定します。
選択値は、それぞれ以下のAPIコールに対応しています。

対象とするAPIコールの種類	認証系	Describe系	読み取り系				書き込み系
対象とするAPIコールの種類	login new access token	describeGlobal describeSObjects	Getting Job Details	Getting Information for a Batch	Getting Information for All Batches in a Job	Getting Batch Results	Creating a New Job	Closing a Job Aborting a Job	Adding a Batch to a Job
[未指定(リトライしない)]	×	×	×	×	×	×	×	×	×
[認証、Describe系コールまで]	○	○	×	×	×	×	×	×	×
[読み取り系コールまで]	○	○	○	○	○	○	×	×	×
[全てのコール]	○	○	○	○	○	○	○	○	○

各オペレーションが使用するAPIコールの種類は、各ヘルプを参照してください。
認証系のコールは、[実行時の接続方式]で[グローバルリソースの設定による認証]を選択した場合において、アダプタが最初に通信を行う際、および実行中にセッションの有効期限が切れた際に実行されます。

接続リトライ詳細設定

[接続リトライ詳細設定]では、リトライ対象とする例外の種類を指定します。
[無条件にすべての例外を接続リトライ対象とする]を[チェックなし]とした場合、 [接続リトライ対象とする例外クラスとメッセージの指定]および [接続リトライ対象とするAPI ExceptionCodeの指定]にそれぞれリトライ対象とする例外の条件を設定することができます。この場合、設定した条件のいづれかに該当する例外がリトライ対象となります。

[接続リトライ対象とする例外クラスとメッセージの指定]
- 通信に失敗した場合に発生する例外の条件を指定します。
- [例外クラス名]と[エラーメッセージ]を共に入力した場合、両方に一致することが条件となります。
- [例外クラス名]と[エラーメッセージ]の一方を入力した場合、省略した方は無条件となります。
[接続リトライ対象とするAPI ExceptionCodeの指定]
- SalesforceからAPI Faultの例外が返された場合のExceptionCodeを指定します。

Bulk API 2.0

リソースの種類がAPI 50.0以降の場合、[API種別]に[Bulk API 2.0]を選択できます。
API 43.0以前の場合、[API種別]を選択できません。Bulk APIが使用されます。

Bulk API 2.0の詳細はSalesforceのドキュメントをご確認ください。
「Salesforce Developer Documentation」-(https://developer.salesforce.com/docs)

Bulk API 2.0 and Bulk API Developer Guide

対応コンポーネント

Bulk API 2.0を使用できるコンポーネントは以下の通りとなります。

コンポーネント	Bulk API	Bulk API 2.0
Bulkデータ書き込み(INSERT)	○	○
Bulkデータ書き込み(UPDATE)	○	○
Bulkデータ書き込み(DELETE)	○	○
Bulkデータ書き込み(UPSERT)	○	○
Bulkデータ読み取り(QUERY)	○	○
ジョブ作成	○	×
ジョブ更新	○	×
バッチ作成	○	×
バッチ結果取得	○	×
ジョブ/バッチ情報取得	○	×

Bulk API 2.0の使用

Bulk API 2.0を使用することで、以下が可能となります。

名前空間の指定
APIコール数の削減

制限事項

Bulk API 2.0を使用できないコンポーネントでスクリプトを実行した場合、エラーとなります。

エラーメッセージ
<コンポーネント名>は[Bulk API 2.0]で実行することができません。グローバルリソースの[API種別]で[Bulk API]を指定してください。

Bulk API 2.0を使用できないコンポーネントは、Bulk API 2.0を使用できるコンポーネントからフローを引いて使用することはできません。
Bulk API 2.0を使用する場合、各コンポーネントの以下のプロパティに制限があります。
- ジョブの同時実行モードは「並列」で実行されます。
  これにより、各コンポーネントの[同時実行モード]を指定することができません。
- 処理実行後のジョブは必ずクローズされます。
  これにより、各コンポーネントの[実行後ジョブ状況]を指定することができません。
- バッチの分割はSalesforceで自動的に行われます。
  これにより、各コンポーネントの[バッチサイズ]を指定することはできません。
- BigObjectへの書き込みを行うことはできません。