独自のスクラッチ組織定義ファイルを作成する

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

org create scratch CLI コマンドでスクラッチ組織を作成するときには、スクラッチ組織設定ファイルへのパスを指定します。

• コマンドラインで Salesforce CLI を使用している場合は、このファイルには任意の名前を指定でき、CLI がアクセスできる任意の場所に配置できます。
• VS Code 向け Salesforce 拡張機能を使用する場合、スクラッチ組織定義ファイルが Salesforce DX プロジェクトの config フォルダーにあることを確認してください。また、その名前は scratch-def.json で終わる必要があります。

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

スクラッチ組織定義ファイルのオプション

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

サンプルのスクラッチ組織定義ファイル

1{
2  "orgName": "Acme",
3  "edition": "Enterprise",
4  "features": ["Communities", "ServiceCloud", "Chatbot"],
5  "settings": {
6      "communitiesSettings": {
7          "enableNetworksEnabled": true
8      },
9      "mobileSettings": {
10          "enableS1EncryptedStoragePref2": true
11      },
12      "omniChannelSettings": {
13          "enableOmniChannel": true
14      },
15      "caseSettings": {
16          "systemUserEmail": "support@acme.com"
17      }
18  }
19}

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

1"features": ["Communities"],
2    "settings": {
3        "communitiesSettings": {
4          "enableNetworksEnabled": true
5      },
6        ...

ScratchOrgInfo のカスタム項目の作成

スクラッチ組織定義にオプションを追加して、Dev Ops プロセスを管理できます。これを行うには、ScratchOrgInfo オブジェクトのカスタム項目を作成します。ScratchOrgInfo は、スクラッチ組織の作成や削除を追跡します。

Dev Hub 組織で、カスタム項目を作成します。

• [設定] から [クイック検索] ボックスに「オブジェクトマネージャー」と入力し、[オブジェクトマネージャー] を選択します。
• [スクラッチ組織情報] をクリックします。
• [項目とリレーション] で、[新規] をクリックします。
• カスタム項目を定義し、[保存] をクリックします。

カスタム項目を作成したら、スクラッチ組織定義ファイルで API 参照名で参照して、カスタム項目に値を渡すことができます。workitem と release の 2 つのカスタム項目を作成するとします。次のようにカスタム項目と関連付けられている値をスクラッチ組織定義に追加して、スクラッチ組織を作成します。

1{
2     "orgName": "MyCompany",
3     "edition": "Developer",
4     "workitem__c": "W-12345678",
5     "release__c": "June 2024 pilot",
6     
7     "settings": {
8         "omniChannelSettings": {
9              "enableOmniChannel": true
10     }
11           }
12}

オブジェクトレベルの共有設定とデフォルトのレコードタイプの設定

正常にインストールするには、一部のパッケージでインストール前に、オブジェクトレベルの共有設定とデフォルトのレコードタイプを定義する必要があります。objectSettings を使用して、共有設定とデフォルトのレコードタイプを設定します。このサンプルのスクラッチ組織定義ファイルでは、商談の共有モデルとデフォルトのレコードタイプ、および取引先のデフォルトのレコードタイプを設定しています。

1{
2  "orgName": "MyCompany",
3  "edition": "Developer",
4  "features": ["Communities", "ServiceCloud", "Chatbot"],
5  "settings": {
6      "communitiesSettings": {
7          "enableNetworksEnabled": true
8      }
9  }
10  "objectSettings": {
11     "opportunity": {
12        "sharingModel": "private",
13        "defaultRecordType": "default"
14     },
15     "account": {
16        "defaultRecordType": "default"
17     }
18  }
19}