本記事でできること

本記事では、SalesforceのREST APIを利用して「昨日登録された商談から商談IDと商談名を取得してタイプファイルに出力する」ロボットを作成します。
APIを用いて開発をすることでSalesforceと別システムの自動化が実現しやすくなると思います。
また、SalesforceのAPIの使い方やBizRobo!でAPIを利用するための設定方法について理解できます。

背景

BizRobo!はステップの編集だけで簡単にデジタルレイバー(ロボット)を作成できるので非エンジニアの方にもなじみやすいのが特徴だと思います。
ただ、画面操作だけの開発だとクラウドサービスのアップデート等でUIが変更になるとロボットが止まってしまって改修に時間がかかってしまう、、、というケースも少なくないと思います。
そういった状況を解決するためにAPIを利用するという方法があります。
ただ、非エンジニアの方の中には「APIって高度なイメージがあって難しそう」「ステップの操作でも実行できるから充分」と思う方もいらっしゃると思います。(かくゆう私もそう思っていた時期がありました)
そのような方に向けて弊社で利用しているAPIとその使い方について紹介したいと思います。

本記事はサードパーティーのツールを利用するため、動作を保証するものではございません。
APIを利用するための参考としてお考え下さい。

BizRobo!に搭載されているコネクター機能を用いてSalesforceを操作することも可能です。
コネクターを使う場合はこちらを参照ください。

事前準備

Salesforceの設定

Salesforceの認証を設定してください

ユーザのAPI有効化
OAuth設定の有効化

認証の設定が終わったらプロパティを用意します。
今回のロボットでは以下の値を利用します。

プロパティ	ラベル
instance_name	組織のインスタンス
username	ユーザ名
passsword	パスワード
client_id	コンシューマ鍵
client_secret	コンシューマの秘密

利用バージョン

本記事で利用する各システムの情報は下記になります。

対象システム	利用バージョン
BizRobo!	11.3.0.2
Salesforce REST API	58.0

ロボットの作成手順

以下のステップにて実現します。
左から12個のステップごとに説明をしていきます。

①パスワード取得（Lookup Password）

ロボットにパスワードを持たせるのはセキュリティ的によくないのでMCのパスワードストアを利用します。
流れとしては以下になります。
A：ステップを用意する
B：MCのパスワードストアにパスワードを設定する
C：アクセストークンを取得する
D：MCのパスワードストアにアクセストークンを設定する

A:ステップを用意

ステップ選択: その他 > パスワード取得

パスワード取得ステップ設定

ユーザー名: Salesforceのユーザ名（username）
ターゲットシステム: 任意の値
変数: パスワード型の変数を設定

B:MCのパスワードストア設定(パスワード)

MCログイン
リポジトリ > パスワードストア > パスワードストアエントリを作成を選択
ユーザー名: DSと同じユーザー名の値を入力
ターゲットシステム: DSと同じターゲットシステムの値を入力
パスワード: Salesforceのパスワード（passsword）
OKボタンクリック

C:アクセストークン取得

DSに戻る
ヘルプ > 製品について

Design Studio アクセストークンをコピー

D:MCのパスワードストア設定(アクセス)

MCログイン
リポジトリ > パスワードストア > パスワードアクセス > パスワードアクセスエントリを作成を選択
プロジェクト: 対象プロジェクト選択
パスワードアクセストークン: 先ほどコピーしたDesign Studio アクセストークンを貼り付け
説明: パスワードについての説明を入力
パスワードエントリ: ユーザー名@ターゲットシステムを選択
OKボタンクリック

以上で設定完了です。
変数にパスワードが格納されていることを確認してください。

②アクセストークン生成（OAth）

アクセストークンを生成するステップを作成します。
流れとしては以下になります。
A：ステップを用意する
B：ステップの設定をする

A:ステップを用意

ステップ選択: Web サービス呼出 > REST Web サービス呼出

第３者が見てもわかりやすいようにコメントを記入しておくと良いでしょうか。

B:ステップの設定

