本記事では、Creative Content Lab Tokyo（クリエイティブコンテンツラボトウキョウ）が提供するユーザ説明資料「Salesforce Workbench（ワークベンチ）の資料の説明とダウンロード方法を説明いたします。
-
-
参考Salesforceワークベンチ(workbench)の機能一覧と使い方の説明（SOQL実行・Metadataのバックアップ/デプロイなど）
本記事では、Salesforce workbenchについての概要や機能について説明していきます。 サポーター突然ですが、皆さんはSalesforce workbench（ワークベンチ）を使ったことが ...
続きを見る
1.ユーザ説明資料サンプル
１．表紙
画像はクリックすると拡大表示されます。
表紙については、以下の箇所をプロジェクトに合わせて変更してください。
情報種別：社外秘など
情報所有者：基本的にはお客様の会社名となります。
会社名：自社の会社名（正式名称）を記入してください。
タイトル：ドキュメントのタイトルをプロジェクトに合わせて変更
版数、作成日、作成者：※必要に応じて、最終更新日、更新者を入れてください。
２．改訂履歴
版数、変更箇所、変更内容、変更理由、作成日、作成者、更新日、更新者などを記述します。
改訂履歴は、ドキュメントのメンテナンス上必ず設定するようにしましょう。
またプロジェクトごとに記載の粒度やルールを検討してください。
３．はじめに（本書の目的）
資料の目的を記載します。
本書は、Salesforce Workbenchに関する概要の説明を行うことを目的として作成しています。※機能に関しては、2023年2月5日時点で提供されている内容となるため、それ以降に変更が発生した場合には、適宜Updateの内容に合わせて本書の当該事項について修正させていただきます。
４．目次
機能概要説明資料の目次を以下の内容で記載しています。
- Workbench概要
- Workbenchとは
- 機能一覧
- Workbenchの使い方
- Workbenchへの接続方法
- 機能紹介
- メタデータ照会機能
- クエリ実行機能
- データ操作（DML）機能
- マイグレーション機能
- その他ユーティリティ
５．Workbench（ワークベンチ）概要
はじめにWorkbenchについての概要を記載しています。ワークベンチとはどういったものか、できることは何かなど概要レベルで説明します。
Salesforce Workbenchは、Salesforceプラットフォームのメタデータ管理やApexコードの実行、Salesforce APIを使ったデータへのアクセスなどを行う機能が提供されたWebベースのツール（サービス）です。Workbenchを使うことで、システム管理者や開発者はプログラムコードを書くことなく、ブラウザ上からのマウス操作で簡単にメタデータを取得したり、APIを実行したりすることができます。
続いて、Workbenchの機能一覧を記載（最新の機能一覧は公式サイトからご確認ください）
６．Workbenchの使い方（ワークベンチへのログイン）
ブラウザでWorkbenchへログインして利用するための手順を記載しています。
Workbench接続先サイト（https://workbench.developerforce.com/login.php）
※サイトのURLの最新情報は公式サイトからご確認ください。
Salesforceのユーザアカウントを使ってログインを行います。
ユーザ名とパスワードを設定して、ログイン
Workbenchのトップ画面で、利用する機能を選択するか、もしくはタブに表示されている各種メニューから利用する機能を選択します。
７．メタデータ情報照会（標準/カスタムオブジェクト）
指定したオブジェクトに関するメタデータ情報を参照することができます。
Metadata Types & Components：メタデータタイプの確認やコンポーネントについての詳細情報を確認することができます。
セッション情報（Session Infromation）：
接続しているSalesforceインスタンスのセッション情報（サービスのエンドポイントなど）を確認することができます。
８．クエリ実行機能（SOQLクエリ）
SOQL：SOQLのクエリを直接実行することができます。表示形式やソート順の指定が可能またフィルタ条件や取得レコードの上限の指定も可能です。
そのほか、削除済み、アーカイブレコードを含めるかなどの指定もできます。
Async SOQL Query：非同期のSOQL(Insert/Upsert）の実行ができます。
最初の画面で指定したSOQLで取得したレコードを使って、INSERTまたはUPSERTを実行することができます。
SOSL（Salesforce Object Search Language) の実行が可能です。SOQLは、Salesforceのレコード内のテキスト検索を実行することができます。
Streaming Push Topics：Salesforceのレコードを監視し、本機能で登録したSOQLクエリに該当した場合に、あらかじめ購読（Subscribe登録）されたクライアントに対して、プッシュ通知を実現するものとなります。
9.データ操作（DML）機能
Insert：指定オブジェクトに対して1つまたは複数のレコードを登録することができます。
【説明】INSERTでは、各項目に直接値を設定して、実行します。実行結果では、作成されたレコードIDと処理結果を確認することができます。
Update：指定オブジェクトに対して1つまたは複数のレコードを更新することができます。
【説明】UPDATEでは、各項目に直接値を設定して、実行します。実行結果では、更新されたレコードIDと処理結果を確認することができます。
Upsert：指定オブジェクトに対して1つまたは複数のレコードを更新または新規登録することができます。
外部IDなどのキー項目を比較し、すでにSalesforce上に登録されているキーと一致する場合にはレコードを更新し、一致しない場合は新規レコードとして登録されます。
【説明】UPSERTでは、各項目に直接値を設定して、実行します。
実行結果の確認画面では、処理結果とステータスを確認することができます。INSERT/UPDATEはレコード単位で確認可能
Delete：指定オブジェクトに対して1つまたは複数のレコードを削除することができます。
【説明】DELETEでは、削除対象のIDを指定して削除処理を実行します。実行結果の確認画面では、処理結果とステータスを確認することができます。
Undelete：指定オブジェクトに対して1つまたは複数の削除されたレコードを復元することができます。
【説明】指定オブジェクトに対して1つまたは複数の削除されたレコードを復元することができます。
Purge：指定オブジェクトに対して1つまたは複数の削除されたレコードをゴミ箱から削除することができます。
【説明】実行結果の確認画面では、処理結果とステータスを確認することができます。
10.マイグレーション
Retrieve：マニフェストファイルで指定したメタデータを取得することができます。Package.xmlファイルは事前に作成しておく必用があります。
マニフェストファイル（Package.xml）のサンプル。以下のサイトからフルバージョンをダウンロードすることができます。
全メタデータ取得用のマニフェストファイル（Package.xml）のサンプルダウンロード
https://creativecontentlabtokyo.com/retrieve-salesforce-full-metadata-package-xml-file-download/
説明：Retrieveを実行すると、メタデータAPIを利用してメタデータの取得処理が行われます。
実行結果の画面では、処理結果と合わせて取得したメタデータの圧縮ファイル（Zip）がダウンロード可能となります。※このZipファイルを使って、Deployを行うことができます。
Deploy（デプロイ）：指定したメタデータのZIPファイルを使ってSalesforce組織にメタデータをデプロイします。
【説明】Deployには、以下のように様々なオプションが用意されています。
・チェック（検証）だけを実行
・警告を無視
・エラーの場合にロールバック
・Apexテストの実行、テストレベルの指定など
実行するとメタデータAPIで処理が行われます。処理結果には、処理した件数や結果が表示されます。
【説明】Deploy実施結果では、ZIPファイルに含まれるメタデータごとの処理結果の詳細情報を確認することができます。
11.その他ユーティリティ機能
Rest Explorer：WorkbenchからSalesforce組織に対して直接REST APIを実行することができます。
利用可能なメソッドは、GET、POST、PUT、PATCH、DELETE、HEADとなります。
Apex Execute：WorkbenchからSalesforceに対して直接Apexコードを実行することができます。
例では、Account（取引先）のレコードを3件取得してリストに格納する処理を実行してます。実行結果では、デバッグログを確認することができます。
Password Management：WorkbenchからSalesforceのユーザに対してパスワードの設定やリセットを行うことができます。
Bulk API Job Status：DataloaderやWorkbenchなどから実行されたBulk APIのジョブステータスを確認することができます。
一括データ読み込みジョブのIDを指定して実行します。実行結果の確認画面では、ステータスや処理件数、失敗件数などを確認することができます。
Metadata API Process Status：メタデータAPIの処理プロセスのステータス（実行状況）を確認することができます。確認したいIDを指定して実行します。
2.ユーザ説明資料「機能概要説明書（Salesforce Workbench（ワークベンチ））のダウンロード
資料のダウンロードおよびご利用に関しては、本サイトのコンテンツ利用規約に同意される場合のみ利用可能となります。
一般公開資料（PDF版資料）
※クリックして資料のダウンロードが開始されるまで少し時間がかかる場合がありますので、そのままお待ちください。
もしダウンロードが開始されない場合、ブラウザでポップアップブロックされている可能性があるのでご確認ください。
関係者のみ（PPT版資料）
関係者の方は、以下のページからログインして資料をダウンロードしてください
-
-
参考保護中: 【関係者】ダウンロード可能なコンテンツ（サンプル・フォーマット）一覧
この投稿はパスワードで保護されているため抜粋文はありません。
続きを見る
