サポーターさん

機能の紹介記事は以下を参考にしてください。

参考

Salesforceワークベンチ(workbench)の機能一覧と使い方の説明（SOQL実行・Metadataのバックアップ/デプロイなど）

本記事では、Salesforce workbenchについての概要や機能について…

続きを読む

1.ユーザ説明資料サンプル

１．表紙

画像はクリックすると拡大表示されます。

表紙については、以下の箇所をプロジェクトに合わせて変更してください。

情報種別：社外秘など

情報所有者：基本的にはお客様の会社名となります。

会社名：自社の会社名（正式名称）を記入してください。

タイトル：ドキュメントのタイトルをプロジェクトに合わせて変更

版数、作成日、作成者：※必要に応じて、最終更新日、更新者を入れてください。

２．改訂履歴

版数、変更箇所、変更内容、変更理由、作成日、作成者、更新日、更新者などを記述します。

改訂履歴は、ドキュメントのメンテナンス上必ず設定するようにしましょう。

またプロジェクトごとに記載の粒度やルールを検討してください。

３．はじめに（本書の目的）

資料の目的を記載します。

４．目次

機能概要説明資料の目次を以下の内容で記載しています。

• Workbench概要
• Workbenchとは
• 機能一覧
• Workbenchの使い方
• Workbenchへの接続方法
• 機能紹介
• メタデータ照会機能
• クエリ実行機能
• データ操作（DML）機能
• マイグレーション機能
• その他ユーティリティ

５．Workbench（ワークベンチ）概要

はじめにWorkbenchについての概要を記載しています。ワークベンチとはどういったものか、できることは何かなど概要レベルで説明します。

続いて、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版資料）

関係者の方は、以下のページからログインして資料をダウンロードしてください

参考

保護中: 【関係者】ダウンロード可能なコンテンツ（サンプル・フォーマット）一覧

  [st-kaiwa2]お問合せ・ご要望いただいているコンテンツも頑…

続きを読む

サポーターさん

ブログランキングに参加しましたので、ご支援していただけると幸いです。

にほんブログ村

サポーターさん

突然ですが、皆さんはSalesforce workbench（ワークベンチ）を使ったことがありますか？

Salesforceの開発に携わった方は、開発者コンソールを使うことは多いと思いますが、リリースや運用保守でメタデータのバックアップを行うなどの機会がない方は使ったことがないという場合も多いと思います。

Workbenchには様々な機能があり、管理者や開発者にとっては開発者コンソール同様、非常に便利なツールとなります。

ワークベンチはWebブラウザから簡単にアクセスすることができ、Salesforce組織ともAPIで簡単に接続できます。さらにブラウザ上から直接クエリを発行したり、メタデータを取得（Retrieve）したり、デプロイ（Deploy）することもできます。

※Bulk、Rest ストリーミング、メタデータなどもサポートしています。

またよく利用されるパターンとして、本番環境で不要となったプログラムを削除するような場合にも利用されています。

1 Workbench概要

1-1. Workbenchとは

Salesforce Workbenchは、Salesforceプラットフォームのメタデータ管理やApexコードの実行、Salesforce APIを使ったデータへのアクセスなどを行う機能が提供されたWebベースのツール（サービス）です。

Workbench（ワークベンチ）を使うことで、システム管理者や開発者はプログラムコードを書くことなく、Webブラウザ上からの操作で簡単にメタデータを取得したり、APIを実行したりすることができます。

公式サイトのURLはこちら「Workbenchサイト（https://workbench.developerforce.com/login.php）」

1-2. 機能一覧

ワークベンチ（workbench）が現時点で提供している機能は以下の通りです。

以上のように、非常に実用性の高い機能が用意されています。

2.Workbenchの使い方

2-１． Workbenchへの接続方法

手順①Workbenchへログインするために以下の公式サイトへブラウザでアクセスします。

Workbenchサイト（https://workbench.developerforce.com/login.php）

• Environment（接続環境）を選択：Production（本番）、またはSandboxを選択します。
• API Version：利用したいAPIのバージョンを指定します。　※バージョンによって利用可能な機能が異なりるため注意

手順②「I agree to terms of service」にチェックを入れて、Login with Salesforceのボタンをクリックします。

手順③Salesforce組織にログインするためのユーザ名とパスワードを入力してログインを行います。

※すでにSalesforce組織にログインしているブラウザでWorkbenchを実行している場合は自動的に接続されます。

手順④Salesforce組織に接続後は、以下ワークベンチのメニューが表示されます。

各機能の利用方法は次の章で紹介します。

3. 機能紹介

3-1. メタデータ照会機能

①Standard ＆Custom Objects（標準＆カスタムオブジェクト）

指定したオブジェクトに関するメタデータ情報を参照することができます。※以下はユーザオブジェクトを照会した例

照会できる情報は以下の通り

• 属性
• 子リレーション
• フィールド（項目）
• レイアウト名

②Metadata Types & Components（メタデータタイプ＆コンポーネント）

メタデータタイプの確認やコンポーネントについての詳細情報（ID、名称、作成者/作成日、最終更新者/最終更新日など）の情報を確認することができます。

上記は、フローのメターデータを照会した例

③Session Information（セッション情報）

