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

接続設定

グローバルリソースの接続設定は、各アダプタのプロパティ設定ダイアログ、コントロールパネルの「グローバルリソースの設定」から行うことができます。
グローバルリソースの設定では、リソースの種類の選択にて以下のバージョンを選択することができます。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 接続先の設定の名前を入力します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
ユーザ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確立の待ち時間を秒単位で設定します。
具体的には、SkyOnDemand Serverから同時に複数のSalesforceとの接続を行う、あるいは、ネットワーク自体の負荷が高い場合などにより、以下の例外発生のタイミングを調整します。

org.apache.commons.httpclient.HttpException: Timeout waiting for connection
  • デフォルト値は「60」です。
送受信時データ圧縮 必須 使用不可 Salesforceに対する要求メッセージおよび応答メッセージをGZIP圧縮するか選択します。
送受信データを圧縮することにより、処理効率が向上します。
  • [圧縮する]:(デフォルト)
    データ圧縮をします。
  • [圧縮しない]:
    データ圧縮をしません。
 
OAuthを使用して接続する 省略可 使用不可 Salesforceへの接続方法を選択します。
  • [チェックあり]:
    OAuth2.0で接続します。
  • [チェックなし]:(デフォルト)
    ユーザID/パスワードで接続します。
  • リソースの種類がAPI 29.0以降の場合に指定できます。
  • 詳細については、「OAuthによる接続とは」を参照してください。
プロパティアクション
項目名 説明 備考
接続テスト ホストへの接続確認を行います。  
オプション設定
項目名 必須/省略可 変数の使用 説明 備考
更新時の文字列項目の切り捨て 必須 使用不可 更新時に項目の桁数よりも更新値の文字列が大きい場合、桁数以上の文字列を切り捨てをするかを選択します。
  • [切り捨てる]:(デフォルト)
    文字列を切り捨てます。
  • [切り捨てない]: API 18.0以降で選択可
    文字列を切り捨てません。
    桁数より大きいとエラーとなります。
  • 詳細についてはAPIドキュメント「SOAP API Developer's Guide」の「AllowFieldTruncationHeader」ページを参照してください。
実行時の接続方式 必須 使用不可 スクリプト実行時のSalesforceへの接続方式を設定します。
  • [グローバルリソースの設定による認証]:(デフォルト)
    [ユーザID][パスワード]によるログイン認証、または[Refresh Token]によるトークン取得にて、自動的にセッションを作成して接続します。
  • [外部からセッションを引き継ぐ]:
    既に確立されているセッション情報(サーバURL、セッションID)を引き継いで接続します。セッションを引き継ぐには、オペレーション[ログイン(セッションIDによる)]を実行してください。
  • [外部からセッションを引き継ぐ]を選択した場合においても、デザイナの操作時に必要となる接続ではグローバルリソースの設定による認証が行われます。
名前空間を指定する 省略可 使用不可 セッションヘッダーのコールオプションに「defaultNameSpace」(名前空間)を設定するかどうかを選択します。
  • [チェックあり]:
    名前空間を指定します。
  • [チェックなし]:(デフォルト)
    名前空間を指定しません。
 
名前空間プレフィックス 省略可 使用可 名前空間プレフィックスを識別する文字列を設定します。
  • [名前空間を指定する]にチェックを入れた場合のみ有効になります。
  • 末尾にアンダースコア(__)を入力する必要はありません。
日付型項目更新時のサマータイム補正を行う 省略可 使用不可 日付型項目(date)の更新時にサマータイム補正を行うかどうかを指定します。
  • [チェックあり]:(デフォルト)
    サマータイム補正を行います。
  • [チェックなし]:
    サマータイム補正を行いません。
    本項目が追加される以前の動作を維持します。
  • 例えば、日本ではサマータイム導入期間(1948年5月から1952年4月までの、毎年5月(ただし、1949年のみ4月)の第1土曜日24時(=日曜日1時)から9月第2土曜日25時(=日曜日0時))はタイムゾーンは「+1000」になっていました。
    サマータイム補正を行わない場合、必ず標準時(日本では「+0900」)を基準にGMT変換を行うため、本項目の設定内容により、この期間の日付入力データに対する、更新系機能の更新結果が異なります。
    • [チェックあり]とした場合の例
      入力データ:1948-06-01 結果:1948-06-01
      入力データ:1948-06-01H12:00:00 結果:1948-06-01
    • [チェックなし]とした場合の例
      入力データ:1948-06-01 結果:1948-05-31
      入力データ:1948-06-01H12:00:00 結果:1948-06-01
  • 本項目が追加される以前のバージョンで作成されたグローバルリソースの場合、[チェックなし]がデフォルトとなります。
  • 日付時間型(datetime)は本項目の設定内容に関わらず、サマータイム補正は行われます。
