Salesforceアダプタで利用できる機能をご紹介します。

SOAP APIとは

SalesforceのAPIの中で、最もスタンダードなAPIと位置付けられています。異なるプログラムやプラットフォーム間で情報を交換するためのプロトコルで、XML形式を使用して情報を送受信し、通信がHTTPやHTTPS等のプロトコルを介して行われます。データ操作の他には、パスワードの管理やメール送信等のコールが用意されています。

適した用途

他APIと比較すると、最も多くの機能が実装されています。リアルタイム処理でありながら、複数のデータを更新することが可能です。例えば企業内のバックエンドシステム間の通信には、SOAP APIが適しています。

読み取り系

SOAP API の query() または、queryAll() を使用してデータを読み取ることができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
テーブル名	Salesforceのテーブル名を選択します。
スキーマ定義	Salesforceから読み取りを行う項目を設定します。
スキーマ定義/ラベル	[テーブル名]で指定したテーブルの列のラベル名を表示します。
スキーマ定義/API	[テーブル名]で指定したテーブルの列のAPI名を表示します。
スキーマ定義/型	[テーブル名]で指定したテーブルの列のデータ型を表示します。
SOQL(検索条件)	テーブル名で選択を行ったテーブルに対する検索条件(Where文)を指定します。

■イメージ図

SOAP API の getUpdated() または、getDeleted() を使用してデータを読み取ることができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
テーブル名	Salesforceのテーブル名を選択します。
レプリケーション対象	レプリケーション対象を選択します。 ・[追加・更新データ]：最終更新日タブで指定した期間内に追加・更新されたデータを読み取ります。 ・[削除データ]：最終更新日タブで指定した期間内に削除されたデータを読み取ります。
スキーマ定義	Salesforceから読み取りを行う項目を設定します。
スキーマ定義/ラベル	[テーブル名]で指定したテーブルの列のラベル名を表示します。
スキーマ定義/API	[テーブル名]で指定したテーブルの列のAPI名を表示します。
スキーマ定義/型	[テーブル名]で指定したテーブルの列のデータ型を表示します。

■イメージ図

SOAP API の retrieve() を使用して入力データで指定された ID に合致するデータを読み取ることができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
テーブル名	Salesforceのテーブル名を選択します。
入力スキーマ定義	[テーブル名]で指定されたテーブルのIDが自動的に選択されます。入力スキーマとして指定されたIDに対して、他のオペレーションからSalesforceのIDを渡します。
入力スキーマ定義/ラベル	[テーブル名]で指定したテーブルの列のラベル名を表示します。
入力スキーマ定義/API	[テーブル名]で指定したテーブルの列のAPI名を表示します。
入力スキーマ定義/型	[テーブル名]で指定したテーブルの列のデータ型を表示します。
出力スキーマ定義	Salesforceから読み取りを行う項目を設定します。
出力スキーマ定義/ラベル	[テーブル名]で指定したテーブルの列のラベル名を表示します。
出力スキーマ定義/API	[テーブル名]で指定したテーブルの列のAPI名を表示します。
出力スキーマ定義/型	[テーブル名]で指定したテーブルの列のデータ型を表示します。

■イメージ図

SOAP API の query() または、queryAll() を使用してデータを読み取ることができます。
また、親オブジェクトから見た子オブジェクトを選択することで、1階層下のオブジェクトまでを合わせて取得することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
親テーブル名	Salesforceのテーブル名を選択します。
親テーブルのスキーマ定義	Salesforceから読み取りを行う項目を設定します。
スキーマ定義/ラベル	[親テーブル名]で指定したテーブルの列のラベル名を表示します。
入力スキーマ定義/API	[親テーブル名]で指定したテーブルの列のAPI名を表示します。
入力スキーマ定義/型	[親テーブル名]で指定したテーブルの列のデータ型を表示します。
親テーブルのSOQL（検索条件）	選択したテーブルに対する検索条件(Where文)を指定します。

