Salesforceの開発やリリース作業を経験する中で、メタデータを取得する機会が増えてきました。
また、その際に用いるツールとしては主に「Salesforce Inspector」や「Salesforce CLI」を用いることを知るとともにどのように使い分けられているのか疑問に思いました。
この記事では、Salesforceにおけるメタデータとは何か、なぜ取得する必要があるか、取得する方法2つの方法とその使い分けについて詳しく解説します。
メタデータとは
Salesforceにおけるメタデータとは、アプリケーションの構造や動作に関する設定情報を指します。具体的には、データベーススキーマ（オブジェクトや項目）、ユーザーインターフェース（レイアウトやページ構成）、ビジネスロジック（フロー、プロセスビルダー、Apexコード）、セキュリティ設定（プロファイルや権限セット）などが含まれます。
これらのメタデータは、Salesforceアプリケーションの設計図であり、開発・運用・保守・環境間の移行において重要な役割を果たします。
メタデータを取得する必要性
まずはSalesforceにおいて、どんな場面でメタデータを取得するのか、その必要性を説明します。
Salesforceで開発や運用を行う際、メタデータの取得は非常に重要です。その理由はいくつかあります。
- 設定の確認やドキュメント化：現在の組織の設定内容を可視化し、他の開発者や運用メンバーと共有するためには、メタデータを取得してドキュメント化することが欠かせません。
- 開発環境間の同期：Sandboxから本番環境へのリリース、あるいは異なる開発環境間での構成の統一には、メタデータの取得と移行が必要です。
- バージョン管理：コードや設定内容の変更履歴を追跡・管理するためには、メタデータをファイルとして取得し、Gitなどのバージョン管理システムに保存します。
- トラブルシューティング：予期せぬ動作や不具合が発生した場合、現在の構成を調査・分析するには、関連するメタデータの確認が不可欠です。
- 自動化・CI/CDパイプラインの構築：本番環境への自動デプロイやテストの自動実行を実現するには、メタデータの抽出・操作が前提となります。
このように、メタデータはSalesforce開発のあらゆる場面で基盤となる情報であり、取得手段とその活用方法を理解しておくことが非常に重要です。
Salesforceにおけるメタデータとは、アプリケーションの構造や動作に関する設定情報を指します。具体的には、データベーススキーマ（オブジェクトや項目）、ユーザーインターフェース（レイアウトやページ構成）、ビジネスロジック（フロー、プロセスビルダー、Apexコード）、セキュリティ設定（プロファイルや権限セット）などが含まれます。
これらのメタデータは、Salesforceアプリケーションの設計図であり、開発・運用・保守・環境間の移行において重要な役割を果たします。
Salesforce Inspectorとは
ツールの概要
Salesforce Inspectorは、Google Chromeの拡張機能として提供されており、Salesforceの画面から直接、データやメタデータを確認・エクスポートできるツールです。GUIベースで直感的に操作できるため、技術的な前提知識が少ないユーザーにも利用しやすい点が特長です。
主な機能と利点
- SOQLクエリの実行やレコードの閲覧・編集が可能
- オブジェクト定義やフィールド情報などのメタデータ取得が容易
- CSV形式でのエクスポートが可能なため、ローカルでの分析やドキュメント作成に活用できる
- インストールが簡単で、即座に使用開始可能
注意点と制限事項
- 一括でのメタデータ抽出やバージョン管理には不向き
- Salesforce API制限の影響を受けやすく、大量データの取得には非効率
- コードベースでの管理や自動化には対応していない
Salesforce Inspectorは、Salesforceに不慣れなユーザーや、特定のメタデータを即時に確認したいときに非常に有用なツールです。
Salesforce CLIとは
ツールの概要
Salesforce CLI（sfまたは旧来のsfdx）は、Salesforce DX（Developer Experience）戦略に基づいて開発された、コマンドラインベースの操作ツールです。これにより、Salesforce組織へのログイン、メタデータの取得・デプロイ、ソースの同期、スクリプトによる自動化などを一貫して実行できます。
主な機能と利点
- Salesforce DXプロジェクト構成をベースとしたソースコード形式でのメタデータ管理
force:source:retrieveやforce:source:deployコマンドによる双方向操作- Gitなどのバージョン管理ツールと連携したCI/CDパイプラインの構築が可能
- スクラッチ組織（Scratch Org）を用いた再現性の高い開発・テスト環境の構築
- スクリプト（バッチファイル、CIジョブ）による作業の自動化
注意点と制限事項
- ターミナル操作やCLI特有の構文に慣れるまでに学習コストがかかる
- 初期構築時にはSalesforce CLIのインストール、認証、プロジェクト作成といった準備が必要
- 誤操作による設定上書きのリスクがあるため、Git等を活用した変更管理が推奨される
Salesforce CLIは、本格的なSalesforce開発を行う上で必須とも言えるツールであり、開発・運用チームにおいて高い生産性を実現できます。
Salesforce InspectorとCLIの比較
| 比較項目 | Salesforce Inspector | Salesforce CLI |
|---|---|---|
| 操作方式 | GUI（ブラウザベース） | CLI（ターミナルベース） |
| 主な利用者 | 初級者、管理者、業務ユーザー | 開発者、DevOpsエンジニア |
| 対象メタデータ範囲 | 限定的（GUIから取得可能な範囲） | 包括的（全メタデータ、ソース形式） |
| 自動化対応 | 非対応 | 対応（スクリプト、CI/CD統合） |
| デプロイ対応 | 非対応 | 対応（Deploy/Retrieve操作が可能） |
| バージョン管理 | 非対応 | Gitとの統合で対応可能 |
| 導入のしやすさ | 拡張機能追加のみで即時利用可能 | 開発環境の準備・認証・プロジェクト構成が必要 |
利用シーンに応じた使い分け
Salesforce Inspectorが適しているケース
- システム管理者や一般ユーザーが、オブジェクト定義やデータを素早く確認したいとき
- 単発のデータ抽出や軽微な設定の確認に留まるケース
- 開発経験が浅く、CLI環境の構築が難しい場面
Salesforce CLIが適しているケース
- 開発者がチーム開発においてコードベースでメタデータを管理したいとき
- 本番組織・Sandbox・スクラッチ組織間での移行や同期をスムーズに行いたいとき
- 継続的インテグレーションや自動化テストを行いたいとき
結論
Salesforceにおけるメタデータ管理は、ツール選定によって大きく効率が変わります。Salesforce Inspectorは、単純かつ迅速な確認・抽出を可能にする初心者向けのツールです。一方、Salesforce CLIは、ソース管理や自動化を前提とした高度な開発・運用において必須のツールです。
利用目的とユーザーのスキルレベルに応じて、これらのツールを適切に使い分けることが、効率的なSalesforce開発・運用の鍵となります。