PROXY設定
項目名 必須/省略可 変数の使用 説明 備考
Proxyサーバ設定 必須 使用不可 Proxyサーバを使用するか選択します。
  • [使用する]:
    Proxyサーバを使用します。
  • [使用しない]:(デフォルト)
    Proxyサーバを使用しません。
 
Proxyホスト 省略可 環境変数のみ使用可 Proxyサーバのホストアドレスを入力します。
[Proxyサーバ設定][使用する]を選択した場合、有効かつ必須入力となります。
 
Proxyポート 省略可 環境変数のみ使用可 Proxyサーバのポート番号を入力します。
[Proxyサーバ設定][使用する]を選択した場合、有効かつ必須入力となります。
 
Proxyユーザ 省略可 環境変数のみ使用可 Proxyサーバの認証ユーザを入力します。
[Proxyサーバ設定][使用する]を選択した場合、有効になります。
  • 認証はBasic認証のみ対応しています。
Proxyパスワード 省略可 環境変数のみ使用可 Proxyサーバの認証パスワードを入力します。
[Proxyサーバ設定][使用する]を選択した場合、有効になります。
 
SOAPヘッダー設定
項目名 必須/省略可 変数の使用 説明 備考
AllOrNoneヘッダー
(allOrNone)
省略可 使用不可 AllOrNoneヘッダーのallOrNoneフィールドを指定します。
  • [チェックあり]:
    更新系のコールにて1バッチ内のすべてのレコードが成功とならなかった際にロールバックされます。
  • [チェックなし]:(デフォルト)
    更新系のコールにてロールバックを無効とします。
  • リソースの種類がAPI 23.0以降の場合に指定できます。
  • 更新系のコールでは、入力データをバッチサイズごとに分割し実行されるため、[チェックあり]とした場合にロールバックされる単位はバッチごととなります。
    例えば、バッチサイズを200と設定した場合において、1,000件の入力データの500件目にエラーデータが存在したとすると、1〜400件目までは成功し、401〜600件目までがロールバックされ、601〜1,000件目までは成功となります。そのため、入力データがバッチサイズ以内(最大200件以内)の場合において効果的な機能といえます。
  • 詳細についてはAPIドキュメント「SOAP API Developer's Guide」の「AllOrNoneHeader」ページを参照してください。
Emailヘッダー
(triggerAutoResponseEmail)
省略可 使用不可 EmailヘッダーのtriggerAutoResponseEmailフィールドを指定します。
  • [チェックあり]:
    リード、ケースに対して自動応答ルールのトリガが有効となります。
  • [チェックなし]:(デフォルト)
    トリガが無効となります。
  • リソースの種類がAPI 14.0以降の場合に指定できます。
  • 詳細についてはAPIドキュメント「SOAP API Developer's Guide」の「EmailHeader」ページを参照してください。
Emailヘッダー
(triggerOtherEmail)
省略可 使用不可 EmailヘッダーのtriggerOtherEmailフィールドを指定します。
  • [チェックあり]:
    組織外の電子メールのトリガが有効となります。
  • [チェックなし]:(デフォルト)
    トリガが無効となります。
  • リソースの種類がAPI 14.0以降の場合に指定できます。
  • 詳細についてはAPIドキュメント「SOAP API Developer's Guide」の「EmailHeader」ページを参照してください。
Emailヘッダー
(triggerUserEmail)
省略可 使用不可 EmailヘッダーのtriggerUserEmailフィールドを指定します。
  • [チェックあり]:
    組織内のユーザに送信される電子メールのトリガが有効となります。
  • [チェックなし]:(デフォルト)
    トリガが無効となります。
  • リソースの種類がAPI 14.0以降の場合に指定できます。
  • 詳細についてはAPIドキュメント「SOAP API Developer's Guide」の「EmailHeader」ページを参照してください。
Mruヘッダー
(updateMru)
省略可 使用不可 MruヘッダーのupdateMruフィールドを指定します。
  • [チェックあり]:
    最近使用した項目のリストを更新します。
  • [チェックなし]:(デフォルト)
    最近使用した項目のリストを更新しません。
  • 詳細についてはAPIドキュメント「SOAP API Developer's Guide」の「MruHeader」ページを参照してください。
AssignmentRuleヘッダー
(useDefaultRule)
省略可 使用不可 AssignmentRuleヘッダーのuseDefaultRuleフィールドを指定します。
  • [チェックあり]:
    リード、ケースに対してデフォルトの割り当てルールを使用します。
  • [チェックなし]:(デフォルト)
    割り当てルールは適用されません。
  • 詳細についてはAPIドキュメント「SOAP API Developer's Guide」の「AssignmentRuleHeader」ページを参照してください。