■イメージ図

SOAP API の query() または、queryAll() を使用してデータを読み取ることができます。
また、子オブジェクトから見た親オブジェクトの項目を、「リレーション名.リレーション先項目名」の形式で1階層上のオブジェクトまで取得することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバル         リソースの設定を編集することができます。
テーブル名	Salesforceのテーブル名を選択します。
スキーマ定義	Salesforceから読み取りを行う項目を設定します。
スキーマ定義/ラベル	[テーブル名]で指定したテーブルの列、または親テーブルの列のラベル名を表示します。
スキーマ定義/API	[テーブル名]で指定したテーブルの列、または親テーブルの列のAPI名を表示します。
スキーマ定義/型	[テーブル名]で指定したテーブルの列、または親テーブルの列のデータ型を表示します。
スキーマ定義/関数	[テーブル名]で指定したテーブルの列、または親テーブルの列に集計関数を指定できます。
SOQL（検索条件）	[テーブル名]で選択を行ったテーブルに対する検索条件(Where文)を指定します。

■イメージ図

SOAP API の query() または queryAll() を使用してデータを読み取ることができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
SOQL	Salesforceへ発行するSOQL文を入力します。
スキーマ定義	発行したSOQLのレスポンスから取得するスキーマを設定します。 各列は以下のボタンで操作することができます。
スキーマ定義/スキーマ名	SOQLのレスポンスから取得するスキーマ名を入力します。 通常、SELECT句に指定した項目名を入力します。
スキーマ定義/型	スキーマのデータ型を選択します。

■イメージ図

書き込み系

SOAP API の create() を使用してデータを追加します。入力データに対するレコードごとの結果や ID は出力スキーマから受け取ることができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバル         リソースの設定を編集することができます。
テーブル名	Salesforceのテーブル名を選択します。
スキーマ定義	Salesforceに対して書き込みを行う項目を設定します。
スキーマ定義/ラベル	[テーブル名]で指定したテーブルの列のラベル名を表示します。
スキーマ定義/API	[テーブル名]で指定したテーブルの列のAPI名を表示します。
スキーマ定義/型	[テーブル名]で指定したテーブルの列のデータ型を表示します。
リレーションシップ項目定義/元項目API名	[テーブル名]で指定したテーブルのリレーション項目の列のAPI名を表示します。
リレーションシップ項目定義/リレーションシップ名	[テーブル名]で指定したテーブルのリレーション項目の列のリレーションシップ名を表示します。

■イメージ図

SOAP API の update() を使用してデータを更新することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
テーブル名	Salesforceのテーブル名を選択します。
スキーマ定義	Salesforceに対して書き込みを行う項目を設定します。
スキーマ定義/キー	[テーブル名]で指定したテーブルの該当の列が更新のキー項目かどうかを選択します。 ・[true]：更新のキー項目に指定します。 ・[false]：更新のキー項目に指定しません。
スキーマ定義/ラベル	[テーブル名]で指定したテーブルの列のラベル名を表示します。
スキーマ定義/API	[テーブル名]で指定したテーブルの列のAPI名を表示します。
スキーマ定義/型	[テーブル名]で指定したテーブルの列のデータ型を表示します。
リレーションシップ項目定義/元項目API名	[テーブル名]で指定したテーブルのリレーション項目の列のAPI名を表示します。
リレーションシップ項目定義/リレーションシップ名	[テーブル名]で指定したテーブルのリレーション項目の列のリレーションシップ名を表示します。

■イメージ図

SOAP API の delete() を使用してデータを削除することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
テーブル名	Salesforceのテーブル名を選択します。
スキーマ定義	Salesforceのデータを削除する際のキーとなる項目を設定します。
スキーマ定義/ラベル	[テーブル名]で指定したテーブルの列のラベル名を表示します。
スキーマ定義/API	[テーブル名]で指定したテーブルの列のAPI名を表示します。
スキーマ定義/型	[テーブル名]で指定したテーブルの列のデータ型を表示します。