URL: REST APIのエンドポイント
- https://[Salesforceの組織のインスタンス（instance_name）]/services/oauth2/token
リクエスト: REST APIの操作方法
- POST
パラメータで指定
パラメータ: REST APIに送信する追加情報
- grant_type: password(固定値)
- username: Salesforceのユーザ名（username）
- password: password(変数)
- client_id: Salesforceのコンシューマ鍵（client_id）
- client_secret: Salesforceのコンシューマの秘密（client_secret）
エンコード:Form-urlencoded
出力値:ブラウザにロード
送信する追加ヘッダー: REST APIに送信する付加情報
- Content-Type:application/x-www-form-urlencoded

SalesforceのOauthの詳細については開発者ガイドをご確認ください。

③レスポンスを読み取り専用で開く（View as JSON）

②で取得した情報をJSON形式で読み取り専用で開きます。

ステップ挿入: アクションを選択 > 開く（読み取り専用）

④アクセストークン取得（Extract Access Token）

③で表示されたJSONからアクセストークンを取得します。

access_tokenを選択して変数に抽出する

変数にアクセストークンが格納されていることを確認してください。

⑤昨日登録された商談を取得（query）

SOQLクエリを設定してSalesforceから情報を取得します。

ステップ選択: Web サービス呼出 > REST Web サービス呼出
ステップ名変更: Call REST Web Serviceからqueryへ変更
URL: https://[Salesforceの組織のインスタンス（instance_name）]/services/data/v58.0/query
リクエスト: GET
パラメータ: SOQL クエリ
- q: SELECT Id,Name FROM Opportunity WHERE CreatedDate=YESTERDAY
出力値:ブラウザにロード
送信する追加ヘッダー
- エクスプレッションを選択して以下を設定
- "Authorization:Bearer "+access_token

SOQLクエリの詳細についてはSalesforceの開発者ガイドをご確認ください。

⑥レスポンスを読み取り専用で開く（View as JSON）

⑤で取得したデータをJSON形式で出力します。

ステップ挿入: アクションを選択 > 開く（読み取り専用）

⑦件数取得（Extract Count）

⑥で出力されたJSONから検索結果に該当する件数を取得します。

totalSizeを選択して変数に抽出

⑧商談があるかどうか判定

該当データが0件の場合は処理が終了するため条件分岐を設定します。

ステップ選択: テスト > 変数判定

データが0件の場合、後続処理を行わない

0件はエラーで無いのでエラー処理のチェックを外す

Tips
本記事ではAPIの処理を優先する為エラーハンドリングを実施していませんが、検索結果0件の場合にログの出力を設定しておくと運用しやすくなります。

ステップ名変更: Test Variablesから商談チェックへ変更

⑨レスポンスJSONをループ（For Each 商談）

出力された商談のデータを取得します。複数のデータが存在する可能性があるためループ処理を実装します。

ステップ挿入

recordsを選択(JSON)
ループ > アイテム

ステップ名変更: For Each ItemからFor Each 商談へ変更

次のステップで必要となるタイプファイルを用意します。
Id,Nameを格納するタイプファイル作成

⑩商談ID抽出（Extract Id）

ループ処理が行われる際にidの情報を抽出します。

囲われた枠の左の+アイコンをクリックする

上記で作成したタイプファイルに抽出

⑪商談名抽出（Extract Name）

⑩の手順と同様に商談名を抽出します。

⑫結果確認（Return Value）

正常に動作しているか結果を確認します。

ステップ選択: 値返却

以上でロボットの作成は完了になります。

まとめ

今回はSalesforceのAPIを利用して商談データの取得を行ってみました。
SalesforceのAPIを利用するとロボットの構築の幅が広がり、メンテナンス性も向上できると思います。
APIを利用したロボットの開発のための一助となれば幸いです。

RPAテクノロジーズではSalesforceの操作を容易にする為にコネクターを開発しております。
APIで構築するよりも簡単に開発ができるツールになっているのでぜひご利用ください。
リンクはこちら