この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

スクラッチ組織定義ファイル

スクラッチ組織定義ファイルは、スクラッチ組織の設計図です。Salesforce、パッケージ化、本番など、開発ライフサイクルで使用する組織シェイプを模倣します。

組織シェイプは、次のような関連付けられた設定のコレクションによって決まります。

エディション — スクラッチ組織の Salesforce エディション (Developer、Enterprise、Group、Professional など)。
アドオン機能 — デフォルトではエディションに含まれない機能 (マルチ通貨など)。
組織設定 — Salesforce 製品の設定に使用される組織と機能の設定 (Chatter やコミュニティなど)。

デフォルトでは、スクラッチ組織は空です。従来の方法で Developer Edition 組織などの組織にサインアップしたときに取得されるサンプルメタデータのほとんどは含まれません。スクラッチ組織に含まれない情報として、次のようなものがあります。

カスタムオブジェクト、項目、インデックス、タブ、エンティティ定義
サンプルデータ
サンプル Chatter フィード
ダッシュボードとレポート
ワークフロー
選択リスト
プロファイルと権限セット
Apex クラス、トリガ、ページ

異なるスクラッチ組織定義ファイルを設定すると、テスト用に異なるシェイプを持つスクラッチ組織を簡単に作成できます。たとえば、定義ファイルに ChatterEnabled 組織設定を指定することで、スクラッチ組織の Chatter を有効または無効にできます。以前のようにサンプルデータとメタデータを含むスクラッチ組織が必要な場合、hasSampleData オプションを指定します。

スクラッチ組織定義ファイルには次のオプションを指定できます。

名前	必須	指定がない場合のデフォルト
orgName	いいえ	会社名
country	いいえ	Dev Hub の国。英大文字 2 文字の ISO-3166 国コード。これらのコードの完全なリストは、https://www.iso.org/iso-3166-country-codes.html などのさまざまなサイトに掲載されています。値を指定するとスクラッチ組織のロケールが設定されます。
username	いいえ	test-`unique_identifier`@example.com
adminEmail	いいえ	スクラッチ組織作成要求を行った Dev Hub ユーザのメールアドレス
edition	はい	なし。有効なエントリは Developer、Enterprise、Group、Professional
説明	いいえ	なし。2,000 文字の自由形式のテキスト項目。説明は、スクラッチ組織の目的を文書化するのに適した方法です。Dev Hub で説明の表示や編集ができます。アプリケーションランチャーから、[スクラッチ組織情報] または [有効なスクラッチ組織] を選択し、スクラッチ組織番号をクリックします。
hasSampleData	いいえ	有効な値は、`true` および `false` です。デフォルトは false で、サンプルデータなしで組織が作成されます。
language	いいえ	国のデフォルト言語
features	いいえ	なし
orgPreferences	いいえ	なし

スクラッチ組織定義 JSON ファイルな次のようになります。

1{
2  "orgName": "Acme",
3  "country": "US",
4  "edition": "Enterprise",
5  "description": "Work Item #12345: add picklist to widget",
6  "hasSampleData": "true",
7  "features": ["MultiCurrency", "AuthorApex"],
8  "orgPreferences": {
9    "enabled": ["S1DesktopEnabled", "ChatterEnabled"],
10    "disabled": ["IsNameSuffixEnabled"]
11  }
12}

コミュニティなど、機能によっては、スクラッチ組織で適切に機能するために機能と orgPreferences パラメータの組み合わせが必要になることがあります。次のコードスニペットでは、コードと組織設定の両方が設定されます。

1"features": ["Communities"],
2    "orgPreferences": {
3        "enabled": ["NetworksEnabled"],
4        ...

force:org:create CLI コマンドでスクラッチ組織を作成するときには、スクラッチ組織設定ファイルへのパスを指定します。このファイルには任意の名前を指定でき、CLI がアクセスできる任意の場所に配置できます。

サンプルリポジトリを使用する場合や Salesforce DX プロジェクトを作成する場合、サンプルのスクラッチ組織定義ファイルは config ディレクトリにあります。異なる組織シェイプやテストシナリオ用に異なる組織設定ファイルを作成できます。識別しやすいように、ファイルにはわかりやすい名前を付けます (たとえば、devEdition-scratch-def.json や packaging-org-scratch-def.json など) 。

このファイルをプロジェクトで保持し、バージョン管理システムにチェックインすることをお勧めします。たとえば、すべてのチームメンバーが使用できるように、チームバージョンを作成してチェックインします。個々の開発者も、スクラッチ組織定義パラメータを含む自分のローカルバージョンを作成できます。これらのパラメータとして、スクラッチ組織の作成者を識別するメールや姓などがあります。

Salesforce DX 開発者ガイド

スクラッチ組織定義ファイル