omnistudio-datapacks-deploy について
OmniStudio と Industries プロジェクト向けに、Vlocity Build による DataPack のエクスポート、デプロイ、再試行、障害診断を扱うスキルです。マニフェストを使った作業と CI/CD の順序を案内し、ローカル検証とキーの整合性を重視します。
主な機能
- 01DataPack のエクスポートとデプロイの調整
- 02マニフェスト駆動のジョブファイル設計
- 03ローカル DataPack データの検証
- 04中断ジョブの再試行と継続
- 05依存関係とキーのエラー診断
活用シーン
- 01Salesforce 組織間での DataPack デプロイ
- 02失敗または部分デプロイのトラブルシューティング
- 03範囲を指定した DataPack CI/CD 手順の構築
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ forcedotcom/ sf-skills --skill omnistudio-datapacks-deployインストール後、Claude Code で/omnistudio-datapacks-deployを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
README.mdexamples/business-internet-plus-bundle-deploy/deploy-business-internet-plus-bundle.yamlTRANSCRIPT.mdexamples/business-internet-plus-bundle/deploy-business-internet-plus-bundle.yamlTRANSCRIPT.mdreferences/job-file-template.mdtroubleshooting-matrix.md詳細
omnistudio-datapacks-deploy:Vlocity Build DataPack のデプロイ
ユーザーが Vlocity DataPack のデプロイオーケストレーション を必要としている場合に、このスキルを使用します。対象には、エクスポート/デプロイのワークフロー、マニフェスト主導のデプロイ、失敗のトリアージ、OmniStudio/Industries DataPack の CI/CD シーケンスが含まれます。
対象範囲
次の作業には omnistudio-datapacks-deploy を使用します。
vlocity packDeploy、packRetry、packContinue、packExport、packGetDiffs、validateLocalData- DataPack ジョブファイルの設計(
projectPath、expansionPath、manifest、queries) - 組織間の DataPack 移行と再試行ループ
- DataPack の依存関係、照合キー、GlobalKey に関するトラブルシューティング
次の場合は、ほかのスキルに委任します。
- 標準メタデータを
sf project deployでデプロイする場合 -> platform-metadata-deploy - OmniScripts、FlexCards、IP、Data Mappers を構築する場合 ->
omnistudio-*-build - Product2 EPC バンドルを設計する場合 -> omnistudio-epc-catalog-generate
- Apex/LWC コードを記述する場合 -> platform-apex-generate、experience-lwc-generate
重要な運用ルール
- DataPack には
sf project deployではなく、Vlocity Build(vlocity) コマンドを使用します。 - 利用可能な場合は、ユーザー名/パスワードファイルより Salesforce CLI の認証連携(
-sfdx.username <alias>)を優先します。 - 完全なデプロイの前には、必ず デプロイ前の品質ゲート を実行します。
validateLocalDatapackGetDiffs(任意)- その後に
packDeploy
- エラー数が減少している場合は
packRetryを繰り返し実行し、再試行で改善しなくなったら停止します。 - ソース組織とターゲット組織の間で、照合キーの戦略と GlobalKey の整合性を維持します。
事前に収集する必須コンテキスト
次の情報を確認するか、推測します。
- ソース組織とターゲット組織のエイリアス
- ジョブファイルのパスと DataPack プロジェクトのパス
- デプロイの範囲(プロジェクト全体、マニフェストのサブセット、または特定の
-key) - エクスポート、デプロイ、再試行、続行、差分のみのいずれか
- 名前空間モデル(
%vlocity_namespace%、vlocity_cmt、または core) - 既知の制約(新しいサンドボックスのブートストラップ、トリガーの動作、照合キーのカスタマイズ)
事前チェック:
vlocity help
sf org list
sf org display --target-org <alias> --json
test -f <job-file>.yaml
推奨ワークフロー
1. ツールの準備状況を確認する
npm install --global vlocity
vlocity help
2. プロジェクトデータをローカルで検証する
vlocity -sfdx.username <source-alias> -job <job-file>.yaml validateLocalData
--fixLocalGlobalKeys は、明示的に依頼された場合に限り、影響を説明してから使用します。
3. 必要に応じてソースからエクスポートする
vlocity -sfdx.username <source-alias> -job <job-file>.yaml packExport
vlocity -sfdx.username <source-alias> -job <job-file>.yaml packRetry
4. ターゲットにデプロイする
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packDeploy
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packRetry
5. 中断したジョブを続行する
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packContinue
6. デプロイ後の整合性を確認する
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packGetDiffs
ジョブファイルのひな形:references/job-file-template.md
注意点
| エラー/症状 | 考えられる原因 | 基本的な修正方針 |
|---|---|---|
No match found for ... | ターゲット組織に依存関係がない | 不足している DataPack キーを含めて再デプロイする |
Duplicate Results found for ... GlobalKey | ターゲットに重複レコードがある | 重複を削除してデプロイを再実行する |
Multiple Imported Records ... same Salesforce Record | ソースに照合キーが重複したレコードがある | ソースの重複を削除して再エクスポートする |
No Configuration Found | DataPack の設定が古い | packUpdateSettings を実行するか、autoUpdateSettings を有効にする |
Some records were not processed | 設定の不一致/依存関係の状態が不完全 | 両方の組織の設定を更新してから再試行する |
| SASS/テンプレートのコンパイルエラー | 参照先の UI テンプレートアセットがない | 参照されているテンプレートの依存関係を先にエクスポート/デプロイする |
詳細な一覧:references/troubleshooting-matrix.md
CI/CD に関するガイダンス
デフォルトのパイプライン構成:
- 組織を認証します(
sf org login ...) - ローカルの DataPack の整合性を検証します(
validateLocalData) - 変更された範囲をエクスポートします(
packExportまたはマニフェスト主導のエクスポート) - デプロイします(
packDeploy) - 安定するまで再試行ループを実行します(
packRetry) - 比較し(
packGetDiffs)、デプロイレポートを公開します
増分デプロイを最適化するには、次のようなジョブファイルのオプションを使用します:
gitCheck: truegitCheckKey: <folder>- 決定的に範囲を制御するための
manifest
スキル間の連携
| 必要な作業 | 委任先 | 理由 |
|---|---|---|
| DataPacks 以外のメタデータのデプロイ | platform-metadata-deploy | Metadata API のワークフロー |
| OmniStudio コンポーネントの作成 | omnistudio-*-build | デプロイ前にビルド成果物を作成 |
| EPC 製品およびオファーのペイロードの作成 | omnistudio-epc-catalog-generate | Product2/DataPack モデルの品質 |
| Apex トリガー/ログエラーの診断 | platform-apex-logs-debug、platform-apex-generate | 自動化側で根本原因を修正 |
出力に関する要件
DataPack の操作が完了したら、完了ブロックを提示します:
DataPack goal: <export / deploy / retry / diff / ci-cd>
Source org: <alias or N/A>
Target org: <alias or N/A>
Scope: <job file + manifest/key/full>
Result: <passed / failed / partial>
Key findings: <errors, dependencies, retries, diffs>
Next step: <safe follow-up action>
参照ファイル一覧
| ファイル | 読み込むタイミング |
|---|---|
references/job-file-template.md | ジョブファイルの構成について説明する前に、基準となる設定リファレンスとして読み込みます |
references/troubleshooting-matrix.md | ユーザーからデプロイ失敗の報告があった場合に読み込み、DataPack エラーを診断して修正方法を適用します |
examples/business-internet-plus-bundle/TRANSCRIPT.md | Product2 バンドルの検証計画と実行の例 |
examples/business-internet-plus-bundle/deploy-business-internet-plus-bundle.yaml | 範囲を限定した validateLocalData 実行用のジョブファイルの例 |
examples/business-internet-plus-bundle-deploy/TRANSCRIPT.md | packDeploy と packRetry の結果を含む、デプロイサイクル全体の例 |
examples/business-internet-plus-bundle-deploy/deploy-business-internet-plus-bundle.yaml | マニフェストを対象にした段階的デプロイ用のジョブファイルの例 |
コメント
Markdown 対応