■イメージ図

SOAP API の upsert() を使用してデータを追加または更新することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
テーブル名	Salesforceのテーブル名を選択します。
スキーマ定義	Salesforceに対して書き込みを行う項目を設定します。
スキーマ定義/外部キー	[テーブル名]で指定したテーブルの該当の列が更新のキー項目かどうかを選択します。 ・[true]：更新のキー項目に指定します。 ・[false]：更新のキー項目に指定しません。
スキーマ定義/ラベル	[テーブル名]で指定したテーブルの列のラベル名を表示します。
スキーマ定義/API	[テーブル名]で指定したテーブルの列のAPI名を表示します。
スキーマ定義/型	[テーブル名]で指定したテーブルの列のデータ型を表示します。
リレーションシップ項目定義/元項目API名	[テーブル名]で指定したテーブルのリレーション項目の列のAPI名を表示します。
リレーションシップ項目定義/リレーションシップ名	[テーブル名]で指定したテーブルのリレーション項目の列のリレーションシップ名を表示します。

■イメージ図

複数のオブジェクトのレコードを、1回の更新系APIコールでまとめて処理するためのデータをローカルファイルに出力することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバル         リソースの設定を編集することができます。
出力ファイル	CSV形式のファイルパスを入力します。
テーブル名	Salesforceのテーブル名を選択します。
スキーマ定義	Salesforceに対して書き込みを行う項目を設定します。
スキーマ定義/ラベル	[テーブル名]で指定したテーブルの列のラベル名を表示します。
スキーマ定義/API	[テーブル名]で指定したテーブルの列のAPI名を表示します。
スキーマ定義/型	[テーブル名]で指定したテーブルの列のデータ型を表示します。
リレーションシップ項目定義/元項目API名	[テーブル名]で指定したテーブルのリレーション項目の列のAPI名を表示します。
リレーションシップ項目定義/リレーションシップ名	[テーブル名]で指定したテーブルのリレーション項目の列のリレーションシップ名を表示します。

■イメージ図

[マルチデータファイル生成]処理にて出力されたファイルを読み込み、Salesforceへデータ更新 create()・update()・delete() を行うことができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバル リソースの設定を編集することができます。
入力ファイル	[マルチデータファイル生成]処理にて出力されたCSV形式のファイルパスを入力します。 [参照]ボタンを押下するとファイルチューザが起動し、ファイルの選択ができます。
オペレーション種類	ジョブのオペレーション種類を選択します。 ・[INSERT]：createサービスを用いてデータを追加します。 ・[UPDATE]：updateサービスを用いてデータを更新します。 ・[DELETE]：deleteサービスを用いてデータを削除します。
更新時Null設定	更新対象フィールドに対する入力データがnullであった場合、nullで上書きするか、該当項目の更新をスキップするかを選択します。 ・[読み込みデータで常に上書き]： 入力データがnullの場合、更新対象フィールドをnullで上書きします。 ・[読み込みデータをスキップ]： 入力データがnullの場合、更新対象フィールドの更新をスキップし、更新前の状態を維持します。入力データがnull以外の場合、更新対象フィールドは入力データで上書きします。
入力データ数上限	入力ファイルに含まれるデータ行の件数上限値を指定します。 上限値を超える場合、エラーが発生します。

■イメージ図

REST API を使用してコンテンツバージョン(ContentVersion)にファイルをアップロードまたは更新することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバル リソースの設定を編集することができます。
スキーマ定義	コンテンツバージョン(ContentVersion)に対して書き込みを行う項目を設定します。
スキーマ定義/ラベル	列のラベル名を表示します。
スキーマ定義/API	列のAPI名を表示します。
スキーマ定義/型	列のデータ型を表示します。
リレーションシップ項目定義/元項目API名	リレーション項目の列のAPI名を表示します。
リレーションシップ項目定義/リレーションシップ名	リレーション項目の列のリレーションシップ名を表示します。