接続しているSalesforceインスタンスのセッション情報（サービスのエンドポイントなど）を確認することができます。

取得可能な情報

• APIのバージョン
• クライアントID
• エンドポイント

（ユーザ情報）

• プロファイル
• ロール
• ユーザ名
• ユーザID
• タイムゾーン、ユーザタイプなど

（組織）

• 添付ファイルの上限など

3-2. クエリ実行機能

①SOQL Query（SOQLクエリ実行）

SOQLを直接実行することができます。表示形式やソート順の指定が可能またフィルタ条件や取得レコードの上限の指定も可能です。そのほか、削除済み、アーカイブレコードを含めるかなどの指定もできます。

SOQL実行結果

②Async SOQL Query

非同期のSOQL(Insert/Upsert）の実行ができます。

③SOSL Search

SOSL（Salesforce Object Search Language) の実行が可能です。※Salesforceのレコード内のテキスト検索を実行

SOSLの実行結果（CCLTという文字列での検索を実行）

④Streaming Push Topics

本機能は、Salesforceのレコードを監視し、本機能で登録したSOQLクエリに該当した場合に、あらかじめ購読（Subscribe登録）されたクライアントに対して、プッシュ通知を実現するものとなります。

以下のメッセージが表示される場合は、Salesforce組織のストリーミングAPIの有効化がされていないため、先に設定しておく必要があります。また本機能を使う場合には、事前にSalesforce側でプッシュ通知の各種設定が必要となります。

PushTopicに関しては、少し古いですが、テラスカイさんの以下の記事がわかりやすいかと思います。

3-３. データ操作（DML）機能

①Insert

指定オブジェクトに対して1つまたは複数のレコードを登録することができます。

以下の画面で登録するための項目の値を指定して実行

実行結果を表示（成功すると以下のように表示されます）

②Update

指定オブジェクトに対して1つまたは複数のレコードを更新することができます。

以下の画面で更新レコードのIDを指定して、変更後の値をセットしたら実行

実行結果の画面

③Upsert

指定オブジェクトに対して1つまたは複数のレコードを登録＆更新することができます。

更新の場合はIDを指定して、変更後の値をセットして実行（新規の場合はID指定なし）

実行結果

④Delete

指定オブジェクトに対して1つまたは複数のレコードを（ごみ箱に）削除することができます。

削除対象レコードのIDを指定して実行

実行結果

⑤Undelete

指定オブジェクトに対して1つまたは複数の削除されたレコードを復元することができます。

UndeleteしたいレコードのIDを指定して実行

Undeleteの実行結果

⑥Purge

指定オブジェクトに対して1つまたは複数の削除されたレコードをごみ箱から完全に削除することができます。

Purgeしたいレコードを指定して実行

Purge（パージ）の実行結果

3-４. マイグレーション機能

①Retrieve（取得）

指定されたマニフェストファイル（Package.xml）に定義されたメタデータをdownloadすることができます。

Package.xmlファイルを指定します。

全てのメタデータ取得用のファイルが欲しい方は、以下からダウンロードしてご利用いただけます。

参考

全メタデータ取得用のマニフェストファイル（Package.xml）のサンプルダウンロード

本記事では、Creative Content Lab Tokyo（クリエイティブ…

続きを読む

Retriveを実行した結果

上記のDownload ZIP Fileをクリックするとメタデータのファイルをダウンロードすることができます。

ダウンロードしたメタデータはデプロイして元に戻すことができます。

②Deploy（デプロイ）

指定されたメタデータをSalesforce組織にデプロイすることができます。

オプションで、チェックだけを行う、ワーニングを無視、テストレベルやテストの実行指定などができます。

あらかじめ取得しておいたメタデータファイル（ZIP形式）を指定して実行します。

実行中の画面

実行結果の確認画面

3-５. その他ユーティリティ

①Rest Explorer

WorkbenchからSalesforce組織に対して直接REST APIを実行することができます。

利用可能なメソッドは、GET、POST、PUT、PATCH、DELETE、HEADとなります。

②Apex Execute

Apexコードを直接実行することができます。※開発コンソールと同様

実行すると以下のようなデバッグログが表示されます。

③Password Management（パスワード管理）

ユーザのパスワードを設定したりリセットすることができます。

パスワードを設定/変更したいユーザIDと新しいパスワードを指定してChange Passwordを実行します。

④Bulk API Job Status

DataloaderやWorkbenchなどから実行されたBulk APIのジョブステータスを確認することができます。

一括データ読み込みジョブのIDを指定して実行

ジョブの実行状況（結果）が表示されます。

⑤Metadata API Process Status

メタデータAPIの処理プロセスのステータス（実行状況）を確認することができます。

確認したいIDを指定して実行します。

Salesforce workbenchの概要説明資料のダウンロード

資料のダウンロードおよびご利用に関しては、本サイトのコンテンツ利用規約に同意される場合のみ利用可能となります。

一般公開資料

参考

要件定義_ユーザ説明資料_Salesforce Workbench（ワークベンチ）機能概要説明」ダウンロード

本記事では、Creative Content Lab Tokyo（クリエイティブ…

続きを読む

まとめ

サポーターさん

ブログランキングに参加しましたので、ご支援していただけると幸いです。

にほんブログ村