mcpField
D
deploying-omnistudio-datapacks

deploying-omnistudio-datapacks

github.com/forcedotcomクラウド・DevOps1.1k2.4k 回インストール1 日前に更新
リポジトリ

deploying-omnistudio-datapacks について

OmniStudio と Industries の Vlocity Build DataPack のエクスポート、デプロイ、再試行、CI/CD の手順を扱うスキルです。Salesforce 組織間の移行やデプロイ障害を管理するチーム向けに、マニフェストによる範囲指定と検証方法を示します。

主な機能

  1. 01DataPack のエクスポートとデプロイ
  2. 02マニフェストによるデプロイ範囲指定
  3. 03デプロイ前のデータ検証
  4. 04再試行と中断ジョブの再開
  5. 05依存関係と障害のトラブルシューティング
  6. 06CI/CD 手順のガイダンス

活用シーン

  1. 01Salesforce 組織間での DataPack 移行
  2. 02依存関係や GlobalKey エラーの調査
  3. 03CI/CD で範囲を絞ったデプロイの準備

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/forcedotcom/sf-skills --skill deploying-omnistudio-datapacks

インストール後、Claude Code で/deploying-omnistudio-datapacksを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

CREDITS.md
README.md
examples/business-internet-plus-bundle-deploy/
deploy-business-internet-plus-bundle.yaml
TRANSCRIPT.md
examples/business-internet-plus-bundle/
deploy-business-internet-plus-bundle.yaml
TRANSCRIPT.md
references/
job-file-template.md
troubleshooting-matrix.md

詳細

deploying-omnistudio-datapacks: Vlocity Build DataPack のデプロイ

ユーザーが Vlocity DataPack のデプロイのオーケストレーション(エクスポート/デプロイのワークフロー、マニフェスト主導のデプロイ、失敗のトリアージ、OmniStudio/Industries DataPack の CI/CD シーケンス)を必要としている場合に、このスキルを使用します。


対象範囲

次の作業に関わる場合は、deploying-omnistudio-datapacks を使用します。

  • vlocity packDeploy、packRetry、packContinue、packExport、packGetDiffs、validateLocalData
  • DataPack ジョブファイルの設計(projectPath、expansionPath、manifest、queries)
  • 組織間の DataPack 移行と再試行ループ
  • DataPack の依存関係、照合キー、GlobalKey に関するトラブルシューティング

ユーザーが次の作業を行っている場合は、別のスキルに委任します。


重要な運用ルール

  • DataPack には sf project deploy ではなく、Vlocity Build(vlocity) コマンドを使用します。
  • 利用できる場合は、ユーザー名/パスワードファイルより Salesforce CLI 認証連携(-sfdx.username <alias>)を優先します。
  • フルデプロイの前には、必ず デプロイ前の品質ゲートを実行します。
    1. validateLocalData
    2. packGetDiffs(任意)
    3. 続けて packDeploy
  • エラー数が減少している場合は、packRetry を繰り返し使用します。再試行で結果が改善しなくなった時点で停止します。
  • ソース組織とターゲット組織の間で、照合キーの戦略と GlobalKey の整合性を維持します。

最初に確認する必須情報

次の情報を確認するか、推定します。

  • ソース組織とターゲット組織のエイリアス
  • ジョブファイルのパスと DataPack プロジェクトのパス
  • デプロイ範囲(プロジェクト全体、マニフェストのサブセット、または特定の -key)
  • これはエクスポート、デプロイ、再試行、続行、差分のみのいずれか
  • 名前空間モデル(%vlocity_namespace%、vlocity_cmt、またはコア)
  • 既知の制約(新規サンドボックスの初期設定、トリガーの動作、照合キーのカスタマイズ)

事前チェック:

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 FoundDataPack の設定が古いpackUpdateSettings を実行するか、autoUpdateSettings を有効にする
Some records were not processed設定の不一致/依存関係が一部しかない状態両方の組織で設定を更新してから再試行する
SASS/テンプレートのコンパイルエラー参照先の UI テンプレートアセットがない参照されているテンプレートの依存関係を先にエクスポート/デプロイする

詳細な一覧:references/troubleshooting-matrix.md


CI/CD ガイダンス

デフォルトのパイプライン構成:

  1. 組織を認証する(sf org login ...)
  2. ローカルの DataPack の整合性を検証する(validateLocalData)
  3. 変更された範囲をエクスポートする(packExport またはマニフェスト駆動型エクスポート)
  4. デプロイする(packDeploy)
  5. 安定するまで再試行ループを実行する(packRetry)
  6. 比較し(packGetDiffs)、デプロイレポートを公開する

増分デプロイを最適化するには、次のようなジョブファイルのオプションを使用します:

  • gitCheck: true
  • gitCheckKey: <folder>
  • 確定的な範囲制御に使用する manifest

スキル間の連携

ニーズ委任先理由
DataPacks 以外のメタデータのデプロイdeploying-metadataMetadata API のワークフロー
OmniStudio コンポーネントの作成building-omnistudio-*デプロイ前にアーティファクトをビルドする
EPC の商品およびオファーのペイロード作成modeling-omnistudio-epc-catalogProduct2/DataPack モデルの品質
Apex トリガー/ログエラーの診断debugging-apex-logs、generating-apex自動化側の根本原因を修正する

出力に関する要件

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.mdProduct2 バンドルの検証計画と実行の例
examples/business-internet-plus-bundle/deploy-business-internet-plus-bundle.yaml範囲を限定した validateLocalData 実行用のジョブファイルの例
examples/business-internet-plus-bundle-deploy/TRANSCRIPT.mdpackDeploy および packRetry の結果を含む、デプロイサイクル全体の例
examples/business-internet-plus-bundle-deploy/deploy-business-internet-plus-bundle.yamlマニフェストを対象にした段階的デプロイ用のジョブファイルの例

コメント