Salesforce DX 開発者ガイド
jSandbox 定義ファイルの作成
Salesforce CLI を使用して Sandbox を作成する前に、Sandbox 定義ファイルにその設定を定義します。Sandbox 定義ファイルは、Sandbox 組織の設計図です。開発プロセスで使用する Sandbox の種類ごとに異なる定義ファイルを作成できます。
Sandbox の設定値
| オプション | 必須かどうか | 説明 |
|---|---|---|
| apexClassId | いいえ | Sandbox のコピー後に毎回実行される Apex クラスの ID の参照。これにより、Sandbox で、使用の準備のためにビジネスロジックを実行できます。 |
| autoActivate | いいえ | true の場合は、Sandbox の更新を即座に有効化できます。 |
| copyArchivedActivities | いいえ | Full Sandbox のみ。この項目は、組織で Sandbox のアーカイブ済み活動をコピーするオプションを購入している場合に表示されます。このオプションの入手については、Salesforce カスタマーサポートにお問い合わせください。 |
| copyChatter | いいえ | true の場合、アーカイブ済み Chatter データが Sandbox にコピーされます。 |
| description | いいえ | Sandbox の説明 (1000 文字以下)。他の Sandbox ボックスと区別するために使用できます。 |
| historyDays | いいえ | Full Sandbox のみ。Sandbox にコピーするオブジェクト履歴の日数を表します。 有効な値は次のとおりです。
|
| licenseType | はい (Sandbox の作成の場合) | 有効な値は、Developer、Developer_Pro、Partial、Full です。 |
| sandboxName | はい | Sandbox を識別するための一意の英数字文字列 (10 文字以下)。Sandbox の削除処理中は、名前を再利用することはできません。 |
| sourceSandboxName | はい (Sandbox のコピーの場合) | コピー元の Sandbox の名前。 |
| templateId | はい (Partial Sandbox の場合) | Full Sandbox では省略可能です。Developer および Developer Pro Sandbox では使用できません。 Sandbox テンプレートへの参照であり、URL での 1ps で始まる 15 文字の ID によって識別されます。ブラウザーで Sandbox テンプレートを表示するときに使用できます。Sandbox テンプレートを使用すると、Sandbox 内でコピーするオブジェクトを選択できます。 |
サンプルの Sandbox 定義ファイル
Sandbox 定義ファイルはどこにでも配置できますが、Salesforce DX プロジェクトの config ディレクトリに保存することをお勧めします。ファイルに名前を付けるときは、わかりやすい名前で sandbox-def.json で終わるものを指定することをお勧めします (例: developer-sandbox-def.json)。
次に示すのは、Sandbox を作成する場合の定義ファイルの例です。
1{
2 "sandboxName": "dev1",
3 "licenseType": "Developer"
4}次に示すのは、Sandbox をコピーする場合の定義ファイルの例です。
1{
2 "sandboxName": "dev1clone",
3 "sourceSandboxName": "dev1"
4}