AssignmentRuleヘッダー
(assignmentRuleId)
省略可 使用不可 AssignmentRuleヘッダーのassignmentRuleIdフィールドを入力します。
リード、ケースの割り当てルールのIDを指定します。IDは、AssignmentRuleオブジェクトを問い合わせて取得することができます。
  • APIの仕様により、AssignmentRuleヘッダー(useDefaultRule)を[チェックあり]としている場合、無効となります。
  • 値が適切なID形式(15文字または18文字のSalesforce.com ID)でない場合、コールは失敗しMALFORMED_ID例外が返されます。
  • 詳細についてはAPIドキュメント「SOAP API Developer's Guide」の「AssignmentRuleHeader」ページを参照してください。
DisableFeedTrackingヘッダー
(disableFeedTracking)
省略可 使用不可 DisableFeedTrackingヘッダーのdisableFeedTrackingフィールドを指定します。
  • [チェックあり]:
    実行した変更に対して、フィードの追跡を無効にします。
  • [チェックなし]:(デフォルト)
    フィードの追跡は無効になりません。
  • リソースの種類がAPI 23.0以降の場合に指定できます。
  • 詳細についてはAPIドキュメント「SOAP API Developer's Guide」の「DisableFeedTrackingHeader」ページを参照してください。
接続リトライ設定
項目名 必須/省略可 変数の使用 説明 備考
対象とするAPIコールの種類 省略可 使用不可 Salesforceへの接続にて特定のエラーが発生した際、リトライ処理の対象となるAPIコールの種類を設定します。
  • [未指定(リトライしない)]:
    オペレーション実行時に使用されるすべてのAPIコールがリトライ処理対象外となります。
  • [認証、Describe系コールまで]:
    オペレーション実行時に使用されるAPIコールの内、認証、Describe系コールがリトライ処理の対象となります。
  • [読み取り系コールまで]:(デフォルト)
    オペレーション実行時に使用されるAPIコールの内、認証、Describe系および読み取り系のAPIコールがリトライ処理の対象となります。
  • [書き込み系コールの一部まで]:
    オペレーション実行時に使用されるAPIコールの内、認証、Describe系および読み取り系のAPIコール、書き込み系の一部のAPIコールがリトライ処理の対象となります。
  • [全てのコール]:
    オペレーション実行時に使用されるすべてのAPIコールがリトライ処理の対象となります。
接続リトライ回数 省略可 環境変数のみ使用可 Salesforceへの接続にて特定のエラーが発生した際、リトライ処理を行う回数を設定します。
  • デフォルト値は「5」です。
接続リトライ時の待機時間(秒) 省略可 環境変数のみ使用可 Salesforceへの接続にて特定のエラーが発生した際、リトライ処理までの待機時間を秒単位で設定します。
  • デフォルト値は「1」です。
接続リトライ詳細設定
項目名 必須/省略可 変数の使用 説明 備考
無条件にすべての例外を接続リトライ対象とする 省略可 使用不可 Salesforceへの接続時に発生するすべての例外を接続リトライ対象とするかどうかを指定します。
  • [チェックあり]:
    すべての例外をリトライ対象とします。
  • [チェックなし]:(デフォルト)
    リトライ対象とする例外を個別に指定します。
  • [対象とするAPIコールの種類][未指定(リトライしない)]以外を選択している場合、有効となります。
接続リトライ対象とする例外クラスとメッセージの指定 省略可 - 接続リトライ対象とする例外クラスとメッセージを1つの組み合わせとして指定します。
この組み合わせは複数指定することができます。
各組み合わせの行は以下のボタンで操作することができます。
  • [追加]:
    行を追加します。
  • [上へ]:
    選択している行の順序を一つ上に上げます。
  • [下へ]:
    選択している行の順序を一つ下に下げます。
  • [削除]:
    行を削除します。
  • [対象とするAPIコールの種類][未指定(リトライしない)]以外を選択しているかつ、[無条件にすべての例外を接続リトライ対象とする][チェックなし]の場合、有効となります。
  • デフォルトでは次の条件が指定されます。
    • API23.0以前:
      接続リトライ対象とする例外の条件
      エラーメッセージに「connection reset」が含まれる
      エラーメッセージに「error in parsing the status  line from the response: unable to find line starting with "http"」が含まれる
    • API26.0以降:
      接続リトライ対象とする例外の条件
      エラーメッセージに「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」ページを参照してください。

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

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

セキュリティ

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

主な例外

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

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

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

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

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

対象とするAPIコールの種類 認証系 Describe系 読み取り系 書き込み系
login
new access token
describeGlobal
describeSObjects
query
queryAll
queryMore
retrieve getUpdated
getDeleted
create upsert update delete setPassword resetPassword emptyRecycleBin undelete sendEmail
[未指定(リトライしない)] × × × × × × × × × × × × × ×
[認証、Describe系コールまで] × × × × × × × × × × × ×
[読み取り系コールまで] × × × × × × × × ×
[書き込み系コールの一部まで] × × × × ×
[全てのコール]

接続リトライ詳細設定

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