データをつなぎサービスを提供するファンタジスタ Salesforce アダプタご紹介 2013 年 5 月 22 日 株式会社アプレッソ
Salesforce アダプタ とは Saasである Salesforce.com の各種データをDataSpiderから直接追加 更新 削除することのできるアダプタです 主な特徴 APIによるプログラム開発をせずに連携可能 本番系 テスト系(SandBOX) の切り替えが可能 クエリー レプリケーション ID 検索を使用したデータ読み取りが可能 内部キーを使用した高速更新(UPSERT) に対応 更新結果を取得することにより エラーデータのハンドリングが可能 例外発生時のエラー情報の取得が可能 特定のエラー発生時のリトライが可能 Bulk API 機能に対応しており 高速なデータ処理が可能 Relationship-Query 機能により リレーション関連 ( 参照関係 主従関係 ) のあるレコードを一度に取得することが可能 Database.comの操作が可能 ( 選択リスト値の読み取り 追加 更新 削除 並び替え等 ) SOQL(Sforce Object Query Language) 記述でのデータ読み取りが可能 Base64 形式のデータをファイルとして出力可能 Chatterオブジェクトの操作が可能
データをつなぎサービスを提供するファンタジスタ Salesforce アダプタ 製品構成と連携イメージ
Salesforce アダプタ製品構成と連携イメージ Salesforceが公開するAPIを使用して 各サービスのデータ操作を行います Database.com Salesforce.com DB ASPサービス Internetによる接続 各種システム HTTPS/SOAP DataSpider Server Salesforce アダプタ 各種 アダプタ ERP XML DB RDB Excel XML メール等
Salesforce API と対応アダプタ 種類概要対応アダプタ SOAP API SOAP ベースの API セールスフォース API の基本に位置づけられる Bulk API REST ベースの API 大量のレコードを Salesforce へ追加する際に使用 Metadata API 設定情報を組織から参照及びデプロイするのに利用 Salesforce アダプタ Salesforce Metadata アダプタ REST API (Chatter REST API) REST ベースの API 主に他の Web アプリ画面のマッシュアップに使用 処理件数が多いことに不向き Streaming API Bayeux プロトコルを使用した API サーバからクライアントへ Push トピックを送信する
データをつなぎサービスを提供するファンタジスタ Salesforce アダプタ 各種処理と設定
Salesforce アダプタ (SOAP API) の操作 SOAP API とは? 最もスタンダードなAPIと位置付けられています セールスフォースのAPIというとこのAPIを指すことが一般的 Summer 2012 以前は Web Services API が正式名称でした データ操作の他にも パスワードの管理やメール送信などのコールが用意されています 適した用途は? 他のAPIと比べて 最も多くの機能が実装されている リアルタイム処理でありながら 複数のデータを更新することが可能です ただし 大量データを更新する場合はBulk APIの方が適しています
Salesforce アダプタ機能一覧 ( 読み取り系 ) 分類機能名機能説明 読み取り系データ読み取り ( クエリー ) query サービスまたは queryall サービスを用いてデータを読み取ります データ読み取り ( レプリケーション ) データ読み取り (ID による検索 ) データ読み取り ( 親 子リレーション ) データ読み取り ( 子 親リレーション ) データ読み取り (SOQL 実行 ) getupdated getdeleted サービスを使用してデータを読み取ります getupdated getdeleted サービスは ある期間内に追加 修正 削除されたデータの読み取りを行うサービスです 入力データで指定された ID に合致するデータを retrieve サービスを使用して読み取ります query サービスまたは queryall サービスを用いてデータを読み取ります データの読み取りの際 親オブジェクトから見た子オブジェクトを選択することで 1 階層下のオブジェクトまでを合わせて取得することができます query サービスまたは queryall サービスを用いてデータを読み取ります データの読み取りの際 子オブジェクトから見た親オブジェクトの項目を リレーション名. リレーション先項目名 の形式で 1 階層上のオブジェクトまで取得することができます また スキーマ定義にて選択した項目に集計関数を用いることができ 集計条件 (GROUP BY 句など ) を合わせて指定することで 集計条件に基づいた集計関数の結果を取得することができます query サービスまたは queryall サービスを用いてデータを読み取ります SOQL(Sforce Object Query Language) を直接記述して データを読み取ります
Salesforce アダプタ機能一覧 ( 書き込み系 ) 分類機能名機能説明 書き込み系 データ書き込み (INSERT) データ書き込み (UPDATE) データ書き込み (DELETE) データ書き込み (UPSERT) マルチデータファイル生成 マルチデータ書き込み create サービスを用いてデータを追加します リレーションシップによる追加も可能です update サービスを用いてデータを更新します データ更新時のキー項目に Salesforce の ID 以外を指定することができます また 更新対象データが存在しない場合 追加処理を自動的に行うことも可能です リレーションシップによる追加 更新も可能です delete サービスを用いてデータを削除します データ削除時のキー項目は Salesforce の ID 以外を指定することが可能です upsert サービスを用いてデータを追加 更新します UPSERT 処理では あらかじめ Salesforce に外部 ID を定義しておく必要があります Salesforce が外部 ID に該当するデータの存在を確認し データが存在しない場合はデータを追加 データが存在する場合は データの更新を行います また ID によるデータの更新も行えます リレーションシップによる追加 更新も可能です 複数のオブジェクトのレコードを 1 回の更新系 API コールでまとめて処理するためのデータをローカルファイルに出力します ファイルには異なるオブジェクトのデータを追加で出力することができます 出力されたファイルの内容は [ マルチデータ書き込み ] 処理を実行することによって 実際に Salesforce への更新が行われます [ マルチデータファイル生成 ] 処理にて出力されたファイルを読み込み Salesforce へ更新を行います
Salesforce アダプタ機能一覧 ( その他 ) 分類機能名機能説明 その他パスワードリセット resetpassword サービスを用いてパスワードリセットをします パスワードセット setpassword サービスを用いて 入力データで指定された Password の値でパスワードセットをします データ削除 ( ゴミ箱 ) empty_recycle_bin サービスを用いてゴミ箱から削除します データ復元 ( ゴミ箱 ) undelete サービスを用いてゴミ箱から復元します 1 通メール送信 sendemail サービスを使用してメールを 1 通送信します 複数メール送信 sendemail サービスを利用してメールを複数送信します ログイン ( セッション ID による ) 事前に他のアプリケーションなどで Salesforce へのログインが完了している場合 当機能を使用することで セッション情報を引き継ぎ Salesforce アダプタを使用することができます 検索パラメータ形成 設定された条件式と入力データをもとに SOQL(Salesforce Object Query Language) の WHERE 句に使用する文字列を形成します
データをつなぎサービスを提供するファンタジスタ Salesforce Bulk アダプタ 各種処理と設定
Salesforce Bulk アダプタ (Bulk API) の操作 Bulk API とは? 大規模データの操作に最適化されている API サーバサイドのバックグラウンドで処理される複数のバッチを送信することにより 多数のレコードを 非同期 で操作します 適した用途は? SOAP API を使用しても多数のレコードを処理することは可能ですが 大量のデータ操作には多くの通信や時間が必要となります 数千から数百万のレコードを処理する場合 Bulk API を使用する方が通信回数や時間を削減することが可能です
Salesforce Bulk アダプタ (Bulk API) の操作 Bulk API の動作ステップとは? SOAP API とは異なり Bulk API でデータ操作する場合には クライアント側で 5 つステップが必要となります 1. オブジェクトとアクションを指定しジョブを作成する 2. 複数のバッチに分かれたデータ (CSV) をサーバに送信する 3. 適切な間隔で処理状況をチェックする 4. すべてのバッチが完了した時点で各バッチ結果を取得する 5. ジョブをクローズする Salesforce Bulk アダプタでは 上記各ステップを個別で設定することも可能ですが 一括設定をすることで 1 つの設定で容易に Bulk 処理を作成 実行することが可能です
Salesforce Bulk アダプタ機能一覧 分類機能名機能説明 ステップ一括 Bulkデータ書き込み (INSERT) 入力データを元に Bulk API を使用したINSERT 処理を行います ジョブ作成 バッチ作成 バッチ結果の取得 ジョブのクローズまで一括で行います Bulk データ書き込み (UPDATE) Bulk データ書き込み (DELETE) Bulk データ書き込み (UPSERT) ステップ単位ジョブ作成ジョブ作成のリクエストを発行します ジョブ更新 バッチ作成 バッチ結果取得 ジョブ / バッチ情報取得 入力データを元に Bulk API を使用した UPDATE 処理を行います ジョブ作成 バッチ作成 バッチ結果の取得 ジョブのクローズまで一括で行います 入力データを元に Bulk API を使用した DELETE 処理を行います ジョブ作成 バッチ作成 バッチ結果の取得 ジョブのクローズまで一括で行います 入力データを元に Bulk API を使用した UPSERT 処理を行います ジョブ作成 バッチ作成 バッチ結果の取得 ジョブのクローズまで一括で行います ジョブ更新のリクエストを発行し ジョブの状況を更新します 入力データを元に CSV 形式のデータを作成し 指定したジョブに対してバッチ作成のリクエストを発行します 入力データを指定したバッチサイズに従って分割し バッチを作成します 指定したジョブ ID およびバッチ ID をキーに バッチ結果取得のリクエストを発行します 指定したジョブのジョブ情報および バッチ情報リスト取得のリクエストを発行します その他 ログイン ( セッションIDによる ) 事前に他のアプリケーションなどでSalesforceへのログインが完了している場合 当 機能を使用することで セッション情報を引き継ぎSalesforceBulkアダプタを使用す ることができます
データをつなぎサービスを提供するファンタジスタ Salesforce Metadata アダプタ 各種処理と設定
Salesforce Metadata アダプタ (Matadata) の操作 Metadata API とは? データ自体ではなく カスタムオブジェクトの定義やページレイアウトといった 組織のカスタマイズ情報を取得 展開 作成 更新 削除する場合に使用します 適した用途は? 一般的には カスタマイズ情報の組織移行などに適しています
Salesforce Metadata アダプタ (Matadata) の操作 アダプタの用途は? セールスフォースには データ型 選択リスト 複数選択リスト があります 選択リストの選択値は メタデータとして扱われるため SOAP APIやBulk APIから操作することはできません Salesforce Metadata アダプタを使用することで 自動的に選択リストの選択値の変更を行う ということが可能になります 但し 選択リストの選択値以外の操作はできません Copyright 2012, APPRESSO K.K. All Rights Reserved.
Salesforce Metadata アダプタ機能一覧 分類機能名機能説明 読み取り系読み取り ( 選択リスト値 ) 選択リスト値を読み取ります 読み取り ( レコードタイプ選択リスト値 ) レコードタイプの選択可能な選択リスト値を読み取ります 結果取得 (AsyncResult) 入力データに指定された AcyncResult の ID をもとに checkstatus サービスを用いて AcyncResult を取得します 書き込み系追加 ( 選択リスト値 ) 入力データを元に 選択リスト値の INSERT 処理を行います 更新 ( 選択リスト値 ) 入力データを元に 選択リスト値の UPDATE 処理を行います 削除 ( 選択リスト値 ) 入力データを元に 選択リスト値の DELETE 処理を行います 並び替え ( 選択リスト値 ) 更新 ( 選択リスト制御項目値 ) 入力データを元に 選択リスト値の並び替え処理を行います 並び替える順番は 入力データに渡す選択リストの値の順番で指定します 入力データを元に 選択リスト制御項目値の UPDATE 処理を行います 更新 ( レコードタイプ選択リスト値 ) 入力データを元に レコードタイプの選択可能な選択リスト値の UPDATE 処理を行います
データをつなぎサービスを提供するファンタジスタ Salesforce アダプタ 適用パターン
適用パターン : 調査会社データとの連携 Salesforce.com SFA データ API コール 分析用 印刷用データの抽出 企業情報のロード PDF XML CSV BI ツール 帳票との連携 企業情報との連携
適用パターン : 基幹システムとの連携や帳票出力に Salesforce.com SFA データ API コール 分析用 印刷用データの抽出 マスターデータのロード ホスト PDF ERP BI ツール 帳票との連携 各種基幹システムとの連携
Salesforce アダプタ導入メリット 1. プログラムコーディングが不要 AppExchangeAPI を使用するコーディングが不要 テーブル JOIN 処理もマージで簡単に作成可能 2.CSV 形式以外のデータとの連携が可能 3.Salesforce.com に直接操作可能ログイン ログアウト セッション管理 本番系 テスト系 (SandBOX) 切り替え 4. 容易なスキーマの設定ユーザ用の構造を設定可能 ラベル名と API 名をサポート
Salesforce アダプタ導入メリット 5. クラウドでも安心感をイントラネットに比べてエラーの発生しやすいクラウドの特性を考慮にいれリトライ条件 リトライ回数 リトライ間隔などが容易にかつ柔軟に設定できるようになっています 6. 複数オブジェクトのデータのマルチデータ書き込みに対応複数オブジェクトのデータを一括で書き込むマルチデータ書き込みに対応しています
お問い合わせは 株式会社アプレッソ営業部 TEL:03-4321-1111 E-mail:info@appresso.com URL:http://www.appresso.com/