■イメージ図

その他

SOAP API の resetPassword() を使用して入力データで指定された ID に対応するユーザのパスワードをリセットすることができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
入力スキーマ	SalesforceのIDを設定します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバル リソースの設定を編集することができます。
カラム名タイプ	マッピングでスキーマを表示する際のカラム名の表示タイプを選択します。 ・[ラベル]：Salesforceで定義されたラベル名（項目名）で   表示します。 ・[API]：Salesforceで定義されたAPI参照名で表示します。
パスワードリセット結果取得	パスワードリセット処理を行った結果を取得するかどうかを指定します。 ・[する]：パスワードリセット処理を行った結果を取得します。 ・[しない]：パスワードリセット処理を行った結果を取得しません。

■イメージ図

SOAP API の setPassword() を使用して入力データで指定されたIDに対応するユーザのパスワードを指定された値で更新することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
入力スキーマ	SalesforceのID、パスワードを設定します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバル リソースの設定を編集することができます。
カラム名タイプ	マッピングでスキーマを表示する際のカラム名の表示タイプを選択します。 ・[ラベル]：Salesforceで定義されたラベル名（項目名）で   表示します。 ・[API]：Salesforceで定義されたAPI参照名で表示します。
パスワードセット結果取得	パスワードセット処理を行った結果を取得するかどうかを指定します。 ・[する]：パスワードセット処理を行った結果を取得します。 ・[しない]：パスワードセット処理を行った結果を取得しません。

■イメージ図

SOAP API の emptyRecycleBin() を使用して入力データで指定されたIDに対応するデータをゴミ箱から削除することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
入力スキーマ	SalesforceのIDを設定します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。

■イメージ図

SOAP API の undelete() を使用して入力データで指定されたIDに対応するデータをゴミ箱から復元することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
入力スキーマ	SalesforceのIDを設定します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。

■イメージ図

SOAP API の sendEmail() を使用してメールを1通送信することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。

■イメージ図

SOAP API の sendEmail() を使用してメールを複数送信することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
入力スキーマ	送信するメールの実質的なパラメータを設定します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。

■イメージ図

外部でSalesforceとのセッションが確立されている場合、セッション情報を受け取ることでセッションを引き継ぎます。セッションを引き継ぐと、そのセッションの権限でアダプタの各オペレーションを実行することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
サーバURL	Salesforceログイン時に返されるサーバURLを設定します。
セッションID	Salesforceログイン時に返されるセッションIDを設定します。

■イメージ図

設定された条件式と入力データをもとに、SOQL(Salesforce Object Query Language)のWHERE句に使用する文字列を形成することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
入力データ	スクリプトキャンバス上にあるコンポーネントを選択します。
入力スキーマ	IN句に指定する値を設定します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
テーブル名	Salesforceのテーブル名を選択します。
パラメータタイプ	形成する構文の種類を選択します。 ・[IN句のパラメータ]：IN句のパラメータを形成します。 ・[AND,ORの繰り返し]：ANDやORの組み合わせを繰り返す条件式を形成します。
折り返し文字数	1件の形成文字列の文字数上限を設定します。文字数が上限を超える場合、複数件の結果を出力します。
条件項目名の指定方法	条件で使用する項目名の指定方法を選択します。 ・[選択する]：選択リストより選択します。 ・[直接入力する]：テキストフィールドに直接入力します。

■イメージ図

SOAP API の getServerTimestamp() を使用してサーバシステムの現在のタイムスタンプを取得します。また、API から応答される SOAP ヘッダーから組織のAPI コールに関する制限情報も合わせて取得することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。

■イメージ図

SOAP API の getUserInfo() を使用してログインユーザの個人情報を取得することができます。

■設定方法（必須設定項目）

名前	スクリプトキャンパス上での名前を入力します。
接続先	グローバルリソースを選択します。 ・[追加]：新規にグローバルリソースを追加します。 ・[一覧の編集]：「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。

■イメージ図